Získání informace o objednávce přepravy

Request

Query Params

ShipmentNumbers

array[string]

optional

Číslo/čísla balíků

<= 50 items

CustomerReferences

array[string]

optional

Reference odesílatele

<= 50 items

OrderReferences

array[string]

optional

Reference objednávky

<= 50 items

OrderNumbers

array[string]

optional

Číslo objednávky

<= 50 items

OrderIds

array[integer <int32>]

optional

ID objednávky

<= 50 items

DateFrom

string <date-time>

optional

Datum od

DateTo

string <date-time>

optional

Datum do

SendDate

string <date-time>

optional

Datum odeslání

ProductType

string

optional

Typ produktu

OrderStates

enum<string>

optional

Stav objednávky

Allowed values:

NoneCreatedPickedUpNotPickedUpCanceled

OrderType

enum<string>

optional

Typ objednávky

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

PHP

Python

HTTP

Objective-C

Ruby

OCaml

Dart

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

orderNumber

string | null

optional

Číslo objednávky

orderState

enum<string>

optional

Stav objednávky

Allowed values:

NoneCreatedPickedUpNotPickedUpCanceled

orderType

enum<string>

optional

Typ objednávky

Allowed values:

CollectionOrderTransportOrder

referenceId

string | null

optional

Reference Id

shipmentCount

integer <int32>

optional

Počet zásilek

realShipmentCount

integer <int32>

optional

Skutečný počet zásilek

string | null

optional

note

string | null

optional

Poznámka

customerReference

string | null

optional

Zákaznická 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

Odesílatel

One of

object

EmptyNullableObject

name

string | null

optional

Jméno

name2

string | null

optional

street

string | null

optional

Ulice

city

string | null

optional

Město

zipCode

string | null

optional

PSČ

country

string | null

optional

Země

contact

string | null

optional

Kontakt

phone

string | null

optional

Telefon

string | null

optional

recipient

optional

Příjemce

One of

object

EmptyNullableObject

name

string | null

optional

Jméno

name2

string | null

optional

street

string | null

optional

Ulice

city

string | null

optional

Město

zipCode

string | null

optional

PSČ

country

string | null

optional

Země

contact

string | null

optional

Kontakt

phone

string | null

optional

Telefon

string | null

optional

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