xclade
Admin APIReturns

List Returns

Retrieve a list of returns. The returns can be filtered by fields such as `id`. The returns can also be sorted or paginated.

GET
/admin/returns

Authorization

AuthorizationBearer <token>

In: header

Query Parameters

fields?string

Comma-separated fields that should be included in the returned data. if a field is prefixed with + it will be added to the default fields, using - will remove it from the default fields. without prefix it will replace the entire default fields.

offset?number

The number of items to skip when retrieving a list.

limit?number

Limit the number of items returned in the list.

order?string

The field to sort the data by. By default, the sort order is ascending. To change the order to descending, prefix the field name with -.

id?id|
status?status|
$and?

Join query parameters with an AND condition. Each object's content is the same type as the expected query parameters.

$or?

Join query parameters with an OR condition. Each object's content is the same type as the expected query parameters.

sales_channel_id?array<sales_channel_id>

Filter by sales channel IDs to retrieve their associated returns.

region_id?region_id|

Filter by region IDs to retrieve their associated returns.

q?string

Search term to filter the return's searchable properties.

created_at?

Filter by the return's creation date.

updated_at?

Filter by the return's update date.

customer_id?customer_id|
with_deleted?boolean

Whether to include deleted records in the result.

Response Body

application/json

application/json

text/plain

application/json

application/json

application/json

application/json

curl -X GET "https://{tenant}.api.myxclade.com/admin/returns"
{
  "limit": 0,
  "offset": 0,
  "count": 0,
  "returns": [
    {
      "id": "string",
      "status": "canceled",
      "refund_amount": 0,
      "order_id": "string",
      "items": [
        {
          "id": "string",
          "quantity": 0,
          "received_quantity": 0,
          "damaged_quantity": 0,
          "reason_id": "string",
          "note": "string",
          "item_id": "string",
          "return_id": "string",
          "metadata": {}
        }
      ],
      "created_at": "2019-08-24T14:15:22Z",
      "canceled_at": "2019-08-24T14:15:22Z",
      "exchange_id": "string",
      "location_id": "string",
      "claim_id": "string",
      "order_version": 0,
      "display_id": 0,
      "no_notification": true,
      "received_at": "string"
    }
  ]
}

{
  "message": "Discount must be set to dynamic",
  "type": "not_allowed"
}

"Unauthorized"
{
  "message": "Entity with id 1 was not found",
  "type": "not_found"
}
{
  "code": "unknown_error",
  "message": "The request conflicted with another request. You may retry the request with the provided Idempotency-Key.",
  "type": "QueryRunnerAlreadyReleasedError"
}
{
  "code": "invalid_request_error",
  "message": "Discount with code TEST already exists.",
  "type": "duplicate_error"
}

{
  "code": "api_error",
  "message": "An error occured while hashing password",
  "type": "database_error"
}

Remove Shipping Method from Return

Remove a shipping method of the return by the ID of the item's `SHIPPING_ADD` action. Every item has an `actions` property, whose value is an array of actions. You can check the action's name using its `action` property, and use the value of the `id` property.

Get a Return

Retrieve a return by its ID. You can expand the return's relations or select the fields that should be returned.