GET
/
vendor
/
returns
{
  "returns": [
    {
      "id": "<string>",
      "status": "canceled",
      "refund_amount": 123,
      "order_id": "<string>",
      "items": [
        {
          "id": "<string>",
          "quantity": 123,
          "received_quantity": 123,
          "damaged_quantity": 123,
          "reason_id": "<string>",
          "note": "<string>",
          "item_id": "<string>",
          "return_id": "<string>",
          "metadata": {}
        }
      ],
      "created_at": "2023-11-07T05:31:56Z",
      "canceled_at": "2023-11-07T05:31:56Z",
      "exchange_id": "<string>",
      "location_id": "<string>",
      "claim_id": "<string>",
      "order_version": 123,
      "display_id": 123,
      "no_notification": true,
      "received_at": "<string>"
    }
  ],
  "count": 123,
  "offset": 123,
  "limit": 123
}

Authorizations

Authorization
string
header
required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Query Parameters

offset
number

The number of items to skip before starting to collect the result set.

limit
number

The number of items to return.

fields
string

Comma-separated fields to include in the response.

Response

200 - application/json

OK

returns
object[]
count
integer

The total number of items available

offset
integer

The number of items skipped before these items

limit
integer

The number of items per page