labelixa-com Bulk API

openapi: 3.2.0
info:
  title: Labelixa Com Bulk API
  version: 0.4.0
  description: 'Operations tagged Bulk 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: Bulk
paths:
  /v1/bulk/jobs:
    post:
      summary: Create bulk job
      description: 'Starts a bulk generation job from a template and data rows (Professional, Business and Enterprise plans). Quota is charged up front, one operation per row; the row limit equals the plan''s per-request label limit (413 above it). `Idempotency-Key` is supported: a retry with the same key does not create a second job or charge the quota twice. With `device_id` (and `cikti: "zpl"`) the generated ZPL stream is also sent to that printer as one print job. Returns 202 with the job id.'
      operationId: bulk_is_olustur_v1_bulk_jobs_post
      requestBody:
        required: true
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/BulkIsIstegi'
      responses:
        '200':
          description: Successful Response
          content:
            application/json:
              schema: {}
        '422':
          description: Validation Error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/HTTPValidationError'
      tags:
      - Bulk
    get:
      summary: List bulk jobs
      description: The caller's bulk job history, newest first, so a finished job can be found again without its id.
      operationId: bulk_is_gecmisi_v1_bulk_jobs_get
      parameters:
      - name: limit
        in: query
        required: false
        schema:
          type: integer
          default: 50
          title: Limit
      responses:
        '200':
          description: Successful Response
          content:
            application/json:
              schema: {}
        '422':
          description: Validation Error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/HTTPValidationError'
      tags:
      - Bulk
  /v1/bulk/jobs/{is_id}/cancel:
    post:
      summary: Cancel bulk job
      description: Cancels a job that has not started yet. A running or finished job cannot be cancelled and returns 404 (the same body, so the state does not leak).
      operationId: bulk_is_iptal_v1_bulk_jobs__is_id__cancel_post
      parameters:
      - name: is_id
        in: path
        required: true
        schema:
          type: string
          title: Is Id
      responses:
        '200':
          description: Successful Response
          content:
            application/json:
              schema: {}
        '422':
          description: Validation Error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/HTTPValidationError'
      tags:
      - Bulk
  /v1/bulk/jobs/{is_id}/download:
    get:
      summary: Download bulk job output
      description: 'Downloads a finished job''s output: a ZIP by default, or a single merged multi-page PDF with `?bicim=pdf`. 409 while the job is not finished; 413 when the job is too large for one PDF (the response says roughly how many labels fit). Someone else''s resource and a non-existent one return the same 404.'
      operationId: bulk_is_indir_v1_bulk_jobs__is_id__download_get
      parameters:
      - name: is_id
        in: path
        required: true
        schema:
          type: string
          title: Is Id
      - name: bicim
        in: query
        required: false
        schema:
          type: string
          default: zip
          title: Bicim
        description: 'Output format: `zip` (default) or `pdf` (one merged PDF).'
      responses:
        '200':
          description: Successful Response
          content:
            application/json:
              schema: {}
        '422':
          description: Validation Error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/HTTPValidationError'
      tags:
      - Bulk
  /v1/bulk/jobs/{is_id}:
    get:
      summary: Bulk job status
      description: Job status and progress. Someone else's resource and a non-existent one return the same 404.
      operationId: bulk_is_durumu_v1_bulk_jobs__is_id__get
      parameters:
      - name: is_id
        in: path
        required: true
        schema:
          type: string
          title: Is Id
      responses:
        '200':
          description: Successful Response
          content:
            application/json:
              schema: {}
        '422':
          description: Validation Error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/HTTPValidationError'
      tags:
      - Bulk
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
    BulkIsIstegi:
      properties:
        zpl:
          type: string
          title: Zpl
        satirlar:
          items:
            additionalProperties:
              type: string
            type: object
          type: array
          title: Satirlar
        cikti:
          type: string
          title: Cikti
          default: zpl
        dpmm:
          type: integer
          title: Dpmm
          default: 8
        genislik_in:
          type: number
          title: Genislik In
          default: 4.0
        yukseklik_in:
          type: number
          title: Yukseklik In
          default: 6.0
        device_id:
          type: string
          title: Device Id
          default: ''
      type: object
      required:
      - zpl
      - satirlar
      title: BulkIsIstegi
x-refined-from:
- labelixa-com-api-openapi.json
- labelixa-com-openapi.json