[1.6.0] Drukowanie zleceń odbioru

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)


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.

1 GET /v1/dispatch_orders/:id/printout

Parametry 

Parametr

Typ

Opis

Walidacja

Domyślna wartość

Parametr

Typ

Opis

Walidacja

Domyślna wartość

format

string

Format etykiety

Dostępne formaty: Pdf 

Pdf

Przykładowe zapytanie

1 curl -X GET "https://api-shipx-pl.easypack24.net/v1/dispatch_orders/1/printout?format=Pdf" -H "Content-Type: application/json" -H "Authorization: Bearer token"

Odpowiedź

1 Plik w wybranym formacie

Informacje o błędach

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.

1 GET /v1/organizations/:organization_id/dispatch_orders/printouts

Parametry 

Parametr

Typ

Opis

Walidacja

Domyślna wartość

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

  • Należy przekazać przynajmniej jeden numer paczki



Przykładowe zapytanie

1 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 "Authorization: Bearer token" -H "Content-Type: application/json" -o test.zip

Odpowiedź

1 Plik zip z etykietami w wybranym formacie

Informacje o błędach

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