- Created by anagorski, last modified by Michał Machowski on Jan 31, 2022
You are viewing an old version of this page. View the current version.
Compare with Current View Page History
« Previous Version 7 Current »
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.
Na tej stronie
Struktura
Zasób Batch
posiada następujące atrybuty:
Atrybut | Typ | Opis |
---|---|---|
|
| Id obiektu |
|
| Status przetwarzania przesyłek |
|
| Przesyłki |
|
| Data utworzenia |
|
| Data aktualizacji |
Przykład zasobu Batch
w formacie 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" } |
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
POST /v1/organizations/:organization_id/batches |
Parametry
Parametr | Typ | Opis | Walidacja |
---|---|---|---|
|
| Ustawienie parametru na | Atrybut nie jest wymagany.
|
|
| Atrybut nie jest wymagany.
|
Parametry zasobu shipments
Parametr | Type | Opis |
---|---|---|
|
| 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 |
Przykład zapytania
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ź
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 walidacjiforbidden
- akcja jest niedostępna dla podanego tokenutoken_invalid
- użytkownik nie ma praw dostępu do określonej organizacji
Podgląd wielu przesyłek
GET /v1/batches/:id |
Przykład zapytania
curl -X GET https://api-shipx-pl.easypack24.net/v1/batches/16 -H 'Authorization: Bearer token' -H 'content-type: application/json' |
Odpowiedź
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 istniejetoken_invalid
- użytkownik nie ma praw dostępu do określonej organizacji
- No labels