Pobieranie etykiet
- anagorski (Unlicensed)
- Michał Machowski
Na tej stronie
Pobieranie etykiety
Etykietę można pobrać dla przesyłki opłaconej - w statusie
confirmedlub 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,.zplzawierający etykiety dla wszystkich paczekUwaga! W przypadku wyboru formatu
EPL, dla przesyłek kurierskich zwrócony zostanieEPL, a dla Paczkomat® oraz AllegroEPL2.
GET /v1/shipments/:shipment_id/label |
Parametry
Parametr | Typ | Opis | Walidacja | Domyślna wartość |
|---|---|---|---|---|
| String | Format etykiety | Dostępne formaty: |
|
| String | Typ etykiety | Dostępne typy:
|
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
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 kluczumessageoraz, 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.
Pobieranie wielu etykiet
Etykiety można pobrać dla przesyłek opłaconych - w statusie
confirmedlub 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 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,.pdfoddzielnie 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 zostanieEPL, a dla Paczkomat® i AllegroEPL2.
Parametry
Parametr | Typ | Opis | Walidacja | Domyślna wartość |
|---|---|---|---|---|
| String | Format etykiety | Dostępne formaty: |
|
| Array[Integer] | Identyfikatory przesyłek |
|
|
| String | Typ etykiety | Dostępne typy:
|
|
Przykładowe zapytanie
Odpowiedź
Przykładowe zapytanie
Odpowiedź