CPL API
Užitečné odkazy
  • Developer
  • Sandbox
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ů
  • Customer
    • Informace k zákazníkovi – povolené měny
    • Zákazníkovy adresy
  • 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
  • ShipmentBatch
    • 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
  1. ShipmentBatch

Slouží k úpravě výstupního formátu štítku

PUT
/shipment/batch/{batchId}
ShipmentBatch
Maintainer:Not configured

Význam a použití#

pomocí této metody lze měnit formát štítku a to zadáním upraveného labelSettings popř. returnChannel body z metody shipment/batch.

Request

Path Params
batchId
string <uuid>
required
batch id z metody POST shipment/batch
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
Body Params application/json
UpdateShipmentBatchModel
returnChannel
optional
One of
ReturnChannelModel
type
optional
address
string  | null 
optional
Pokud je vybrán Type = Email, pak zde vyplňovat email příjemce etikety Délka: 100
<= 100 characters
labelSettings
object (Eps.Api.MyApi2.Web.Models.ShipmentBatch.LabelSettingsModel) 
required
LabelSettingsModel
format
enum<string> 
optional
Label format
Allowed values:
ZplPdfJpegPngSvg
dpi
integer <int32> | null 
optional
Volba DPI pro ZPL
>= 203<= 1200
completeLabelSettings
optional
Example
{
  "labelSettings": {
    "format": "Pdf",
    "completeLabelSettings": {
      "isCompleteLabelRequested": true,
      "pageSize": "A4"
    }
  }
}

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 PUT '/shipment/batch/' \
--header 'Accept-Language;' \
--header 'X-Correlation-ID;' \
--header 'X-LogLevel;' \
--header 'Content-Type: application/json' \
--data-raw '{
    "labelSettings": {
        "format": "Pdf",
        "completeLabelSettings": {
            "isCompleteLabelRequested": true,
            "pageSize": "A4"
        }
    }
}'

Responses

🟢204No Content
application/json
No Content
Headers
X-Correlation-ID
string 
optional
Correlation Id of request otherwise id of response
Body
object {0}
Example
{}
🟠400Bad Request
🔴500Server Error
🔴503Service Unavailable
Modified at 2025-02-04 12:55:26
Previous
Vytvoření zásilky
Next
Získání stavu importu zásilky
Built with