Skip to content

Returns

Operations related to returns

Operations

List returns

Request

Returns the returns of the orders of all the merchant's sales channels, newest first. Only returns whose order is also a Merchant API order (one /orders can return) are listed; returns of orders that reached Hive any other way are not.

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
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://hive-merchant-api.redocly.app/_mock/merchant-api-v1/mapi_v1_oas31/returns?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 returns

Bodyapplication/json
dataArray of objects(Return)required

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