CPL API
Užitečné odkazy
  • Developer
  • Sandbox
Užitečné odkazy
  • Developer
  • Sandbox
Switch to english
  1. OrderBatch
  • Back to home
  • API Metody
  • AccessPoint
    • Seznam výdejních míst
  • AddressWhisper
    • Našeptávač adres
  • Codelist
    • Číselník pro službu kontroly věku příjemce
    • Číselník produktů
    • Číselník typů externích čísel
    • Číselník zemí + povolení COD
    • Číselník povolených měn
    • Metoda pro získání poskytovaných služeb k zásilkám.
    • Metoda pro získání minimálních a maximálních hodnot u služeb
    • Fáze zásilky
    • Statusy zásilky /shipment
    • Chybové hlášení
    • Typy osobních dokladů
  • Customer
    • Informace k zákazníkovi – povolené měny
    • Zákazníkovy adresy
  • Info
    • info
  • Order
    • Získání informace o objednávce přepravy
  • OrderBatch
    • Slouží k vytvoření objednávky. Odpověď je v header (Location)
      POST
    • Získaní stavu objednávky
      GET
  • OrderEvent
    • Zrušení objednání svozu nebo balíku z libovolné adresy
  • Shipment
    • Slouží k získání informací (trackingu) k zásilce
  • ShipmentBatch
    • Vytvoření zásilky
    • Slouží k úpravě výstupního formátu štítku
    • Získání stavu importu zásilky
    • Získání etikety
  • ShipmentEvent
    • storno zásilky
    • úprava kontaktu
  • VersionInformation
    • informace o novinkách
  1. OrderBatch

Slouží k vytvoření objednávky. Odpověď je v header (Location)

POST
/order/batch
OrderBatch
Maintainer:Not configured

Request

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
Body Params application/json
orders
array [object {12}] 
required
Objednávky
>= 1 items
orderType
enum<string> 
required
Typ objednávky:
CollectionOrder – objednání svozu,
TransportOrder – objednávková
přeprava (Balík z libovolné adresy)
Allowed values:
CollectionOrderTransportOrder
referenceId
string 
required
Jedinečná reference!
>= 1 characters<= 50 characters
shipmentCount
integer <int32>
required
Počet balíků Max: 50 Délka: 2
>= 1
email
string  | null 
optional
Notifikační email pro objednavatele Délka: 2
<= 100 characters
note
string  | null 
optional
Poznámka Délka 50
<= 300 characters
customerReference
string  | null 
optional
Zákaznická reference. Délka: 9,2
<= 40 characters
sendDate
string <date-time>
required
Datum odeslání Délka: 9,2
sendTimeFrom
string <date-span> | null 
optional
Čas odeslání od
sendTimeTo
string <date-span> | null 
optional
Čas odeslání do
productType
string  | null 
optional
BUSS / IMPO Délka: 4
sender
optional
recipient
optional
Příjemce
Pokud je svoz ( CollectionOrder )
NEYPLŇUJE SE
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 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
X-Correlation-ID
string 
optional
Correlation Id of request otherwise id of response
Location
string 
optional
Newly created entity location
Body
object {0}
Example
{}
🟠400Bad Request
🔴500Server Error
🔴503Service Unavailable
Modified at 2025-01-29 07:47:53
Previous
OrderBatch
Next
Získaní stavu objednávky
Built with