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.
Na tej stronie
Uwierzytelnianie
Dostęp do zasobu wymaga podania prawidłowego i ważnego access tokenu.
Pobieranie etykiety przesyłki
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
Brak podania parametru type skutkuje zwróceniem etykiety normal. Wyjątkiem są serwisy kurierskie, ponieważ nie występuje typenormal, zostanie zwrócony A6.
Przykładowe zapytanie
curl "https://api-shipx-pl.easypack24.net/v1/shipments/4257799/label?format=zpl" -X GET -H "Authorization: Bearer token"
Odpowiedź
serwer zwróci plik .pdf/.epl/.epl2/.zpl/.zip
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.