Etykietę można pobrać dla przesyłki opłaconej - w statusie confirmed
lub późniejszym.
etykiety można pobrać dla przesyłek opłaconych - w statusie
confirmed
lub późniejszymaby 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 sa tego samego serwisu, zwracany jest pojedynczy plik z wszystkimi przesyłkami
- jeżeli przesyłki sa 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 paczkomatowych i allegro EPL2.
Pobranie etykiety przesyłki:
POST /v1/organizations/:organization_id/ shipments/labels
Parametry
Parametr | Typ | Opis | Walidacja | Domyślna wartość |
---|---|---|---|---|
format | string | Format etykiety | Formaty etykiet: Pdf , Epl , Zpl | Pdf |
shipment_ids | Array[Integer] | IDki przesyłek |
Przykładowe zapytanie
POST /v1/organizations/115/shipments/labels HTTP/1.1 Host: api-shipx-pl.easypack24.net Authorization: Bearer eyJ0eXAiOiJKV1QiLCJhbG ...[ommited for brevity]... Content-Type: application/json { "format": "pdf", "shipment_ids": [16728825,16237313] }
W odpowiedzi na poprawnie przesłane zapytanie, serwer zwróci plik .pdf/.epl/.epl2/.zpl/.zip ze statusem HTTP 200 OK:
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 kluczumessage
oraz, ewentualnie, obiekciedetails
.
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
.