Schemas

Name of the recipient

Street address

ZIP code

City name

ISO country code (2 letters)

Name of the company

Additional street details

Phone number

Email address

Required if you want to send shipment to parcel shop

Value of shipment

Currency code

Date of shipment pickup by courier (format yyyy-MM-dd)

Note for the shipment

Note for the driver

Description of items inside package

Value of cash on delivery

Currency of cash on delivery

Variable symbol of payment cash on delivery

Enable email notifications

Enable phone notifications

Enable SMS notifications

Weight of package in the unit specified by WeightUnit (kilograms when WeightUnit is omitted)

Unit of the Weight field. When omitted, Weight is interpreted in kilograms.

Package cover type

Volume of package

Width of package in the unit specified by DimensionUnit

Height of package in the unit specified by DimensionUnit

Length of package in the unit specified by DimensionUnit

Unit of the Width, Height and Length fields. When omitted, the courier's default unit applies (centimeters for most couriers).

List of ADR (dangerous goods) items in the package

UN number identifying the dangerous substance or article

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

UN packing group indicating the degree of danger

Type of packaging used for the dangerous goods

ADR hazard class (e.g. "3", "4.1")

Whether the goods are shipped as limited quantity

Whether the goods are environmentally hazardous

Whether this is an empty uncleaned container

Technical chemical name of the dangerous goods

Net explosive mass in kilograms (for class 1 goods)

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

Parameter key

Parameter value

Unique value that identify entity in the application Chameleoon

Reference that identify entity in your system

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 /configurations/sources). The pair is validated against the sources activated on your account (see GET /configurations/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.

ID of shipping order

Reference number of shipping order

External reference

Source of data

Source identifier

ID of courier

ID of courier profile

Shipping numbers returned by courier

Date and time when shipping order was created (format yyyy-MM-ddTHH:mm:ss)

Current state of shipment (created, shipping, ready_for_pickup, ready_for_pickup_2_days, not_delivered, delivered, returned, unknown)

Tracking code from courier

Tracking message

Date and time of tracking event (format yyyy-MM-ddTHH:mm:ss)

State of shipment at this point

Status of validation result, one of OK, WARNING, ERROR

Reference number of sent shipping order

Status of validation result, one of OK, WARNING, ERROR

Status of validation item result, one of WARNING, ERROR

Name of invalid attribute

Validation message

ID of shipping order

Reference number of shipping order

Source of data

Shipping numbers returned by courier

Additional properties

Reference number of shipping order

Source of data

Error code

Message returned by courier API

Rewritten error message, can be same as originalMessage

Current page number

Number of items per page

Total number of pages

Indicates if there is a next page

Indicates if there is a previous page

Total number of items

Array of result items

The ID of the courier

The name of the courier

Indicates whether the courier allows the creation of an order pickup

Indicates whether the courier allows the printing of a shipment manifest

The ID of the courier

The ID of the configuration

A user-friendly name for the configuration

The ID of the source — send this as ReferenceSource

Instances of this source configured on the account

ID of shipping order

Reference number

Source of reference

Source identifier

ID of courier

Configuration profile

Shipping number

Name of addressee

Street address

City

ZIP code

Payment type

Variable symbol

Currency of total price

Total price

Currency of COD price

COD price

Indicates if pickup was created

Date and time when shipping order was created (format yyyy-MM-ddTHH:mm:ss)

List of shipping numbers, all of which must belong to the same courier

Base64 encoded manifest document (if courier supports it)

List of IDs, maximum number of items is 20

Position on the page

Label format (a4)

List of shipping numbers

ID of the printer. If provided, the label will be printed on the specified printer.

A short, human-readable summary of the problem

The HTTP status code

A human-readable explanation of the problem

A URI reference that identifies the specific occurrence of the problem

Unique request identifier

Additional error details