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 Bc API
version: 0.4.0
description: 'Operations tagged Bc 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: Bc
paths:
/v1/bc/tenants:
get:
summary: List Business Central mappings
operationId: bc_kiraci_listesi_v1_bc_tenants_get
responses:
'200':
description: Successful Response
content:
application/json:
schema: {}
description: Lists the Business Central tenant/environment/company mappings of this account. Requires an account on a plan with printing.
tags:
- Bc
post:
summary: Map Business Central tenant
description: 'Maps a Business Central tenant, environment and company to this account: 201 when new, 200 when it already exists, 409 when another account owns it. Requires an account on a plan with printing.'
operationId: bc_kiraci_ekle_v1_bc_tenants_post
requestBody:
content:
application/json:
schema:
$ref: '#/components/schemas/BcKiraciIstegi'
required: true
responses:
'200':
description: Successful Response
content:
application/json:
schema: {}
'422':
description: Validation Error
content:
application/json:
schema:
$ref: '#/components/schemas/HTTPValidationError'
tags:
- Bc
/v1/bc/tenants/{eslesme_id}:
delete:
summary: Delete Business Central mapping
operationId: bc_kiraci_sil_v1_bc_tenants__eslesme_id__delete
parameters:
- name: eslesme_id
in: path
required: true
schema:
type: string
title: Eslesme Id
responses:
'200':
description: Successful Response
content:
application/json:
schema: {}
'422':
description: Validation Error
content:
application/json:
schema:
$ref: '#/components/schemas/HTTPValidationError'
description: Deletes a tenant mapping. 204 on success, 404 when not found.
tags:
- Bc
/v1/bc/print:
post:
summary: Print from Business Central
description: 'Print request from Business Central: the tenant mapping is checked, then the monthly cap, then the job is queued exactly like `POST /v1/print` (202 means queued, not printed). Routing context (document type, location, user, category) can select a device through print rules. A saved label that uses `shipment_package_number` prints once per parcel when the values carry `shipment_package_count`. 404 when the mapping is unknown, 402 with `X-Quota-Action: upgrade` when the monthly cap is reached, 409 when a rule cannot be resolved.'
operationId: bc_baski_gonder_v1_bc_print_post
requestBody:
content:
application/json:
schema:
$ref: '#/components/schemas/BcBaskiIstegi'
required: true
responses:
'200':
description: Successful Response
content:
application/json:
schema: {}
'422':
description: Validation Error
content:
application/json:
schema:
$ref: '#/components/schemas/HTTPValidationError'
tags:
- Bc
/v1/bc/dictionary:
get:
summary: Business Central field dictionary
description: 'Static mapping of Business Central source types and fields to label variables, used by the Business Central extension and the designer. A field that is not a stored Business Central field carries `uretim` (`hesap`: computed by the extension, e.g. parcels and gross weight from the shipment lines; `labelixa`: filled by Labelixa, e.g. the parcel sequence) and `hesap_notu`.'
operationId: bc_sozluk_getir_v1_bc_dictionary_get
responses:
'200':
description: Successful Response
content:
application/json:
schema: {}
tags:
- Bc
components:
schemas:
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
BcBaskiIstegi:
properties:
device_id:
type: string
title: Device Id
default: ''
zpl:
type: string
title: Zpl
default: ''
yuk:
type: string
title: Yuk
default: ''
dil:
type: string
title: Dil
default: ''
kopya:
type: integer
title: Kopya
default: 1
etiket_sayisi:
type: integer
title: Etiket Sayisi
default: 1
kaynak_is_id:
type: string
title: Kaynak Is Id
default: ''
sablon_id:
type: string
title: Sablon Id
default: ''
degiskenler:
additionalProperties:
type: string
type: object
title: Degiskenler
default: {}
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: []
kiraci:
type: string
title: Kiraci
ortam:
type: string
title: Ortam
sirket:
type: string
title: Sirket
default: ''
belge_turu:
type: string
title: Belge Turu
default: ''
lokasyon:
type: string
title: Lokasyon
default: ''
kullanici:
type: string
title: Kullanici
default: ''
kategori:
type: string
title: Kategori
default: ''
type: object
required:
- kiraci
- ortam
title: BcBaskiIstegi
description: 'The `/v1/print` body plus the Business Central identity. Without a tenant mapping the job is not queued. Routing context (document type, location, user, category): when print rules are enabled, a matching rule takes precedence over the device in the request.'
HTTPValidationError:
properties:
detail:
items:
$ref: '#/components/schemas/ValidationError'
type: array
title: Detail
type: object
title: HTTPValidationError
BcKiraciIstegi:
properties:
kiraci:
type: string
title: Kiraci
ortam:
type: string
title: Ortam
sirket:
type: string
title: Sirket
default: ''
type: object
required:
- kiraci
- ortam
title: BcKiraciIstegi
x-refined-from:
- labelixa-com-api-openapi.json
- labelixa-com-openapi.json