Zbiorowe opłacanie przesyłek
Na tej stronie
Zbiorowe opłacanie przesyłek
W momencie wyboru oferty, pozostałe (niewybrane) są usuwane. Aplikacja pozwala opłacić masowo przesyłki tylko wtedy gdy wszystkie dane są prawidłowo wprowadzone (podane numery przesyłek nalezą do organizacji, ID ofert są poprawnie przypisane do przesyłki, nie były wczesnej opłacone itp.)
Ponieważ zakup przesyłki działa asynchronicznie, serwer w odpowiedzi zwróci informacje o przesyłce nieuwzględniające zmian wywołanych przez zakup (zmiana statusu, nadanie numeru przewozowego), gdyż informacje te będą dostępne dopiero po pewnym czasie.
POST /v1/organizations/:organization_id/shipments/bulk_buy |
Parametry
Parametr | Typ | Opis | Walidacja |
|---|---|---|---|
|
Bulk Buy Shipments | Umożliwia dokonania zbiorowego opłacenia przesyłek. | Tablica może zawierać maksymalnie 100 elementów. |
shipments posiada następujące atrybuty:
Parametr | Typ | Opis |
|---|---|---|
| String | Unikalny identyfikator danej przesyłki, który pozwala zwrócić użytkownikowi informację o błędach walidacji przypisanych do konkretnej przesyłki. |
| Integer | Identyfikator przesyłki. |
| Integer | Identyfikator oferty. |
Przykład zapytania
curl -X POST https://api-shipx-pl.easypack24.net/v1/organizations/1/shipments/bulk_buy -H 'Authorization: Bearer token' -H 'Content-Type: application/json' -d '{
"shipments":[
{"id": 1, "shipment_id": 235, "offer_id": 284},
{"id": 2, "shipment_id": 236, "offer_id": 285}
]
}' |
Odpowiedź
HTTP/1.1 204 No Content
Content-Type: application/json |
Informacje o błędach
Lista błędów, które mogą wystąpić przy opłacaniu przesyłki:
resource_not_found- może wystąpić gdy określona przesyłka nie istnieje lub użytkownik nie ma do niej dostępu,offer_unavailable- występuje jeśli podejmowana próba opłacenia oferty w statusie innym niżavailablealboselected,transaction_failed- może wystąpić jeżeli nie uda się opłacić przesyłki.
Asynchroniczne opłacanie przesyłki
Po wykonaniu requestu zostanie uruchomiony asynchroniczny proces opłacania przesyłki.
Aby otrzymać informację o pomyślnym zakupieniu przesyłki, należy zdefiniować w konfiguracji organizacji adres url, pod który mają być wysyłane informacje dla zdarzenia shipment_confirmed. Dzięki temu aplikacja ShipX wyśle na podany adres następujące informacje: