Skip to end of metadata
Go to start of metadata

You are viewing an old version of this page. View the current version.

Compare with Current View Page History

« Previous Version 3 Next »

  • 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

(info) Aby pobrać manifest, użytkownik musi być nadawcą przesyłki.

GET /v1/dispatch_orders/:id/printout

Parametry 

Parametr

Typ

Opis

Walidacja

Domyślna wartość

Dostępny

format

string

Format etykiety

Dostępne formaty: Pdf 

Pdf

PL

Przykładowe zapytanie

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ź

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

Drukowanie zleceń odbioru

(info) 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ść

Dostępny

format

string

Format etykiety

Dostępne formaty: Pdf 

Pdf

PL

dispatch_order_id

Integer

Id zlecenia odbioru



PL

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

PL

Przykładowe zapytanie

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ź

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


  • No labels