CPL API
Useful links
  • Developer
  • Sandbox
Useful links
  • Developer
  • Sandbox
Přepni do češtiny
  1. Order
  • Back to home
  • API Methods
  • AccessPoint
    • List of access points
  • AddressWhisper
    • Address Whisperer
  • Codelist
    • Codelist for the beneficiary's age verification service
    • Codelist product
    • Codelist externalNumbers
    • Codelist country + COD authorization
    • Codelist currency
    • Method for obtaining the services provided for shipments.
    • A method for obtaining minimum and maximum values ​​for services
    • Codelist shipment phase
    • Codelist status
    • Codelist of validation messages
    • Types of personal documents
  • Customer
    • Customer information - permitted currencies
    • Customer addresess
  • Info
    • /info
  • Order
    • Order tracking
      GET
  • OrderBatch
    • Create an order
    • Get order status
  • OrderEvent
    • Order cancel
  • Shipment
    • Shipment tracking
  • ShipmentBatch
    • Shipment creation
    • Used to modify the output format of the label.
    • Getting import state
    • Pick up label
  • ShipmentEvent
    • Shipment cancel
    • Adding informations to shipment
  • VersionInformation
    • News
  1. Order

Order tracking

GET
/order
Maintainer:Not configured

Request

Query Params
ShipmentNumbers
array[string]
optional
ShipmentNumbers
<= 50 items
CustomerReferences
array[string]
optional
CustomerReferences
<= 50 items
OrderReferences
array[string]
optional
OrderReferences
<= 50 items
OrderNumbers
array[string]
optional
OrderNumbers
<= 50 items
OrderIds
array[integer <int32>]
optional
OrderIds
<= 50 items
DateFrom
string <date-time>
optional
DateFrom
DateTo
string <date-time>
optional
DateTo
SendDate
string <date-time>
optional
SendDate
ProductType
string 
optional
ProductType
OrderStates
enum<string> 
optional
OrderStates
Allowed values:
NoneCreatedPickedUpNotPickedUpCanceled
OrderType
enum<string> 
optional
OrderType
Allowed values:
CollectionOrderTransportOrder
Limit
integer <int32>
required
>= 1<= 1000
Offset
integer <int32>
required
>= 0
Header Params
Accept-Language
string 
optional
Language specification, default language: cs-CZ
X-Correlation-ID
string 
optional
Correlation Id of request
X-LogLevel
enum<string> 
optional
The forced log level
Allowed values:
TraceDebugInformationWarningErrorCritical

Request samples

Shell
JavaScript
Java
Swift
Go
PHP
Python
HTTP
C
C#
Objective-C
Ruby
OCaml
Dart
R
Request Request Example
Shell
JavaScript
Java
Swift
curl --location --request GET '/order?ShipmentNumbers&CustomerReferences&OrderReferences&OrderNumbers&OrderIds&DateFrom&DateTo&SendDate&ProductType&OrderStates&OrderType&Limit&Offset' \
--header 'Accept-Language;' \
--header 'X-Correlation-ID;' \
--header 'X-LogLevel;'

Responses

🟢200OK
application/json
Success
Headers
X-Correlation-ID
string 
optional
Correlation Id of request otherwise id of response
X-Paging-Total-Items-Count
string 
optional
Total items in result
X-Paging-Offset
string 
optional
Paging offset
X-Paging-Limit
string 
optional
Page size
Body
OrderModel
orderNumber
string  | null 
optional
Order number
orderState
enum<string> 
optional
Order states
Allowed values:
NoneCreatedPickedUpNotPickedUpCanceled
orderType
enum<string> 
optional
Order type
Allowed values:
CollectionOrderTransportOrder
referenceId
string  | null 
optional
Reference Id
shipmentCount
integer <int32>
optional
Count of shipments
realShipmentCount
integer <int32>
optional
Real count of shipments
email
string  | null 
optional
Email
note
string  | null 
optional
Note
customerReference
string  | null 
optional
Customer reference
productType
string  | null 
optional
Typ produktu
sendDate
string <date-time> | null 
optional
Datum vyzvednutí zadané objednatelem
realCollectionDate
string <date-time> | null 
optional
Skutečné datum vyzvednutí
deliveryDateTime
string <date-time> | null 
optional
Datum doručení
sender
optional
One of
SenderAddressModel
name
string  | null 
optional
Name
name2
string  | null 
optional
Name2
street
string  | null 
optional
Street
city
string  | null 
optional
City
zipCode
string  | null 
optional
ZipCode
country
string  | null 
optional
Country
contact
string  | null 
optional
Contact
phone
string  | null 
optional
Phone
email
string  | null 
optional
Email
recipient
optional
One of
RecipientAddressModel
name
string  | null 
optional
Name
name2
string  | null 
optional
Name2
street
string  | null 
optional
Street
city
string  | null 
optional
City
zipCode
string  | null 
optional
ZipCode
country
string  | null 
optional
Country
contact
string  | null 
optional
Contact
phone
string  | null 
optional
Phone
email
string  | null 
optional
Email
shipmentNumbers
array[string] | null 
optional
Zásilky na objednávce
Example
{
    "orderNumber": "string",
    "orderState": "None",
    "orderType": "CollectionOrder",
    "referenceId": "string",
    "shipmentCount": 0,
    "realShipmentCount": 0,
    "email": "string",
    "note": "string",
    "customerReference": "string",
    "productType": "string",
    "sendDate": "2019-08-24T14:15:22Z",
    "realCollectionDate": "2019-08-24T14:15:22Z",
    "deliveryDateTime": "2019-08-24T14:15:22Z",
    "sender": {
        "name": "string",
        "name2": "string",
        "street": "string",
        "city": "string",
        "zipCode": "string",
        "country": "string",
        "contact": "string",
        "phone": "string",
        "email": "string"
    },
    "recipient": {
        "name": "string",
        "name2": "string",
        "street": "string",
        "city": "string",
        "zipCode": "string",
        "country": "string",
        "contact": "string",
        "phone": "string",
        "email": "string"
    },
    "shipmentNumbers": [
        "string"
    ]
}
🟠400Bad Request
🔴500Server Error
🔴503Service Unavailable
Modified at 2025-02-07 13:20:27
Previous
/info
Next
Create an order
Built with