[1.6.0] Pobieranie etykiet przesyłki
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 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/labelsParametry
Parametr | Typ | Opis | Walidacja | Domyślna wartość |
|---|---|---|---|---|
|
| Typ etykiety | Dostępne typy: |
|
| Array[Integer] | Identyfikatory przesyłek |
|
|
| string | Format etykiety | Dostepne formaty: |
|
Przykładowe zapytanie
curl "https://api-shipx-pl.easypack24.net/v1/organizations/1/shipments/labels" -X POST -H "Content-Type: application/json" -H "Authorization: Bearer token" -d '{
"format": "zpl",
"shipment_ids": [4257802, 4257803, 4257804, 4257799, 4257800, 4257801]
}'
}
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 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.