Przykładowe zapytanie dla zlecenia odbioru
/v1/dispatch_orders/7/printout?format=Pdf curl -X GET "https://api-shipx-pl.easypack24.net/v1/organizations/1/dispatch_orders/printout?dispatch_order_id=24&format=Pdf" -H "Content-Type: application/json" -H "Authorization: Bearer token" -o test.zip
Przykładowe zapytanie dla wskazanych numerów paczek
curl -X GET "https://api-shipx-pl.easypack24.net/v1/organizations/1/dispatch_orders/printouts?shipment_ids[]=123&shipment_ids[]=124&shipment_ids[]=125&format=Pdf" -H "Content-Type: application/json" -H "Authorization: Bearer token" -o test.zip
Parametry
Parametr | Typ | Opis | Walidacja | Domyślna wartość | Metoda |
---|---|---|---|---|---|
format | string | Format etykiety | Dostępne formaty: Pdf | Pdf | printout / printouts |
dispatch_order_id | Integer | Id zlecenia odbioru | printouts | ||
shipment_ids | Array[Integer] | Identyfikatory przesyłek | Wymagane jeśli nie podamy parametru dispatch_order_id | printouts |
Uwierzytelnianie
Do wygenerowania manifestu, który będzie zwracany na podstawie przekazywanych numerów paczek, występuje potrzeba uwierzytelnienia.
Uwierzytelnienie polega na przekazaniu token'u w nagłówkach żądania.
Authorization: Bearer token
Dodatkowa walidacja
- Do metody generującej manifest dla wielu wskazanych numerów paczek, nie można przekazywać przesyłek posiadających zlecenie odbioru oraz przesyłek, do których nie wygenerowano zlecenia odbioru.
- Do metody generującej manifest dla wielu wskazanych numerów paczek, przekazane przesyłki kurierskie muszą posiadać status
confirmed
- Do metody generującej manifest dla wielu wskazanych numerów paczek, przekazane przesyłki nie mogą posiadać statusu
prepared
- Do metody generującej manifest dla wielu wskazanych numerów paczek, należy przekazać przynajmniej jeden numer paczki
Błędy jakie mogą wystąpić podczas pobierania manifestu:
resource_not_found
- organizacja, dla której użytkownik chce pobrać listę zleceń odbioru nie istnieje,token_invalid
- token nie uprawnia do do pobrania listy zleceń odbioru dla wybranej organizacji,printout_generation_failed
- wystapił bład podczas komunikacji z systemem logistycznymcannot_mix_shipments_with_and_without_dispatch_order
- nie można przekazać jednocześnie przesyłek posiadających zlecenie odbioru oraz nieposiadających zlecenia odbioru.invalid_status
- przekazana w żądaniu przesyłka posiada nieprawidłowy status