CPL API
Useful links
  • Developer
  • Sandbox
Useful links
  • Developer
  • Sandbox
Přepni do češtiny
  1. OrderBatch
  • 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
      POST
    • Get order status
      GET
  • 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. OrderBatch

Create an order

POST
/order/batch
Maintainer:Not configured

Request

Header Params

Body Params application/json

Example
{
    "orders": [
        {
            "orderType": "CollectionOrder",
            "referenceId": "string",
            "shipmentCount": 1,
            "email": "string",
            "note": "string",
            "customerReference": "string",
            "sendDate": "2019-08-24T14:15:22Z",
            "sendTimeFrom": "string",
            "sendTimeTo": "string",
            "productType": "string",
            "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"
            }
        }
    ]
}

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 POST '/order/batch' \
--header 'Accept-Language;' \
--header 'X-Correlation-ID;' \
--header 'X-LogLevel;' \
--header 'Content-Type: application/json' \
--data-raw '{
    "orders": [
        {
            "orderType": "CollectionOrder",
            "referenceId": "string",
            "shipmentCount": 1,
            "email": "string",
            "note": "string",
            "customerReference": "string",
            "sendDate": "2019-08-24T14:15:22Z",
            "sendTimeFrom": "string",
            "sendTimeTo": "string",
            "productType": "string",
            "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"
            }
        }
    ]
}'

Responses

🟢201Created
application/json
Created
Headers

Body

Example
{}
🟠400Bad Request
🔴500Server Error
🔴503Service Unavailable
Modified at 2025-02-07 13:55:57
Previous
Order tracking
Next
Get order status