Shipping Orders

CRUD operations for shipping orders

List of Shipping Orders

GET

https://api.chameleoon.sk/v1

/shipping-orders

Returns list of created shipping orders. In addition to the data you sent, shipping orders contain additional attributes such as shippingNumber and shipmentTracking.

List of Shipping Orders › query Parameters

createdFrom

string · date-time

Start of date range, format yyyy-MM-ddTHH:mm:ss

createdTo

string · date-time

End of date range, format yyyy-MM-ddTHH:mm:ss

referenceNumbers

string[] · style: form · explode: true

Filter shipping orders by reference number, you can specify multiple values

ids

string[] · style: form · explode: true

Filter shipping orders by ID, you can specify multiple values

shippingNumbers

string[] · style: form · explode: true

Filter shipping orders by shipping number, you can specify multiple values

status

string[] · style: form · explode: true

Filter shipping orders by shipping status, you can specify multiple values

Enum values:

created

shipping

ready_for_pickup

ready_for_pickup_2_days

not_delivered

delivered

returned

unknown

courier

string

ID of courier

courierProfile

string

ID of courier configuration

page

integer · min: 1

Page number, cannot be less than 1

Default: 1

pageSize

integer · min: 1 · max: 50

Number of items per page, cannot be less than 1 and greater than 50

Default: 50

List of Shipping Orders › Responses

Successful response

page

integer

Current page number

pageSize

integer

Number of items per page

totalPages

integer

Total number of pages

nextPage

boolean

Indicates if there is a next page

previousPage

boolean

Indicates if there is a previous page

itemsCount

integer

Total number of items

ShippingOrderResponse[]

Array of result items

GET/shipping-orders

curl https://api.chameleoon.sk/v1/shipping-orders \
  --header 'X-Chameleoon-ApiKey: <api-key>'

Example Responses

{
  "page": 1,
  "pageSize": 50,
  "totalPages": 1,
  "nextPage": false,
  "previousPage": false,
  "itemsCount": 1,
  "result": [
    {
      "id": "16e304a1-b18d-46b3-94bd-2a3a1efd1731",
      "referenceNumber": "27",
      "externalReference": null,
      "referenceSource": "prestashop",
      "sourceIdentifier": "prestashop_v1.7",
      "courier": "dhl",
      "courierProfile": "default",
      "shippingNumber": [
        "7760396711"
      ],
      "created": "2022-11-30T20:48:43.02",
      "recipientAddress": {
        "recipientName": "Jano Johnson",
        "companyName": "johny s.r.o.",
        "street": "Jánckov 553",
        "streetDetail": "",
        "zipCode": "10000",
        "city": "Praha",
        "countryCode": "CZ",
        "phone": "0910909311",
        "email": "test@gtservis.sk",
        "parcelShopId": null
      },
      "shipment": {
        "weight": 1,
        "packageCount": 1,
        "totalPrice": 25,
        "currency": "EUR",
        "shippingDate": "2022-11-30T20:48:39",
        "note": null,
        "driverNote": null,
        "packageDescription": null
      },
      "codPrice": null,
      "notifications": {
        "email": false,
        "phone": false,
        "sms": false
      },
      "shipmentTracking": {
        "state": "delivered",
        "history": [
          {
            "code": "13",
            "text": "Parcel was successfully delivered.",
            "date": "2021-07-02T12:28:37",
            "state": "delivered"
          },
          {
            "code": "18",
            "text": "Infoscan",
            "date": "2021-07-02T07:57:28",
            "state": "shipping"
          }
        ]
      },
      "packages": [
        {
          "cover": "DP",
          "weight": 1.5
        }
      ]
    }
  ]
}

json

application/json

Shipping Order

GET

https://api.chameleoon.sk/v1

/shipping-orders/{id}

Returns shipping order by ID. In addition to the data you sent, shipping order contains additional attributes such as shippingNumber and shipmentTracking.

Shipping Order › path Parameters

id

string · uuid · required

ID of shipping order

Shipping Order › Responses

Successful response

ShippingOrderResponse

id

string · uuid

ID of shipping order

referenceNumber

string

Reference number of shipping order

externalReference

string

External reference

referenceSource

string

Source of data

sourceIdentifier

string

Source identifier

courier

string

ID of courier

courierProfile

string

ID of courier profile

shippingNumber

string[]

Shipping numbers returned by courier

created

string · date-time

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

object

codPrice

object

ShipmentTracking

object[]

GET/shipping-orders/{id}

curl https://api.chameleoon.sk/v1/shipping-orders/:id \
  --header 'X-Chameleoon-ApiKey: <api-key>'

Example Responses

{
  "id": "5f186d49-d7c0-4558-92a8-c84c89b0f1db",
  "referenceNumber": "45",
  "externalReference": null,
  "referenceSource": "prestashop",
  "sourceIdentifier": "prestashop_v1.7",
  "courier": "sp",
  "courierProfile": "default",
  "shippingNumber": [
    "EB162001715SK"
  ],
  "created": "2022-11-28T21:36:42.263",
  "recipientAddress": {
    "recipientName": "Matúš Mathews",
    "companyName": "",
    "street": "Janka Matúšku 45",
    "streetDetail": "",
    "zipCode": "02743",
    "city": "Liptovská Matúšovka",
    "countryCode": "SK",
    "phone": "0910909311",
    "email": "test@chameleoon.sk",
    "parcelShopId": null
  },
  "shipment": {
    "weight": 1,
    "packageCount": 1,
    "totalPrice": 40,
    "currency": "EUR",
    "shippingDate": "2022-11-28T21:36:43",
    "note": null,
    "driverNote": null,
    "packageDescription": null
  },
  "codPrice": null,
  "notifications": {
    "email": null,
    "phone": null,
    "sms": null
  },
  "shipmentTracking": {
    "state": "delivered",
    "history": [
      {
        "code": "13",
        "text": "Parcel was successfully delivered.",
        "date": "2021-07-02T12:28:37",
        "state": "delivered"
      }
    ]
  },
  "packages": [
    {
      "cover": "DP",
      "weight": 1.5
    }
  ]
}

json

application/json

Remove Shipping Order

DELETE

https://api.chameleoon.sk/v1

/shipping-orders/{id}

The request removes the shipping order by ID. After successful removal, returns the status 204 No Content.

Remove Shipping Order › path Parameters

id

string · uuid · required

ID of shipping order

Remove Shipping Order › Responses

Shipping order successfully removed

No data returned

Create Shipping Order(s)

POST

https://api.chameleoon.sk/v1

/shipping-orders/{courier_id}

The request is used for the creation of new shipping order(s) in the courier system. After successful execution, shipping numbers are returned, which can be used to retrieve the shipping label.

The request can end with failure. There are two types of failure:

Validation problem: Returns 400 Bad Request with validation response, same as in the validation request
Courier API failure: Returns 200 OK with failure details in the failed attribute

For single shipping order creation, use Content-Type: application/cham.shipping-order+json
For multiple shipping orders creation, use Content-Type: application/cham.shipping-orders+json

If a shipping order with the same reference number already exists, the previous shipping order will be removed.

Source attribution: every shipping order is recorded under a ReferenceSource + SourceIdentifier pair, which defaults to api / default. Set both fields to attribute an order to one of your connected sources instead — notification triggers, statistics and order-state synchronization back to your e-shop or ERP are keyed on that pair. The pair is also part of the identity used by the duplicate-replacement rule above, so an order created under a different pair does not replace an existing one with the same reference number.

Note that if duplicate-order prevention is enabled on your API key, that separate check matches on the reference number alone and ignores the source pair — it will reject a reference number already used under a different source.

Create Shipping Order(s) › path Parameters

courier_id

string · required

ID of courier

Create Shipping Order(s) › query Parameters

profile

string · required

ID of configuration

Create Shipping Order(s) › Request Body

ShippingOrder

ReferenceNumber

string · required

Unique value that identify entity in the application Chameleoon

ExternalReference

string

Reference that identify entity in your system

ReferenceSource

string · maxLength: 64

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.

Default: api

SourceIdentifier

string · maxLength: 64

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.

Default: default

RecipientAddress

Shipment

CodPrice

Notifications

Package[]

Parameter[]

Create Shipping Order(s) › Responses

Shipping order creation completed (can include both successful and failed items)

UploadResult

SuccessUploadItem[]

FailedUploadItem[]

POST/shipping-orders/{courier_id}

curl 'https://api.chameleoon.sk/v1/shipping-orders/:courier_id?profile=<string>' \
  --request POST \
  --header 'Content-Type: application/cham.shipping-order+json' \
  --header 'X-Chameleoon-ApiKey: <api-key>' \
  --data '{
  "ReferenceNumber": "OBJ1010",
  "ExternalReference": "1001",
  "ReferenceSource": "shoptet",
  "SourceIdentifier": "my-shop",
  "RecipientAddress": {
    "RecipientName": "Adam Baník",
    "CompanyName": "ABCx s.r.o.",
    "Street": "Sokolská 81",
    "StreetDetail": null,
    "ZipCode": "90001",
    "City": "Modra",
    "CountryCode": "SK",
    "Phone": "+421910909311",
    "Email": "test@chameleoon.sk",
    "ParcelShopId": "4321"
  },
  "Shipment": {
    "TotalPrice": 124.5,
    "Currency": "EUR",
    "ShippingDate": "2022-09-11",
    "Note": null,
    "DriverNote": null,
    "PackageDescription": null
  },
  "CodPrice": {
    "Value": 124.5,
    "Currency": "EUR",
    "VariableSymbol": "2022102115"
  },
  "Packages": [
    {
      "Weight": 1.5,
      "Cover": "DP"
    }
  ],
  "Parameters": [
    {
      "Key": "VDP",
      "Value": "1"
    },
    {
      "Key": "NRB",
      "Value": "true"
    }
  ]
}'

Example Request Body

{
  "ReferenceNumber": "OBJ1010",
  "ExternalReference": "1001",
  "ReferenceSource": "shoptet",
  "SourceIdentifier": "my-shop",
  "RecipientAddress": {
    "RecipientName": "Adam Baník",
    "CompanyName": "ABCx s.r.o.",
    "Street": "Sokolská 81",
    "StreetDetail": null,
    "ZipCode": "90001",
    "City": "Modra",
    "CountryCode": "SK",
    "Phone": "+421910909311",
    "Email": "test@chameleoon.sk",
    "ParcelShopId": "4321"
  },
  "Shipment": {
    "TotalPrice": 124.5,
    "Currency": "EUR",
    "ShippingDate": "2022-09-11",
    "Note": null,
    "DriverNote": null,
    "PackageDescription": null
  },
  "CodPrice": {
    "Value": 124.5,
    "Currency": "EUR",
    "VariableSymbol": "2022102115"
  },
  "Packages": [
    {
      "Weight": 1.5,
      "Cover": "DP"
    }
  ],
  "Parameters": [
    {
      "Key": "VDP",
      "Value": "1"
    },
    {
      "Key": "NRB",
      "Value": "true"
    }
  ]
}

json

Example Responses

{
  "uploaded": [
    {
      "id": "16e304a1-b18d-46b3-94bd-2a3a1efd1731",
      "referenceNumber": "OBJ1010",
      "referenceSource": "api",
      "shippingNumbers": [
        "1762707304"
      ],
      "properties": {}
    }
  ],
  "failed": []
}

json

application/json

Remove Shipping Orders

POST

https://api.chameleoon.sk/v1

/shipping-orders/batch/delete

The request removes the shipping orders by IDs. After successful removal, returns the status 204 No Content.

Remove Shipping Orders › Request Body

RemoveShippingOrdersRequest

Ids

string[]

List of IDs, maximum number of items is 20

Remove Shipping Orders › Responses

Shipping orders successfully removed

No data returned

Validation Shipping Labels

List of Shipping Orders

GET

https://api.chameleoon.sk/v1

/shipping-orders

Returns list of created shipping orders. In addition to the data you sent, shipping orders contain additional attributes such as shippingNumber and shipmentTracking.

List of Shipping Orders › query Parameters

createdFrom

string · date-time

Start of date range, format yyyy-MM-ddTHH:mm:ss

createdTo

string · date-time

End of date range, format yyyy-MM-ddTHH:mm:ss

referenceNumbers

string[] · style: form · explode: true

Filter shipping orders by reference number, you can specify multiple values

ids

string[] · style: form · explode: true

Filter shipping orders by ID, you can specify multiple values

shippingNumbers

string[] · style: form · explode: true

Filter shipping orders by shipping number, you can specify multiple values

status

string[] · style: form · explode: true

Filter shipping orders by shipping status, you can specify multiple values

Enum values:

created

shipping

ready_for_pickup

ready_for_pickup_2_days

not_delivered

delivered

returned

unknown

courier

string

ID of courier

courierProfile

string

ID of courier configuration

page

integer · min: 1

Page number, cannot be less than 1

Default: 1

pageSize

integer · min: 1 · max: 50

Number of items per page, cannot be less than 1 and greater than 50

Default: 50

List of Shipping Orders › Responses

Successful response

page

integer

Current page number

pageSize

integer

Number of items per page

totalPages

integer

Total number of pages

nextPage

boolean

Indicates if there is a next page

previousPage

boolean

Indicates if there is a previous page

itemsCount

integer

Total number of items

ShippingOrderResponse[]

Array of result items

Shipping Order

GET

https://api.chameleoon.sk/v1

/shipping-orders/{id}

Returns shipping order by ID. In addition to the data you sent, shipping order contains additional attributes such as shippingNumber and shipmentTracking.

Shipping Order › path Parameters

id

string · uuid · required

ID of shipping order

Shipping Order › Responses

Successful response

ShippingOrderResponse

id

string · uuid

ID of shipping order

referenceNumber

string

Reference number of shipping order

externalReference

string

External reference

referenceSource

string

Source of data

sourceIdentifier

string

Source identifier

courier

string

ID of courier

courierProfile

string

ID of courier profile

shippingNumber

string[]

Shipping numbers returned by courier

created

string · date-time

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

object

codPrice

object

ShipmentTracking

object[]

Remove Shipping Order

DELETE

https://api.chameleoon.sk/v1

/shipping-orders/{id}

The request removes the shipping order by ID. After successful removal, returns the status 204 No Content.

Remove Shipping Order › path Parameters

id

string · uuid · required

ID of shipping order

Remove Shipping Order › Responses

Shipping order successfully removed

No data returned

Create Shipping Order(s)

POST

https://api.chameleoon.sk/v1

/shipping-orders/{courier_id}

The request is used for the creation of new shipping order(s) in the courier system. After successful execution, shipping numbers are returned, which can be used to retrieve the shipping label.

The request can end with failure. There are two types of failure:

Validation problem: Returns 400 Bad Request with validation response, same as in the validation request
Courier API failure: Returns 200 OK with failure details in the failed attribute

For single shipping order creation, use Content-Type: application/cham.shipping-order+json
For multiple shipping orders creation, use Content-Type: application/cham.shipping-orders+json

If a shipping order with the same reference number already exists, the previous shipping order will be removed.

Create Shipping Order(s) › path Parameters

courier_id

string · required

ID of courier

Create Shipping Order(s) › query Parameters

profile

string · required

ID of configuration

Create Shipping Order(s) › Request Body

ShippingOrder

ReferenceNumber

string · required

Unique value that identify entity in the application Chameleoon

ExternalReference

string

Reference that identify entity in your system

ReferenceSource

string · maxLength: 64

Default: api

SourceIdentifier

string · maxLength: 64

Default: default

RecipientAddress

Shipment

CodPrice

Notifications

Package[]

Parameter[]

Create Shipping Order(s) › Responses

Shipping order creation completed (can include both successful and failed items)

UploadResult

SuccessUploadItem[]

FailedUploadItem[]

Remove Shipping Orders

POST

https://api.chameleoon.sk/v1

/shipping-orders/batch/delete

The request removes the shipping orders by IDs. After successful removal, returns the status 204 No Content.

Remove Shipping Orders › Request Body

RemoveShippingOrdersRequest

Ids

string[]

List of IDs, maximum number of items is 20

Remove Shipping Orders › Responses

Shipping orders successfully removed

No data returned