- AccessPoint
- AddressWhisper
- 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
- Info
- Order
- OrderBatch
- OrderEvent
- Shipment
- ShipmentBatch
- ShipmentEvent
- VersionInformation
Shipment creation
POST
/shipment/batch
ShipmentBatch
Maintainer:Not configured
Purpose and usage#
Request
Header Params
Accept-Language
string
optional
X-Correlation-ID
string
optional
X-LogLevel
enum<string>
optional
Allowed values:
TraceDebugInformationWarningErrorCritical
Body Params application/json
returnChannel
optional
One of
type
optional
supported!
address
string | null
optional
Email format: xxxxxxx@yyyy.zzz
FTP format:
ftp://user:password@host:port/path
Délka: 100
<= 100 characters
labelSettings
optional
One of
format
enum<string>
Eps.Api.MyApi2.Web.Constants.ConstLabelFormat
Allowed values:
ZplPdfJpegPngSvg
dpi
integer <int32> | null
optional
>= 203<= 1200
completeLabelSettings
optional
labels into one response
shipments
array [object {21}]
required
>= 1 items
referenceId
string
required
>= 1 characters<= 128 characters
shipmentNumber
string | null
optional
productType
string
required
>= 1 characters
note
string | null
optional
depot
string | null
optional
ageCheck
string | null
optional
integratorId
integer <int32> | null
optional
>= 1
shipmentSet
optional
backAddress
optional
shipments
sender
optional
senderMask
optional
different shipper on the label than the
one on record.
recipient
object
required
specificDelivery
optional
cashOnDelivery
optional
insurance
optional
externalNumbers
array [object {2}] | null
optional
services
array [object {1}] | null
optional
dormant
optional
shipmentRouting
optional
directInjection
optional
labelService
optional
shipmentsOrderBy
string | null
optional
Example
{
"returnChannel": {
"type": "<string>",
"address": "<string>"
},
"labelSettings": {
"format": "<string>",
"dpi": "<integer>",
"completeLabelSettings": {
"isCompleteLabelRequested": "<boolean>",
"pageSize": "<string>",
"position": "<integer>"
}
},
"shipments": [
{
"productType": "<string>",
"recipient": {
"country": "<string>",
"zipCode": "<string>",
"name": "<string>",
"name2": "<string>",
"street": "<string>",
"city": "<string>",
"contact": "<string>",
"phone": "<string>",
"email": "<string>"
},
"referenceId": "<string>",
"shipmentNumber": "<string>",
"note": "<string>",
"depot": "<string>",
"ageCheck": "<string>",
"integratorId": "<integer>",
"shipmentSet": {
"numberOfShipments": "<integer>",
"shipmentSetItems": [
{
"shipmentNumber": "<string>",
"weighedShipmentInfo": {
"weight": "<double>"
},
"externalNumbers": [
{
"code": "<string>",
"externalNumber": "<string>"
},
{
"code": "<string>",
"externalNumber": "<string>"
}
],
"insurance": {
"insuranceCurrency": "<string>",
"insurancePrice": "<double>"
}
},
{
"shipmentNumber": "<string>",
"weighedShipmentInfo": {
"weight": "<double>"
},
"externalNumbers": [
{
"code": "<string>",
"externalNumber": "<string>"
},
{
"code": "<string>",
"externalNumber": "<string>"
}
],
"insurance": {
"insuranceCurrency": "<string>",
"insurancePrice": "<double>"
}
}
]
},
"backAddress": {
"country": "<string>",
"zipCode": "<string>",
"name": "<string>",
"name2": "<string>",
"street": "<string>",
"city": "<string>",
"contact": "<string>",
"phone": "<string>",
"email": "<string>"
},
"sender": {
"country": "<string>",
"zipCode": "<string>",
"name": "<string>",
"name2": "<string>",
"street": "<string>",
"city": "<string>",
"contact": "<string>",
"phone": "<string>",
"email": "<string>"
},
"senderMask": {
"country": "<string>",
"zipCode": "<string>",
"name": "<string>",
"name2": "<string>",
"street": "<string>",
"city": "<string>",
"contact": "<string>",
"phone": "<string>",
"email": "<string>"
},
"specificDelivery": {
"specificDeliveryDate": "<dateTime>",
"specificDeliveryTimeFrom": "<dateTime>",
"specificDeliveryTimeTo": "<dateTime>",
"specificTakeDate": "<dateTime>",
"parcelShopCode": "<string>"
},
"cashOnDelivery": {
"codCurrency": "<string>",
"codPrice": "<double>",
"codVarSym": "088919",
"iban": "<string>",
"swift": "<string>",
"specSymbol": "<string>",
"account": "<string>",
"accountPre": "<string>",
"bankCode": "<string>"
},
"insurance": {
"insuranceCurrency": "<string>",
"insurancePrice": "<double>"
},
"externalNumbers": [
{
"code": "<string>",
"externalNumber": "<string>"
},
{
"code": "<string>",
"externalNumber": "<string>"
}
],
"services": [
{
"code": "<string>"
},
{
"code": "<string>"
}
],
"dormant": {
"shipmentNumber": "<string>",
"note": "<string>",
"recipient": {
"country": "<string>",
"zipCode": "<string>",
"name": "<string>",
"name2": "<string>",
"street": "<string>",
"city": "<string>",
"contact": "<string>",
"phone": "<string>",
"email": "<string>"
},
"externalNumbers": [
{
"code": "<string>",
"externalNumber": "<string>"
},
{
"code": "<string>",
"externalNumber": "<string>"
}
],
"services": [
{
"code": "<string>"
},
{
"code": "<string>"
}
],
"weighedShipmentInfo": {
"weight": "<double>"
}
},
"shipmentRouting": {
"inputRouteCode": "28696"
},
"directInjection": {
"directAddressing": "<boolean>",
"gatewayZipCode": "<string>",
"gatewayCity": "<string>",
"country": "<string>"
},
"labelService": {
"labelless": "<boolean>"
}
}
],
"shipmentsOrderBy": "<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 '/shipment/batch' \
--header 'Accept-Language;' \
--header 'X-Correlation-ID;' \
--header 'X-LogLevel;' \
--header 'Content-Type: application/json' \
--data-raw '{
"returnChannel": {
"type": "<string>",
"address": "<string>"
},
"labelSettings": {
"format": "<string>",
"dpi": "<integer>",
"completeLabelSettings": {
"isCompleteLabelRequested": "<boolean>",
"pageSize": "<string>",
"position": "<integer>"
}
},
"shipments": [
{
"productType": "<string>",
"recipient": {
"country": "<string>",
"zipCode": "<string>",
"name": "<string>",
"name2": "<string>",
"street": "<string>",
"city": "<string>",
"contact": "<string>",
"phone": "<string>",
"email": "<string>"
},
"referenceId": "<string>",
"shipmentNumber": "<string>",
"note": "<string>",
"depot": "<string>",
"ageCheck": "<string>",
"integratorId": "<integer>",
"shipmentSet": {
"numberOfShipments": "<integer>",
"shipmentSetItems": [
{
"shipmentNumber": "<string>",
"weighedShipmentInfo": {
"weight": "<double>"
},
"externalNumbers": [
{
"code": "<string>",
"externalNumber": "<string>"
},
{
"code": "<string>",
"externalNumber": "<string>"
}
],
"insurance": {
"insuranceCurrency": "<string>",
"insurancePrice": "<double>"
}
},
{
"shipmentNumber": "<string>",
"weighedShipmentInfo": {
"weight": "<double>"
},
"externalNumbers": [
{
"code": "<string>",
"externalNumber": "<string>"
},
{
"code": "<string>",
"externalNumber": "<string>"
}
],
"insurance": {
"insuranceCurrency": "<string>",
"insurancePrice": "<double>"
}
}
]
},
"backAddress": {
"country": "<string>",
"zipCode": "<string>",
"name": "<string>",
"name2": "<string>",
"street": "<string>",
"city": "<string>",
"contact": "<string>",
"phone": "<string>",
"email": "<string>"
},
"sender": {
"country": "<string>",
"zipCode": "<string>",
"name": "<string>",
"name2": "<string>",
"street": "<string>",
"city": "<string>",
"contact": "<string>",
"phone": "<string>",
"email": "<string>"
},
"senderMask": {
"country": "<string>",
"zipCode": "<string>",
"name": "<string>",
"name2": "<string>",
"street": "<string>",
"city": "<string>",
"contact": "<string>",
"phone": "<string>",
"email": "<string>"
},
"specificDelivery": {
"specificDeliveryDate": "<dateTime>",
"specificDeliveryTimeFrom": "<dateTime>",
"specificDeliveryTimeTo": "<dateTime>",
"specificTakeDate": "<dateTime>",
"parcelShopCode": "<string>"
},
"cashOnDelivery": {
"codCurrency": "<string>",
"codPrice": "<double>",
"codVarSym": "088919",
"iban": "<string>",
"swift": "<string>",
"specSymbol": "<string>",
"account": "<string>",
"accountPre": "<string>",
"bankCode": "<string>"
},
"insurance": {
"insuranceCurrency": "<string>",
"insurancePrice": "<double>"
},
"externalNumbers": [
{
"code": "<string>",
"externalNumber": "<string>"
},
{
"code": "<string>",
"externalNumber": "<string>"
}
],
"services": [
{
"code": "<string>"
},
{
"code": "<string>"
}
],
"dormant": {
"shipmentNumber": "<string>",
"note": "<string>",
"recipient": {
"country": "<string>",
"zipCode": "<string>",
"name": "<string>",
"name2": "<string>",
"street": "<string>",
"city": "<string>",
"contact": "<string>",
"phone": "<string>",
"email": "<string>"
},
"externalNumbers": [
{
"code": "<string>",
"externalNumber": "<string>"
},
{
"code": "<string>",
"externalNumber": "<string>"
}
],
"services": [
{
"code": "<string>"
},
{
"code": "<string>"
}
],
"weighedShipmentInfo": {
"weight": "<double>"
}
},
"shipmentRouting": {
"inputRouteCode": "28696"
},
"directInjection": {
"directAddressing": "<boolean>",
"gatewayZipCode": "<string>",
"gatewayCity": "<string>",
"country": "<string>"
},
"labelService": {
"labelless": "<boolean>"
}
}
],
"shipmentsOrderBy": "<string>"
}'
Responses
🟢201Created
application/json
Headers
X-Correlation-ID
string
optional
Location
string
optional
Body
object {0}
Example
{}
🟠400Bad Request
🔴500Server Error
🔴503Service Unavailable
Modified at 2025-05-21 11:59:08