- AccessPoint
- AddressWhisper
- 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
- Info
- Order
- OrderBatch
- OrderEvent
- Shipment
- ShipmentBatch
- ShipmentEvent
- VersionInformation
Slouží k získání informací (trackingu) k zásilce
GET
/shipment
Shipment
Maintainer:Not configured
Request
Query Params
ShipmentNumbers
array[string]
optional
<= 50 items
InvoiceNumbers
array[string]
optional
<= 50 items
CustomerReferences
array[string]
optional
<= 50 items
VariableSymbols
array[string]
optional
<= 50 items
DateFrom
string <date-time>
optional
DateTo
string <date-time>
optional
ShipmentStates
enum<string>
optional
Allowed values:
NoneUndeliveredDeliveredPickedUpFromSenderDeliveredToPickupPointOutForDeliveryNotDeliveredCodPaidDateBackToSenderRejectedDataShipmentActiveCanceledDormant
Limit
integer <int32>
required
>= 1<= 1000
Offset
integer <int32>
required
>= 0
Header Params
Accept-Language
string
optional
X-Correlation-ID
string
optional
X-LogLevel
enum<string>
optional
Allowed values:
TraceDebugInformationWarningErrorCritical
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 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
Headers
X-Correlation-ID
string
optional
X-Paging-Total-Items-Count
string
optional
X-Paging-Offset
string
optional
X-Paging-Limit
string
optional
Body
array of:
shipmentNumber
string | null
optional
productType
string | null
optional
note
string | null
optional
depot
string | null
optional
integratorId
integer <int32> | null
optional
lastUpdateDate
string <date-time> | null
optional
shipmentState
enum<string>
optional
Allowed values:
NoneUndeliveredDeliveredPickedUpFromSenderDeliveredToPickupPointOutForDeliveryNotDeliveredCodPaidDateBackToSenderRejectedDataShipmentActiveCanceledDormant
shipmentSet
optional
One of
masterShipmentNumber
string | null
optional
shipmentsInSet
integer <int32>
optional
shipmentInSetNumber
integer <int32>
optional
sender
optional
One of
name
string | null
optional
name2
string | null
optional
street
string | null
optional
city
string | null
optional
zipCode
string | null
optional
country
string | null
optional
contact
string | null
optional
phone
string | null
optional
email
string | null
optional
recipient
optional
One of
name
string | null
optional
name2
string | null
optional
street
string | null
optional
city
string | null
optional
zipCode
string | null
optional
country
string | null
optional
contact
string | null
optional
phone
string | null
optional
email
string | null
optional
specificDelivery
optional
One of
specificDeliveryDate
string <date-time> | null
optional
specificDeliveryTimeFrom
string <date-span> | null
optional
specificDeliveryTimeTo
string <date-span> | null
optional
specificTakeDate
string <date-time> | null
optional
specificTakeTimeFrom
string <date-span> | null
optional
specificTakeTimeTo
string <date-span> | null
optional
accessPointCode
string | null
optional
1.
2.
externalNumbers
array [object {2}] | null
optional
externalNumber
string | null
optional
code
string | null
optional
services
array [object {4}] | null
optional
additionalParameters
array [object] | null
optional
code
string | null
optional
price
number <double> | null
optional
priceCurrency
string | null
optional
trackAndTrace
optional
One of
externalShipmentId
string | null
optional
partnerUrl
string | null
optional
lastEventCode
string | null
optional
lastEventDate
string <date-time> | null
optional
lastEventName
string | null
optional
events
array [object] | null
optional
shipmentWeightInfo
optional
One of
weight
number <double> | null
optional
weighedDate
string <date-time> | null
optional
paymentInfo
optional
One of
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
loadDate
string <date-time> | null
optional
delivDate
string <date-time> | null
optional
delivPerson
string | null
optional
notDelivDate
string <date-time> | null
optional
outDepDate
string <date-time> | null
optional
hubDate
string <date-time> | null
optional
deliveryToAccessPoint
boolean
optional
backShipmentFeature
optional
One of
backDate
string <date-time> | null
optional
dormantShipmentFeature
optional
One of
dormantShipmentNumber
string | null
optional
dormantShipmentNumberActive
boolean | null
optional
accessPointFeature
optional
One of
accessPointDaysInStorage
integer <int32> | null
optional
accessPointDaysInStorageRemain
integer <int32> | null
optional
accessPointHoursInStorageRemain
integer <int32> | null
optional
routingFeature
optional
One of
routingNumber
string | null
optional
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": [
{}
],
"code": "string",
"price": 0,
"priceCurrency": "string"
}
],
"trackAndTrace": {
"externalShipmentId": "string",
"partnerUrl": "string",
"lastEventCode": "string",
"lastEventDate": "2019-08-24T14:15:22Z",
"lastEventName": "string",
"events": [
{}
]
},
"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-04 09:15:19