Skip to content

List an order's documents

Request

Returns the documents attached to a B2B order, on any of the merchant's sales channels. These are the same documents returned in the documents field of the order. Orders that are not B2B are rejected with 422.

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

Security
BearerAuth
Path
idinteger, (int64)required

Order ID

Query
limitinteger, [ 1 .. 100 ]

Number of items to return per page (for pagination)

Default:20
curl -i -X GET \
  'https://hive-merchant-api.redocly.app/_mock/merchant-api-v2/mapi_v2_oas31/orders/{id}/documents?limit=20' \
  -H 'Authorization: Bearer <YOUR_token_HERE>'

Responses

A list of the order's documents

Bodyapplication/json
dataArray of objects(OrderDocumentDetails)

Documents attached to the order

paginationobject(Pagination)
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"
  }
}