Versions Compared

Version Old Version 8 New Version 9
Changes made by

Michał Machowski

Michał Machowski

Saved on

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.

Uwierzytelnianie

Dostęp do zasobu wymaga podania prawidłowego i ważnego access tokenu.

Na tej stronie

Table of Contents

Pobieranie etykiety

  • Etykietę można pobrać dla przesyłki opłaconej - w statusie confirmed lub późniejszym.

  • Aby, pobrać etykietę przesyłki użytkownik musi być jej nadawcą.

  • W przypadku przesyłek jednopaczkowych zwracany jest pojedynczy plik .pdf, .epl/.epl2, .zpl,

  • W przypadku przesyłek wielopaczkowych zwracany jest pojedynczy plik .pdf, .epl, .zpl zawierający etykiety dla wszystkich paczek

  • Uwaga! W przypadku wyboru formatu EPL, dla przesyłek kurierskich zwrócony zostanie EPL, a dla Paczkomat® oraz Allegro EPL2.

Na tej stronie

Table of Contents

Uwierzytelnianie

Dostęp do zasobu wymaga podania prawidłowego i ważnego access tokenu

  • .

Pobieranie etykiety przesyłki

Code Block
languagejson
GET /v1/shipments/:shipment_id/label

Parametry

Parametr

Typ

Opis

Walidacja

Domyślna wartość

format

String

Format etykiety

Dostępne formaty: Pdf, Zpl, Epl

Pdf

type

String

Typ etykiety

Dostępne typy:
normal, A6

dpi300 - dostępny tylko dla formatu zpl oraz serwisów:
inpost_locker_standard, inpost_locker_allegro, inpost_locker_pass_thru, inpost_letter_allegro, inpost_courier_allegro, inpost_courier_c2c


Info

Brak podania parametru type skutkuje zwróceniem etykiety normal. Wyjątkiem są serwisy kurierskie, ponieważ nie występuje type normal, zostanie zwrócony A6.

Przykładowe zapytanie

Code Block
languagejson
curl "https://api-shipx-pl.easypack24.net/v1/shipments/4257799/label?format=zpl" -X GET -H "Authorization: Bearer token"

Odpowiedź

Code Block
languagejson
serwer zwróci plik .pdf/.epl/.epl2/.zpl/.zip
Warning

Informacje o błędach

Błędy jakie mogą wystąpić podczas pobierania etykiety przesyłki:

  • label_generation_failed - nie udało się wygenerować etykiety, powód opisany jest w kluczu message oraz, ewentualnie, obiekcie details.

  • label_template_not_found - w systemie centralnym nie ma szablonu etykiety, więc nie można jej wygenerować,

  • invalid_action - przy próbie pobrania etykiety dla przesyłki nieopłaconej - w statusie wcześniejszym niż confirmed.

Pobieranie wielu etykiet

  • Etykiety można pobrać dla przesyłek opłaconych - w statusie confirmed lub późniejszym

  • Aby pobrać etykiety, użytkownik musi być jej nadawcą.

  • W przypadku jednej przesyłki zwracany jest pojedynczy plik .pdf, .epl/.epl2, .zpl,

  • W przypadku wielu przesyłek:
    - jeżeli przesyłki są tego samego serwisu, zwracany jest pojedynczy plik z wszystkimi przesyłkami
    - jeżeli przesyłki są dla różnych serwisów, zwracany jest plik .zip z plikami .epl/.epl2 , .zpl, .pdf oddzielnie dla każdego serwisu.

  • Maksymalnie można pobrać etykiety dla 100 przesyłek

  • Uwaga! W przypadku wyboru formatu EPL, dla przesyłek kurierskich zwrócony zostanie EPL, a dla Paczkomat® i Allegro EPL2.

Code Block
languagejson
GET /v1/organizations/:organization_id/shipments/labels?format=zpl&shipemnt_ids[]=1&shipemnt_ids[]=12&shipemnt_ids[]=123&shipemnt_ids[]=1234

Parametry 

Parametr

Typ

Opis

Walidacja

Domyślna wartość

format

String

Format etykiety

Dostępne formaty: Pdf, Epl, Zpl 

Pdf

shipment_ids

Array[Integer]

Identyfikatory przesyłek

type

String

Typ etykiety

Dostępne typy:
normal, A6

dpi300 - dostępny tylko dla formatu zpl oraz serwisów:
inpost_locker_standard, inpost_locker_allegro, inpost_locker_pass_thru, inpost_letter_allegro, inpost_courier_allegro, inpost_courier_c2c

Przykładowe zapytanie

Code Block
languagejson
curl -X GET "https://api-shipx-pl.easypack24.net/v1/organizations/1/shipments/labels?shipment_ids[]=4257802&shipment_ids[]=4257803&format=zpl" -H "Content-Type: application/json" -H "Authorization: Bearer token"

Odpowiedź

Code Block
languagejson
serwer zwróci plik .pdf/.epl/.epl2/.zpl/.zip

Przykładowe zapytanie

Code Block
languagejson
curl -X POST https://api-shipx-pl.easypack24.net/v1/organizations/1/shipments/labels -H 'Authorization: Bearer token' -H 'Content-Type: application/json' -d '{
"type": "A6",	
"format": "pdf",
"shipment_ids": [41938,41937]
}

Odpowiedź

Code Block
languagejson
serwer zwróci plik .pdf/.epl/.epl2/.zpl/.zip