Comment on page

The return line item object

A comprehensive list of the return line item resource's attributes and relationships

A return line item object is returned as part of the response body of each successful list, retrieve, create or update API call to the /api/return_line_items endpoint.
Fields
Field
Type
Description
type
string
return_line_items
id
string
The return line item unique identifier
links.self
string
The return line item endpoint URL
attributes.sku_code
string
The code of the associated SKU.
attributes.bundle_code
string
The code of the associated bundle.
attributes.quantity
integer
The return line item quantity.
attributes.name
string
The name of the line item.
attributes.image_url
string
The image_url of the associated line item.
attributes._restock
boolean
Send this attribute if you want to restock the line item.
attributes.return_reason
object
Set of key-value pairs that you can use to add details about return reason.
attributes.restocked_at
datetime
Time at which the return line item was restocked.
attributes.created_at
datetime
Time at which the resource was created.
attributes.updated_at
datetime
Time at which the resource was last updated.
attributes.reference
string
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
string
Any identifier of the third party system that defines the reference code
attributes.metadata
object
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.return
object
The associated return.
relationships.line_item
object
The associated line item.
meta.mode
string
The resource environment (can be one of test or live)

Field	Type	Description
type	`string`	`return_line_items`
id	`string`	The return line item unique identifier
links.self	`string`	The return line item endpoint URL
attributes.sku_code	`string`	The code of the associated SKU.
attributes.bundle_code	`string`	The code of the associated bundle.
attributes.quantity	`integer`	The return line item quantity.
attributes.name	`string`	The name of the line item.
attributes.image_url	`string`	The image_url of the associated line item.
attributes._restock	`boolean`	Send this attribute if you want to restock the line item.
attributes.return_reason	`object`	Set of key-value pairs that you can use to add details about return reason.
attributes.restocked_at	`datetime`	Time at which the return line item was restocked.
attributes.created_at	`datetime`	Time at which the resource was created.
attributes.updated_at	`datetime`	Time at which the resource was last updated.
attributes.reference	`string`	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	`string`	Any identifier of the third party system that defines the reference code
attributes.metadata	`object`	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.return	`object`	The associated return.
relationships.line_item	`object`	The associated line item.
meta.mode	`string`	The resource environment (can be one of `test` or `live`)

Return line items

Create a return line item

Last modified 4mo ago