| Name | Type | Description | Notes |
|---|---|---|---|
| id | String | The swap's ID | |
| fulfillmentStatus | FulfillmentStatusEnum | The status of the Fulfillment of the Swap. | |
| paymentStatus | PaymentStatusEnum | The status of the Payment of the Swap. The payment may either refer to the refund of an amount or the authorization of a new amount. | |
| orderId | String | The ID of the Order where the Line Items to be returned where purchased. | |
| order | Object | An order object. Available if the relation `order` is expanded. | [optional] |
| additionalItems | List<LineItem> | The new Line Items to ship to the Customer. Available if the relation `additional_items` is expanded. | [optional] |
| returnOrder | Object | A return order object. The Return that is issued for the return part of the Swap. Available if the relation `return_order` is expanded. | [optional] |
| fulfillments | List<Object> | The Fulfillments used to send the new Line Items. Available if the relation `fulfillments` is expanded. | [optional] |
| payment | Object | The Payment authorized when the Swap requires an additional amount to be charged from the Customer. Available if the relation `payment` is expanded. | [optional] |
| differenceDue | Integer | The difference that is paid or refunded as a result of the Swap. May be negative when the amount paid for the returned items exceed the total of the new Products. | |
| shippingAddressId | String | The Address to send the new Line Items to - in most cases this will be the same as the shipping address on the Order. | |
| shippingAddress | Address | [optional] | |
| shippingMethods | List<ShippingMethod> | The Shipping Methods used to fulfill the additional items purchased. Available if the relation `shipping_methods` is expanded. | [optional] |
| cartId | String | The id of the Cart that the Customer will use to confirm the Swap. | |
| cart | Object | A cart object. Available if the relation `cart` is expanded. | [optional] |
| confirmedAt | OffsetDateTime | The date with timezone at which the Swap was confirmed by the Customer. | |
| canceledAt | OffsetDateTime | The date with timezone at which the Swap was canceled. | |
| noNotification | Boolean | If set to true, no notification will be sent related to this swap | |
| allowBackorder | Boolean | If true, swaps can be completed with items out of stock | |
| idempotencyKey | String | Randomly generated key used to continue the completion of the swap in case of failure. | |
| createdAt | OffsetDateTime | The date with timezone at which the resource was created. | |
| updatedAt | OffsetDateTime | The date with timezone at which the resource was updated. | |
| deletedAt | OffsetDateTime | The date with timezone at which the resource was deleted. | |
| metadata | Object | An optional key-value map with additional details |
| Name | Value |
|---|---|
| NOT_FULFILLED | "not_fulfilled" |
| FULFILLED | "fulfilled" |
| SHIPPED | "shipped" |
| PARTIALLY_SHIPPED | "partially_shipped" |
| CANCELED | "canceled" |
| REQUIRES_ACTION | "requires_action" |
| Name | Value |
|---|---|
| NOT_PAID | "not_paid" |
| AWAITING | "awaiting" |
| CAPTURED | "captured" |
| CONFIRMED | "confirmed" |
| CANCELED | "canceled" |
| DIFFERENCE_REFUNDED | "difference_refunded" |
| PARTIALLY_REFUNDED | "partially_refunded" |
| REFUNDED | "refunded" |
| REQUIRES_ACTION | "requires_action" |