Calls without X-API-Key need no key. Calls with it need a paid plan — get a key.
Get an API key
Free tier, no form to fill in. Signing in shares your email address with us — we
store it to create your key and to recognise you if you sign in with another
provider. See our Privacy Policy and
Terms.
openapi: 3.2.0
info:
title: Labelixa Com Print API
version: 0.4.0
description: 'Operations tagged Print across 2 of this provider''s published API definitions: labelixa-com-api-openapi.json, labelixa-com-openapi.json. Each path carries the servers of the definition it was published in.'
tags:
- name: Print
paths:
/v1/print:
post:
summary: Queue print job
description: 'Queues a print job for a registered printer and returns 202. This is not a print confirmation: the agent picks the job up and the furthest status is `dispatched` (bytes handed to the printer); the response says so with `basim_onaylandi: false`. Target `device_id` or `printer_group`; payload `yuk` (or its older name `zpl`) or a stored template (`sablon_id` + `degiskenler`). Passing `kaynak_is_id` of an already rendered job makes the print free; raw payloads are charged here. `Idempotency-Key` is supported and strongly recommended: a retry after a timeout must not print the label twice. Requires an account on a plan with printing (Starter and above, or the free print trial). 400 for invalid requests, 402 when the free print trial is used up, 403 for a premium template on a plan without it, 429 with `Retry-After` when the queue is full.'
operationId: baski_gonder_v1_print_post
requestBody:
content:
application/json:
schema:
$ref: '#/components/schemas/BaskiIstegi'
required: true
responses:
'200':
description: Successful Response
content:
application/json:
schema: {}
'422':
description: Validation Error
content:
application/json:
schema:
$ref: '#/components/schemas/HTTPValidationError'
tags:
- Print
/v1/print/jobs/{job_id}:
get:
summary: Print job status
description: Status of one print job, including the stage it reached and the agent's liveness. Someone else's resource and a non-existent one return the same 404.
operationId: baski_durumu_v1_print_jobs__job_id__get
parameters:
- name: job_id
in: path
required: true
schema:
type: string
title: Job Id
responses:
'200':
description: Successful Response
content:
application/json:
schema: {}
'422':
description: Validation Error
content:
application/json:
schema:
$ref: '#/components/schemas/HTTPValidationError'
tags:
- Print
/v1/print/jobs/{job_id}/cancel:
post:
summary: Cancel queued print job
description: 'Cancels a print job that is still `queued` and returns its status (`cancelled`); the payload is deleted. Idempotent: cancelling a cancelled job returns the same 200 body. 409 with the current `status` when the job is `dispatching`, `uncertain`, `dispatched` or `failed` — a job handed to the agent or the printer cannot be recalled. No webhook event is sent. Someone else''s resource and a non-existent one return the same 404.'
operationId: baski_iptal_v1_print_jobs__job_id__cancel_post
parameters:
- name: job_id
in: path
required: true
schema:
type: string
title: Job Id
responses:
'200':
description: Successful Response
content:
application/json:
schema: {}
'422':
description: Validation Error
content:
application/json:
schema:
$ref: '#/components/schemas/HTTPValidationError'
tags:
- Print
components:
schemas:
BaskiIstegi:
properties:
device_id:
type: string
title: Device Id
default: ''
zpl:
type: string
title: Zpl
default: ''
description: Older name of `yuk`; do not send both.
yuk:
type: string
title: Yuk
default: ''
description: Payload bytes sent to the printer as-is.
dil:
type: string
title: Dil
default: ''
description: 'Payload language: zpl, epl, tspl, cpcl or raw (default: the device''s language).'
kopya:
type: integer
title: Kopya
default: 1
description: Number of copies.
etiket_sayisi:
type: integer
title: Etiket Sayisi
default: 1
description: Number of labels in the payload.
kaynak_is_id:
type: string
title: Kaynak Is Id
default: ''
description: Id of an already rendered job; printing it is not charged again.
sablon_id:
type: string
title: Sablon Id
default: ''
description: Stored template to build the payload from.
degiskenler:
additionalProperties:
type: string
type: object
title: Degiskenler
default: {}
description: Variable values for `sablon_id`.
printer_group:
type: string
title: Printer Group
default: ''
etiket_id:
type: string
title: Etiket Id
default: ''
satirlar:
items:
additionalProperties:
type: string
type: object
type: array
title: Satirlar
default: []
type: object
title: BaskiIstegi
description: 'Print request. `zpl` and `yuk` are two names for the same field: the payload is opaque bytes and ZPL is only one form of it, so `yuk` is the new name and `zpl` is kept for existing integrations. Sending both is rejected.'
HTTPValidationError:
properties:
detail:
items:
$ref: '#/components/schemas/ValidationError'
type: array
title: Detail
type: object
title: HTTPValidationError
ValidationError:
properties:
loc:
items:
anyOf:
- type: string
- type: integer
type: array
title: Location
msg:
type: string
title: Message
type:
type: string
title: Error Type
input:
title: Input
ctx:
type: object
title: Context
type: object
required:
- loc
- msg
- type
title: ValidationError
x-refined-from:
- labelixa-com-api-openapi.json
- labelixa-com-openapi.json