CPL API
Užitečné odkazy
Užitečné odkazy
  • Developer
  • Sandbox
Užitečné odkazy
Užitečné odkazy
  • Developer
  • Sandbox
Switch to english
  1. ShipmentBatch
  • 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ů
    • Typy dokumentů
  • Customer
    • Informace k zákazníkovi – povolené měny
    • Zákazníkovy adresy
    • Založení číselné řady
  • Data
    • data
  • Info
    • info
  • Order
    • Získání informace o objednávce přepravy
  • OrderBatch
    • Slouží k vytvoření objednávky. Odpověď je v header (Location)
    • Získaní stavu objednávky
  • OrderEvent
    • Zrušení objednání svozu nebo balíku z libovolné adresy
  • Shipment
    • Slouží k získání informací (trackingu) k zásilce
    • Slouží k uložení celních dokumentů k zásilce
  • ShipmentBatch
    • Slouží ke spojení sad zásilek
      POST
    • Vytvoření zásilky
      POST
    • Slouží k úpravě výstupního formátu štítku
      PUT
    • Získání stavu importu zásilky
      GET
    • Získání etikety
      GET
  • ShipmentEvent
    • storno zásilky
    • úprava kontaktu
  • VersionInformation
    • informace o novinkách
  • Routing
    • Slouží k získání směrovacích informací pro štítek
Užitečné odkazy
Užitečné odkazy
  • Developer
  • Sandbox
Užitečné odkazy
Užitečné odkazy
  • Developer
  • Sandbox
Switch to english
  1. ShipmentBatch

Vytvoření zásilky

POST
/shipment/batch
Maintainer:Not configured
Metoda shipment/batch slouží k vytvoření požadavku na získání zásilky , nebo skupiny zásilek. Při zavolání metody je návratovou hodnotou batchId, které následně slouží pro získávání stavu zpracovaní zásilky a následně pro získání etikety. Batch id je v odpovědi zobrazeno v hlavičce (headers) Location.
BatchId je globální unikátní identifikátor (GUID), který se generuje pro každé zavolání metody pro vytvoření zásilky a pro další jeho zpracování je potřeba si jej uchovat.
Je zapsané jako 32 hexadecimálních znaků rozdělených čtyřmi pomlčkami.

Request

Authorization
JWT Bearer
Add the parameter
Authorization
to Headers
Example:
Authorization: ********************
or
Header Params

Body Params application/json

Example
{
  "returnChannel": {
    "type": "<string>",
    "address": "<string>"
  },
  "labelSettings": {
    "format": "<string>",
    "dpi": "<integer>",
    "completeLabelSettings": {
      "isCompleteLabelRequested": "<boolean>",
      "pageSize": "<string>",
      "position": "<integer>"
    }
  },
  "shipments": [
    {
      "productType": "<string>",
      "referenceId": "<string>",
      "shipmentNumber": "<string>",
      "note": "<string>",
      "depot": "<string>",
      "ageCheck": "<string>",
      "integratorId": "<integer>",
      "shipmentSet": {
        "numberOfShipments": "<integer>",
        "additionallyAdded": "<boolean>",
        "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>"
      },
      "recipient": {
        "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>"
          }
        ],
      "shipmentRouting": {
        "inputRouteCode": "28696"
      },
      "directInjection": {
        "directAddressing": "<boolean>",
        "gatewayZipCode": "<string>",
        "gatewayCity": "<string>",
        "country": "<string>"
      },
      "labelService": {
        "labelless": "<boolean>"
      }
    }
  ],
  "shipmentsOrderBy": "<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' \
--header 'Accept-Language;' \
--header 'X-Correlation-ID;' \
--header 'X-LogLevel;' \
--header 'Authorization: Bearer <token>' \
--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>",
      "referenceId": "<string>",
      "shipmentNumber": "<string>",
      "note": "<string>",
      "depot": "<string>",
      "ageCheck": "<string>",
      "integratorId": "<integer>",
      "shipmentSet": {
        "numberOfShipments": "<integer>",
        "additionallyAdded": "<boolean>",
        "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>"
      },
      "recipient": {
        "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>"
          }
        ],
      "shipmentRouting": {
        "inputRouteCode": "28696"
      },
      "directInjection": {
        "directAddressing": "<boolean>",
        "gatewayZipCode": "<string>",
        "gatewayCity": "<string>",
        "country": "<string>"
      },
      "labelService": {
        "labelless": "<boolean>"
      }
    }
  ],
  "shipmentsOrderBy": "<string>"
}'

Responses

🟢201Created
application/json
Created
Headers

Body

Example
//Pokud metoda GET/shipment/batch volá více zásilek a vrátí se jí chyba v podobě statusu 400, je chybná zásilka zobrazena v errors, kdy pořadí zásilky určuje číslo v závorce [1] počítáno od 0.
{
    "errors": {
        "shipments[1].ProductType": [
            "Invalid value"
        ]
    },
    "type": "https://asp.net/core",
    "title": "One or more validation errors occurred.",
    "status": 400,
    "detail": "Please refer to the errors property for additional details.",
    "instance": "/shipment/batch"
}
🟠400Bad Request
🔴500Server Error
🔴503Service Unavailable
Modified at 2026-02-25 12:55:36
Previous
Slouží ke spojení sad zásilek
Next
Slouží k úpravě výstupního formátu štítku