Przykładowe zapytanie dla zlecenia odbioru
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.
Code Block |
---|
GET /v1/dispatch_orders/7:id/printout?format=Pdf |
Parametry
Parametr | Typ | Opis | Walidacja | Domyślna wartość | Dostępny |
---|---|---|---|---|---|
| string | Format etykiety | Dostępne formaty: |
| PL |
Przykładowe zapytanie
Code Block |
---|
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" -o test.zip |
Odpowiedź
Code Block |
---|
curlPlik -Xw GET "https://api-shipx-pl.easypack24.netwybranym 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 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.invalid_status
- przekazana w żądaniu przesyłka posiada nieprawidłowy status
Drukowanie zleceń odbioru
Aby pobrać manifest, użytkownik musi być nadawcą przesyłki.
Code Block |
---|
GET /v1/organizations/1:organization_id/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
Dodatkowa walidacja
Do metody generującej manifest dla wielu wskazanych numerów paczek, nieParametr | Typ | Opis | Walidacja | Domyślna wartość |
---|
Dostępny | ||||
---|---|---|---|---|
| string | Format etykiety | Dostępne formaty: |
|
printout / printouts
PL | ||
| Integer | Id zlecenia odbioru |
printouts
PL | |||
| Array[Integer] | Identyfikatory przesyłek | Wymagane jeśli nie podamy parametru |
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 |
|
|
|
| PL |
Przykładowe zapytanie
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 "Authorization: Bearer token" -H "Content-Type: application/json" -o test.zip |
Odpowiedź
Code Block |
---|
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 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.invalid_status
- przekazana w żądaniu przesyłka posiada nieprawidłowy status