Get My Return
curl --request GET \
--url https://api.headlesscommerce.io/v1/storefront/returns/{id} \
--header 'Authorization: Bearer <token>' \
--header 'X-Customer-Token: <api-key>'{
"id": "<string>",
"order_id": "<string>",
"customer_id": "<string>",
"reason": "<string>",
"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,
"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"
}Storefront - Returns
Get My Return
GET
/
storefront
/
returns
/
{id}
Get My Return
curl --request GET \
--url https://api.headlesscommerce.io/v1/storefront/returns/{id} \
--header 'Authorization: Bearer <token>' \
--header 'X-Customer-Token: <api-key>'{
"id": "<string>",
"order_id": "<string>",
"customer_id": "<string>",
"reason": "<string>",
"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,
"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"
}Authorizations
API Key. Example: sk_live_xxxxx or pk_live_xxxxx
Storefront customer authentication token. Issued via POST /admin/customers/{id}/token. Required for accessing /storefront/customers/, /storefront/orders/.
Path Parameters
Resource ID
Response
200 - application/json
Success
Available options:
refund, exchange Available options:
requested, approved, rejected, received, completed, cancelled Available options:
defective, wrong_item, changed_mind, damaged, other Show child attributes
Show child attributes
Show child attributes
Show child attributes
⌘I