Pickup Records

Retrieve created pickup records, view pickup details, and download pickup manifest documents.

List pickup records

GET

https://api.chameleoon.sk

/v2/pickups/records

Returns a paginated list of created pickup records with optional filtering by date range and courier.

List pickup records › 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

fromDate

string · date-time

Filter pickups created from this date-time (format yyyy-MM-ddTHH:mm:ss.fff)

toDate

string · date-time

Filter pickups created until this date-time (format yyyy-MM-ddTHH:mm:ss.fff)

courierId

string

Filter by courier identifier (e.g., "gls", "dhl", "dpd")

List pickup records › Headers

Accept-Language

string · enum

Language code for localized responses

Enum values:

Default: en

List pickup records › Responses

Paginated list of pickup records

PagedPickupRecordListDto

page

integer · required

Current page number

pageSize

integer · required

Number of items per page

totalPages

integer · required

Total number of pages

nextPage

boolean · required

Whether a next page exists

previousPage

boolean · required

Whether a previous page exists

itemsCount

integer · required

Total number of items across all pages

PickupRecordListItemDto[]

List of pickup records

GET/v2/pickups/records

curl https://api.chameleoon.sk/v2/pickups/records \
  --header 'X-Chameleoon-ApiKey: <api-key>'

Example Responses

{
  "page": 1,
  "pageSize": 20,
  "totalPages": 1,
  "nextPage": false,
  "previousPage": false,
  "itemsCount": 2,
  "items": [
    {
      "id": "a1b2c3d4-e5f6-7890-abcd-ef1234567890",
      "courierId": "gls",
      "courierProfile": "na_adresu",
      "createdAt": "2025-09-01T08:00:00.000",
      "shippingDate": "2025-09-02T00:00:00.000",
      "shipmentCount": 5,
      "hasManifest": true
    },
    {
      "id": "b2c3d4e5-f6a7-4b8c-9d0e-1f2a3b4c5d6e",
      "courierId": "dpd",
      "courierProfile": "standard",
      "createdAt": "2025-09-01T10:00:00.000",
      "shippingDate": "2025-09-02T00:00:00.000",
      "shipmentCount": 3,
      "hasManifest": false
    }
  ]
}

json

application/json

Get pickup record detail

GET

https://api.chameleoon.sk

/v2/pickups/records/{id}

Returns full details of a specific pickup record including the list of shipment numbers.

Get pickup record detail › path Parameters

id

string · uuid · required

Pickup record ID

Get pickup record detail › Headers

Accept-Language

string · enum

Language code for localized responses

Enum values:

Default: en

Get pickup record detail › Responses

Pickup record detail

Full pickup record detail

PickupRecordDetailDto

id

string · uuid · required

Unique pickup identifier

courierId

string · required

Courier identifier

courierProfile

string · required

Courier profile used for the pickup

createdAt

string · date-time · required

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

shipmentIds

string[] · required

List of shipment IDs included in the pickup

hasManifest

boolean · required

Whether a pickup manifest PDF is available for download

Download pickup manifest

GET

https://api.chameleoon.sk

/v2/pickups/records/{id}/manifest

Downloads the pickup manifest PDF document. Returns 404 if the pickup does not exist or has no manifest available.

Download pickup manifest › path Parameters

id

string · uuid · required

Pickup record ID

Download pickup manifest › Responses

Pickup manifest document

PickupManifestDto

document

string · byte · required

Base64-encoded PDF pickup manifest document

Pickups Statistics

Chameleoon API v2

Pickup Records

Retrieve created pickup records, view pickup details, and download pickup manifest documents.

List pickup records

GET

https://api.chameleoon.sk

/v2/pickups/records

Returns a paginated list of created pickup records with optional filtering by date range and courier.

List pickup records › 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

fromDate

string · date-time

Filter pickups created from this date-time (format yyyy-MM-ddTHH:mm:ss.fff)

toDate

string · date-time

Filter pickups created until this date-time (format yyyy-MM-ddTHH:mm:ss.fff)

courierId

string

Filter by courier identifier (e.g., "gls", "dhl", "dpd")

List pickup records › Headers

Accept-Language

string · enum

Language code for localized responses

Enum values:

Default: en

List pickup records › Responses

Paginated list of pickup records

PagedPickupRecordListDto

page

integer · required

Current page number

pageSize

integer · required

Number of items per page

totalPages

integer · required

Total number of pages

nextPage

boolean · required

Whether a next page exists

previousPage

boolean · required

Whether a previous page exists

itemsCount

integer · required

Total number of items across all pages

PickupRecordListItemDto[]

List of pickup records

GET/v2/pickups/records

curl https://api.chameleoon.sk/v2/pickups/records \
  --header 'X-Chameleoon-ApiKey: <api-key>'

Example Responses

{
  "page": 1,
  "pageSize": 20,
  "totalPages": 1,
  "nextPage": false,
  "previousPage": false,
  "itemsCount": 2,
  "items": [
    {
      "id": "a1b2c3d4-e5f6-7890-abcd-ef1234567890",
      "courierId": "gls",
      "courierProfile": "na_adresu",
      "createdAt": "2025-09-01T08:00:00.000",
      "shippingDate": "2025-09-02T00:00:00.000",
      "shipmentCount": 5,
      "hasManifest": true
    },
    {
      "id": "b2c3d4e5-f6a7-4b8c-9d0e-1f2a3b4c5d6e",
      "courierId": "dpd",
      "courierProfile": "standard",
      "createdAt": "2025-09-01T10:00:00.000",
      "shippingDate": "2025-09-02T00:00:00.000",
      "shipmentCount": 3,
      "hasManifest": false
    }
  ]
}

json

application/json

Get pickup record detail

GET

https://api.chameleoon.sk

/v2/pickups/records/{id}

Returns full details of a specific pickup record including the list of shipment numbers.

Get pickup record detail › path Parameters

id

string · uuid · required

Pickup record ID

Get pickup record detail › Headers

Accept-Language

string · enum

Language code for localized responses

Enum values:

Default: en

Get pickup record detail › Responses

Pickup record detail

Full pickup record detail

PickupRecordDetailDto

id

string · uuid · required

Unique pickup identifier

courierId

string · required

Courier identifier

courierProfile

string · required

Courier profile used for the pickup

createdAt

string · date-time · required

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

shipmentIds

string[] · required

List of shipment IDs included in the pickup

hasManifest

boolean · required

Whether a pickup manifest PDF is available for download

Download pickup manifest

GET

https://api.chameleoon.sk

/v2/pickups/records/{id}/manifest

Downloads the pickup manifest PDF document. Returns 404 if the pickup does not exist or has no manifest available.

Download pickup manifest › path Parameters

id

string · uuid · required

Pickup record ID

Download pickup manifest › Responses

Pickup manifest document

PickupManifestDto

document

string · byte · required

Base64-encoded PDF pickup manifest document

Pickups Statistics