Skip to content

List orders

Request

Returns all orders across all sales channels belonging to the authenticated merchant.

See the Pagination section in the API overview above for details on how pagination works.

Security
BearerAuth
Query
id[in]Array of integers, (int64)

Filter results by one or more IDs, comma-separated (id[in]=1,2). The same filter can be sent as repeated id[in][] parameters instead.

id[in][]Array of integers, (int64)

The id[in] filter sent as repeated parameters, one ID each (id[in][]=1&id[in][]=2). Accepts the same values as id[in]. Use either form.

merchant_order_id[in]Array of strings

Filter results by one or more merchant order IDs

merchant_order_id[in][]Array of strings

The merchant_order_id[in] filter sent as repeated parameters, one merchant order ID each (merchant_order_id[in][]=A1&merchant_order_id[in][]=A2). Accepts the same values as merchant_order_id[in]. Use either form.

sales_channel_id[in]Array of integers, (int64)

Filter results by one or more sales channel ID

limitinteger, [ 1 .. 100 ]

Number of items to return per page (for pagination)

Default:20
created_at[gt]string, (date-time)

Filter results created after this date (ISO 8601 format)

created_at[lt]string, (date-time)

Filter results created before this date (ISO 8601 format)

created_at[gte]string, (date-time)

Filter results created on or after this date (ISO 8601 format)

created_at[lte]string, (date-time)

Filter results created on or before this date (ISO 8601 format)

updated_at[gt]string, (date-time)

Only orders whose updated_at is after this time (ISO 8601 format). An order's updated_at moves whenever the order changes, as listed under the order's updated_at. To poll for changes, use updated_at[gte] with the time your previous poll started: gt leaves out an order updated at exactly that time.

updated_at[lt]string, (date-time)

Only orders whose updated_at is before this time (ISO 8601 format).

updated_at[gte]string, (date-time)

Only orders whose updated_at is at or after this time (ISO 8601 format). An order's updated_at moves whenever the order changes, as listed under the order's updated_at, so passing the time your previous poll started returns every order that changed since. Let consecutive polls overlap by a few minutes: a change carries the time it was made but is listed only once it is saved.

updated_at[lte]string, (date-time)

Only orders whose updated_at is at or before this time (ISO 8601 format).

curl -i -X GET \
  'https://developers.hive.app/_mock/merchant-api-v2/mapi_v2_oas31/orders?id%5Bin%5D=0&id%5Bin%5D%5B%5D=0&merchant_order_id%5Bin%5D=string&merchant_order_id%5Bin%5D%5B%5D=string&sales_channel_id%5Bin%5D=0&limit=20&created_at%5Bgt%5D=2019-08-24T14%3A15%3A22Z&created_at%5Blt%5D=2019-08-24T14%3A15%3A22Z&created_at%5Bgte%5D=2019-08-24T14%3A15%3A22Z&created_at%5Blte%5D=2019-08-24T14%3A15%3A22Z&updated_at%5Bgt%5D=2019-08-24T14%3A15%3A22Z&updated_at%5Blt%5D=2019-08-24T14%3A15%3A22Z&updated_at%5Bgte%5D=2019-08-24T14%3A15%3A22Z&updated_at%5Blte%5D=2019-08-24T14%3A15%3A22Z' \
  -H 'Authorization: Bearer <YOUR_token_HERE>'

Responses

A list of orders

Headers
X-Rate-Limit-Usedinteger

The number of requests used in the current minute.

Examples:
default
10
X-Rate-Limit-Maxinteger

The maximum number of requests allowed per minute (100).

Examples:
default
100
Bodyapplication/json
dataArray of objects(Order)
paginationobject(Pagination)
Example:
{
  "first_page_url": "https://app.hive.app/merchant_api/v2/collection_of_items?limit=20",
  "limit": 20,
  "next_page_url": "https://app.hive.app/merchant_api/v2/collection_of_items?limit=20&page=eyJpZCI6MTIzNDU2fQ"
}
Response
{
  "data": [
    { … }
  ],
  "pagination": {
    "first_page_url": "https://app.hive.app/merchant_api/v2/collection_of_items?limit=20",
    "limit": 20,
    "next_page_url": "https://app.hive.app/merchant_api/v2/collection_of_items?limit=20&page=eyJpZCI6MTIzNDU2fQ"
  }
}