The return object
A comprehensive list of the return resource's attributes and relationships
A return object is returned as part of the response body of each successful list, retrieve, create or update API call to the /api/returns
endpoint.
Fields
Field | Type | Description |
---|---|---|
type |
|
|
id |
| The return unique identifier |
links.self |
| The return endpoint URL |
attributes.number |
| Unique identifier for the return |
attributes.status |
| The return status, one of 'draft', 'requested', 'approved', 'cancelled', 'shipped', 'rejected' or 'received' |
attributes.customer_email |
| The email address of the associated customer. |
attributes.skus_count |
| The total number of SKUs in the return's line items. This can be useful to display a preview of the return content. |
attributes.approved_at |
| Time at which the return was approved. |
attributes.cancelled_at |
| Time at which the return was cancelled. |
attributes.shipped_at |
| Time at which the return was shipped. |
attributes.rejected_at |
| Time at which the return was rejected. |
attributes.received_at |
| Time at which the return was received. |
attributes.archived_at |
| Time at which the resource has been archived. |
attributes._request |
| Send this attribute if you want to activate this return. |
attributes._approve |
| Send this attribute if you want to mark this return as approved. |
attributes._cancel |
| Send this attribute if you want to mark this return as cancelled. |
attributes._ship |
| Send this attribute if you want to mark this return as shipped. |
attributes._reject |
| Send this attribute if you want to mark this return as rejected. |
attributes._receive |
| Send this attribute if you want to mark this return as received. |
attributes._restock |
| Send this attribute if you want to restock all of the return line items. |
attributes._archive |
| Send this attribute if you want to archive the return. |
attributes._unarchive |
| Send this attribute if you want to unarchive the return. |
attributes.created_at |
| Time at which the resource was created. |
attributes.updated_at |
| Time at which the resource was last updated. |
attributes.reference |
| A string that you can use to add any external identifier to the resource. This can be useful for integrating the resource to an external system, like an ERP, a marketing tool, a CRM, or whatever. |
attributes.reference_origin |
| Any identifier of the third party system that defines the reference code |
attributes.metadata |
| Set of key-value pairs that you can attach to the resource. This can be useful for storing additional information about the resource in a structured format. |
relationships.order |
| The associated order. |
relationships.customer |
| The associated customer. |
relationships.stock_location |
| The stock location to which the return will be shipped. |
relationships.origin_address |
| The customer shipping address. |
relationships.destination_address |
| The associated stock location address. |
relationships.return_line_items |
| The order line items associated to the return. |
relationships.attachments |
| The associated attachments. |
relationships.events |
| The associated events. |
relationships.tags |
| The associated tags. |
relationships.versions |
| The associated changes. |
meta.mode |
| The resource environment (can be one of |
Last updated