| id |
String |
The order's ID |
|
| status |
StatusEnum |
The order's status |
|
| fulfillmentStatus |
FulfillmentStatusEnum |
The order's fulfillment status |
|
| paymentStatus |
PaymentStatusEnum |
The order's payment status |
|
| displayId |
Integer |
The order's display ID |
|
| cartId |
String |
The ID of the cart associated with the order |
|
| cart |
Object |
A cart object. Available if the relation `cart` is expanded. |
[optional] |
| customerId |
String |
The ID of the customer associated with the order |
|
| customer |
Object |
A customer object. Available if the relation `customer` is expanded. |
[optional] |
| email |
String |
The email associated with the order |
|
| billingAddressId |
String |
The ID of the billing address associated with the order |
|
| billingAddress |
Address |
|
[optional] |
| shippingAddressId |
String |
The ID of the shipping address associated with the order |
|
| shippingAddress |
Address |
|
[optional] |
| regionId |
String |
The region's ID |
|
| region |
Region |
|
[optional] |
| currencyCode |
String |
The 3 character currency code that is used in the order |
|
| currency |
Currency |
|
[optional] |
| taxRate |
BigDecimal |
The order's tax rate |
|
| discounts |
List<Discount> |
The discounts used in the order. Available if the relation `discounts` is expanded. |
[optional] |
| giftCards |
List<GiftCard> |
The gift cards used in the order. Available if the relation `gift_cards` is expanded. |
[optional] |
| shippingMethods |
List<ShippingMethod> |
The shipping methods used in the order. Available if the relation `shipping_methods` is expanded. |
[optional] |
| payments |
List<Object> |
The payments used in the order. Available if the relation `payments` is expanded. |
[optional] |
| fulfillments |
List<Object> |
The fulfillments used in the order. Available if the relation `fulfillments` is expanded. |
[optional] |
| returns |
List<Object> |
The returns associated with the order. Available if the relation `returns` is expanded. |
[optional] |
| claims |
List<Object> |
The claims associated with the order. Available if the relation `claims` is expanded. |
[optional] |
| refunds |
List<Object> |
The refunds associated with the order. Available if the relation `refunds` is expanded. |
[optional] |
| swaps |
List<Object> |
The swaps associated with the order. Available if the relation `swaps` is expanded. |
[optional] |
| draftOrderId |
String |
The ID of the draft order this order is associated with. |
|
| draftOrder |
Object |
A draft order object. Available if the relation `draft_order` is expanded. |
[optional] |
| items |
List<LineItem> |
The line items that belong to the order. Available if the relation `items` is expanded. |
[optional] |
| edits |
List<Object> |
Order edits done on the order. Available if the relation `edits` is expanded. |
[optional] |
| giftCardTransactions |
List<GiftCardTransaction> |
The gift card transactions used in the order. Available if the relation `gift_card_transactions` is expanded. |
[optional] |
| canceledAt |
OffsetDateTime |
The date the order was canceled on. |
|
| noNotification |
Boolean |
Flag for describing whether or not notifications related to this should be send. |
|
| idempotencyKey |
String |
Randomly generated key used to continue the processing of the order in case of failure. |
|
| externalId |
String |
The ID of an external order. |
|
| salesChannelId |
String |
The ID of the sales channel this order is associated with. |
[optional] |
| salesChannel |
SalesChannel |
|
[optional] |
| shippingTotal |
Integer |
The total of shipping |
[optional] |
| discountTotal |
Integer |
The total of discount |
[optional] |
| taxTotal |
Integer |
The total of tax |
[optional] |
| refundedTotal |
Integer |
The total amount refunded if the order is returned. |
[optional] |
| total |
Integer |
The total amount of the order |
[optional] |
| subtotal |
Integer |
The subtotal of the order |
[optional] |
| paidTotal |
Integer |
The total amount paid |
[optional] |
| refundableAmount |
Integer |
The amount that can be refunded |
[optional] |
| giftCardTotal |
Integer |
The total of gift cards |
[optional] |
| giftCardTaxTotal |
Integer |
The total of gift cards with taxes |
[optional] |
| returnableItems |
List<LineItem> |
The items that are returnable as part of the order, order swaps or order claims |
[optional] |
| 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 |
|