Funkcjonalność umożliwia generowanie manifestów, zarówno dla przesyłek posiadających zlecenie odbioru, oraz przesyłek nieposiadających zleceń odbioru.
Dostępne są 2 metody:
Metoda generująca manifest dla zlecenia odbioru (printout)
Metoda generująca manifest dla wskazanych numerów paczek (printouts)
Na tej stronie
Struktura
W przypadku jednej przesyłki zwracany jest pojedynczy plik *.pdf
W przypadku wielu przesyłek: - jeżeli przesyłki są tego samego serwisu, zwracany jest pojedynczy plik *.pdf z wszystkimi przesyłkami - jeżeli przesyłki są dla różnych serwisów, zwracany jest plik *.zip z plikami *.pdf (oddzielnie dla każdego serwisu).
Maksymalnie można pobrać manifest dla 100 przesyłek
Uwierzytelnianie
Dostęp do zasobu wymaga podania prawidłowego i ważnego access tokenu.
Drukowanie zlecenia odbioru
Aby pobrać manifest, użytkownik musi być nadawcą przesyłki. Wygenerować zlecenie odbioru można tylko dla przesyłek utworzonych w API ShipX.
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 pobrania listy zleceń odbioru dla wybranej organizacji,
printout_generation_failed - wystapił bład podczas komunikacji z systemem logistycznym
cannot_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 statu
Drukowanie zleceń odbioru
Aby pobrać manifest, użytkownik musi być nadawcą przesyłki.
GET /v1/organizations/:organization_id/dispatch_orders/printouts
Parametry
Parametr
Typ
Opis
Walidacja
Domyślna wartość
format
string
Format etykiety
Dostępne formaty: Pdf
Pdf
dispatch_order_id
Integer
Id zlecenia odbioru
shipment_ids
Array[Integer]
Identyfikatory przesyłek
Wymagane jeśli nie podamy parametru dispatch_order_id
Nie można przekazywać przesyłek posiadających zlecenie odbioru oraz przesyłek, do których nie wygenerowano zlecenia odbioru.
Przekazane przesyłki kurierskie muszą posiadać status confirmed
Przekazane przesyłki nie mogą posiadać statusu prepared
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 pobrania listy zleceń odbioru dla wybranej organizacji,
printout_generation_failed - wystapił bład podczas komunikacji z systemem logistycznym
cannot_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