ST12 - List items to ship

Request

Call Frequency

Recommended usage: Every 15 minutes

Maximum usage: Every 5 minutes

Pagination

This resource supports seek pagination (see documentation)

Sort fields

sort field can have the following values:

shippingDate (Default) - Sort by shipping date (asc by default)

Security

Shop-API-Key(Required scopes: ROLE_SHOP_ADMINROLE_PARTNER_ORDER_READROLE_PARTNER_ORDER_SHIPMENT_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...).

fulfillment_center_codeArray of strings

Fulfillment center code for filtering. This parameter can be supplied multiple times (fulfillment_center_code=ABC&fulfillment_center_code=DEF...).

shipping_date_fromstring, (date-time)

Filter items that moved to shipping status after the given date.

shipping_date_tostring, (date-time)

Filter items that moved to shipping status 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/items_to_ship?order_id=string&fulfillment_center_code=string&shipping_date_from=2019-08-24T14%3A15%3A22Z&shipping_date_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": null,
  "previous_page_token": null
}