[1.6.4] Tworzenie i podgląd wielu przesyłek

Zasób Batch słuzy do tworzenia i podglądu wielu przesyłek. W trybie asynchronicznym po walidacji każda przesyłka procesuje się w osobnym wątku, a co za tym idzie informacje zwrotne są wysyłane na WebHooki dla każdej przesyłki z osobna.

Struktura

Zasób Batch posiada następujące atrybuty:

Atrybut

Typ

Opis

Atrybut

Typ

Opis

id

Integer

Id obiektu

status

String

Status przetwarzania przesyłek

shipments

Array[Shipment]

Przesyłki

created_at

DateTime

Data utworzenia

updated_at

DateTime

Data aktualizacji

Przykład zasobu Batch w formacie JSON:

1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 { "href": "https://api-shipx-pl.easypack24.net/v1/batches/16", "id": 16, "status": "done", "shipments": [ { "href": "https://api-shipx-pl.easypack24.net/v1/shipments/151", "id": 151, "status": "confirmed",   "tracking_number": "633100159730624319900067" }, { "href": "https://api-shipx-pl.easypack24.net/v1/shipments/150", "id": 150, "status": "confirmed",  "tracking_number": "633100159730624319900068" } ], "created_at": "2017-06-08T14:17:25.675+02:00", "updated_at": "2017-06-08T14:17:25.675+02:00" }

 

Uwierzytelnianie

Dostęp do zasobu wymaga podania prawidłowego i aktualnego access tokenu.


 

Tworzenie wielu przesyłek

Po utworzeniu przesyłki nie zwracamy cen dla klientów debetowych.
Atrybut rate przyjmuje wartość null

1 POST /v1/organizations/:organization_id/batches

Parametry

 

Parametr

Typ

Opis

Walidacja

Parametr

Typ

Opis

Walidacja

only_choice_of_offer

Boolean

Ustawienie parametru na true powoduje, że oferta we wszystkich przesyłkach zostanie wybrana dla podanego serwisu, ale nie zostanie automatycznie opłacona.
Taka przesyłkę trzeba opłacić przed końcem wygaśnięcia oferty wykonując operacje (Opłacanie przesyłki).
Parametr ten można ustawić również dla każdej przesyłki z osobna (w takim przypadku parametr ustawiony w przesyłce ma wyższy priorytet).

Atrybut nie jest wymagany.

  • Defoultowa wartość false

shipments

Array[Hash]

 

Atrybut nie jest wymagany.

  • Minimum 1

  • Maksimum 2500

 

Parametry zasobu shipments

Parametr

Type

Opis

Parametr

Type

Opis

id

String

Wymagany. Unikalny identyfikator danej przesyłki, który pozwala zwrócić użytkownikowi informację o błędach walidacji przypisanych do konkretnej przesyłki. Id nie jest zapisywany w bazie danych i nie jest zwracany jak atrybut utworzonej przesyłki.

...

...

Pozostałe parametry przesyłki uproszczonej opisane na stronie

https://dokumentacja-inpost.atlassian.net/wiki/spaces/PL/pages/11731061

Przykład zapytania

1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 curl -X POST https://api-shipx-pl.easypack24.net/v1/organizations/1/batches -H 'Authorization: Bearer token' -H 'content-type: application/json' -d '{ "only_choice_of_offer": false, "shipments": [ { "id": 1, "service": "inpost_locker_standard", "custom_attributes": { "target_point": "KRA010" }, "parcels":{ "template": "small" }, "receiver": { "company_name": "Company name 1", "email": "sklep@inpost.pl", "phone": "888888888", "address": { "line1": "Zawila 65L", "city": "Krakow", "post_code": "30-390", "country_code": "PL" } }, "sender": { "company_name": "Company name 2", "email": "sklep@inpost.pl", "phone": "999999999", "address": { "line1": "Zawila 65L", "city": "Krakow", "post_code": "30-390", "country_code": "PL" } }, "cod": { "amount": 1, "currency": "PLN" }, "insurance": { "amount": 23, "currency": "PLN" } }, { "id": 2, "service": "inpost_locker_standard", "custom_attributes": { "target_point": "KRA010" }, "parcels":{ "template": "small" }, "receiver": { "company_name": "Company name 1", "email": "sklep@inpost.pl", "phone": "888888888", "address": { "line1": "Zawila 65L", "city": "Krakow", "post_code": "30-390", "country_code": "PL" } }, "sender": { "company_name": "Company name 2", "email": "sklep@inpost.pl", "phone": "999999999", "address": { "line1": "Zawila 65L", "city": "Krakow", "post_code": "30-390", "country_code": "PL" } }, "cod": { "amount": 1, "currency": "PLN" }, "insurance": { "amount": 23, "currency": "PLN" } } ] }'

Odpowiedź

1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 HTTP/1.1 201 Created Content-Type: application/json { "href": "https://api-shipx-pl.easypack24.net/v1/batches/35", "id": 35, "status": "in_progress", "shipments": [ { "href": "https://api-shipx-pl.easypack24.net/v1/shipments/195", "id": 195, "status": "confirmed", "tracking_number": "520000017830390003337439" }, { "href": "https://api-shipx-pl.easypack24.net/v1/shipments/195", "id": 195, "status": "offer_selected", "tracking_number": "520000017830390003337439" }, { "href": "https://api-shipx-pl.easypack24.net/v1/shipments/196", "id": 196, "status": "create", "tracking_number": null } ], "created_at": "2017-06-12T14:19:20.432+02:00", "updated_at": "2017-06-12T14:19:20.432+02:00" }

Informacje o błędach

 Serwer może zwrócić następujące błędy

  • validation_failed - błąd walidacji 

    forbidden - akcja jest niedostępna dla podanego tokenu

  • token_invalid - użytkownik nie ma praw dostępu do określonej organizacji


 

Podgląd wielu przesyłek

 

1 GET /v1/batches/:id

Przykład zapytania

1 curl -X GET https://api-shipx-pl.easypack24.net/v1/batches/16 -H 'Authorization: Bearer token' -H 'content-type: application/json'

Odpowiedź

1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 HTTP/1.1 200 OK Content-Type: application/json { "href": "https://api-shipx-pl.easypack24.net/v1/batches/16", "id": 16, "status": "done", "shipments": [ { "href": "https://api-shipx-pl.easypack24.net/v1/shipments/151", "id": 151, "status": "confirmed",  "tracking_number": "633100159730624319900067" }, { "href": "https://api-shipx-pl.easypack24.net/v1/shipments/150", "id": 150, "status": "confirmed",  "tracking_number": "633100159730624319900068" } ], "created_at": "2017-06-08T14:17:25.675+02:00", "updated_at": "2017-06-08T14:17:25.675+02:00" }

Informacje o błędach

Serwer może zwrócić następujące błędy

  • resource_not_found - w przypadku gdy batch nie istnieje

  • token_invalid - użytkownik nie ma praw dostępu do określonej organizacji