labelixa-com Printers API

openapi: 3.2.0
info:
  title: Labelixa Com Printers API
  version: 0.4.0
  description: 'Operations tagged Printers 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: Printers
paths:
  /v1/printers/{dpmm}dpmm/labels/{width}x{height}/{index}:
    post:
      summary: Render label
      operationId: render_label_v1_printers__dpmm_dpmm_labels__width_x_height___index__post
      parameters:
      - name: dpmm
        in: path
        required: true
        schema:
          type: integer
          title: Dpmm
      - name: width
        in: path
        required: true
        schema:
          type: number
          title: Width
      - name: height
        in: path
        required: true
        schema:
          type: number
          title: Height
      - name: index
        in: path
        required: true
        schema:
          type: integer
          title: Index
      responses:
        '200':
          description: Successful Response
          content:
            application/json:
              schema: {}
        '422':
          description: Validation Error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/HTTPValidationError'
      description: 'Renders one label of the ZPL in the request body. `dpmm` is the print density (6, 8, 12 or 24 dots/mm), `width`x`height` the label size in inches and `index` the 0-based label to render.


        The `Accept` header picks the output: `image/png` (default), `application/pdf`, `application/json` (visible text and barcode fields with coordinates), `application/zpl` (reformatted ZPL, optionally rescaled with `X-Target-Dpmm`) or `application/epl` (EPL2 conversion). Optional headers: `X-Rotation`, `X-Quality`, `X-Page-Size`, `X-Page-Layout`, `X-Page-Orientation`, `X-Label-Border`.


        Works without a key on the anonymous quota; `X-API-Key` uses your account quota. Each produced label counts as one operation. The response carries `X-Total-Count`, `X-Plan`, `X-RateLimit-Remaining` and, for skipped or unsupported commands, `X-Warnings`. 400: invalid density or size. 413: body over 1 MB, more labels than the plan allows per request, or a single label with too many commands. 429: rate or quota limit (`Retry-After`). 503 with `Retry-After`: the label exceeded the render time cap; the quota is refunded.'
      tags:
      - Printers
  /v1/printers/{dpmm}dpmm/labels/{width}x{height}/:
    post:
      summary: Render all labels
      description: 'Same as the indexed render endpoint but without `index`: with `Accept: application/pdf` every label of the ZPL is returned in a single PDF (one operation per label). Same headers, limits and status codes as the indexed call.'
      operationId: render_all_v1_printers__dpmm_dpmm_labels__width_x_height___post
      parameters:
      - name: dpmm
        in: path
        required: true
        schema:
          type: integer
          title: Dpmm
      - name: width
        in: path
        required: true
        schema:
          type: number
          title: Width
      - name: height
        in: path
        required: true
        schema:
          type: number
          title: Height
      responses:
        '200':
          description: Successful Response
          content:
            application/json:
              schema: {}
        '422':
          description: Validation Error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/HTTPValidationError'
      tags:
      - Printers
components:
  schemas:
    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