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
  • Data
    • Single label print
  • 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
Maintainer:Not configured

Request

Query Params

Header Params

Request Code 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 '/shipment?ShipmentNumbers&InvoiceNumbers&CustomerReferences&VariableSymbols&DateFrom&DateTo&ShipmentStates&Limit&Offset' \
--header 'Accept-Language;' \
--header 'X-Correlation-ID;' \
--header 'X-LogLevel;'

Responses

🟢200OK
application/json
Success
Headers

Body

Example
[
    {
        "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"
        }
    }
]
🟠400Bad Request
🟠404Record Not Found
🔴500Server Error
🔴503Service Unavailable
Modified at 2025-02-07 13:20:08
Previous
Order cancel
Next
ShipmentBatch