Warning!

The resource is available only in the following countries: PL, IT.

On this page

Authentication

Access to the resource requires a valid access token.

Bulk Offer selection

POST /v1/organizations/:organization_id/shipments/select_offers

Parameters

Parameter

Type

Description

Validation

Availability

shipments

Array[Hash]

Shipment Select Offers

Allows for bulk offer selection


Table may consist of a maximum of 100 elements.

PL, IT

shipments have the following attributes:

Parameter

Type

Description

id

String

Unique shipment ID that allows the return of shipment validation errors related to the specific shipment.

shipment_id

Integer

Shipment ID

offer_id

Integer

Offer ID

Example request

curl -X POST https://api-shipx-pl.easypack24.net/v1/organizations/1/shipments/select_offers -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} 
  ]
}'

Response

HTTP/1.1 204 No Content
Content-Type: application/json

Error information

The server can return the following errors during bulk offer selection:

  • validation_failed - validation error

  • forbidden -  user has no access rights to the organization

  • token_invalid - token is invalid