Bar Tender Templates

Celigo-published BarTender (.btw) label templates synced daily from BarTender Cloud. List unique names, load selected template details and lookup-cache field mappings, or download a published .btw.

Requires a standard integrator.io JWT with manage or monitor role, plus EDI and EDI label-printing entitlements on the account.

BarTender template schemas

List BarTender label templates

get

/v1/bartenderTemplates

Returns Celigo-published BarTender catalog data. The catalog is read from S3 (catalog.json, written by the daily sync cron) and cached in-process.

Omit name to get unique published template names (sorted). Pass one or more name values to get matching templates and lookup-cache field mappings plus the catalog syncedAt.

name accepts a comma-separated list or repeated query parameters. Matching is case-sensitive and also treats pipe-separated tokens as aliases (amazon | 133 matches amazon or 133). Unknown names return empty templates and fieldMappings — not 404. limit, page, and search are ignored.

Authorizations

AuthorizationstringRequired

Bearer authentication header of the form Bearer <token>.

Query parameters

namestringOptional

Filter to these published template names. Comma-separated or repeated (?name=amazon&name=walmart). When omitted or empty, the response is { names } only.

Example: amazon

Responses

200

Unique names when name is omitted; filtered catalog details when name is provided.

application/json

Response from GET /v1/bartenderTemplates. When name is omitted the body is { names }. When name is provided the body is { syncedAt, templates, fieldMappings } for the matching entries.

namesstring[]Optional

Unique published template names, sorted. Present when name is omitted. An empty catalog returns [].

Example: ["amazon","walmart"]

syncedAtstring · date-timeOptional

UTC timestamp of the last successful catalog sync. Present when name is provided.

Example: 2026-07-10T02:15:00.000Z

401

Unauthorized. The request lacks a valid bearer token, or the provided token failed to authenticate.

Note: the 401 response is produced by the auth middleware before the request reaches the endpoint handler, so it does not follow the standard {errors: [...]} envelope. Instead the body is a bare {message: string} object with no code, no errors array. Callers handling 401s should key off the HTTP status and the message string, not try to destructure an errors[].

application/json

404

The global BarTender label-printing kill switch (BARTENDER_LABEL_PRINTING_DISABLED) is active. The route responds with a bare 404 and an empty body so the feature appears unavailable.

422

The account lacks a required EDI entitlement. Missing edi.enabled or edi.labelPrinting.enabled both return the same edi_subscription_required error — the route reuses the standard EDI license gate used by other B2B Manager endpoints.

application/json

502

The catalog could not be read from S3 or the stored catalog.json is malformed.

application/json

503

The catalog has never been published for this environment, or the EDI license check could not be completed.

application/json

get/v1/bartenderTemplates

GET /v1/bartenderTemplates HTTP/1.1
Host: api.integrator.io
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*

{
  "names": [
    "amazon",
    "walmart"
  ]
}

Download a BarTender label template

get

/v1/bartenderTemplates/{name}/download

Returns the published .btw binary for the named template.

name must match a published catalog entry exactly — pipe-token alias matching from the list route is not applied here. The file is streamed as application/octet-stream with Content-Disposition: attachment.

Authorizations

AuthorizationstringRequired

Bearer authentication header of the form Bearer <token>.

Path parameters

namestringRequired

Published template name from GET /v1/bartenderTemplates. Allowed characters are letters, digits, period, underscore, space, and hyphen; .. is rejected.

Example: amazonPattern: ^[A-Za-z0-9._ -]+$

Responses

200

Published .btw binary.

application/octet-stream

Responsestring · binary

400

name is empty or contains characters outside [A-Za-z0-9._ -], or includes ...

application/json

401

Unauthorized. The request lacks a valid bearer token, or the provided token failed to authenticate.

Note: the 401 response is produced by the auth middleware before the request reaches the endpoint handler, so it does not follow the standard {errors: [...]} envelope. Instead the body is a bare {message: string} object with no code, no errors array. Callers handling 401s should key off the HTTP status and the message string, not try to destructure an errors[].

application/json

404

The template is not in the published catalog, or the global label-printing kill switch is active (bare 404, empty body).

application/json

422

The account lacks a required EDI entitlement. Missing edi.enabled or edi.labelPrinting.enabled both return edi_subscription_required.

application/json

502

The catalog could not be read, or the .btw object could not be fetched from S3.

application/json

503

The catalog has never been published for this environment, or the EDI license check could not be completed.

application/json

get/v1/bartenderTemplates/{name}/download

GET /v1/bartenderTemplates/{name}/download HTTP/1.1
Host: api.integrator.io
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*

binary