| Name | Type | Description | Notes |
|---|---|---|---|
| id | String | The return's ID | |
| status | StatusEnum | Status of the Return. | |
| items | List<ReturnItem> | The Return Items that will be shipped back to the warehouse. Available if the relation `items` is expanded. | [optional] |
| swapId | String | The ID of the Swap that the Return is a part of. | |
| swap | Object | A swap object. Available if the relation `swap` is expanded. | [optional] |
| claimOrderId | String | The ID of the Claim that the Return is a part of. | |
| claimOrder | Object | A claim order object. Available if the relation `claim_order` is expanded. | [optional] |
| orderId | String | The ID of the Order that the Return is made from. | |
| order | Object | An order object. Available if the relation `order` is expanded. | [optional] |
| shippingMethod | ShippingMethod | [optional] | |
| shippingData | Object | Data about the return shipment as provided by the Fulfilment Provider that handles the return shipment. | |
| locationId | String | The id of the stock location the return will be added back. | |
| refundAmount | Integer | The amount that should be refunded as a result of the return. | |
| noNotification | Boolean | When set to true, no notification will be sent related to this return. | |
| idempotencyKey | String | Randomly generated key used to continue the completion of the return in case of failure. | |
| receivedAt | OffsetDateTime | The date with timezone at which the return was received. | |
| createdAt | OffsetDateTime | The date with timezone at which the resource was created. | |
| updatedAt | OffsetDateTime | The date with timezone at which the resource was updated. | |
| metadata | Object | An optional key-value map with additional details |
| Name | Value |
|---|---|
| REQUESTED | "requested" |
| RECEIVED | "received" |
| REQUIRES_ACTION | "requires_action" |
| CANCELED | "canceled" |