Skip to content

List restocking shipments

Request

Returns the merchant's restocking shipments, newest first. Only restocking shipments with at least one item of a SKU the merchant's sales channels know are included.

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
curl -i -X GET \
  'https://hive-merchant-api.redocly.app/_mock/merchant-api-v1/mapi_v1_oas31/restocking_shipments?page=1&limit=20' \
  -H 'Authorization: Bearer <YOUR_TOKEN_HERE>'

Responses

A page of restocking shipments

Bodyapplication/json
dataArray of objects(RestockingShipment)required

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