Skip to main content
POST
/
v1
/
return_requests
Create
curl --request POST \
  --url https://{defaultHost}/v1/return_requests \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "return_request": {
    "order": "edca98c7-418c-429d-8203-a07c89715e0e",
    "return_items": [
      {
        "line_item": "814a9213-6421-4f52-9007-12782a457b0a",
        "quantity": 1,
        "return_reason_id": "wrong_item"
      }
    ]
  }
}
'
{
  "id": "30f516f0-0a76-4ff4-8c3a-33dcbcd1f357",
  "object": "return_request",
  "number": "0000-R1",
  "status": "open",
  "order": "edca98c7-418c-429d-8203-a07c89715e0e",
  "created_at": 1770234894,
  "updated_at": 1770234894
}

Authorizations

​
Authorization
string
header
required

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

Body

application/json
​
return_request
object

Response

200 - application/json

Success

​
id
string | null

The UUID of the specific object.

​
object
string

A string describing the object type returned.

​
metadata
object

Set of key-value pairs that you can attach to an object. This can be useful for storing additional information about the object in a structured format.

​
number
string

The unique identifier for this return request that is auto generated based on this account's order protocol.

​
order

Expandable – The associated order ID.

​
return_items

Expandable – Property not returned unless expanded.

​
status
string

The current status of this return request – either open or complete.

​
created_at
integer | null

Time at which the object was created. Measured in seconds since the Unix epoch.

​
updated_at
integer | null

Time at which the object was last updated. Measured in seconds since the Unix epoch.