Zbiorowe opłacanie przesyłek

Uwierzytelnianie

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

Na tej stronie

1 Uwierzytelnianie
2 Zbiorowe opłacanie przesyłek
3 Asynchroniczne opłacanie przesyłki

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

Parametr

Typ

Opis

Walidacja

shipments

Array[Hash]

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

Parametr	Typ	Opis
`id`	String	Unikalny identyfikator danej przesyłki, który pozwala zwrócić użytkownikowi informację o błędach walidacji przypisanych do konkretnej przesyłki.
`shipment_id`	Integer	Identyfikator przesyłki.
`offer_id`	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ż available albo selected,
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:

POST http://{{adres_podany_w_konfiguracji}}
Content-Type: application/json
{
	"event_ts":"2015-12-08 19:42:42 +0100",
	"event":"shipment_confirmed",
	"organization_id":1,
	"payload": {
		"shipment_id":1234567890,
		"tracking_number":"681549342531876019900138"
	}
}