Schemas

Machine-readable error code

Human-readable error message

Field path that caused the error (null for non-field errors)

Short, human-readable summary

HTTP status code

Unique request identifier for troubleshooting

Error type identifier

Human-readable explanation

List of validation errors with per-field details

M2M client identifier provided by Chameleoon support

M2M client secret provided by Chameleoon support

JWT access token for Private API authentication

When the token expires, in UTC (format yyyy-MM-ddTHH:mm:ss.fff)

Number of seconds until the token expires

Current page number

Number of items per page

Total number of pages

Whether a next page exists

Whether a previous page exists

Total number of items across all pages

List of couriers

Unique courier identifier

Display name of the courier

Whether the courier supports configuration profiles

Courier capabilities and constraints

Courier image assets

Whether the courier supports creating pickup requests

Whether the courier supports printing/downloading manifests

Whether the courier supports delivery to a recipient address

Whether the courier supports delivery to a parcel shop/pickup point

Per-country limits and capabilities. Each entry represents a country where the courier delivers.

Whether the courier accepts an ordered shipping/pickup date on a shipment. required — a shipping date must be provided; optional — may be provided; unsupported — not accepted.

Whether the courier accepts package dimensions (width/height/length) on a shipment. supported — dimensions may be provided; unsupported — not accepted.

Last mile couriers that deliver on behalf of this courier, for couriers that delegate final delivery. The full catalog is returned — it is not filtered to the countries you ship to. Empty for couriers that deliver themselves, and also when the catalog is temporarily unavailable.

Pass this value as recipientAddress.parcelShopId when creating a shipment that this last mile courier delivers. Couriers that deliver to their own pickup points additionally require the courierParcelShopId shipment parameter, carrying that point's identifier.

Display name of the last mile courier

ISO 3166-1 alpha-2 country code the last mile courier delivers in

ISO 4217 currency code

Maximum COD amount in the specified currency

ISO 3166-1 alpha-2 country code

ISO 4217 currency code; null when both maxCodPrice and maxInsurance are null

Maximum cash-on-delivery amount in currency; null when COD not supported for this country

Maximum insurance amount in currency; null when insurance not supported for this country

Maximum package weight in kg for this country; null if no known limit

Courier identifier

Courier display name

List of configurable fields

Courier image assets

Courier capabilities and options

Flattened field path (e.g., "api.user", "sender.city", "enableCoverAddress")

Data type of the field — describes how the value is serialized in the configuration JSON, not which UI control to render. There is no dedicated select type.

A field is a dropdown (choice) whenever the options array is present; the type then tells you how the selected value(s) are submitted:

• Single-select dropdown → type: "string" + options. Submit one option value as a string.
• Multi-select dropdown → type: "array" + options (optionally with minItems / maxItems validation). Submit an array of option values.

Free-input fields simply omit options: string for text, number / integer for numerics, boolean for toggles, and object for nested structures.

time is a 24-hour local time-of-day, transmitted as a JSON string in HH:mm form (for example "08:00"). Such fields also carry the exact regex in validation.pattern.value:

Code
^([01][0-9]|2[0-3]):[0-5][0-9]$

Whether the field is mandatory

Pre-translated human-readable field label (server translates based on Accept-Language header)

Configuration group (null for root-level fields)

Whether field contains sensitive data (password, API key)

Pre-translated field description and usage guidelines (server translates based on Accept-Language header)

Example value demonstrating valid input

Default value applied when the field is left unset. Present only for fields that carry a server-side default (e.g. a country or payer-type code); omitted otherwise.

Validation rules for the field

Available choices for dropdown (select) fields. When present, render the field as a dropdown: single-select if type is string, multi-select if type is array. Absent for free-input fields.

Courier identifier

Display name of the courier

Available profiles for this courier

Courier image assets

Profile identifier

Profile display name

Current page number

Number of items per page

Total number of pages

Whether a next page exists

Whether a previous page exists

Total number of items across all pages

List of activated sources

Source identifier — send this as referenceSource when creating a shipment

Instances of this source configured on the account

API credentials and connection settings required by the courier

Sender/return address details used on shipping labels

Default values applied to new shipments when not explicitly provided (e.g., package count, services)

Label printing preferences such as format, paper size, and print options

Identifier of the courier to use for the shipment (e.g., "gls", "dpd", "packeta")

Delivery profile for the courier defining the delivery method (e.g., "na_adresu" for home delivery, "na_pobocku" for pickup point)

Your unique reference number for the shipment, typically an order number from your e-commerce system

Recipient address information

Shipment details

Cash on delivery (COD) information

List of packages in the shipment

Optional secondary reference from an external system (e.g., marketplace order ID)

Optional. System the shipment is attributed to. Defaults to api when omitted, empty or blank, so existing integrations that never send this field are unaffected. Notification triggers, statistics attribution and order-state synchronization back to your e-shop or ERP are keyed on the referenceSource + sourceIdentifier pair, so set it when you want a shipment routed as if it originated in one of your connected systems. Use the identifier of a source connected to your account (see GET /v2/sources). The pair is validated against the sources activated on your account (see GET /v2/sources); a pair that matches none of them is rejected with 422. The values must match the configured source and profile ids exactly, casing included. The pair api / default is always accepted. referenceSource and sourceIdentifier must be supplied together — send both or neither.

Optional. Identifier of the concrete instance of referenceSource, used to distinguish several instances of the same source (for example two e-shops on the same platform). Defaults to default when omitted, empty or blank. referenceSource and sourceIdentifier must be supplied together — send both or neither.

Courier-specific parameters for this shipment. Keys are matched case insensitively and a key that the selected courier does not support is rejected — with 422 on create, and as a failed item on validate, leaving the rest of the batch validated. A key supplied here overrides the same key configured as a courier profile default. Both key and value must be JSON strings — send "150", not 150.

Supported keys per courier: packeta — courierParcelShopId (the external carrier's own pickup point, required when recipientAddress.parcelShopId is a Packeta carrier rather than a Packeta pickup point); gls — DocumentReturnNumber; sds — EUR, VDP, HAP (numeric) and NRB, NRZ, VDL (true / false); gw — any key, forwarded as a courier text key, except the reserved COD_CASH and COD_CREDIT_CARD (use codPrice instead). Every other courier accepts no parameters.

The shape is the same array of key / value entries that v1 accepts.

Full name of the recipient or contact person

Street name and house/building number of the delivery address

Postal/ZIP code of the delivery address

City or town of the delivery address

ISO 3166-1 alpha-2 country code of the delivery address (e.g., "SK", "CZ", "DE")

Recipient phone number including country code, used by courier for delivery notifications (e.g., +421901234567)

Recipient email address, used by courier for delivery notifications and tracking updates

Company or business name of the recipient (omit for private individuals)

Additional address line such as apartment number, floor, or building entrance

Identifier of the pickup point or parcel shop for non-home deliveries (required when courier profile targets a pickup point)

Total declared value of goods in the shipment, used for insurance and customs declarations

ISO 4217 three-letter currency code for the shipment value (e.g., "EUR", "CZK", "PLN")

Requested date for courier to pick up or process the shipment (format yyyy-MM-dd)

Delivery instructions or notes for the courier (e.g., "Leave at reception", "Call before delivery")

ISO 4217 three-letter currency code for the COD amount (e.g., "EUR", "CZK")

Variable symbol used to identify the COD payment in bank reconciliation (typically an order or invoice number)

Amount the courier should collect from the recipient upon delivery. Must not be negative; 0 is accepted. Omitting the field is the same as sending 0. The codPrice object itself is required — send {"value": 0, ...} for a non-COD shipment.

1-based index identifying this package within a multi-package shipment

Total weight of the package in the unit specified by weightUnit (defaults to kilograms)

Unit of weight measurement for the weight field

Longest side of the package in the unit specified by dimensionUnit

Second-longest side of the package in the unit specified by dimensionUnit

Shortest side (depth) of the package in the unit specified by dimensionUnit

Unit of measurement for length, width, and height fields

Human-readable description of the package contents, used for customs declarations on international shipments

List of ADR (dangerous goods) items in the package. Required for shipments containing hazardous materials.

UN number identifying the dangerous substance or article (e.g. "1234")

Weight of the dangerous goods in kilograms

Number of pieces containing this dangerous good

Volume of the dangerous goods in liters

Official shipping name of the dangerous goods as defined by ADR regulations

UN packing group indicating the degree of danger (I = great, II = medium, III = minor)

Type of packaging used for the dangerous goods (UN packaging code)

ADR hazard class or division (e.g. "3" for flammable liquids, "4.1" for flammable solids)

Whether the goods are shipped under ADR limited quantity exemptions

Whether the goods are classified as environmentally hazardous (marine pollutant)

Whether this is an empty uncleaned container that previously held dangerous goods

Technical chemical name of the dangerous goods (required for generic or N.O.S. entries)

Net explosive mass in kilograms (applicable to class 1 explosives)

ADR tunnel restriction code (e.g. "C/D", "E") defining tunnel passage restrictions

Overall validation result

Individual validation results

Reference number of the validated shipment

Source of the reference

Validation messages

Whether the shipment passed validation

Property that failed validation

Message severity

Validation message text

Current page number

Number of items per page

Total number of pages

Whether a next page exists

Whether a previous page exists

Total number of items across all pages

Current page number

Number of items per page

Total number of pages

Whether a next page exists

Whether a previous page exists

Total number of items across all pages

List of parcel shops

Identifier of the parcel-shop record in the Chameleoon database.

Identifier of the courier operating this point (e.g., "packeta", "gls", "dpd").

Courier-native branch identifier. Pass this value as parcelShopId when creating a shipment to this pickup point.

Display name of the point.

ISO 3166-1 alpha-2 country code.

Latitude of the point. Null when the courier does not provide coordinates.

Longitude of the point. Null when the courier does not provide coordinates.

Weekly opening hours. Absent when the courier does not provide them.

URLs of photos of the point.

Whether card payment is available at this point. Null when the courier does not report it.

Timestamp of the last update to this record.

Opening time, 24-hour zero-padded "HH:mm".

Closing time, 24-hour zero-padded "HH:mm".

Current page number

Number of items per page

Total number of pages

Whether a next page exists

Whether a previous page exists

Total number of items across all pages

List of shipments

Unique shipment identifier

Your reference number for this shipment (typically an order number from your system)

Secondary reference from an external system (e.g., marketplace order ID)

Channel through which the shipment was created (e.g., "api", "web", "shopify")

Identifier of the specific integration or source that created this shipment

Identifier of the courier handling this shipment (e.g., "gls", "dpd", "packeta")

Delivery profile used for this shipment (e.g., "na_adresu" for home delivery)

Tracking numbers assigned by the courier, one per package in the shipment

Timestamp when the shipment was created in Chameleoon (format yyyy-MM-ddTHH:mm:ss.fff)

Recipient address information

Shipment summary details

Cash on delivery (COD) information

Tracking information for a shipment

List of packages

Current shipment state

Tracking history events

Courier-specific event code

Event description

Shipment state at this event

Event timestamp (format yyyy-MM-ddTHH:mm:ss.fff)

Additional event metadata

Metadata key or code

Metadata value

Successfully uploaded shipments

Failed shipments

Unique shipment identifier

Your reference number for this shipment (as provided in the request)

Channel through which the shipment was created (e.g., "api")

Tracking numbers assigned by the courier, one per package

Courier-specific additional properties returned after shipment creation

Your reference number for the shipment that failed to create

Validation or courier error messages explaining why the shipment creation failed

List of shipment IDs to delete

List of shipping numbers to print labels for

Label paper size format. Passed directly to courier.

Output format type. "pdf" returns base64-encoded PDF, "zpl" returns raw ZPL text.

Starting position on A4 label sheet

Base64-encoded PDF string when outputType is "pdf", or raw ZPL text when outputType is "zpl"

The output format type of the document

Current page number

Number of items per page

Total number of pages

Whether a next page exists

Whether a previous page exists

Total number of items across all pages

List of pickup items

Shipment ID

Customer reference number

Courier identifier

Courier profile used

Tracking number assigned by the courier

Recipient name

Recipient street address

Recipient city

Recipient postal code

Whether a pickup has already been scheduled

Creation timestamp

Courier identifier for the pickup

List of shipping numbers to include in pickup

Base64-encoded PDF pickup document

Current page number

Number of items per page

Total number of pages

Whether a next page exists

Whether a previous page exists

Total number of items across all pages

List of pickup records

Unique pickup identifier

Courier identifier

Courier profile used for the pickup

Timestamp when the pickup was created (format yyyy-MM-ddTHH:mm:ss.fff)

Number of shipments included in the pickup

Whether a pickup manifest PDF is available for download

Unique pickup identifier

Courier identifier

Courier profile used for the pickup

Timestamp when the pickup was created (format yyyy-MM-ddTHH:mm:ss.fff)

List of shipment IDs included in the pickup

Whether a pickup manifest PDF is available for download

Base64-encoded PDF pickup manifest document

Event type to subscribe to.

• shipment_created / shipment_updated / shipment_deleted — shipment lifecycle events. Payload: ShipmentResponseDto (created / updated) or WebhookDeletedShipmentDto (deleted).
• account_updated / account_deleted — account lifecycle events. Payload: WebhookAccountDto (updated) or WebhookDeletedAccountDto (deleted).
• configuration_created / configuration_updated / configuration_deleted — courier configuration lifecycle events. Payload: WebhookConfigurationDto, which identifies the affected configuration by courierId and profileId.

HTTPS endpoint URL where webhook event payloads will be delivered via POST

Event type that triggers this webhook. See CreateWebhookRequestDto.type for the meaning of each value.

HTTPS endpoint URL where webhook event payloads will be delivered via POST

Webhook delivery status:

• active: Webhooks are being sent normally
• suspended: Automatically paused due to client-side processing errors
• inactive: Manually paused by the user

Unique webhook subscription identifier

Event type that triggers this webhook. See CreateWebhookRequestDto.type for the meaning of each value.

HTTPS endpoint URL where webhook event payloads will be delivered via POST

Timestamp when the webhook subscription was created (format yyyy-MM-ddTHH:mm:ss.fff)

Webhook delivery status:

• active: Webhooks are being sent normally
• suspended: Automatically paused due to client-side processing errors
• inactive: Manually paused by the user

Timestamp of the most recent modification to this webhook subscription

Current page number

Number of items per page

Total number of pages

Whether a next page exists

Whether a previous page exists

Total number of items across all pages

List of webhooks

Event identifier

Identifier of the account that owns the event

Event type that triggered this webhook delivery

Timestamp when the event was generated (format yyyy-MM-ddTHH:mm:ss.fff)

Event data. Schema varies by event type:

• For shipment_created and shipment_updated events, this is a full ShipmentResponseDto.
• For shipment_deleted events, this is a WebhookDeletedShipmentDto with minimal shipment info.
• For account_updated events, this is a WebhookAccountDto.
• For account_deleted events, this is a WebhookDeletedAccountDto with minimal account info.
• For configuration_created, configuration_updated, and configuration_deleted events, this is a WebhookConfigurationDto.

Unique shipment identifier

Reference number of the deleted shipment

Tracking numbers that were assigned by the courier

Courier identifier

Delivery profile used for this shipment

Channel through which the shipment was created

Identifier of the specific integration or source that created this shipment

Unique account identifier

Account address included in WebhookAccountDto

Timestamp when the account was last changed (format yyyy-MM-ddTHH:mm:ss.fff)

Account / company name

Primary contact email

Email address used for invoicing

Contact phone number

Business registration number (IČO)

VAT registration number (IČ DPH)

Tax identification number (DIČ)

Current account status

Street and house number

City

Postal code

ISO 3166-1 alpha-2 country code

Unique identifier of the deleted account

Name of the deleted account

Primary contact email of the deleted account

Timestamp when the account was removed (format yyyy-MM-ddTHH:mm:ss.fff)

Courier identifier the configuration belongs to

Delivery profile the configuration belongs to

Unique account identifier

Company or trading name of the account holder

Street name and building number of the account billing address

City or town of the account billing address

Postal/ZIP code of the account billing address

ISO 3166-1 alpha-2 country code of the account billing address (e.g., "SK", "CZ")

Primary contact email address for billing and platform notifications

Primary contact phone number including country code (e.g., +421901234567)

Current account status; inactive accounts cannot create shipments or use API functionality

Timestamp when the account was created (format yyyy-MM-ddTHH:mm:ss.fff)

Timestamp when the account was last modified (format yyyy-MM-ddTHH:mm:ss.fff)

National business/company registration number (e.g., ICO in SK/CZ)

Tax identification number (e.g., DIC in SK/CZ)

VAT identification number for EU VAT purposes (e.g., IC DPH in SK/CZ)

Current prepaid credit balance available for shipment processing

Whether automatic top-up payments are enabled when credit balance drops below the configured threshold

Additional account-level configuration parameters as key-value pairs

Unique account identifier

Company or trading name of the account holder

Street name and building number of the account billing address

City or town of the account billing address

Postal/ZIP code of the account billing address

ISO 3166-1 alpha-2 country code

Primary contact email address

Primary contact phone number including country code

Current account status

Timestamp when the account was created (format yyyy-MM-ddTHH:mm:ss.fff)

Timestamp when the account was last modified (format yyyy-MM-ddTHH:mm:ss.fff)

National business/company registration number

Tax identification number

VAT identification number

Additional account-level configuration parameters

Current page number

Number of items per page

Total number of pages

Whether a next page exists

Whether a previous page exists

Total number of items across all pages

List of accounts

Company or trading name of the account holder

Street name and building number of the billing address

City or town of the billing address

Postal/ZIP code of the billing address

ISO 3166-1 alpha-2 country code of the billing address (e.g., "SK", "CZ")

Primary contact email address for billing and platform notifications

Primary contact phone number including country code (e.g., +421901234567)

National business/company registration number (e.g., ICO in SK/CZ)

Tax identification number (e.g., DIC in SK/CZ)

VAT identification number for EU VAT purposes (e.g., IC DPH in SK/CZ)

Additional account-level configuration parameters as key-value pairs

Company or trading name of the account holder

Street name and building number of the billing address

City or town of the billing address

Postal/ZIP code of the billing address

ISO 3166-1 alpha-2 country code of the billing address (e.g., "SK", "CZ")

Primary contact email address for billing and platform notifications

Primary contact phone number including country code (e.g., +421901234567)

National business/company registration number (e.g., ICO in SK/CZ)

Tax identification number (e.g., DIC in SK/CZ)

VAT identification number for EU VAT purposes (e.g., IC DPH in SK/CZ)

Additional account-level configuration parameters as key-value pairs

Unique API key identifier

Human-readable key name

Masked API key value (first 4 + **** + last 4)

Whether the key is currently active

Creation timestamp (format yyyy-MM-ddTHH:mm:ss.fff)

Current page number

Number of items per page

Total number of pages

Whether a next page exists

Whether a previous page exists

Total number of items across all pages

List of API keys

Unique API key identifier

Human-readable key name

Full API key value (only available at creation time)

Creation timestamp (format yyyy-MM-ddTHH:mm:ss.fff)

Partner account ID

Human-readable name for the key

Current page number

Number of items per page

Total number of pages

Whether a next page exists

Whether a previous page exists

Total number of items across all pages

List of invoices

Unique invoice identifier

Invoice title or number

Invoice creation timestamp

Unique payment identifier

Current payment processing status

Payment amount that was charged or will be charged

ISO 4217 three-letter currency code for the payment (e.g., "EUR", "CZK")

Timestamp of the most recent payment status change (format yyyy-MM-ddTHH:mm:ss.fff)

Account identifier to charge

Credit amount to add to the account balance (minimum 1)

Payment currency. Only "EUR" is supported.

URL to redirect user after payment

Whether to enable recurring payments

Auto-charge when balance drops below this amount

URL where a POST request will be sent when payment status changes. Must use HTTPS protocol.

Unique payment identifier

URL to redirect user to payment gateway

Unique payment identifier

Current payment processing status

Payment amount that was charged or will be charged

ISO 4217 three-letter currency code for the payment (e.g., "EUR", "CZK")

Timestamp of the most recent payment status change (format yyyy-MM-ddTHH:mm:ss.fff)

Street and house number

City

Postal code

ISO 3166-1 alpha-2 country code. Chameleoon Delivery currently operates in Czechia only.

Company / organization name

Name of the contact person at this address

Contact phone number

Contact email address

Display label for this address entry

A single physical address used on a Chameleoon Delivery contract. The same shape is used for the pickup, cover (billing), and return addresses.

Unique address identifier

Optional billing / cover address. Defaults to the pickup address when omitted.

Optional return address for undelivered shipments. Defaults to the pickup address when omitted.

Display label for this address entry

A single physical address used on a Chameleoon Delivery contract. The same shape is used for the pickup, cover (billing), and return addresses.

Optional billing / cover address. Defaults to the pickup address when omitted.

Optional return address for undelivered shipments. Defaults to the pickup address when omitted.

Payout currency

Account holder name

Unique bank account identifier

IBAN. Provide this, or accountNumber + bankCode.

SWIFT / BIC code

Domestic account number. Use together with bankCode when iban is not provided.

Domestic bank code. Use together with accountNumber when iban is not provided.