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": "f9d9b078-d841-429b-a4ce-4b70fc659565",
    "return_items": [
      {
        "line_item": "87b23c78-b5e2-4e82-a50c-04e2c083f965",
        "quantity": 1,
        "return_reason_id": "wrong_item"
      }
    ]
  }
}
'
{
  "id": "45bca963-114d-455f-b0c7-7449791c355e",
  "object": "return_request",
  "number": "0000-R1",
  "status": "open",
  "order": "f9d9b078-d841-429b-a4ce-4b70fc659565",
  "created_at": 1780335156,
  "updated_at": 1780335156
}

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.