Chameleoon Delivery
Activate and manage Chameleoon Delivery — shipping under Chameleoon's own carrier contracts (PPL and Balíkovna) instead of bringing your own courier credentials.
Activation is contract-based and mirrors the onboarding wizard in the partner portal:
- Create the contract —
POST /v2/chameleoon-delivery/contractcreates a draft contract (pending,submittedAtunset). - Add at least one pickup address —
POST /v2/chameleoon-delivery/contract/addresses. - Add at least one bank account —
POST /v2/chameleoon-delivery/contract/bank-accounts(for cash-on-delivery payouts). - Submit for approval —
POST /v2/chameleoon-delivery/contract/submit. Chameleoon reviews the contract and moves it toactive. - Enable carriers — once the contract is
active, enableppland/orbalikovnaviaPOST /v2/chameleoon-delivery/contract/carriers.
Read the current state, status, addresses, bank accounts, and enabled carriers any time via GET /v2/chameleoon-delivery/contract. Chameleoon Delivery currently operates in Czechia only.
Get Chameleoon Delivery contract
Returns the partner's Chameleoon Delivery contract, including its current status, addresses, bank accounts, and enabled carriers. Returns 404 if no contract has been created yet.
Headers
Accept-LanguageLanguage code for localized responses
Get Chameleoon Delivery contract › Responses
The Chameleoon Delivery contract
idUnique contract identifier
statusLifecycle status of a Chameleoon Delivery contract, and of each carrier within it.
pending— created and still editable, or submitted and awaiting Chameleoon approval (tell the two apart via the contract'ssubmittedAt)active— approved by Chameleoon and usablesuspended— temporarily disabled by Chameleoondeactivated— permanently disabled
submittedAtWhen the contract was submitted for approval; null while still a draft (format yyyy-MM-ddTHH:mm:ss.fff)
Pickup / cover / return addresses on the contract
Bank accounts used for cash-on-delivery payouts
Carriers enabled (or pending) within the contract
createdWhen the contract was created (format yyyy-MM-ddTHH:mm:ss.fff)
changedWhen the contract was last changed (format yyyy-MM-ddTHH:mm:ss.fff)
Create Chameleoon Delivery contract
Creates a new draft Chameleoon Delivery contract for the partner. The contract starts in
pending status with submittedAt unset. Add at least one address and one bank account, then
submit it for approval. A partner can have only one contract — calling this when a contract
already exists returns 409.
Create Chameleoon Delivery contract › Responses
Contract created
idUnique contract identifier
statusLifecycle status of a Chameleoon Delivery contract, and of each carrier within it.
pending— created and still editable, or submitted and awaiting Chameleoon approval (tell the two apart via the contract'ssubmittedAt)active— approved by Chameleoon and usablesuspended— temporarily disabled by Chameleoondeactivated— permanently disabled
submittedAtWhen the contract was submitted for approval; null while still a draft (format yyyy-MM-ddTHH:mm:ss.fff)
Pickup / cover / return addresses on the contract
Bank accounts used for cash-on-delivery payouts
Carriers enabled (or pending) within the contract
createdWhen the contract was created (format yyyy-MM-ddTHH:mm:ss.fff)
changedWhen the contract was last changed (format yyyy-MM-ddTHH:mm:ss.fff)
Submit Chameleoon Delivery contract for approval
Submits the draft contract for Chameleoon's approval and stamps submittedAt. Requires at least
one address and one bank account. Fails with 409 if the contract was already submitted, and with
422 if the contract is incomplete.
Submit Chameleoon Delivery contract for approval › Responses
Contract submitted for approval
Add contract address
Adds a pickup address (with optional cover and return addresses) to the contract.
Add contract address › Request Body
titleDisplay 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.
Add contract address › Responses
Address created
titleDisplay 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.
idUnique 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.
Update contract address
Updates an existing contract address.
path Parameters
addressIdUnique address identifier
Update contract address › Request Body
titleDisplay 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.
Update contract address › Responses
Address updated
titleDisplay 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.
idUnique 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.
Add contract bank account
Adds a bank account to the contract, used for cash-on-delivery payouts. Provide either iban,
or accountNumber together with bankCode.
Add contract bank account › Request Body
currencyPayout currency
holderNameAccount holder name
ibanIBAN. Provide this, or accountNumber + bankCode.
swiftSWIFT / BIC code
accountNumberDomestic account number. Use together with bankCode when iban is not provided.
bankCodeDomestic bank code. Use together with accountNumber when iban is not provided.
Add contract bank account › Responses
Bank account created
currencyPayout currency
holderNameAccount holder name
idUnique bank account identifier
ibanIBAN. Provide this, or accountNumber + bankCode.
swiftSWIFT / BIC code
accountNumberDomestic account number. Use together with bankCode when iban is not provided.
bankCodeDomestic bank code. Use together with accountNumber when iban is not provided.
Update contract bank account
Updates an existing bank account. Provide either iban, or accountNumber together with bankCode.
path Parameters
bankAccountIdUnique bank account identifier
Update contract bank account › Request Body
currencyPayout currency
holderNameAccount holder name
ibanIBAN. Provide this, or accountNumber + bankCode.
swiftSWIFT / BIC code
accountNumberDomestic account number. Use together with bankCode when iban is not provided.
bankCodeDomestic bank code. Use together with accountNumber when iban is not provided.
Update contract bank account › Responses
Bank account updated
currencyPayout currency
holderNameAccount holder name
idUnique bank account identifier
ibanIBAN. Provide this, or accountNumber + bankCode.
swiftSWIFT / BIC code
accountNumberDomestic account number. Use together with bankCode when iban is not provided.
bankCodeDomestic bank code. Use together with accountNumber when iban is not provided.
Enable a carrier
Requests activation of a carrier (ppl or balikovna) within the contract. The contract must be
active (approved). The carrier item starts in pending until Chameleoon completes its setup,
after which it becomes active.
Enable a carrier › Request Body
courierIdCarrier identifier to enable
Enable a carrier › Responses
Carrier enablement requested
courierIdCarrier identifier within Chameleoon Delivery
statusLifecycle status of a Chameleoon Delivery contract, and of each carrier within it.
pending— created and still editable, or submitted and awaiting Chameleoon approval (tell the two apart via the contract'ssubmittedAt)active— approved by Chameleoon and usablesuspended— temporarily disabled by Chameleoondeactivated— permanently disabled
statusChangedAtWhen this carrier's status last changed (format yyyy-MM-ddTHH:mm:ss.fff)
activatedAtWhen this carrier was activated; null while not yet active