Versions Compared

Old Version 3

changes.mady.by.user Michał Machowski

Saved on

compared with

New Version Current

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

potwierdzenia nadania, 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)

PanelbgColor#f0f0f0titleBGColor

#f0f0f0title

Na tej stronie

Table of Contents
minLevel2
 

Struktura

  • w

    W przypadku jednej przesyłki zwracany jest pojedynczy plik *.pdf

  • w

    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

    Maksymalnie można pobrać manifest dla 100 przesyłek


Uwierzytelnianie

Dostęp do zasobu wymaga podania prawidłowego i

ważnego 

ważnego access tokenu.

by

Drukowanie potwierdzenia nadania dla utworzonego zlecenia odbioru

Info
(info) A

Aby pobrać manifest, użytkownik musi być nadawcą przesyłki. Wygenerować potwierdzenie nadania można tylko dla przesyłek utworzonych w API ShipX.

Code Block
languagejson
GET /v1/dispatch_orders/:id/printout
Parametry 

Parametry 

Parametr

Typ

Opis

Walidacja

Domyślna wartość

Dostępny

format

string

Format etykiety

Dostępne formaty: Pdf 

Pdf

PL

Przykładowe zapytanie

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

Code Block
Plik w wybranym formacie
Warning

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

  • wystąpił błąd podczas komunikacji

z systemem invalid_status

  • 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 ma nieprawidłowy status

    • does_not_exist - przekazana w żądaniu przesyłka

    posiada nieprawidłowy status

    Drukowanie zleceń odbioru

    (info) Aby

    • nie jest dostępna dla danej organizacji

    • invalid_range - podano nieprawidłowy zakres identyfikatora przesyłki

    Drukowanie potwierdzenia nadania dla utworzonych przesyłek

    Info

    Aby pobrać manifest, użytkownik musi być nadawcą przesyłki. Wygenerować potwierdzenie nadania można tylko dla przesyłek utworzonych w API ShipX.

    Code Block
    languagejson
    GET /v1/organizations/:organization_id/dispatch_orders/printouts
    Parametry 

    Parametry 

    Parametr

    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

    przekazane



    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

    • Przekazane przesyłki nie mogą posiadać statusu prepared

    należy

    • Należy przekazać przynajmniej jeden numer paczki

    PL


    Przykładowe zapytanie

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

    Code Block
    Plik zip
    z
    etykietami 
    w wybranym formacie
    Warning

    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

    • wystąpił błąd 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.

    • z systemem logistycznym

    • invalid_status - przekazana w żądaniu przesyłka posiada nieprawidłowy status

    • does_not_exist - przekazana w żądaniu przesyłka nie jest dostępna dla danej organizacji

    • invalid_range - podano nieprawidłowy zakres identyfikatora przesyłki