Return

The details of a return order.

Declaration

object Return

Name	Type	Description
`returnIdentifier` Required	string	A unique identifier for the return. This isn’t displayed to the user, and is only used for identifying changes and user notifications.
`status` Required	string	The status of the return.
`carrier`	string	The carrier used to return the products.
`dropOffBy`	date-time	The date and time for the product drop-off. Use `ISO 8601` format.
`initiatedAt`	date-time	The date and time for the initated return. Use `ISO 8601` format.
`lineItems`	[`LineItem`]	An array of line items for the customer to return, displayed in the order provided.
`notes`	string	Additional information about the return.
`returnedAt`	date-time	The return date and time of a product. Use `ISO 8601` format.
`returnLabel`	string	A printable filename of a label within the bundle used to mail the products back. The total size of the bundle must be below 5 MB. Supports, `PDF`, `JPG`, and `PNG` labels.
`returnManagementURL`	uri	A URL where the customer can manage the return.
`returnNumber`	string	The number of the return displayed to the customer.
`statusDescription`	string	A localized message describing the return status.