Page tree
Skip to end of metadata
Go to start of metadata

Zbiorowe opłacanie przesyłek:

POST /v1/organizations/:organization_id/shipments/bulk_buy

Parametry

ParametrTypOpisWalidacja
shipments

Array[Hash]

Bulk Buy Shipments Form

Umożliwia dokonania zbiorowego opłacenia przesyłek.

ParemetrTypOpis
idStringUnikalny identyfikator danej przesyłki, który pozwala zwrócić użytkownikowi informację o błędach walidacji przypisanych do konkretnej przesyłki
shipment_idIntegerIdentyfikator przesyłki
offer_idIntegerIdentyfikator oferty
Tablica może zawierać maksymalnie 100 elementów.

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}
  ]
}'

W odpowiedzi serwer zwróci status 204.


W momencie wyboru oferty, pozostałe - niewybrane oferty są usuwane. Aplikacja pozwala opłacić masowo przesyłki tylko wtedy gdy wszystkie dane sa prawidłowo wprowadzone (podane numery przesyłek nalezą do organizacji, ID ofert sa poprawnie przypisane do przesyłki, nie byly wczesnej opłacone itp.)

Uwaga! Działanie asynchroniczne.

 Ponieważ zakup przesyłki działa asynchronicznie, serwer w odpowiedzi zwróci informacje o przesyłce nie uwzględniające zmian wywołanych przez zakup (zmiana statusu, nadanie numeru przewozowego), gdyż informacje te będą dostępne dopiero po pewnym czasie.

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 https://{{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"
	}
}


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.


  • No labels