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 paczkomatowych oraz allegro EPL2.
Pobranie etykiety przesyłki:
GET /v1/shipments/:shipment_id/label?format=...
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 |
Przykładowe zapytanie
curl "https://api-shipx-pl.easypack24.net/v1/shipments/4257799/label?format=zpl" -X GET -H "Authorization: Bearer token"
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
.