CPL API
Useful links
  • Developer
  • Sandbox
Useful links
  • Developer
  • Sandbox
Přepni do češtiny
  1. Shipment
  • 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
  • OrderBatch
    • Create an order
    • Get order status
  • OrderEvent
    • Order cancel
  • Shipment
    • Shipment tracking
      GET
  • 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. Shipment

Shipment tracking

GET
/shipment
Shipment
Request Request Example
Shell
JavaScript
Java
Swift
curl --location --request GET '/shipment?ShipmentNumbers&InvoiceNumbers&CustomerReferences&VariableSymbols&DateFrom&DateTo&ShipmentStates&Limit&Offset' \
--header 'Accept-Language;' \
--header 'X-Correlation-ID;' \
--header 'X-LogLevel;'
Response Response Example
200 - Example 1
[
  {
    "shipmentNumber": "string",
    "productType": "string",
    "note": "string",
    "depot": "string",
    "integratorId": 0,
    "lastUpdateDate": "2019-08-24T14:15:22Z",
    "shipmentState": "None",
    "shipmentSet": {
      "masterShipmentNumber": "string",
      "shipmentsInSet": 0,
      "shipmentInSetNumber": 0
    },
    "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"
    },
    "specificDelivery": {
      "specificDeliveryDate": "2019-08-24T14:15:22Z",
      "specificDeliveryTimeFrom": "string",
      "specificDeliveryTimeTo": "string",
      "specificTakeDate": "2019-08-24T14:15:22Z",
      "specificTakeTimeFrom": "string",
      "specificTakeTimeTo": "string",
      "accessPointCode": "string"
    },
    "externalNumbers": [
      {
        "externalNumber": "string",
        "code": "string"
      }
    ],
    "services": [
      {
        "additionalParameters": [
          {
            "type": "string",
            "reference": "string"
          }
        ],
        "code": "string",
        "price": 0,
        "priceCurrency": "string"
      }
    ],
    "trackAndTrace": {
      "externalShipmentId": "string",
      "partnerUrl": "string",
      "lastEventCode": "string",
      "lastEventDate": "2019-08-24T14:15:22Z",
      "lastEventName": "string",
      "events": [
        {
          "statusId": 0,
          "code": "string",
          "phase": "string",
          "group": "string",
          "eventDate": "2019-08-24T14:15:22Z",
          "name": "string",
          "gpsLatitude": 0,
          "gpsLongitude": 0
        }
      ]
    },
    "shipmentWeightInfo": {
      "weight": 0,
      "weighedDate": "2019-08-24T14:15:22Z"
    },
    "paymentInfo": {
      "paidByCard": true,
      "codPaidDate": "2019-08-24T14:15:22Z",
      "invoiceNumber": "string",
      "bankAccount": "string",
      "bankCode": "string",
      "codBankStatementDate": "2019-08-24T14:15:22Z",
      "codCurrency": "string",
      "codPaymentAccDate": "2019-08-24T14:15:22Z",
      "codPrice": 0,
      "codVariableSymbol": "string",
      "specificSymbol": "string"
    },
    "deliveryFeature": {
      "loadDate": "2019-08-24T14:15:22Z",
      "delivDate": "2019-08-24T14:15:22Z",
      "delivPerson": "string",
      "notDelivDate": "2019-08-24T14:15:22Z",
      "outDepDate": "2019-08-24T14:15:22Z",
      "hubDate": "2019-08-24T14:15:22Z",
      "deliveryToAccessPoint": true
    },
    "backShipmentFeature": {
      "backDate": "2019-08-24T14:15:22Z"
    },
    "dormantShipmentFeature": {
      "dormantShipmentNumber": "string",
      "dormantShipmentNumberActive": true
    },
    "accessPointFeature": {
      "accessPointDaysInStorage": 0,
      "accessPointDaysInStorageRemain": 0,
      "accessPointHoursInStorageRemain": 0
    },
    "routingFeature": {
      "routingNumber": "string"
    }
  }
]

Request

Query Params
ShipmentNumbers
array[string]
optional
ShipmentNumbers
<= 50 items
InvoiceNumbers
array[string]
optional
InvoiceNumbers
<= 50 items
CustomerReferences
array[string]
optional
CustomerReferences
<= 50 items
VariableSymbols
array[string]
optional
VariableSymbols
<= 50 items
DateFrom
string <date-time>
optional
DateFrom
DateTo
string <date-time>
optional
DateTo
ShipmentStates
enum<string> 
optional
ShipmentStates
Allowed values:
NoneUndeliveredDeliveredPickedUpFromSenderDeliveredToPickupPointOutForDeliveryNotDeliveredCodPaidDateBackToSenderRejectedDataShipmentActiveCanceledDormant
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

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
array of:
shipmentNumber
string  | null 
optional
ShipmentNumber
productType
string  | null 
optional
ProductType
note
string  | null 
optional
Note
depot
string  | null 
optional
Depot
integratorId
integer <int32> | null 
optional
IntegratorId
lastUpdateDate
string <date-time> | null 
optional
Last update date
shipmentState
enum<string> 
optional
ShipmentStates
Allowed values:
NoneUndeliveredDeliveredPickedUpFromSenderDeliveredToPickupPointOutForDeliveryNotDeliveredCodPaidDateBackToSenderRejectedDataShipmentActiveCanceledDormant
shipmentSet
optional
One of
ShipmentSetFeatureModel
masterShipmentNumber
string  | null 
optional
MasterShipmentNumber
shipmentsInSet
integer <int32>
optional
ShipmentsInSet
shipmentInSetNumber
integer <int32>
optional
ShipmentInSetNumber
sender
optional
One of
AddressBaseModel
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
AddressBaseModel
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
specificDelivery
optional
One of
SpecificDeliveryFeatureModel
specificDeliveryDate
string <date-time> | null 
optional
SpecificDeliveryDate
specificDeliveryTimeFrom
string <date-span> | null 
optional
SpecificDeliveryTimeFrom
specificDeliveryTimeTo
string <date-span> | null 
optional
SpecificDeliveryTimeTo
specificTakeDate
string <date-time> | null 
optional
SpecificTakeDate
specificTakeTimeFrom
string <date-span> | null 
optional
SpecificTakeTimeFrom
specificTakeTimeTo
string <date-span> | null 
optional
SpecificTakeTimeTo
accessPointCode
string  | null 
optional
ParcelShopCode
externalNumbers
array[object (Eps.Api.MyApi2.Web.Models.Shipment.ExternalNumberModel) {2}]  | null 
optional
ExternalNumbers
externalNumber
string  | null 
optional
ExternalNumber
code
string  | null 
optional
Code
services
array[object (Eps.Api.MyApi2.Web.Models.Shipment.ServiceModel) {4}]  | null 
optional
Services
additionalParameters
array[object (Eps.Api.MyApi2.Web.Models.Shipment.AdditionalParameterModel) {2}]  | null 
optional
AdditionalParameters
code
string  | null 
optional
Code
price
number <double> | null 
optional
Price
priceCurrency
string  | null 
optional
PriceCurrency
trackAndTrace
optional
One of
Track and trace
externalShipmentId
string  | null 
optional
External shipment Id
partnerUrl
string  | null 
optional
Partner track and trace URL
lastEventCode
string  | null 
optional
Last event code
lastEventDate
string <date-time> | null 
optional
Last event date
lastEventName
string  | null 
optional
Last event name
events
array[object (Eps.Api.MyApi2.Web.Models.Shipment.TrackAndTraceItemModel) {8}]  | null 
optional
Track and trace events
shipmentWeightInfo
optional
One of
ShipmentWeightFeatureModel
weight
number <double> | null 
optional
Gets or sets the weight.
weighedDate
string <date-time> | null 
optional
Weighed date
paymentInfo
optional
One of
ShipmentPaymentFeatureModel
paidByCard
boolean 
optional
codPaidDate
string <date-time> | null 
optional
invoiceNumber
string  | null 
optional
bankAccount
string  | null 
optional
bankCode
string  | null 
optional
codBankStatementDate
string <date-time> | null 
optional
codCurrency
string  | null 
optional
codPaymentAccDate
string <date-time> | null 
optional
codPrice
number <double> | null 
optional
codVariableSymbol
string  | null 
optional
specificSymbol
string  | null 
optional
deliveryFeature
optional
One of
ShipmentDeliveryFeatureModel
loadDate
string <date-time> | null 
optional
Date of loading shipment for delivery.
delivDate
string <date-time> | null 
optional
Delivery date
delivPerson
string  | null 
optional
Delivery person
notDelivDate
string <date-time> | null 
optional
Not delivery date
outDepDate
string <date-time> | null 
optional
Out dep date
hubDate
string <date-time> | null 
optional
Hub date
deliveryToAccessPoint
boolean 
optional
DeliveryToAccessPoint
backShipmentFeature
optional
One of
BackShipmentFeatureModel
backDate
string <date-time> | null 
optional
Back date
dormantShipmentFeature
optional
One of
DormantShipmentFeatureModel
dormantShipmentNumber
string  | null 
optional
DormantShipmentNumber
dormantShipmentNumberActive
boolean  | null 
optional
DormantShipmentNumberActive
accessPointFeature
optional
One of
Access point feature model
accessPointDaysInStorage
integer <int32> | null 
optional
Number of days at the access point
accessPointDaysInStorageRemain
integer <int32> | null 
optional
Number of remaining days at the access point
accessPointHoursInStorageRemain
integer <int32> | null 
optional
Number of remaining hours at the access point
routingFeature
optional
One of
RoutingFeatureModel
routingNumber
string  | null 
optional
Routing number
🟠400Bad Request
🟠404Record Not Found
🔴500Server Error
🔴503Service Unavailable
Modified at 2025-02-07 13:20:08
Previous
Order cancel
Next
ShipmentBatch
Built with