Skip to content

List returns

Request

Returns all returns 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
sales_channel_id[in]Array of integers, (int64)

Filter results by one or more sales channel ID

created_at[gt]string, (date-time)

Filter results created after this date (ISO 8601 format)

created_at[lt]string, (date-time)

Filter results created before this date (ISO 8601 format)

created_at[gte]string, (date-time)

Filter results created on or after this date (ISO 8601 format)

created_at[lte]string, (date-time)

Filter results created on or before this date (ISO 8601 format)

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/returns?sales_channel_id%5Bin%5D=0&created_at%5Bgt%5D=2019-08-24T14%3A15%3A22Z&created_at%5Blt%5D=2019-08-24T14%3A15%3A22Z&created_at%5Bgte%5D=2019-08-24T14%3A15%3A22Z&created_at%5Blte%5D=2019-08-24T14%3A15%3A22Z&limit=20' \
  -H 'Authorization: Bearer <YOUR_token_HERE>'

Responses

A list of returns

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