Skip to content

Orders

Operations related to orders

Operations

List orders

Request

Returns the orders of the sales channel, newest first. Orders created manually in the Hive app are not included.

The created_at filters apply to the time Hive received the order, which can differ from the order's own created_at.

Security
BearerAuth
Query
pageinteger, >= 1

The page to return, starting at 1. A page past the last one returns no records.

Default:1
limitinteger, >= 1

The number of records per page. A value above 100 is treated as 100.

Default:20
created_at[gt]string

Only return records created after this time (ISO 8601).

created_at[gte]string

Only return records created at or after this time (ISO 8601).

created_at[lt]string

Only return records created before this time (ISO 8601).

created_at[lte]string

Only return records created at or before this time (ISO 8601).

curl -i -X GET \
  'https://developers.hive.app/_mock/merchant-api-v1/mapi_v1_oas31/orders?page=1&limit=20&created_at%5Bgt%5D=string&created_at%5Bgte%5D=string&created_at%5Blt%5D=string&created_at%5Blte%5D=string' \
  -H 'Authorization: Bearer <YOUR_TOKEN_HERE>'

Responses

A page of orders

Bodyapplication/json
dataArray of objects(Order)required

The orders on this page.

paginationobject(Pagination)required

Where this page sits in the whole result.

Response
{
  "data": [
    { … }
  ],
  "pagination": {
    "current_page": 1,
    "item_count": 2,
    "page_count": 1,
    "items_per_page": 20
  }
}