Skip to main content
GET
/
admin
/
returns
List Returns
curl --request GET \
  --url https://api.headlesscommerce.io/v1/admin/returns \
  --header 'Authorization: Bearer <token>'
{
  "data": [
    {
      "id": "<string>",
      "order_id": "<string>",
      "customer_id": "<string>",
      "return_type": "refund",
      "status": "requested",
      "reason": "<string>",
      "reason_category": "defective",
      "customer_notes": "<string>",
      "admin_notes": "<string>",
      "lines": [
        {
          "id": "<string>",
          "order_line_id": "<string>",
          "quantity": 123,
          "reason": "<string>",
          "condition": "<string>",
          "exchange_variant_id": "<string>"
        }
      ],
      "refund": {
        "id": "<string>",
        "order_id": "<string>",
        "amount": {
          "amount": 123,
          "currency": "<string>"
        },
        "reason": "<string>",
        "restock": true,
        "status": "pending",
        "lines": [
          {
            "order_line_id": "<string>",
            "quantity": 123
          }
        ],
        "created_at": "2023-11-07T05:31:56Z"
      },
      "created_at": "2023-11-07T05:31:56Z",
      "updated_at": "2023-11-07T05:31:56Z"
    }
  ],
  "has_more": true,
  "next_cursor": "<string>"
}

Authorizations

Authorization
string
header
required

API Key. Example: sk_live_xxxxx or pk_live_xxxxx

Query Parameters

limit
integer
default:20
Required range: 1 <= x <= 100
starting_after
string

Return results after this ID (cursor)

status
enum<string>
Available options:
requested,
approved,
rejected,
received,
completed,
cancelled
order_id
string

Response

200 - application/json

Success

data
object[]
has_more
boolean
next_cursor
string | null