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

Význam a použití

Pomocí této metody lze měnit formát štítku a to zadáním upraveného labelSettings objektu z metody POST shipment/batch.

Optimalizace získávání štítků

Pro zpracování velkého množství štítků (např. tisk na formát A4) je proces výpočetně náročný. Proto je pro tisk štítků implementována cache.

Nad A4 to je 5 minut

Pro jednoduché štítky 60 s.

Proto pokud chcete zpracování štítků po zavolání metody PUT výrazně urychlit, doporučujeme místo opakovaného volání metody GET shipment/batch/{batchId}/label použít metodu data, která vrací štítky pro jednotlivé zásilky a je zde nastavena cache na 1s.

Výhody metody data

Metoda je dostupná v response body volání GET shipment/batch/{batchId} jako hodnota klíče labelUrl.

Při konverzi do formátu ZPL se přímo vrací ZPL, takže není nutné převádět Base64 → ZPL, jako je tomu u metody label.

Nevýhody metody data

Vrací pouze jednotlivý štítek. Pokud budete mít v GET/shipment/batch/batchId více zásilek budete muset metodu zavolat pro každou zásilku zvlášť

Vrací štítek pouze ve formátu default to znamená, že pokud budete metodou PUT měnit pouze pozici štítku (např z default na A4), tak tuto metodu nepoužívejte.

Doporučený postup

Zavolejte metodu PUT pro vytvoření nebo aktualizaci batch.

Zavolejte GET shipment/batch/{batchId}.

V odpovědi je k dispozici nový dataGUID v metodě data viz obrázek.

Tento identifikátor se mění po každém volání metody PUT.

Můžete buď:

porovnat nový GUID s předchozím (pokud si ho ukládáte), nebo

nastavit minimální prodlevu mezi metodami PUT a GET.

Zavolejte metodu data s novým GUID pro získání štítku kde bude aktualizovaný formát.

Request

Authorization

JWT Bearer

Add the parameter

Authorization

to Headers，whose value is to concatenate the Token after the Bearer.

Example:

Authorization: Bearer ********************

Path Params

Header Params

Body Params application/json

Example

{
    "labelSettings": {
        "format": "Pdf",
        "completeLabelSettings": {
            "isCompleteLabelRequested": true,
            "pageSize": "A4"
        }
    }
}

Request Code Samples

Shell

JavaScript

Java

Swift

PHP

Python

HTTP

Objective-C

Ruby

OCaml

Dart

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

Význam a použití#

Optimalizace získávání štítků#

Výhody metody data#

Nevýhody metody data#

Doporučený postup#