Configurations

Manage courier-specific configurations and profiles that control shipment creation defaults, API credentials, sender addresses, and label printing preferences. Each courier can have multiple profiles representing different delivery methods.

List courier configurations with profiles

GET

https://api.chameleoon.sk

/v2/configurations/couriers

Returns a list of configured couriers with their available profiles for the authenticated account.

List courier configurations with profiles › query Parameters

page

integer · min: 1

Page number for pagination

Default: 1

pageSize

integer · min: 1 · max: 100

Number of items per page

Default: 20

List courier configurations with profiles › Headers

Accept-Language

string · enum

Language code for localized responses

Enum values:

Default: en

List courier configurations with profiles › Responses

List of courier configurations

CourierProfileListDto[]

List of courier profiles for configuration

CourierProfileListDto

id

string · required

Courier identifier

title

string · required

Display name of the courier

ProfileDto[] · required

Available profiles for this courier

object

Courier image assets

Get courier configuration

GET

https://api.chameleoon.sk

/v2/configurations/couriers/{courierId}

Returns the configuration for a specific courier and profile.

Get courier configuration › path Parameters

courierId

string · required

Unique courier identifier

Get courier configuration › query Parameters

profile

string · required

Profile identifier

Get courier configuration › Headers

Accept-Language

string · enum

Language code for localized responses

Enum values:

Default: en

Get courier configuration › Responses

Courier configuration

Courier configuration organized by groups. The top-level keys represent configuration groups (e.g., "api", "sender", "defaultValues", "print"). Each group contains key-value pairs where keys may contain dots as part of the literal key name (see dot-notation documentation on the courier configuration schema endpoint).

CourierConfigurationDto

object

API credentials and connection settings required by the courier

object

Sender/return address details used on shipping labels

object

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

object

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

GET/v2/configurations/couriers/{courierId}

curl 'https://api.chameleoon.sk/v2/configurations/couriers/:courierId?profile=<string>' \
  --header 'X-Chameleoon-ApiKey: <api-key>'

Example Responses

{
  "api": {
    "user": "1000002",
    "password": "******",
    "integrationId": "CZ",
    "email": "test@chameleoon.sk",
    "referenceNumber": 42
  },
  "sender": {
    "organizationName": "Test s.r.o",
    "street": "Trojičné námestie 122",
    "city": "Praha",
    "zipCode": "10000",
    "country": "CZ",
    "email": "test@chameleoon.sk",
    "phone": "+421901234567"
  },
  "defaultValues": {
    "fds": true,
    "fss": false,
    "psd": false,
    "printReturnLabel": false,
    "cover": null,
    "description": null
  }
}

json

Example GLS configuration (fake data) in the DTO shape the API returns — grouped into `api`, `sender`, and `defaultValues`. Sensitive fields such as `api.password` are masked on read as a run of `*` as long as the stored value — a 20-character password reads back as 20 asterisks.

application/json

Save courier configuration

POST

https://api.chameleoon.sk

/v2/configurations/couriers/{courierId}

Saves or updates the configuration for a specific courier and profile. Each profile represents a separate configuration for the same courier. Saving a configuration will replace existing configuration for the specified profile or create a new one if it does not exist.

Some couriers enforce combination rules across defaultValues fields, evaluated against the effective state after merging the request with the currently stored configuration. Violations return 422 with an entry in the errors array: code conflict when two fields cannot be combined, code dependency when a field requires another field to be set. For GLS, Parcel Shop Delivery (defaultValues.psd) cannot be combined with the FlexDelivery service or the FlexDelivery SMS service (errors[].field = "defaultValues.psd"), and the FlexDelivery SMS service requires the FlexDelivery service to also be enabled (errors[].field = "defaultValues.fss"). Breaking change: a request sending fss: true where fds is neither supplied nor already stored now returns 422 (dependency) where it previously returned 204.

Save courier configuration › path Parameters

courierId

string · required

Unique courier identifier

Save courier configuration › query Parameters

profile

string · maxLength: 36 · pattern: ^[a-z0-9_.]+$ · required

Profile identifier. Only lowercase letters, digits, underscores, and dots are allowed.

profileTitle

string · maxLength: 40

Display name for the profile. If omitted when creating a new profile, the profile ID is used as the title. If omitted when updating an existing profile, the current title is preserved.

Save courier configuration › Headers

Accept-Language

string · enum

Language code for localized responses

Enum values:

Default: en

Save courier configuration › Request Body

CourierConfigurationDto

object

API credentials and connection settings required by the courier

object

Sender/return address details used on shipping labels

object

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

object

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

Save courier configuration › Responses

Configuration saved successfully

No data returned

POST/v2/configurations/couriers/{courierId}

curl 'https://api.chameleoon.sk/v2/configurations/couriers/:courierId?profile=<string>' \
  --request POST \
  --header 'Content-Type: application/json' \
  --header 'X-Chameleoon-ApiKey: <api-key>' \
  --data '{
  "api": {
    "user": "1000002",
    "password": "s3cr3t-password",
    "integrationId": "CZ",
    "email": "test@chameleoon.sk",
    "referenceNumber": 42
  },
  "sender": {
    "organizationName": "Test s.r.o",
    "street": "Trojičné námestie 122",
    "city": "Praha",
    "zipCode": "10000",
    "country": "CZ",
    "email": "test@chameleoon.sk",
    "phone": "+421901234567"
  },
  "defaultValues": {
    "fds": true,
    "fss": false,
    "psd": false,
    "printReturnLabel": false,
    "cover": null,
    "description": null
  }
}'

Example Request Body

{
  "api": {
    "user": "1000002",
    "password": "s3cr3t-password",
    "integrationId": "CZ",
    "email": "test@chameleoon.sk",
    "referenceNumber": 42
  },
  "sender": {
    "organizationName": "Test s.r.o",
    "street": "Trojičné námestie 122",
    "city": "Praha",
    "zipCode": "10000",
    "country": "CZ",
    "email": "test@chameleoon.sk",
    "phone": "+421901234567"
  },
  "defaultValues": {
    "fds": true,
    "fss": false,
    "psd": false,
    "printReturnLabel": false,
    "cover": null,
    "description": null
  }
}

json

Example request in the DTO shape the API accepts — grouped into `api`, `sender`, and `defaultValues`. Send the real `api.password` when setting or changing it; send a value made up only of `*` — such as the mask returned on read — to keep the currently stored value unchanged.

application/json

Example Responses

No example specified for this content type

Delete courier configuration

DELETE

https://api.chameleoon.sk

/v2/configurations/couriers/{courierId}

Deletes the configuration for a specific courier and optional profile.

Delete courier configuration › path Parameters

courierId

string · required

Unique courier identifier

Delete courier configuration › query Parameters

profile

string

Profile identifier for the courier configuration

Delete courier configuration › Responses

Configuration deleted successfully

No data returned

Couriers Sources

List courier configurations with profiles

GET

https://api.chameleoon.sk

/v2/configurations/couriers

Returns a list of configured couriers with their available profiles for the authenticated account.

List courier configurations with profiles › query Parameters

page

integer · min: 1

Page number for pagination

Default: 1

pageSize

integer · min: 1 · max: 100

Number of items per page

Default: 20

List courier configurations with profiles › Headers

Accept-Language

string · enum

Language code for localized responses

Enum values:

Default: en

List courier configurations with profiles › Responses

List of courier configurations

CourierProfileListDto[]

List of courier profiles for configuration

CourierProfileListDto

id

string · required

Courier identifier

title

string · required

Display name of the courier

ProfileDto[] · required

Available profiles for this courier

object

Courier image assets

Get courier configuration

GET

https://api.chameleoon.sk

/v2/configurations/couriers/{courierId}

Returns the configuration for a specific courier and profile.

Get courier configuration › path Parameters

courierId

string · required

Unique courier identifier

Get courier configuration › query Parameters

profile

string · required

Profile identifier

Get courier configuration › Headers

Accept-Language

string · enum

Language code for localized responses

Enum values:

Default: en

Get courier configuration › Responses

Courier configuration

CourierConfigurationDto

object

API credentials and connection settings required by the courier

object

Sender/return address details used on shipping labels

object

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

object

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

Save courier configuration

POST

https://api.chameleoon.sk

/v2/configurations/couriers/{courierId}

Save courier configuration › path Parameters

courierId

string · required

Unique courier identifier

Save courier configuration › query Parameters

profile

string · maxLength: 36 · pattern: ^[a-z0-9_.]+$ · required

Profile identifier. Only lowercase letters, digits, underscores, and dots are allowed.

profileTitle

string · maxLength: 40

Display name for the profile. If omitted when creating a new profile, the profile ID is used as the title. If omitted when updating an existing profile, the current title is preserved.

Save courier configuration › Headers

Accept-Language

string · enum

Language code for localized responses

Enum values:

Default: en

Save courier configuration › Request Body

CourierConfigurationDto

object

API credentials and connection settings required by the courier

object

Sender/return address details used on shipping labels

object

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

object

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

Save courier configuration › Responses

Configuration saved successfully

No data returned

Delete courier configuration

DELETE

https://api.chameleoon.sk

/v2/configurations/couriers/{courierId}

Deletes the configuration for a specific courier and optional profile.

Delete courier configuration › path Parameters

courierId

string · required

Unique courier identifier

Delete courier configuration › query Parameters

profile

string

Profile identifier for the courier configuration

Delete courier configuration › Responses

Configuration deleted successfully

No data returned