Skip to content

Shipments

Operations related to shipments

Operations
Webhooks

List shipments

Request

Returns all shipments 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
limitinteger, [ 1 .. 100 ]

Number of items to return per page (for pagination)

Default:20
order_id[in]Array of integers, (int64)

Filter results by one or more Hive order IDs

merchant_order_id[in]Array of strings

Filter results by one or more merchant order IDs

shipped_at[gt]string, (date-time)

Filter shipments shipped after this date (ISO 8601 format)

shipped_at[gte]string, (date-time)

Filter shipments shipped on or after this date (ISO 8601 format)

shipped_at[lt]string, (date-time)

Filter shipments shipped before this date (ISO 8601 format)

shipped_at[lte]string, (date-time)

Filter shipments shipped on or before this date (ISO 8601 format)

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

Responses

A list of shipments

Bodyapplication/json
dataArray of objects(Shipment)
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"
  }
}