Versions Compared

Old Version 1

changes.mady.by.user anagorski

Saved on

compared with

New Version 2

changes.mady.by.user Michał Machowski

Saved on

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.

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)

Warunki:

  • aby pobrać manifest, użytkownik musi być nadawcą przesyłki.
  • 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


Panel
bgColor#f0f0f0
titleBGColor#f0f0f0
titleNa tej stronie

Table of Contents
minLevel2
 


Przykładowe zapytanie dla zlecenia odbioru

Code Block
/v1/dispatch_orders/7/printout?format=Pdf
 
curl -X GET "https://api-shipx-pl.easypack24.net/v1/organizations/1/dispatch_orders/printoutsprintout?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

Code Block
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 

ParametrTypOpisWalidacjaDomyślna wartośćMetoda
formatstringFormat etykietyDostępne formaty: Pdf Pdfprintout / printouts
dispatch_order_idIntegerId zlecenia odbioru

printouts
shipment_idsArray[Integer]Identyfikatory przesyłekWymagane 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. 


Code Block
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 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