Skip to main content
GET
Retrieve

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.