Skip to content

Shipments

Operations related to outbound shipments

Operations

List shipments

Request

Returns the shipped shipments of the sales channel's orders, newest first. Shipments that have not been shipped yet are not listed; their status changes are available through the shipment_status_updated webhook.

Filter by order with order_id or merchant_order_id. When both are given, order_id is used. An order that does not exist in the sales channel is answered with 404 Not Found.

Security
BearerAuth
Query
order_idinteger, (int64)

The Hive ID of the order whose shipments to return.

merchant_order_idstring

The merchant's order ID (merchant_order_id) of the order whose shipments to return.

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/shipments?order_id=0&merchant_order_id=string&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 shipments

Bodyapplication/json
dataArray of objects(Shipment)required

The shipments 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
  }
}