labelixa-com Labels API

openapi: 3.2.0
info:
  title: Labelixa Com Labels API
  version: 0.4.0
  description: 'Operations tagged Labels 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: Labels
paths:
  /v1/labels:
    post:
      summary: Save label
      description: 'Saves a label (201 with an `ETag`). Render endpoints stay stateless; persistence happens only through this explicit call. `Idempotency-Key` is supported: a retry after a network timeout does not create a second label. Requires an account (API key or panel session); anonymous calls get 403 with `X-Quota-Action: signup`. Available on every plan, including Free. The number of saved labels is limited per plan (403 with `X-Quota-Action: upgrade` when full); 413 for oversized content.'
      operationId: etiket_olustur_v1_labels_post
      requestBody:
        required: true
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/EtiketIstegi'
      responses:
        '200':
          description: Successful Response
          content:
            application/json:
              schema: {}
        '422':
          description: Validation Error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/HTTPValidationError'
      tags:
      - Labels
    get:
      summary: List labels
      description: 'Lists the workspace''s labels without ZPL or canvas bodies. `toplam` is the total for the same status filter, for pagination. When the approval workflow is on, the response also carries `onay_akisi: true`: only published labels can be printed. Requires an account (API key or panel session); anonymous calls get 403 with `X-Quota-Action: signup`. Available on every plan, including Free.'
      operationId: etiket_listesi_v1_labels_get
      parameters:
      - name: arama
        in: query
        required: false
        schema:
          anyOf:
          - type: string
          - type: 'null'
          title: Arama
        description: Case-insensitive search in the label name.
      - name: durum
        in: query
        required: false
        schema:
          anyOf:
          - type: string
          - type: 'null'
          title: Durum
        description: 'Status filter: `taslak` (draft), `onay_bekliyor` (awaiting approval) or `yayinlandi` (published).'
      - name: klasor_id
        in: query
        required: false
        schema:
          anyOf:
          - type: string
          - type: 'null'
          title: Klasor Id
        description: Only labels in this folder.
      - name: kok
        in: query
        required: false
        schema:
          type: boolean
          default: false
          title: Kok
        description: Only labels at the root (in no folder).
      - name: favori
        in: query
        required: false
        schema:
          anyOf:
          - type: boolean
          - type: 'null'
          title: Favori
        description: Only favourites (`true`) or only non-favourites (`false`).
      - name: arsiv
        in: query
        required: false
        schema:
          type: boolean
          default: false
          title: Arsiv
        description: List archived labels instead of active ones.
      - name: cop
        in: query
        required: false
        schema:
          type: boolean
          default: false
          title: Cop
        description: List labels in the trash instead of active ones.
      - name: sirala
        in: query
        required: false
        schema:
          type: string
          default: guncel
          title: Sirala
        description: 'Sort order: `guncel` (recently updated, default), `eski` (least recently updated), `ad` (name), `olusturma` (newest created) or `favori` (favourites first).'
      - name: limit
        in: query
        required: false
        schema:
          type: integer
          default: 100
          title: Limit
      - name: offset
        in: query
        required: false
        schema:
          type: integer
          default: 0
          title: Offset
      responses:
        '200':
          description: Successful Response
          content:
            application/json:
              schema: {}
        '422':
          description: Validation Error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/HTTPValidationError'
      tags:
      - Labels
  /v1/labels/{etiket_id}:
    get:
      summary: Get label
      description: Full content of one label plus its `ETag` (the value to send as `If-Match` on writes). Someone else's resource and a non-existent one return the same 404.
      operationId: etiket_getir_v1_labels__etiket_id__get
      parameters:
      - name: etiket_id
        in: path
        required: true
        schema:
          type: string
          title: Etiket Id
      responses:
        '200':
          description: Successful Response
          content:
            application/json:
              schema: {}
        '422':
          description: Validation Error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/HTTPValidationError'
      tags:
      - Labels
    patch:
      summary: Update label
      description: 'Partial update: omitted fields do not change. Every update increments the version and stores the previous state in the history. Requires the `If-Match` header with the label''s current ETag: 428 without it, 412 (with the current version in the body) when it is stale; `*` overwrites deliberately. 400 when no field is given. Someone else''s resource and a non-existent one return the same 404.'
      operationId: etiket_guncelle_v1_labels__etiket_id__patch
      parameters:
      - name: etiket_id
        in: path
        required: true
        schema:
          type: string
          title: Etiket Id
      requestBody:
        required: true
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/EtiketGuncelleme'
      responses:
        '200':
          description: Successful Response
          content:
            application/json:
              schema: {}
        '422':
          description: Validation Error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/HTTPValidationError'
      tags:
      - Labels
    delete:
      summary: Delete label
      description: Moves the label to the trash, where it can be restored for 30 days. `?kalici=true` deletes it permanently instead. Someone else's resource and a non-existent one return the same 404.
      operationId: etiket_sil_v1_labels__etiket_id__delete
      parameters:
      - name: etiket_id
        in: path
        required: true
        schema:
          type: string
          title: Etiket Id
      - name: kalici
        in: query
        required: false
        schema:
          type: boolean
          default: false
          title: Kalici
        description: '`true` deletes permanently instead of moving to the trash.'
      responses:
        '200':
          description: Successful Response
          content:
            application/json:
              schema: {}
        '422':
          description: Validation Error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/HTTPValidationError'
      tags:
      - Labels
  /v1/labels/{etiket_id}/versions:
    get:
      summary: Label version history
      description: 'Version history, newest first, without bodies (the last 50 versions are kept). `guncel_surum` is separate because the current version is not in the history: a version enters the history only when it is overwritten.'
      operationId: etiket_surumleri_v1_labels__etiket_id__versions_get
      parameters:
      - name: etiket_id
        in: path
        required: true
        schema:
          type: string
          title: Etiket Id
      responses:
        '200':
          description: Successful Response
          content:
            application/json:
              schema: {}
        '422':
          description: Validation Error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/HTTPValidationError'
      tags:
      - Labels
  /v1/labels/{etiket_id}/versions/{surum}:
    get:
      summary: Get label version
      description: 'Full content of one version: ZPL, canvas, variable schema and asset references. A missing label, someone else''s label and a pruned version return the same 404.'
      operationId: etiket_surum_getir_v1_labels__etiket_id__versions__surum__get
      parameters:
      - name: etiket_id
        in: path
        required: true
        schema:
          type: string
          title: Etiket Id
      - name: surum
        in: path
        required: true
        schema:
          type: integer
          title: Surum
      responses:
        '200':
          description: Successful Response
          content:
            application/json:
              schema: {}
        '422':
          description: Validation Error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/HTTPValidationError'
      tags:
      - Labels
  /v1/labels/{etiket_id}/versions/{surum}/restore:
    post:
      summary: Restore label version
      description: 'Restores the label to an older version''s content. The restore is written forward as a new version, so the history is never deleted and a restore can itself be undone. Returns the current record. Requires the `If-Match` header with the label''s current ETag: 428 without it, 412 (with the current version in the body) when it is stale; `*` overwrites deliberately.'
      operationId: etiket_surume_don_v1_labels__etiket_id__versions__surum__restore_post
      parameters:
      - name: etiket_id
        in: path
        required: true
        schema:
          type: string
          title: Etiket Id
      - name: surum
        in: path
        required: true
        schema:
          type: integer
          title: Surum
      responses:
        '200':
          description: Successful Response
          content:
            application/json:
              schema: {}
        '422':
          description: Validation Error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/HTTPValidationError'
      tags:
      - Labels
  /v1/labels/{etiket_id}/favorite:
    put:
      summary: Mark label as favourite
      description: Adds the label to favourites. Does not change the version or `updated_at`, so sorting by last change stays truthful.
      operationId: etiket_favori_ac_v1_labels__etiket_id__favorite_put
      parameters:
      - name: etiket_id
        in: path
        required: true
        schema:
          type: string
          title: Etiket Id
      responses:
        '200':
          description: Successful Response
          content:
            application/json:
              schema: {}
        '422':
          description: Validation Error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/HTTPValidationError'
      tags:
      - Labels
    delete:
      summary: Unmark favourite
      operationId: etiket_favori_kaldir_v1_labels__etiket_id__favorite_delete
      parameters:
      - name: etiket_id
        in: path
        required: true
        schema:
          type: string
          title: Etiket Id
      responses:
        '200':
          description: Successful Response
          content:
            application/json:
              schema: {}
        '422':
          description: Validation Error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/HTTPValidationError'
      description: Removes the label from favourites. Does not change the version or `updated_at`.
      tags:
      - Labels
  /v1/labels/{etiket_id}/events:
    get:
      summary: Label event log
      description: 'The label''s audit trail, newest first: event type, version and time only, no content. Labels in the trash are not shown.'
      operationId: etiket_olaylari_v1_labels__etiket_id__events_get
      parameters:
      - name: etiket_id
        in: path
        required: true
        schema:
          type: string
          title: Etiket Id
      - name: limit
        in: query
        required: false
        schema:
          type: integer
          default: 100
          title: Limit
      responses:
        '200':
          description: Successful Response
          content:
            application/json:
              schema: {}
        '422':
          description: Validation Error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/HTTPValidationError'
      tags:
      - Labels
  /v1/labels/{etiket_id}/publish:
    post:
      summary: Publish label
      description: 'Publishes the label as ready to print. The editor''s rule engine runs first: any error-level finding rejects the publish with 409 and the findings (warnings and info do not block). Does not increment the version. When the approval workflow is enabled the label is submitted for approval instead and the call returns 202 with the pending request.'
      operationId: etiket_yayinla_v1_labels__etiket_id__publish_post
      parameters:
      - name: etiket_id
        in: path
        required: true
        schema:
          type: string
          title: Etiket Id
      responses:
        '200':
          description: Successful Response
          content:
            application/json:
              schema: {}
        '422':
          description: Validation Error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/HTTPValidationError'
      tags:
      - Labels
  /v1/labels/{etiket_id}/approve:
    post:
      summary: Approve publish request
      description: Approves the pending approval request; the label is published. Requires the owner or admin role; an editor cannot approve. The response and the record show whether requester and approver are the same account (`ayni_kisi`). 409 when there is no pending request or the content changed.
      operationId: etiket_onayla_v1_labels__etiket_id__approve_post
      parameters:
      - name: etiket_id
        in: path
        required: true
        schema:
          type: string
          title: Etiket Id
      requestBody:
        required: true
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/OnayKarari'
      responses:
        '200':
          description: Successful Response
          content:
            application/json:
              schema: {}
        '422':
          description: Validation Error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/HTTPValidationError'
      tags:
      - Labels
  /v1/labels/{etiket_id}/reject:
    post:
      summary: Reject publish request
      description: Rejects the pending approval request; the label returns to draft. A note (`karar_notu`) is required. Owner or admin role.
      operationId: etiket_reddet_v1_labels__etiket_id__reject_post
      parameters:
      - name: etiket_id
        in: path
        required: true
        schema:
          type: string
          title: Etiket Id
      requestBody:
        required: true
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/OnayKarari'
      responses:
        '200':
          description: Successful Response
          content:
            application/json:
              schema: {}
        '422':
          description: Validation Error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/HTTPValidationError'
      tags:
      - Labels
  /v1/labels/{etiket_id}/approvals:
    get:
      summary: Label approval history
      description: The label's approval history, newest first.
      operationId: etiket_onaylari_v1_labels__etiket_id__approvals_get
      parameters:
      - name: etiket_id
        in: path
        required: true
        schema:
          type: string
          title: Etiket Id
      - 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:
      - Labels
  /v1/labels/{etiket_id}/unpublish:
    post:
      summary: Unpublish label
      description: Moves the label back to draft. The last publish time is kept.
      operationId: etiket_yayindan_kaldir_v1_labels__etiket_id__unpublish_post
      parameters:
      - name: etiket_id
        in: path
        required: true
        schema:
          type: string
          title: Etiket Id
      responses:
        '200':
          description: Successful Response
          content:
            application/json:
              schema: {}
        '422':
          description: Validation Error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/HTTPValidationError'
      tags:
      - Labels
  /v1/labels/{etiket_id}/restore:
    post:
      summary: Restore label from trash
      description: Restores a label from the trash; its folder and status are kept.
      operationId: etiket_geri_al_v1_labels__etiket_id__restore_post
      parameters:
      - name: etiket_id
        in: path
        required: true
        schema:
          type: string
          title: Etiket Id
      responses:
        '200':
          description: Successful Response
          content:
            application/json:
              schema: {}
        '422':
          description: Validation Error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/HTTPValidationError'
      tags:
      - Labels
  /v1/labels/{etiket_id}/duplicate:
    post:
      summary: Duplicate label
      description: Copies a label (201). The copy starts as a draft with no history; it counts towards the plan's saved-label limit.
      operationId: etiket_kopyala_v1_labels__etiket_id__duplicate_post
      parameters:
      - name: etiket_id
        in: path
        required: true
        schema:
          type: string
          title: Etiket Id
      responses:
        '200':
          description: Successful Response
          content:
            application/json:
              schema: {}
        '422':
          description: Validation Error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/HTTPValidationError'
      tags:
      - Labels
  /v1/labels/{etiket_id}/archive:
    put:
      summary: Archive label
      description: 'Archives the label: hidden from the main list but not deleted. The version and `updated_at` do not change.'
      operationId: etiket_arsivle_v1_labels__etiket_id__archive_put
      parameters:
      - name: etiket_id
        in: path
        required: true
        schema:
          type: string
          title: Etiket Id
      responses:
        '200':
          description: Successful Response
          content:
            application/json:
              schema: {}
        '422':
          description: Validation Error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/HTTPValidationError'
      tags:
      - Labels
    delete:
      summary: Unarchive label
      operationId: etiket_arsivden_cikar_v1_labels__etiket_id__archive_delete
      parameters:
      - name: etiket_id
        in: path
        required: true
        schema:
          type: string
          title: Etiket Id
      responses:
        '200':
          description: Successful Response
          content:
            application/json:
              schema: {}
        '422':
          description: Validation Error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/HTTPValidationError'
      description: Moves an archived label back to the main list.
      tags:
      - Labels
  /v1/labels/{etiket_id}/folder:
    put:
      summary: Move label to folder
      description: 'Moves the label into a folder, or to the root with `klasor_id: null`. Does not increment the version.'
      operationId: etiket_klasore_tasi_v1_labels__etiket_id__folder_put
      parameters:
      - name: etiket_id
        in: path
        required: true
        schema:
          type: string
          title: Etiket Id
      requestBody:
        required: true
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/TasimaIstegi'
      responses:
        '200':
          description: Successful Response
          content:
            application/json:
              schema: {}
        '422':
          description: Validation Error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/HTTPValidationError'
      tags:
      - Labels
  /v1/labels/starter-set:
    post:
      summary: Add the shipment label set
      description: 'Adds unbranded shipment labels in five sizes (10x10 cm, 10x15 cm, 4x6 in, 103x150 mm, A6) to the account as drafts; they fill from Business Central posted sales shipments. Names and printed captions are in English. A label that already exists under the same name is skipped, so a second call adds nothing. If the saved-label limit cannot fit every missing label, none is added (403 with X-Quota-Action: upgrade).'
      operationId: bc_gonderi_seti_v1_labels_starter_set_post
      responses:
        '200':
          description: Successful Response
          content:
            application/json:
              schema: {}
      tags:
      - Labels
components:
  schemas:
    EtiketIstegi:
      properties:
        ad:
          type: string
          title: Ad
        zpl:
          type: string
          title: Zpl
        canvas:
          anyOf:
          - {}
          - type: 'null'
          title: Canvas
        degisken_sema:
          anyOf:
          - {}
          - type: 'null'
          title: Degisken Sema
        assetler:
          anyOf:
          - {}
          - type: 'null'
          title: Assetler
        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
      type: object
      required:
      - ad
      - zpl
      title: EtiketIstegi
      description: Body for saving a new label.
    OnayKarari:
      properties:
        karar_notu:
          type: string
          title: Karar Notu
          default: ''
          description: Decision note; required when rejecting.
      type: object
      title: OnayKarari
      description: Body of `approve` and `reject`. A note is required for a rejection and optional for an approval.
    TasimaIstegi:
      properties:
        klasor_id:
          anyOf:
          - type: string
          - type: 'null'
          title: Klasor Id
          description: Target folder id, or `null` for the root.
      type: object
      title: TasimaIstegi
      description: '`klasor_id: null` moves the label to the root. This is a separate endpoint because in a label update `null` means "leave as is".'
    HTTPValidationError:
      properties:
        detail:
          items:
            $ref: '#/components/schemas/ValidationError'
          type: array
          title: Detail
      type: object
      title: HTTPValidationError
    EtiketGuncelleme:
      properties:
        ad:
          anyOf:
          - type: string
          - type: 'null'
          title: Ad
        zpl:
          anyOf:
          - type: string
          - type: 'null'
          title: Zpl
        canvas:
          anyOf:
          - {}
          - type: 'null'
          title: Canvas
        degisken_sema:
          anyOf:
          - {}
          - type: 'null'
          title: Degisken Sema
        assetler:
          anyOf:
          - {}
          - type: 'null'
          title: Assetler
        dpmm:
          anyOf:
          - type: integer
          - type: 'null'
          title: Dpmm
        genislik_in:
          anyOf:
          - type: number
          - type: 'null'
          title: Genislik In
        yukseklik_in:
          anyOf:
          - type: number
          - type: 'null'
          title: Yukseklik In
      type: object
      title: EtiketGuncelleme
      description: 'Partial update: a field that is not sent does not change. To clear a text field send `""`, not `null` (`null` means "leave as is").'
    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