Skip to main content
GET
/
v1
/
return_items
/
{id}
Retrieve
curl --request GET \
  --url https://{defaultHost}/v1/return_items/{id} \
  --header 'Authorization: Bearer <token>'
{
  "id": "cb77a49d-e82f-473c-b335-00b738f35861",
  "object": "return_item",
  "note": null,
  "return_reason": "wrong_item",
  "return_reason_description": "Received the wrong item",
  "quantity": 1,
  "return_request": "3191a27c-a987-4ca0-a229-567aef8ea04f",
  "line_item": "cd0b6cdb-9f3d-4251-a826-020ec47646df",
  "created_at": 1771429902,
  "updated_at": 1771429902
}

Authorizations

​
Authorization
string
header
required

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

Path Parameters

​
id
string
required

Response

200 - application/json

Success

​
id
string | null

The UUID of the specific object.

​
object
string

A string describing the object type returned.

​
note
string | null

A note to capture extra details about this return item. This is required when the return reason is other.

​
return_reason
string

The reason for returning the item – one of color, defective, not_as_described, other, size_too_large, size_too_small, style, unknown, unwanted, or wrong_item. The list of these reasons can be fetched from the /return_reasons endpoint.

​
quantity
integer

The quantity of products being returned. This must be less than or equal to the fulfilled quantity of the associated line item.

​
return_reason_description
string

The full description of the return reason.

​
return_request

Expandable – The associated return request ID.

​
line_item

Expandable – The associated line item ID.

​
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.