Versions Compared

Old Version 2

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ówpotwierdzenia 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)

Warunki:

  • aby pobrać manifest, użytkownik musi być nadawcą przesyłki.
    • w

    Na tej stronie

    Table of Contents

    Struktura

    • 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

    Panel
    bgColor#f0f0f0
    titleBGColor#f0f0f0
    titleNa tej stronie

    Table of Contents
    minLevel2
     

    Przykładowe zapytanie dla zlecenia odbioru

    Code Block


    Uwierzytelnianie

    Dostęp do zasobu wymaga podania prawidłowego i ważnego access tokenu.

    Drukowanie potwierdzenia nadania dla utworzonego zlecenia odbioru

    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/dispatch_orders/
    7
    :id/printout
    ?format=Pdf   
    Parametry 
    Parametr
    Typ
    Opis
    Walidacja
    Domyślna wartość
    format
    string
    Format etykiety
    Dostępne formaty: Pdf 
    Pdf
    Przykładowe zapytanie
     Code Block
    languagejson
    curl -X GET "https://api-shipx-pl.easypack24.net/v1/
    organizations/1/
    dispatch_orders/1/printout?
    dispatch_order_id=24&
    format=Pdf" -H "Content-Type: application/json" -H "Authorization: Bearer token"
    Odpowiedź
     Code Block
    Plik w 
    -o test.zip
    Przykładowe zapytanie dla wskazanych numerów paczek
    code
    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 pobrania listy zleceń odbioru dla wybranej organizacji
    • printout_generation_failed - wystąpił błąd podczas komunikacji z systemem logistycznym
    • invalid_status - przekazana w żądaniu przesyłka ma 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
    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 
    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
    • 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
     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 "
    Content-Type
    Authorization: 
    application/json
    Bearer token" -H "
    Authorization
    Content-Type: 
    Bearer token
    application/json" -o test.zip
    Parametry 
    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
    Odpowiedź
    ParametrTypOpisWalidacjaDomyślna wartośćMetodaformatstringFormat etykietyDostępne formaty: Pdf Pdfprintout / printoutsdispatch_order_idIntegerId zlecenia odbioruprintoutsshipment_idsArray[Integer]Identyfikatory przesyłekWymagane jeśli nie podamy parametru dispatch_order_idprintouts
    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
     Code Block
    Plik zip 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 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.
    • 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