Skip to content
Products
/
/
/
ST11 - List shipments

ST11 - List shipments

Request

Call Frequency
Recommended usage: at each shipment page display
Maximum usage: at each shipment page display
Pagination

This resource supports seek pagination (see documentation)

Sort fields

sort field can have the following values:

  • dateCreated (Default) - Sort by creation date (asc by default)

Security
Shop-API-Key(Required scopes: ROLE_SHOP_ADMINROLE_PARTNER_ORDER_READ)
Query
order_idArray of strings

Order id for filtering. This parameter can be supplied multiple times (order_id=OR01-A&order_id=OR02-A...).

shipment_state_codeArray of strings

Shipment state code for filtering. This parameter can be supplied multiple times (shipment_state_code=SHIPPING&shipment_state_code=SHIPPED...).

shipment_customer_debit_state_codeArray of strings

Shipment customer debit state code for filtering. This parameter can be supplied multiple times (shipment_customer_debit_state_code=WAITING_TAX_CONFIRMATION&shipment_customer_debit_state_code=DEBIT_OK...).

last_updated_fromstring, (date-time)

Filter shipments updated after the given date.

last_updated_tostring, (date-time)

Filter shipments updated before the given date.

shop_idinteger, (int64)

Use this parameter when your user has access to several shops. If not specified, the shop_id from your default shop will be used.

curl -i -X GET \
  'https://your-instance.mirakl.net/api/shipments?order_id=string&shipment_state_code=string&shipment_customer_debit_state_code=string&last_updated_from=2019-08-24T14%3A15%3A22Z&last_updated_to=2019-08-24T14%3A15%3A22Z&shop_id=0' \
  -H 'Authorization: YOUR_API_KEY_HERE'

Responses

OK

Bodyapplication/json
dataArray of objectsrequired

Page of data

next_page_tokenstring

Token to access the next page. Absent if the current page is the last one.

previous_page_tokenstring

Token to access the previous page. Absent if the current page is the first one.

Response
{
  "data": [
    { … },
    { … },
    { … },
    { … }
  ],
  "next_page_token": "bGltaXQ9MTAmYWZ0ZXI9MjAxOS0wOC0xMlQxMDowMzoyMy43NzNaJmFmdGVyPU1JUi1RTDNXVE1DSi1BJmFmdGVyPTEmc29ydD1kYXRlQ3JlYXRlZCxBU0M=",
  "previous_page_token": null
}