CPL API
Useful links
  • Developer
  • Sandbox
Useful links
  • Developer
  • Sandbox
Přepni do češtiny
  1. ShipmentBatch
  • 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
    • Get order status
  • OrderEvent
    • Order cancel
  • Shipment
    • Shipment tracking
  • ShipmentBatch
    • Shipment creation
      POST
    • Used to combine sets of shipments
      POST
    • Used to modify the output format of the label.
      PUT
    • Getting import state
      GET
    • Pick up label
      GET
  • ShipmentEvent
    • Shipment cancel
    • Adding informations to shipment
  • Routing
    • Used to obtain routing information for a label
  • VersionInformation
    • News
  1. ShipmentBatch

Used to combine sets of shipments

POST
/shipment/batch/connectSet
Maintainer:Not configured
This method is used to merge shipments into a set.
In order to merge shipments into a set, you must include the flag "additionallyAdded": true in the POST shipment/batch request body when creating a shipment that you want to later merge into a set, and add the external number ESPN to the external numbers. A shipment created in this way can then be merged using this method into a set together with other shipments created in the same way.
Conditions for merging
Only shipments of the same productType can be merged
Shipments that were already created in a set can also be merged
Shipments with COD (Cash on Delivery) cannot be merged
Shipments can only be merged until they are physically processed (scanned at loading)
Shipments of type Smart2Box cannot be merged
Only shipments within the Czech Republic can be merged (in the future this method will be extended for international shipments)
All shipments to be merged must meet these conditions. If not, no partial merging will occur and the method will return an error.
For a better understanding of the merging process, see the examples, where shipment merging is described in detail.

Request

Authorization
JWT Bearer
Add the parameter
Authorization
to Headers
,whose value is to concatenate the Token after the Bearer.
Example:
Authorization: Bearer ********************
or
Header Params

Body Params application/json-patch+json

Example
{
    "customerId": 1,
    "externalSetNumber": "string",
    "shipmentNumbers": [
        "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 '/shipment/batch/connectSet' \
--header 'Accept-Language;' \
--header 'X-Correlation-ID;' \
--header 'X-LogLevel;' \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json-patch+json' \
--data-raw '{
    "customerId": 1,
    "externalSetNumber": "string",
    "shipmentNumbers": [
        "string"
    ]
}'

Responses

🟢200OK
application/json
Success
Headers

Body

Example
{
    "masterShipmentNumber": "string",
    "shipmentNumbers": [
        "string"
    ]
}
🟠400Bad Request
🟠401Unauthorized
🟠403Forbidden
🟠409409
🔴500Server Error
🔴503Service Unavailable
Modified at 2025-10-16 08:55:33
Previous
Shipment creation
Next
Used to modify the output format of the label.