Skip to main content
Skip to main content

ReturnReason

A Return Reason is a value defined by an admin. It can be used on Return Items in order to indicate why a Line Item was returned.

Properties

created_atDateRequired
The date with timezone at which the resource was created.
deleted_atnull | DateRequired
The date with timezone at which the resource was deleted.
descriptionstringRequired
A description of the Reason.
idstringRequired
The return reason's ID
labelstringRequired
A text that can be displayed to the Customer as a reason.
metadataRecord<string, unknown>Required
An optional key-value map with additional details
parent_return_reasonnull | ReturnReasonRequired
The details of the parent reason.
parent_return_reason_idnull | stringRequired
The ID of the parent reason.
return_reason_childrenReturnReason[]Required
The details of the child reasons.
updated_atDateRequired
The date with timezone at which the resource was updated.
valuestringRequired
The value to identify the reason by.
Was this section helpful?