---
displayed_sidebar: jsClientSidebar
slug: /references/js-client/OrdersResource
---

import ParameterTypes from "@site/src/components/ParameterTypes"

# OrdersResource

This class is used to send requests to [Store Order API Routes](https://docs.medusajs.com/api/store#orders). All its method
are available in the JS Client under the `medusa.orders` property.

Orders are purchases made by customers, typically through a storefront.
Orders are placed and created using [CartsResource](js_client.CartsResource.mdx). The methods in this class allow retrieving and claiming orders.

Related Guide: [How to retrieve order details in a storefront](https://docs.medusajs.com/modules/orders/storefront/retrieve-order-details).

## Methods

### confirmRequest

Verify the claim order token provided to the customer when they request ownership of an order.

#### Example

```ts
import Medusa from "@medusajs/medusa-js"
const medusa = new Medusa({ baseUrl: MEDUSA_BACKEND_URL, maxRetries: 3 })
// must be previously logged in or use api token
medusa.orders.confirmRequest(
  token,
)
.then(() => {
  // successful
})
.catch(() => {
  // an error occurred
})
```

#### Parameters

<ParameterTypes parameters={[
  {
    "name": "payload",
    "type": "[StorePostCustomersCustomerAcceptClaimReq](../../medusa/classes/medusa.StorePostCustomersCustomerAcceptClaimReq.mdx)",
    "description": "The claim order to verify.",
    "optional": false,
    "defaultValue": "",
    "expandable": false,
    "children": [
      {
        "name": "token",
        "type": "`string`",
        "description": "The claim token generated by previous request to the Claim Order API Route.",
        "optional": false,
        "defaultValue": "",
        "expandable": false,
        "children": []
      }
    ]
  },
  {
    "name": "customHeaders",
    "type": "`Record<string, any>`",
    "description": "Custom headers to attach to the request.",
    "optional": false,
    "defaultValue": "{}",
    "expandable": false,
    "children": []
  }
]} expandUrl="https://docs.medusajs.com/js-client/overview#expanding-fields"/>

#### Returns

<ParameterTypes parameters={[
  {
    "name": "ResponsePromise",
    "type": "`ResponsePromise`",
    "optional": false,
    "defaultValue": "",
    "description": "Resolves when the claim order is verified successfully.",
    "expandable": false,
    "children": []
  }
]} />

___

### lookupOrder

Look up an order using filters. If the filters don't narrow down the results to a single order, a `404` response is returned with no orders.

#### Example

```ts
import Medusa from "@medusajs/medusa-js"
const medusa = new Medusa({ baseUrl: MEDUSA_BACKEND_URL, maxRetries: 3 })
medusa.orders.lookupOrder({
  display_id: 1,
  email: "user@example.com"
})
.then(({ order }) => {
  console.log(order.id);
})
```

#### Parameters

<ParameterTypes parameters={[
  {
    "name": "payload",
    "type": "[StoreGetOrdersParams](../../medusa/classes/medusa.StoreGetOrdersParams.mdx)",
    "description": "Filters used to retrieve the order.",
    "optional": false,
    "defaultValue": "",
    "expandable": false,
    "children": [
      {
        "name": "display_id",
        "type": "`number`",
        "description": "Display ID of the order.",
        "optional": false,
        "defaultValue": "",
        "expandable": false,
        "children": []
      },
      {
        "name": "email",
        "type": "`string`",
        "description": "Email of the order.",
        "optional": false,
        "defaultValue": "",
        "expandable": false,
        "children": []
      },
      {
        "name": "expand",
        "type": "`string`",
        "description": "Comma-separated relations that should be expanded in the returned data.",
        "optional": true,
        "defaultValue": "",
        "expandable": false,
        "children": []
      },
      {
        "name": "fields",
        "type": "`string`",
        "description": "Comma-separated fields that should be included in the returned data.",
        "optional": true,
        "defaultValue": "",
        "expandable": false,
        "children": []
      },
      {
        "name": "shipping_address",
        "type": "[ShippingAddressPayload](../../medusa/classes/medusa.ShippingAddressPayload.mdx)",
        "description": "Filter the retrieved order by its shipping address details.",
        "optional": true,
        "defaultValue": "",
        "expandable": false,
        "children": [
          {
            "name": "postal_code",
            "type": "`string`",
            "description": "Postal code.",
            "optional": true,
            "defaultValue": "",
            "expandable": false,
            "children": []
          }
        ]
      }
    ]
  },
  {
    "name": "customHeaders",
    "type": "`Record<string, any>`",
    "description": "Custom headers to attach to the request.",
    "optional": false,
    "defaultValue": "{}",
    "expandable": false,
    "children": []
  }
]} expandUrl="https://docs.medusajs.com/js-client/overview#expanding-fields"/>

#### Returns

<ParameterTypes parameters={[
  {
    "name": "ResponsePromise",
    "type": "ResponsePromise&#60;StoreOrdersRes&#62;",
    "optional": false,
    "defaultValue": "",
    "description": "Resolves to the details of the order.",
    "expandable": false,
    "children": [
      {
        "name": "order",
        "type": "[Order](../../entities/classes/entities.Order.mdx)",
        "description": "Order details.",
        "optional": false,
        "defaultValue": "",
        "expandable": false,
        "children": [
          {
            "name": "billing_address",
            "type": "[Address](../../entities/classes/entities.Address.mdx)",
            "description": "The details of the billing address associated with the order.",
            "optional": false,
            "defaultValue": "",
            "expandable": true,
            "children": [
              {
                "name": "address_1",
                "type": "`null` \\| `string`",
                "description": "Address line 1",
                "optional": false,
                "defaultValue": "",
                "expandable": false,
                "children": []
              },
              {
                "name": "address_2",
                "type": "`null` \\| `string`",
                "description": "Address line 2",
                "optional": false,
                "defaultValue": "",
                "expandable": false,
                "children": []
              },
              {
                "name": "city",
                "type": "`null` \\| `string`",
                "description": "City",
                "optional": false,
                "defaultValue": "",
                "expandable": false,
                "children": []
              },
              {
                "name": "company",
                "type": "`null` \\| `string`",
                "description": "Company name",
                "optional": false,
                "defaultValue": "",
                "expandable": false,
                "children": []
              },
              {
                "name": "country",
                "type": "`null` \\| [Country](../../entities/classes/entities.Country.mdx)",
                "description": "A country object.",
                "optional": false,
                "defaultValue": "",
                "expandable": true,
                "children": []
              },
              {
                "name": "country_code",
                "type": "`null` \\| `string`",
                "description": "The 2 character ISO code of the country in lower case",
                "optional": false,
                "defaultValue": "",
                "expandable": false,
                "children": []
              },
              {
                "name": "created_at",
                "type": "`Date`",
                "description": "The date with timezone at which the resource was created.",
                "optional": false,
                "defaultValue": "",
                "expandable": false,
                "children": []
              },
              {
                "name": "customer",
                "type": "`null` \\| [Customer](../../entities/classes/entities.Customer.mdx)",
                "description": "Available if the relation `customer` is expanded.",
                "optional": false,
                "defaultValue": "",
                "expandable": false,
                "children": []
              },
              {
                "name": "customer_id",
                "type": "`null` \\| `string`",
                "description": "ID of the customer this address belongs to",
                "optional": false,
                "defaultValue": "",
                "expandable": false,
                "children": []
              },
              {
                "name": "deleted_at",
                "type": "`null` \\| `Date`",
                "description": "The date with timezone at which the resource was deleted.",
                "optional": false,
                "defaultValue": "",
                "expandable": false,
                "children": []
              },
              {
                "name": "first_name",
                "type": "`null` \\| `string`",
                "description": "First name",
                "optional": false,
                "defaultValue": "",
                "expandable": false,
                "children": []
              },
              {
                "name": "id",
                "type": "`string`",
                "description": "ID of the address",
                "optional": false,
                "defaultValue": "",
                "expandable": false,
                "children": []
              },
              {
                "name": "last_name",
                "type": "`null` \\| `string`",
                "description": "Last name",
                "optional": false,
                "defaultValue": "",
                "expandable": false,
                "children": []
              },
              {
                "name": "metadata",
                "type": "`Record<string, unknown>`",
                "description": "An optional key-value map with additional details",
                "optional": false,
                "defaultValue": "",
                "expandable": false,
                "children": []
              },
              {
                "name": "phone",
                "type": "`null` \\| `string`",
                "description": "Phone Number",
                "optional": false,
                "defaultValue": "",
                "expandable": false,
                "children": []
              },
              {
                "name": "postal_code",
                "type": "`null` \\| `string`",
                "description": "Postal Code",
                "optional": false,
                "defaultValue": "",
                "expandable": false,
                "children": []
              },
              {
                "name": "province",
                "type": "`null` \\| `string`",
                "description": "Province",
                "optional": false,
                "defaultValue": "",
                "expandable": false,
                "children": []
              },
              {
                "name": "updated_at",
                "type": "`Date`",
                "description": "The date with timezone at which the resource was updated.",
                "optional": false,
                "defaultValue": "",
                "expandable": false,
                "children": []
              }
            ]
          },
          {
            "name": "billing_address_id",
            "type": "`string`",
            "description": "The ID of the billing address associated with the order",
            "optional": false,
            "defaultValue": "",
            "expandable": false,
            "children": []
          },
          {
            "name": "canceled_at",
            "type": "`Date`",
            "description": "The date the order was canceled on.",
            "optional": false,
            "defaultValue": "",
            "expandable": false,
            "children": []
          },
          {
            "name": "cart",
            "type": "[Cart](../../entities/classes/entities.Cart.mdx)",
            "description": "The details of the cart associated with the order.",
            "optional": false,
            "defaultValue": "",
            "expandable": true,
            "children": [
              {
                "name": "billing_address",
                "type": "[Address](../../entities/classes/entities.Address.mdx)",
                "description": "The details of the billing address associated with the cart.",
                "optional": false,
                "defaultValue": "",
                "expandable": true,
                "children": []
              },
              {
                "name": "billing_address_id",
                "type": "`string`",
                "description": "The billing address's ID",
                "optional": false,
                "defaultValue": "",
                "expandable": false,
                "children": []
              },
              {
                "name": "completed_at",
                "type": "`Date`",
                "description": "The date with timezone at which the cart was completed.",
                "optional": false,
                "defaultValue": "",
                "expandable": false,
                "children": []
              },
              {
                "name": "context",
                "type": "`Record<string, unknown>`",
                "description": "The context of the cart which can include info like IP or user agent.",
                "optional": false,
                "defaultValue": "",
                "expandable": false,
                "children": []
              },
              {
                "name": "created_at",
                "type": "`Date`",
                "description": "The date with timezone at which the resource was created.",
                "optional": false,
                "defaultValue": "",
                "expandable": false,
                "children": []
              },
              {
                "name": "customer",
                "type": "[Customer](../../entities/classes/entities.Customer.mdx)",
                "description": "The details of the customer the cart belongs to.",
                "optional": false,
                "defaultValue": "",
                "expandable": true,
                "children": []
              },
              {
                "name": "customer_id",
                "type": "`string`",
                "description": "The customer's ID",
                "optional": false,
                "defaultValue": "",
                "expandable": false,
                "children": []
              },
              {
                "name": "deleted_at",
                "type": "`null` \\| `Date`",
                "description": "The date with timezone at which the resource was deleted.",
                "optional": false,
                "defaultValue": "",
                "expandable": false,
                "children": []
              },
              {
                "name": "discount_total",
                "type": "`number`",
                "description": "The total of discount rounded",
                "optional": true,
                "defaultValue": "",
                "expandable": false,
                "children": []
              },
              {
                "name": "discounts",
                "type": "[Discount](../../entities/classes/entities.Discount.mdx)[]",
                "description": "An array of details of all discounts applied to the cart.",
                "optional": false,
                "defaultValue": "",
                "expandable": true,
                "children": []
              },
              {
                "name": "email",
                "type": "`string`",
                "description": "The email associated with the cart",
                "optional": false,
                "defaultValue": "",
                "expandable": false,
                "children": []
              },
              {
                "name": "gift_card_tax_total",
                "type": "`number`",
                "description": "The total of gift cards with taxes",
                "optional": true,
                "defaultValue": "",
                "expandable": false,
                "children": []
              },
              {
                "name": "gift_card_total",
                "type": "`number`",
                "description": "The total of gift cards",
                "optional": true,
                "defaultValue": "",
                "expandable": false,
                "children": []
              },
              {
                "name": "gift_cards",
                "type": "[GiftCard](../../entities/classes/entities.GiftCard.mdx)[]",
                "description": "An array of details of all gift cards applied to the cart.",
                "optional": false,
                "defaultValue": "",
                "expandable": true,
                "children": []
              },
              {
                "name": "id",
                "type": "`string`",
                "description": "The cart's ID",
                "optional": false,
                "defaultValue": "",
                "expandable": false,
                "children": []
              },
              {
                "name": "idempotency_key",
                "type": "`string`",
                "description": "Randomly generated key used to continue the completion of a cart in case of failure.",
                "optional": false,
                "defaultValue": "",
                "expandable": false,
                "children": []
              },
              {
                "name": "item_tax_total",
                "type": "`null` \\| `number`",
                "description": "The total of items with taxes",
                "optional": true,
                "defaultValue": "",
                "expandable": false,
                "children": []
              },
              {
                "name": "items",
                "type": "[LineItem](../../entities/classes/entities.LineItem.mdx)[]",
                "description": "The line items added to the cart.",
                "optional": false,
                "defaultValue": "",
                "expandable": true,
                "children": []
              },
              {
                "name": "metadata",
                "type": "`Record<string, unknown>`",
                "description": "An optional key-value map with additional details",
                "optional": false,
                "defaultValue": "",
                "expandable": false,
                "children": []
              },
              {
                "name": "object",
                "type": "`\"cart\"`",
                "description": "",
                "optional": false,
                "defaultValue": "\"cart\"",
                "expandable": false,
                "children": []
              },
              {
                "name": "payment",
                "type": "[Payment](../../entities/classes/entities.Payment.mdx)",
                "description": "The details of the payment associated with the cart.",
                "optional": false,
                "defaultValue": "",
                "expandable": true,
                "children": []
              },
              {
                "name": "payment_authorized_at",
                "type": "`Date`",
                "description": "The date with timezone at which the payment was authorized.",
                "optional": false,
                "defaultValue": "",
                "expandable": false,
                "children": []
              },
              {
                "name": "payment_id",
                "type": "`string`",
                "description": "The payment's ID if available",
                "optional": false,
                "defaultValue": "",
                "expandable": false,
                "children": []
              },
              {
                "name": "payment_session",
                "type": "`null` \\| [PaymentSession](../../entities/classes/entities.PaymentSession.mdx)",
                "description": "The details of the selected payment session in the cart.",
                "optional": false,
                "defaultValue": "",
                "expandable": true,
                "children": []
              },
              {
                "name": "payment_sessions",
                "type": "[PaymentSession](../../entities/classes/entities.PaymentSession.mdx)[]",
                "description": "The details of all payment sessions created on the cart.",
                "optional": false,
                "defaultValue": "",
                "expandable": true,
                "children": []
              },
              {
                "name": "raw_discount_total",
                "type": "`number`",
                "description": "The total of discount",
                "optional": true,
                "defaultValue": "",
                "expandable": false,
                "children": []
              },
              {
                "name": "refundable_amount",
                "type": "`number`",
                "description": "The amount that can be refunded",
                "optional": true,
                "defaultValue": "",
                "expandable": false,
                "children": []
              },
              {
                "name": "refunded_total",
                "type": "`number`",
                "description": "The total amount refunded if the order associated with this cart is returned.",
                "optional": true,
                "defaultValue": "",
                "expandable": false,
                "children": []
              },
              {
                "name": "region",
                "type": "[Region](../../entities/classes/entities.Region.mdx)",
                "description": "The details of the region associated with the cart.",
                "optional": false,
                "defaultValue": "",
                "expandable": true,
                "children": []
              },
              {
                "name": "region_id",
                "type": "`string`",
                "description": "The region's ID",
                "optional": false,
                "defaultValue": "",
                "expandable": false,
                "children": []
              },
              {
                "name": "sales_channel",
                "type": "[SalesChannel](../../entities/classes/entities.SalesChannel.mdx)",
                "description": "The details of the sales channel associated with the cart.",
                "optional": false,
                "defaultValue": "",
                "expandable": true,
                "children": []
              },
              {
                "name": "sales_channel_id",
                "type": "`null` \\| `string`",
                "description": "The sales channel ID the cart is associated with.",
                "optional": false,
                "defaultValue": "",
                "expandable": false,
                "children": []
              },
              {
                "name": "shipping_address",
                "type": "`null` \\| [Address](../../entities/classes/entities.Address.mdx)",
                "description": "The details of the shipping address associated with the cart.",
                "optional": false,
                "defaultValue": "",
                "expandable": true,
                "children": []
              },
              {
                "name": "shipping_address_id",
                "type": "`string`",
                "description": "The shipping address's ID",
                "optional": false,
                "defaultValue": "",
                "expandable": false,
                "children": []
              },
              {
                "name": "shipping_methods",
                "type": "[ShippingMethod](../../entities/classes/entities.ShippingMethod.mdx)[]",
                "description": "The details of the shipping methods added to the cart.",
                "optional": false,
                "defaultValue": "",
                "expandable": true,
                "children": []
              },
              {
                "name": "shipping_tax_total",
                "type": "`null` \\| `number`",
                "description": "The total of shipping with taxes",
                "optional": true,
                "defaultValue": "",
                "expandable": false,
                "children": []
              },
              {
                "name": "shipping_total",
                "type": "`number`",
                "description": "The total of shipping",
                "optional": true,
                "defaultValue": "",
                "expandable": false,
                "children": []
              },
              {
                "name": "subtotal",
                "type": "`number`",
                "description": "The subtotal of the cart",
                "optional": true,
                "defaultValue": "",
                "expandable": false,
                "children": []
              },
              {
                "name": "tax_total",
                "type": "`null` \\| `number`",
                "description": "The total of tax",
                "optional": true,
                "defaultValue": "",
                "expandable": false,
                "children": []
              },
              {
                "name": "total",
                "type": "`number`",
                "description": "The total amount of the cart",
                "optional": true,
                "defaultValue": "",
                "expandable": false,
                "children": []
              },
              {
                "name": "type",
                "type": "[CartType](../../entities/enums/entities.CartType.mdx)",
                "description": "The cart's type.",
                "optional": false,
                "defaultValue": "default",
                "expandable": false,
                "children": []
              },
              {
                "name": "updated_at",
                "type": "`Date`",
                "description": "The date with timezone at which the resource was updated.",
                "optional": false,
                "defaultValue": "",
                "expandable": false,
                "children": []
              }
            ]
          },
          {
            "name": "cart_id",
            "type": "`string`",
            "description": "The ID of the cart associated with the order",
            "optional": false,
            "defaultValue": "",
            "expandable": false,
            "children": []
          },
          {
            "name": "claims",
            "type": "[ClaimOrder](../../entities/classes/entities.ClaimOrder.mdx)[]",
            "description": "The details of the claims created for the order.",
            "optional": false,
            "defaultValue": "",
            "expandable": true,
            "children": [
              {
                "name": "additional_items",
                "type": "[LineItem](../../entities/classes/entities.LineItem.mdx)[]",
                "description": "The details of the new items to be shipped when the claim's type is `replace`",
                "optional": false,
                "defaultValue": "",
                "expandable": true,
                "children": []
              },
              {
                "name": "canceled_at",
                "type": "`Date`",
                "description": "The date with timezone at which the claim was canceled.",
                "optional": false,
                "defaultValue": "",
                "expandable": false,
                "children": []
              },
              {
                "name": "claim_items",
                "type": "[ClaimItem](../../entities/classes/entities.ClaimItem.mdx)[]",
                "description": "The details of the items that should be replaced or refunded.",
                "optional": false,
                "defaultValue": "",
                "expandable": true,
                "children": []
              },
              {
                "name": "created_at",
                "type": "`Date`",
                "description": "The date with timezone at which the resource was created.",
                "optional": false,
                "defaultValue": "",
                "expandable": false,
                "children": []
              },
              {
                "name": "deleted_at",
                "type": "`Date`",
                "description": "The date with timezone at which the resource was deleted.",
                "optional": false,
                "defaultValue": "",
                "expandable": false,
                "children": []
              },
              {
                "name": "fulfillment_status",
                "type": "[ClaimFulfillmentStatus](../../entities/enums/entities.ClaimFulfillmentStatus.mdx)",
                "description": "The claim's fulfillment status",
                "optional": false,
                "defaultValue": "not_fulfilled",
                "expandable": false,
                "children": []
              },
              {
                "name": "fulfillments",
                "type": "[Fulfillment](../../entities/classes/entities.Fulfillment.mdx)[]",
                "description": "The fulfillments of the new items to be shipped",
                "optional": false,
                "defaultValue": "",
                "expandable": true,
                "children": []
              },
              {
                "name": "id",
                "type": "`string`",
                "description": "The claim's ID",
                "optional": false,
                "defaultValue": "",
                "expandable": false,
                "children": []
              },
              {
                "name": "idempotency_key",
                "type": "`string`",
                "description": "Randomly generated key used to continue the completion of the cart associated with the claim in case of failure.",
                "optional": false,
                "defaultValue": "",
                "expandable": false,
                "children": []
              },
              {
                "name": "metadata",
                "type": "`Record<string, unknown>`",
                "description": "An optional key-value map with additional details",
                "optional": false,
                "defaultValue": "",
                "expandable": false,
                "children": []
              },
              {
                "name": "no_notification",
                "type": "`boolean`",
                "description": "Flag for describing whether or not notifications related to this should be send.",
                "optional": false,
                "defaultValue": "",
                "expandable": false,
                "children": []
              },
              {
                "name": "order",
                "type": "[Order](../../entities/classes/entities.Order.mdx)",
                "description": "The details of the order that this claim was created for.",
                "optional": false,
                "defaultValue": "",
                "expandable": true,
                "children": []
              },
              {
                "name": "order_id",
                "type": "`string`",
                "description": "The ID of the order that the claim comes from.",
                "optional": false,
                "defaultValue": "",
                "expandable": false,
                "children": []
              },
              {
                "name": "payment_status",
                "type": "[ClaimPaymentStatus](../../entities/enums/entities.ClaimPaymentStatus.mdx)",
                "description": "The status of the claim's payment",
                "optional": false,
                "defaultValue": "na",
                "expandable": false,
                "children": []
              },
              {
                "name": "refund_amount",
                "type": "`number`",
                "description": "The amount that will be refunded in conjunction with the claim",
                "optional": false,
                "defaultValue": "",
                "expandable": false,
                "children": []
              },
              {
                "name": "return_order",
                "type": "[Return](../../entities/classes/entities.Return.mdx)",
                "description": "The details of the return associated with the claim if the claim's type is `replace`.",
                "optional": false,
                "defaultValue": "",
                "expandable": true,
                "children": []
              },
              {
                "name": "shipping_address",
                "type": "[Address](../../entities/classes/entities.Address.mdx)",
                "description": "The details of the address that new items should be shipped to.",
                "optional": false,
                "defaultValue": "",
                "expandable": true,
                "children": []
              },
              {
                "name": "shipping_address_id",
                "type": "`string`",
                "description": "The ID of the address that the new items should be shipped to",
                "optional": false,
                "defaultValue": "",
                "expandable": false,
                "children": []
              },
              {
                "name": "shipping_methods",
                "type": "[ShippingMethod](../../entities/classes/entities.ShippingMethod.mdx)[]",
                "description": "The details of the shipping methods that the claim order will be shipped with.",
                "optional": false,
                "defaultValue": "",
                "expandable": true,
                "children": []
              },
              {
                "name": "type",
                "type": "[ClaimType](../../entities/enums/entities.ClaimType.mdx)",
                "description": "The claim's type",
                "optional": false,
                "defaultValue": "",
                "expandable": false,
                "children": []
              },
              {
                "name": "updated_at",
                "type": "`Date`",
                "description": "The date with timezone at which the resource was updated.",
                "optional": false,
                "defaultValue": "",
                "expandable": false,
                "children": []
              }
            ]
          },
          {
            "name": "created_at",
            "type": "`Date`",
            "description": "The date with timezone at which the resource was created.",
            "optional": false,
            "defaultValue": "",
            "expandable": false,
            "children": []
          },
          {
            "name": "currency",
            "type": "[Currency](../../entities/classes/entities.Currency.mdx)",
            "description": "The details of the currency used in the order.",
            "optional": false,
            "defaultValue": "",
            "expandable": true,
            "children": [
              {
                "name": "code",
                "type": "`string`",
                "description": "The 3 character ISO code for the currency.",
                "optional": false,
                "defaultValue": "",
                "expandable": false,
                "children": []
              },
              {
                "name": "includes_tax",
                "type": "`boolean`",
                "description": "Whether the currency prices include tax",
                "optional": true,
                "defaultValue": "false",
                "expandable": false,
                "featureFlag": "tax_inclusive_pricing",
                "children": []
              },
              {
                "name": "name",
                "type": "`string`",
                "description": "The written name of the currency",
                "optional": false,
                "defaultValue": "",
                "expandable": false,
                "children": []
              },
              {
                "name": "symbol",
                "type": "`string`",
                "description": "The symbol used to indicate the currency.",
                "optional": false,
                "defaultValue": "",
                "expandable": false,
                "children": []
              },
              {
                "name": "symbol_native",
                "type": "`string`",
                "description": "The native symbol used to indicate the currency.",
                "optional": false,
                "defaultValue": "",
                "expandable": false,
                "children": []
              }
            ]
          },
          {
            "name": "currency_code",
            "type": "`string`",
            "description": "The 3 character currency code that is used in the order",
            "optional": false,
            "defaultValue": "",
            "expandable": false,
            "children": []
          },
          {
            "name": "customer",
            "type": "[Customer](../../entities/classes/entities.Customer.mdx)",
            "description": "The details of the customer associated with the order.",
            "optional": false,
            "defaultValue": "",
            "expandable": true,
            "children": [
              {
                "name": "billing_address",
                "type": "[Address](../../entities/classes/entities.Address.mdx)",
                "description": "The details of the billing address associated with the customer.",
                "optional": false,
                "defaultValue": "",
                "expandable": true,
                "children": []
              },
              {
                "name": "billing_address_id",
                "type": "`null` \\| `string`",
                "description": "The customer's billing address ID",
                "optional": false,
                "defaultValue": "",
                "expandable": false,
                "children": []
              },
              {
                "name": "created_at",
                "type": "`Date`",
                "description": "The date with timezone at which the resource was created.",
                "optional": false,
                "defaultValue": "",
                "expandable": false,
                "children": []
              },
              {
                "name": "deleted_at",
                "type": "`null` \\| `Date`",
                "description": "The date with timezone at which the resource was deleted.",
                "optional": false,
                "defaultValue": "",
                "expandable": false,
                "children": []
              },
              {
                "name": "email",
                "type": "`string`",
                "description": "The customer's email",
                "optional": false,
                "defaultValue": "",
                "expandable": false,
                "children": []
              },
              {
                "name": "first_name",
                "type": "`string`",
                "description": "The customer's first name",
                "optional": false,
                "defaultValue": "",
                "expandable": false,
                "children": []
              },
              {
                "name": "groups",
                "type": "[CustomerGroup](../../entities/classes/entities.CustomerGroup.mdx)[]",
                "description": "The customer groups the customer belongs to.",
                "optional": false,
                "defaultValue": "",
                "expandable": true,
                "children": []
              },
              {
                "name": "has_account",
                "type": "`boolean`",
                "description": "Whether the customer has an account or not",
                "optional": false,
                "defaultValue": "false",
                "expandable": false,
                "children": []
              },
              {
                "name": "id",
                "type": "`string`",
                "description": "The customer's ID",
                "optional": false,
                "defaultValue": "",
                "expandable": false,
                "children": []
              },
              {
                "name": "last_name",
                "type": "`string`",
                "description": "The customer's last name",
                "optional": false,
                "defaultValue": "",
                "expandable": false,
                "children": []
              },
              {
                "name": "metadata",
                "type": "`Record<string, unknown>`",
                "description": "An optional key-value map with additional details",
                "optional": false,
                "defaultValue": "",
                "expandable": false,
                "children": []
              },
              {
                "name": "orders",
                "type": "[Order](../../entities/classes/entities.Order.mdx)[]",
                "description": "The details of the orders this customer placed.",
                "optional": false,
                "defaultValue": "",
                "expandable": true,
                "children": []
              },
              {
                "name": "password_hash",
                "type": "`string`",
                "description": "",
                "optional": false,
                "defaultValue": "",
                "expandable": false,
                "children": []
              },
              {
                "name": "phone",
                "type": "`string`",
                "description": "The customer's phone number",
                "optional": false,
                "defaultValue": "",
                "expandable": false,
                "children": []
              },
              {
                "name": "shipping_addresses",
                "type": "[Address](../../entities/classes/entities.Address.mdx)[]",
                "description": "The details of the shipping addresses associated with the customer.",
                "optional": false,
                "defaultValue": "",
                "expandable": true,
                "children": []
              },
              {
                "name": "updated_at",
                "type": "`Date`",
                "description": "The date with timezone at which the resource was updated.",
                "optional": false,
                "defaultValue": "",
                "expandable": false,
                "children": []
              }
            ]
          },
          {
            "name": "customer_id",
            "type": "`string`",
            "description": "The ID of the customer associated with the order",
            "optional": false,
            "defaultValue": "",
            "expandable": false,
            "children": []
          },
          {
            "name": "discount_total",
            "type": "`number`",
            "description": "The total of discount rounded",
            "optional": false,
            "defaultValue": "",
            "expandable": false,
            "children": []
          },
          {
            "name": "discounts",
            "type": "[Discount](../../entities/classes/entities.Discount.mdx)[]",
            "description": "The details of the discounts applied on the order.",
            "optional": false,
            "defaultValue": "",
            "expandable": true,
            "children": [
              {
                "name": "code",
                "type": "`string`",
                "description": "A unique code for the discount - this will be used by the customer to apply the discount",
                "optional": false,
                "defaultValue": "",
                "expandable": false,
                "children": []
              },
              {
                "name": "created_at",
                "type": "`Date`",
                "description": "The date with timezone at which the resource was created.",
                "optional": false,
                "defaultValue": "",
                "expandable": false,
                "children": []
              },
              {
                "name": "deleted_at",
                "type": "`null` \\| `Date`",
                "description": "The date with timezone at which the resource was deleted.",
                "optional": false,
                "defaultValue": "",
                "expandable": false,
                "children": []
              },
              {
                "name": "ends_at",
                "type": "`null` \\| `Date`",
                "description": "The time at which the discount can no longer be used.",
                "optional": false,
                "defaultValue": "",
                "expandable": false,
                "children": []
              },
              {
                "name": "id",
                "type": "`string`",
                "description": "The discount's ID",
                "optional": false,
                "defaultValue": "",
                "expandable": false,
                "children": []
              },
              {
                "name": "is_disabled",
                "type": "`boolean`",
                "description": "Whether the Discount has been disabled. Disabled discounts cannot be applied to carts",
                "optional": false,
                "defaultValue": "",
                "expandable": false,
                "children": []
              },
              {
                "name": "is_dynamic",
                "type": "`boolean`",
                "description": "A flag to indicate if multiple instances of the discount can be generated. I.e. for newsletter discounts",
                "optional": false,
                "defaultValue": "",
                "expandable": false,
                "children": []
              },
              {
                "name": "metadata",
                "type": "`Record<string, unknown>`",
                "description": "An optional key-value map with additional details",
                "optional": false,
                "defaultValue": "",
                "expandable": false,
                "children": []
              },
              {
                "name": "parent_discount",
                "type": "[Discount](../../entities/classes/entities.Discount.mdx)",
                "description": "The details of the parent discount that this discount was created from.",
                "optional": false,
                "defaultValue": "",
                "expandable": true,
                "children": []
              },
              {
                "name": "parent_discount_id",
                "type": "`string`",
                "description": "The Discount that the discount was created from. This will always be a dynamic discount",
                "optional": false,
                "defaultValue": "",
                "expandable": false,
                "children": []
              },
              {
                "name": "regions",
                "type": "[Region](../../entities/classes/entities.Region.mdx)[]",
                "description": "The details of the regions in which the Discount can be used.",
                "optional": false,
                "defaultValue": "",
                "expandable": true,
                "children": []
              },
              {
                "name": "rule",
                "type": "[DiscountRule](../../entities/classes/entities.DiscountRule.mdx)",
                "description": "The details of the discount rule that defines how the discount will be applied to a cart..",
                "optional": false,
                "defaultValue": "",
                "expandable": true,
                "children": []
              },
              {
                "name": "rule_id",
                "type": "`string`",
                "description": "The ID of the discount rule that defines how the discount will be applied to a cart.",
                "optional": false,
                "defaultValue": "",
                "expandable": false,
                "children": []
              },
              {
                "name": "starts_at",
                "type": "`Date`",
                "description": "The time at which the discount can be used.",
                "optional": false,
                "defaultValue": "",
                "expandable": false,
                "children": []
              },
              {
                "name": "updated_at",
                "type": "`Date`",
                "description": "The date with timezone at which the resource was updated.",
                "optional": false,
                "defaultValue": "",
                "expandable": false,
                "children": []
              },
              {
                "name": "usage_count",
                "type": "`number`",
                "description": "The number of times a discount has been used.",
                "optional": false,
                "defaultValue": "0",
                "expandable": false,
                "children": []
              },
              {
                "name": "usage_limit",
                "type": "`null` \\| `number`",
                "description": "The maximum number of times that a discount can be used.",
                "optional": false,
                "defaultValue": "",
                "expandable": false,
                "children": []
              },
              {
                "name": "valid_duration",
                "type": "`null` \\| `string`",
                "description": "Duration the discount runs between",
                "optional": false,
                "defaultValue": "",
                "expandable": false,
                "children": []
              }
            ]
          },
          {
            "name": "display_id",
            "type": "`number`",
            "description": "The order's display ID",
            "optional": false,
            "defaultValue": "",
            "expandable": false,
            "children": []
          },
          {
            "name": "draft_order",
            "type": "[DraftOrder](../../entities/classes/entities.DraftOrder.mdx)",
            "description": "The details of the draft order this order was created from.",
            "optional": false,
            "defaultValue": "",
            "expandable": true,
            "children": [
              {
                "name": "canceled_at",
                "type": "`Date`",
                "description": "The date the draft order was canceled at.",
                "optional": false,
                "defaultValue": "",
                "expandable": false,
                "children": []
              },
              {
                "name": "cart",
                "type": "[Cart](../../entities/classes/entities.Cart.mdx)",
                "description": "The details of the cart associated with the draft order.",
                "optional": false,
                "defaultValue": "",
                "expandable": true,
                "children": []
              },
              {
                "name": "cart_id",
                "type": "`string`",
                "description": "The ID of the cart associated with the draft order.",
                "optional": false,
                "defaultValue": "",
                "expandable": false,
                "children": []
              },
              {
                "name": "completed_at",
                "type": "`Date`",
                "description": "The date the draft order was completed at.",
                "optional": false,
                "defaultValue": "",
                "expandable": false,
                "children": []
              },
              {
                "name": "created_at",
                "type": "`Date`",
                "description": "The date with timezone at which the resource was created.",
                "optional": false,
                "defaultValue": "",
                "expandable": false,
                "children": []
              },
              {
                "name": "display_id",
                "type": "`number`",
                "description": "The draft order's display ID",
                "optional": false,
                "defaultValue": "",
                "expandable": false,
                "children": []
              },
              {
                "name": "id",
                "type": "`string`",
                "description": "The draft order's ID",
                "optional": false,
                "defaultValue": "",
                "expandable": false,
                "children": []
              },
              {
                "name": "idempotency_key",
                "type": "`string`",
                "description": "Randomly generated key used to continue the completion of the cart associated with the draft order in case of failure.",
                "optional": false,
                "defaultValue": "",
                "expandable": false,
                "children": []
              },
              {
                "name": "metadata",
                "type": "`Record<string, unknown>`",
                "description": "An optional key-value map with additional details",
                "optional": false,
                "defaultValue": "",
                "expandable": false,
                "children": []
              },
              {
                "name": "no_notification_order",
                "type": "`boolean`",
                "description": "Whether to send the customer notifications regarding order updates.",
                "optional": false,
                "defaultValue": "",
                "expandable": false,
                "children": []
              },
              {
                "name": "order",
                "type": "[Order](../../entities/classes/entities.Order.mdx)",
                "description": "The details of the order created from the draft order when its payment is captured.",
                "optional": false,
                "defaultValue": "",
                "expandable": true,
                "children": []
              },
              {
                "name": "order_id",
                "type": "`string`",
                "description": "The ID of the order created from the draft order when its payment is captured.",
                "optional": false,
                "defaultValue": "",
                "expandable": false,
                "children": []
              },
              {
                "name": "status",
                "type": "[DraftOrderStatus](../../entities/enums/entities.DraftOrderStatus.mdx)",
                "description": "The status of the draft order. It's changed to `completed` when it's transformed to an order.",
                "optional": false,
                "defaultValue": "open",
                "expandable": false,
                "children": []
              },
              {
                "name": "updated_at",
                "type": "`Date`",
                "description": "The date with timezone at which the resource was updated.",
                "optional": false,
                "defaultValue": "",
                "expandable": false,
                "children": []
              }
            ]
          },
          {
            "name": "draft_order_id",
            "type": "`string`",
            "description": "The ID of the draft order this order was created from.",
            "optional": false,
            "defaultValue": "",
            "expandable": false,
            "children": []
          },
          {
            "name": "edits",
            "type": "[OrderEdit](../../entities/classes/entities.OrderEdit.mdx)[]",
            "description": "The details of the order edits done on the order.",
            "optional": false,
            "defaultValue": "",
            "expandable": true,
            "children": [
              {
                "name": "canceled_at",
                "type": "`Date`",
                "description": "The date with timezone at which the edit was cancelled.",
                "optional": true,
                "defaultValue": "",
                "expandable": false,
                "children": []
              },
              {
                "name": "canceled_by",
                "type": "`string`",
                "description": "The unique identifier of the user or customer who cancelled the order edit.",
                "optional": true,
                "defaultValue": "",
                "expandable": false,
                "children": []
              },
              {
                "name": "changes",
                "type": "[OrderItemChange](../../entities/classes/entities.OrderItemChange.mdx)[]",
                "description": "The details of all the changes on the original order's line items.",
                "optional": false,
                "defaultValue": "",
                "expandable": true,
                "children": []
              },
              {
                "name": "confirmed_at",
                "type": "`Date`",
                "description": "The date with timezone at which the edit was confirmed.",
                "optional": true,
                "defaultValue": "",
                "expandable": false,
                "children": []
              },
              {
                "name": "confirmed_by",
                "type": "`string`",
                "description": "The unique identifier of the user or customer who confirmed the order edit.",
                "optional": true,
                "defaultValue": "",
                "expandable": false,
                "children": []
              },
              {
                "name": "created_at",
                "type": "`Date`",
                "description": "The date with timezone at which the resource was created.",
                "optional": false,
                "defaultValue": "",
                "expandable": false,
                "children": []
              },
              {
                "name": "created_by",
                "type": "`string`",
                "description": "The unique identifier of the user or customer who created the order edit.",
                "optional": false,
                "defaultValue": "",
                "expandable": false,
                "children": []
              },
              {
                "name": "declined_at",
                "type": "`Date`",
                "description": "The date with timezone at which the edit was declined.",
                "optional": true,
                "defaultValue": "",
                "expandable": false,
                "children": []
              },
              {
                "name": "declined_by",
                "type": "`string`",
                "description": "The unique identifier of the user or customer who declined the order edit.",
                "optional": true,
                "defaultValue": "",
                "expandable": false,
                "children": []
              },
              {
                "name": "declined_reason",
                "type": "`string`",
                "description": "An optional note why  the order edit is declined.",
                "optional": true,
                "defaultValue": "",
                "expandable": false,
                "children": []
              },
              {
                "name": "difference_due",
                "type": "`number`",
                "description": "The difference between the total amount of the order and total amount of edited order.",
                "optional": false,
                "defaultValue": "",
                "expandable": false,
                "children": []
              },
              {
                "name": "discount_total",
                "type": "`number`",
                "description": "The total of discount",
                "optional": false,
                "defaultValue": "",
                "expandable": false,
                "children": []
              },
              {
                "name": "gift_card_tax_total",
                "type": "`number`",
                "description": "The total of the gift card tax amount",
                "optional": false,
                "defaultValue": "",
                "expandable": false,
                "children": []
              },
              {
                "name": "gift_card_total",
                "type": "`number`",
                "description": "The total of the gift card amount",
                "optional": false,
                "defaultValue": "",
                "expandable": false,
                "children": []
              },
              {
                "name": "id",
                "type": "`string`",
                "description": "The order edit's ID",
                "optional": false,
                "defaultValue": "",
                "expandable": false,
                "children": []
              },
              {
                "name": "internal_note",
                "type": "`string`",
                "description": "An optional note with additional details about the order edit.",
                "optional": true,
                "defaultValue": "",
                "expandable": false,
                "children": []
              },
              {
                "name": "items",
                "type": "[LineItem](../../entities/classes/entities.LineItem.mdx)[]",
                "description": "The details of the cloned items from the original order with the new changes. Once the order edit is confirmed, these line items are associated with the original order.",
                "optional": false,
                "defaultValue": "",
                "expandable": true,
                "children": []
              },
              {
                "name": "order",
                "type": "[Order](../../entities/classes/entities.Order.mdx)",
                "description": "The details of the order that this order edit was created for.",
                "optional": false,
                "defaultValue": "",
                "expandable": true,
                "children": []
              },
              {
                "name": "order_id",
                "type": "`string`",
                "description": "The ID of the order that is edited",
                "optional": false,
                "defaultValue": "",
                "expandable": false,
                "children": []
              },
              {
                "name": "payment_collection",
                "type": "[PaymentCollection](../../entities/classes/entities.PaymentCollection.mdx)",
                "description": "The details of the payment collection used to authorize additional payment if necessary.",
                "optional": false,
                "defaultValue": "",
                "expandable": true,
                "children": []
              },
              {
                "name": "payment_collection_id",
                "type": "`string`",
                "description": "The ID of the payment collection",
                "optional": false,
                "defaultValue": "",
                "expandable": false,
                "children": []
              },
              {
                "name": "requested_at",
                "type": "`Date`",
                "description": "The date with timezone at which the edit was requested.",
                "optional": true,
                "defaultValue": "",
                "expandable": false,
                "children": []
              },
              {
                "name": "requested_by",
                "type": "`string`",
                "description": "The unique identifier of the user or customer who requested the order edit.",
                "optional": true,
                "defaultValue": "",
                "expandable": false,
                "children": []
              },
              {
                "name": "shipping_total",
                "type": "`number`",
                "description": "The total of the shipping amount",
                "optional": false,
                "defaultValue": "",
                "expandable": false,
                "children": []
              },
              {
                "name": "status",
                "type": "[OrderEditStatus](../../entities/enums/entities.OrderEditStatus.mdx)",
                "description": "The status of the order edit.",
                "optional": false,
                "defaultValue": "",
                "expandable": false,
                "children": []
              },
              {
                "name": "subtotal",
                "type": "`number`",
                "description": "The total of subtotal",
                "optional": false,
                "defaultValue": "",
                "expandable": false,
                "children": []
              },
              {
                "name": "tax_total",
                "type": "`null` \\| `number`",
                "description": "The total of tax",
                "optional": false,
                "defaultValue": "",
                "expandable": false,
                "children": []
              },
              {
                "name": "total",
                "type": "`number`",
                "description": "The total amount of the edited order.",
                "optional": false,
                "defaultValue": "",
                "expandable": false,
                "children": []
              },
              {
                "name": "updated_at",
                "type": "`Date`",
                "description": "The date with timezone at which the resource was updated.",
                "optional": false,
                "defaultValue": "",
                "expandable": false,
                "children": []
              }
            ]
          },
          {
            "name": "email",
            "type": "`string`",
            "description": "The email associated with the order",
            "optional": false,
            "defaultValue": "",
            "expandable": false,
            "children": []
          },
          {
            "name": "external_id",
            "type": "`null` \\| `string`",
            "description": "The ID of an external order.",
            "optional": false,
            "defaultValue": "",
            "expandable": false,
            "children": []
          },
          {
            "name": "fulfillment_status",
            "type": "[FulfillmentStatus](../../entities/enums/entities.FulfillmentStatus.mdx)",
            "description": "The order's fulfillment status",
            "optional": false,
            "defaultValue": "not_fulfilled",
            "expandable": false,
            "children": [
              {
                "name": "CANCELED",
                "type": "`\"canceled\"`",
                "description": "The order's fulfillments are canceled.",
                "optional": true,
                "defaultValue": "",
                "expandable": false,
                "children": []
              },
              {
                "name": "FULFILLED",
                "type": "`\"fulfilled\"`",
                "description": "The order's items are fulfilled.",
                "optional": true,
                "defaultValue": "",
                "expandable": false,
                "children": []
              },
              {
                "name": "NOT_FULFILLED",
                "type": "`\"not_fulfilled\"`",
                "description": "The order's items are not fulfilled.",
                "optional": true,
                "defaultValue": "",
                "expandable": false,
                "children": []
              },
              {
                "name": "PARTIALLY_FULFILLED",
                "type": "`\"partially_fulfilled\"`",
                "description": "Some of the order's items, but not all, are fulfilled.",
                "optional": true,
                "defaultValue": "",
                "expandable": false,
                "children": []
              },
              {
                "name": "PARTIALLY_RETURNED",
                "type": "`\"partially_returned\"`",
                "description": "Some of the order's items, but not all, are returned.",
                "optional": true,
                "defaultValue": "",
                "expandable": false,
                "children": []
              },
              {
                "name": "PARTIALLY_SHIPPED",
                "type": "`\"partially_shipped\"`",
                "description": "Some of the order's items, but not all, are shipped.",
                "optional": true,
                "defaultValue": "",
                "expandable": false,
                "children": []
              },
              {
                "name": "REQUIRES_ACTION",
                "type": "`\"requires_action\"`",
                "description": "The order's fulfillment requires action.",
                "optional": true,
                "defaultValue": "",
                "expandable": false,
                "children": []
              },
              {
                "name": "RETURNED",
                "type": "`\"returned\"`",
                "description": "The order's items are returned.",
                "optional": true,
                "defaultValue": "",
                "expandable": false,
                "children": []
              },
              {
                "name": "SHIPPED",
                "type": "`\"shipped\"`",
                "description": "The order's items are shipped.",
                "optional": true,
                "defaultValue": "",
                "expandable": false,
                "children": []
              }
            ]
          },
          {
            "name": "fulfillments",
            "type": "[Fulfillment](../../entities/classes/entities.Fulfillment.mdx)[]",
            "description": "The details of the fulfillments created for the order.",
            "optional": false,
            "defaultValue": "",
            "expandable": true,
            "children": [
              {
                "name": "canceled_at",
                "type": "`Date`",
                "description": "The date with timezone at which the Fulfillment was canceled.",
                "optional": false,
                "defaultValue": "",
                "expandable": false,
                "children": []
              },
              {
                "name": "claim_order",
                "type": "[ClaimOrder](../../entities/classes/entities.ClaimOrder.mdx)",
                "description": "The details of the claim that the fulfillment may belong to.",
                "optional": false,
                "defaultValue": "",
                "expandable": true,
                "children": []
              },
              {
                "name": "claim_order_id",
                "type": "`string`",
                "description": "The ID of the Claim that the Fulfillment belongs to.",
                "optional": false,
                "defaultValue": "",
                "expandable": false,
                "children": []
              },
              {
                "name": "created_at",
                "type": "`Date`",
                "description": "The date with timezone at which the resource was created.",
                "optional": false,
                "defaultValue": "",
                "expandable": false,
                "children": []
              },
              {
                "name": "data",
                "type": "`Record<string, unknown>`",
                "description": "This contains all the data necessary for the Fulfillment provider to handle the fulfillment.",
                "optional": false,
                "defaultValue": "",
                "expandable": false,
                "children": []
              },
              {
                "name": "id",
                "type": "`string`",
                "description": "The fulfillment's ID",
                "optional": false,
                "defaultValue": "",
                "expandable": false,
                "children": []
              },
              {
                "name": "idempotency_key",
                "type": "`string`",
                "description": "Randomly generated key used to continue the completion of the fulfillment in case of failure.",
                "optional": false,
                "defaultValue": "",
                "expandable": false,
                "children": []
              },
              {
                "name": "items",
                "type": "[FulfillmentItem](../../entities/classes/entities.FulfillmentItem.mdx)[]",
                "description": "The Fulfillment Items in the Fulfillment. These hold information about how many of each Line Item has been fulfilled.",
                "optional": false,
                "defaultValue": "",
                "expandable": true,
                "children": []
              },
              {
                "name": "location_id",
                "type": "`null` \\| `string`",
                "description": "The ID of the stock location the fulfillment will be shipped from",
                "optional": false,
                "defaultValue": "",
                "expandable": false,
                "children": []
              },
              {
                "name": "metadata",
                "type": "`Record<string, unknown>`",
                "description": "An optional key-value map with additional details",
                "optional": false,
                "defaultValue": "",
                "expandable": false,
                "children": []
              },
              {
                "name": "no_notification",
                "type": "`boolean`",
                "description": "Flag for describing whether or not notifications related to this should be sent.",
                "optional": false,
                "defaultValue": "",
                "expandable": false,
                "children": []
              },
              {
                "name": "order",
                "type": "[Order](../../entities/classes/entities.Order.mdx)",
                "description": "The details of the order that the fulfillment may belong to.",
                "optional": false,
                "defaultValue": "",
                "expandable": true,
                "children": []
              },
              {
                "name": "order_id",
                "type": "`string`",
                "description": "The ID of the Order that the Fulfillment belongs to.",
                "optional": false,
                "defaultValue": "",
                "expandable": false,
                "children": []
              },
              {
                "name": "provider",
                "type": "[FulfillmentProvider](../../entities/classes/entities.FulfillmentProvider.mdx)",
                "description": "The details of the fulfillment provider responsible for handling the fulfillment.",
                "optional": false,
                "defaultValue": "",
                "expandable": true,
                "children": []
              },
              {
                "name": "provider_id",
                "type": "`string`",
                "description": "The ID of the Fulfillment Provider responsible for handling the fulfillment.",
                "optional": false,
                "defaultValue": "",
                "expandable": false,
                "children": []
              },
              {
                "name": "shipped_at",
                "type": "`Date`",
                "description": "The date with timezone at which the Fulfillment was shipped.",
                "optional": false,
                "defaultValue": "",
                "expandable": false,
                "children": []
              },
              {
                "name": "swap",
                "type": "[Swap](../../entities/classes/entities.Swap.mdx)",
                "description": "The details of the swap that the fulfillment may belong to.",
                "optional": false,
                "defaultValue": "",
                "expandable": true,
                "children": []
              },
              {
                "name": "swap_id",
                "type": "`string`",
                "description": "The ID of the Swap that the Fulfillment belongs to.",
                "optional": false,
                "defaultValue": "",
                "expandable": false,
                "children": []
              },
              {
                "name": "tracking_links",
                "type": "[TrackingLink](../../entities/classes/entities.TrackingLink.mdx)[]",
                "description": "The Tracking Links that can be used to track the status of the Fulfillment. These will usually be provided by the Fulfillment Provider.",
                "optional": false,
                "defaultValue": "",
                "expandable": true,
                "children": []
              },
              {
                "name": "tracking_numbers",
                "type": "`string`[]",
                "description": "The tracking numbers that can be used to track the status of the fulfillment.",
                "optional": false,
                "defaultValue": "",
                "expandable": false,
                "children": []
              },
              {
                "name": "updated_at",
                "type": "`Date`",
                "description": "The date with timezone at which the resource was updated.",
                "optional": false,
                "defaultValue": "",
                "expandable": false,
                "children": []
              }
            ]
          },
          {
            "name": "gift_card_tax_total",
            "type": "`number`",
            "description": "The total of gift cards with taxes",
            "optional": false,
            "defaultValue": "",
            "expandable": false,
            "children": []
          },
          {
            "name": "gift_card_total",
            "type": "`number`",
            "description": "The total of gift cards",
            "optional": false,
            "defaultValue": "",
            "expandable": false,
            "children": []
          },
          {
            "name": "gift_card_transactions",
            "type": "[GiftCardTransaction](../../entities/classes/entities.GiftCardTransaction.mdx)[]",
            "description": "The gift card transactions made in the order.",
            "optional": false,
            "defaultValue": "",
            "expandable": true,
            "children": [
              {
                "name": "amount",
                "type": "`number`",
                "description": "The amount that was used from the Gift Card.",
                "optional": false,
                "defaultValue": "",
                "expandable": false,
                "children": []
              },
              {
                "name": "created_at",
                "type": "`Date`",
                "description": "The date with timezone at which the resource was created.",
                "optional": false,
                "defaultValue": "",
                "expandable": false,
                "children": []
              },
              {
                "name": "gift_card",
                "type": "[GiftCard](../../entities/classes/entities.GiftCard.mdx)",
                "description": "The details of the gift card associated used in this transaction.",
                "optional": false,
                "defaultValue": "",
                "expandable": true,
                "children": []
              },
              {
                "name": "gift_card_id",
                "type": "`string`",
                "description": "The ID of the Gift Card that was used in the transaction.",
                "optional": false,
                "defaultValue": "",
                "expandable": false,
                "children": []
              },
              {
                "name": "id",
                "type": "`string`",
                "description": "The gift card transaction's ID",
                "optional": false,
                "defaultValue": "",
                "expandable": false,
                "children": []
              },
              {
                "name": "is_taxable",
                "type": "`boolean`",
                "description": "Whether the transaction is taxable or not.",
                "optional": false,
                "defaultValue": "",
                "expandable": false,
                "children": []
              },
              {
                "name": "order",
                "type": "[Order](../../entities/classes/entities.Order.mdx)",
                "description": "The details of the order that the gift card was used for payment.",
                "optional": false,
                "defaultValue": "",
                "expandable": true,
                "children": []
              },
              {
                "name": "order_id",
                "type": "`string`",
                "description": "The ID of the order that the gift card was used for payment.",
                "optional": false,
                "defaultValue": "",
                "expandable": false,
                "children": []
              },
              {
                "name": "tax_rate",
                "type": "`null` \\| `number`",
                "description": "The tax rate of the transaction",
                "optional": false,
                "defaultValue": "",
                "expandable": false,
                "children": []
              }
            ]
          },
          {
            "name": "gift_cards",
            "type": "[GiftCard](../../entities/classes/entities.GiftCard.mdx)[]",
            "description": "The details of the gift card used in the order.",
            "optional": false,
            "defaultValue": "",
            "expandable": true,
            "children": [
              {
                "name": "balance",
                "type": "`number`",
                "description": "The remaining value on the Gift Card.",
                "optional": false,
                "defaultValue": "",
                "expandable": false,
                "children": []
              },
              {
                "name": "code",
                "type": "`string`",
                "description": "The unique code that identifies the Gift Card. This is used by the Customer to redeem the value of the Gift Card.",
                "optional": false,
                "defaultValue": "",
                "expandable": false,
                "children": []
              },
              {
                "name": "created_at",
                "type": "`Date`",
                "description": "The date with timezone at which the resource was created.",
                "optional": false,
                "defaultValue": "",
                "expandable": false,
                "children": []
              },
              {
                "name": "deleted_at",
                "type": "`null` \\| `Date`",
                "description": "The date with timezone at which the resource was deleted.",
                "optional": false,
                "defaultValue": "",
                "expandable": false,
                "children": []
              },
              {
                "name": "ends_at",
                "type": "`Date`",
                "description": "The time at which the Gift Card can no longer be used.",
                "optional": false,
                "defaultValue": "",
                "expandable": false,
                "children": []
              },
              {
                "name": "id",
                "type": "`string`",
                "description": "The gift card's ID",
                "optional": false,
                "defaultValue": "",
                "expandable": false,
                "children": []
              },
              {
                "name": "is_disabled",
                "type": "`boolean`",
                "description": "Whether the Gift Card has been disabled. Disabled Gift Cards cannot be applied to carts.",
                "optional": false,
                "defaultValue": "false",
                "expandable": false,
                "children": []
              },
              {
                "name": "metadata",
                "type": "`Record<string, unknown>`",
                "description": "An optional key-value map with additional details",
                "optional": false,
                "defaultValue": "",
                "expandable": false,
                "children": []
              },
              {
                "name": "order",
                "type": "[Order](../../entities/classes/entities.Order.mdx)",
                "description": "The details of the order that the gift card was purchased in.",
                "optional": false,
                "defaultValue": "",
                "expandable": true,
                "children": []
              },
              {
                "name": "order_id",
                "type": "`string`",
                "description": "The ID of the order that the gift card was purchased in.",
                "optional": false,
                "defaultValue": "",
                "expandable": false,
                "children": []
              },
              {
                "name": "region",
                "type": "[Region](../../entities/classes/entities.Region.mdx)",
                "description": "The details of the region this gift card is available in.",
                "optional": false,
                "defaultValue": "",
                "expandable": true,
                "children": []
              },
              {
                "name": "region_id",
                "type": "`string`",
                "description": "The ID of the region this gift card is available in.",
                "optional": false,
                "defaultValue": "",
                "expandable": false,
                "children": []
              },
              {
                "name": "tax_rate",
                "type": "`null` \\| `number`",
                "description": "The gift card's tax rate that will be applied on calculating totals",
                "optional": false,
                "defaultValue": "",
                "expandable": false,
                "children": []
              },
              {
                "name": "updated_at",
                "type": "`Date`",
                "description": "The date with timezone at which the resource was updated.",
                "optional": false,
                "defaultValue": "",
                "expandable": false,
                "children": []
              },
              {
                "name": "value",
                "type": "`number`",
                "description": "The value that the Gift Card represents.",
                "optional": false,
                "defaultValue": "",
                "expandable": false,
                "children": []
              }
            ]
          },
          {
            "name": "id",
            "type": "`string`",
            "description": "The order's ID",
            "optional": false,
            "defaultValue": "",
            "expandable": false,
            "children": []
          },
          {
            "name": "idempotency_key",
            "type": "`string`",
            "description": "Randomly generated key used to continue the processing of the order in case of failure.",
            "optional": false,
            "defaultValue": "",
            "expandable": false,
            "children": []
          },
          {
            "name": "item_tax_total",
            "type": "`null` \\| `number`",
            "description": "The tax total applied on items",
            "optional": false,
            "defaultValue": "",
            "expandable": false,
            "children": []
          },
          {
            "name": "items",
            "type": "[LineItem](../../entities/classes/entities.LineItem.mdx)[]",
            "description": "The details of the line items that belong to the order.",
            "optional": false,
            "defaultValue": "",
            "expandable": true,
            "children": [
              {
                "name": "adjustments",
                "type": "[LineItemAdjustment](../../entities/classes/entities.LineItemAdjustment.mdx)[]",
                "description": "The details of the item's adjustments, which are available when a discount is applied on the item.",
                "optional": false,
                "defaultValue": "",
                "expandable": true,
                "children": []
              },
              {
                "name": "allow_discounts",
                "type": "`boolean`",
                "description": "Flag to indicate if the Line Item should be included when doing discount calculations.",
                "optional": false,
                "defaultValue": "true",
                "expandable": false,
                "children": []
              },
              {
                "name": "cart",
                "type": "[Cart](../../entities/classes/entities.Cart.mdx)",
                "description": "The details of the cart that the line item may belongs to.",
                "optional": false,
                "defaultValue": "",
                "expandable": true,
                "children": []
              },
              {
                "name": "cart_id",
                "type": "`string`",
                "description": "The ID of the cart that the line item may belongs to.",
                "optional": false,
                "defaultValue": "",
                "expandable": false,
                "children": []
              },
              {
                "name": "claim_order",
                "type": "[ClaimOrder](../../entities/classes/entities.ClaimOrder.mdx)",
                "description": "The details of the claim that the line item may belong to.",
                "optional": false,
                "defaultValue": "",
                "expandable": true,
                "children": []
              },
              {
                "name": "claim_order_id",
                "type": "`string`",
                "description": "The ID of the claim that the line item may belong to.",
                "optional": false,
                "defaultValue": "",
                "expandable": false,
                "children": []
              },
              {
                "name": "created_at",
                "type": "`Date`",
                "description": "The date with timezone at which the resource was created.",
                "optional": false,
                "defaultValue": "",
                "expandable": false,
                "children": []
              },
              {
                "name": "description",
                "type": "`null` \\| `string`",
                "description": "A more detailed description of the contents of the Line Item.",
                "optional": false,
                "defaultValue": "",
                "expandable": false,
                "children": []
              },
              {
                "name": "discount_total",
                "type": "`null` \\| `number`",
                "description": "The total of discount of the line item rounded",
                "optional": true,
                "defaultValue": "",
                "expandable": false,
                "children": []
              },
              {
                "name": "fulfilled_quantity",
                "type": "`null` \\| `number`",
                "description": "The quantity of the Line Item that has been fulfilled.",
                "optional": false,
                "defaultValue": "",
                "expandable": false,
                "children": []
              },
              {
                "name": "gift_card_total",
                "type": "`null` \\| `number`",
                "description": "The total of the gift card of the line item",
                "optional": true,
                "defaultValue": "",
                "expandable": false,
                "children": []
              },
              {
                "name": "has_shipping",
                "type": "`null` \\| `boolean`",
                "description": "Flag to indicate if the Line Item has fulfillment associated with it.",
                "optional": false,
                "defaultValue": "",
                "expandable": false,
                "children": []
              },
              {
                "name": "id",
                "type": "`string`",
                "description": "The line item's ID",
                "optional": false,
                "defaultValue": "",
                "expandable": false,
                "children": []
              },
              {
                "name": "includes_tax",
                "type": "`boolean`",
                "description": "Indicates if the line item unit\\_price include tax",
                "optional": false,
                "defaultValue": "false",
                "expandable": false,
                "featureFlag": "tax_inclusive_pricing",
                "children": []
              },
              {
                "name": "is_giftcard",
                "type": "`boolean`",
                "description": "Flag to indicate if the Line Item is a Gift Card.",
                "optional": false,
                "defaultValue": "false",
                "expandable": false,
                "children": []
              },
              {
                "name": "is_return",
                "type": "`boolean`",
                "description": "Is the item being returned",
                "optional": false,
                "defaultValue": "false",
                "expandable": false,
                "children": []
              },
              {
                "name": "metadata",
                "type": "`Record<string, unknown>`",
                "description": "An optional key-value map with additional details",
                "optional": false,
                "defaultValue": "",
                "expandable": false,
                "children": []
              },
              {
                "name": "order",
                "type": "[Order](../../entities/classes/entities.Order.mdx)",
                "description": "The details of the order that the line item may belongs to.",
                "optional": false,
                "defaultValue": "",
                "expandable": true,
                "children": []
              },
              {
                "name": "order_edit",
                "type": "`null` \\| [OrderEdit](../../entities/classes/entities.OrderEdit.mdx)",
                "description": "The details of the order edit.",
                "optional": true,
                "defaultValue": "",
                "expandable": true,
                "children": []
              },
              {
                "name": "order_edit_id",
                "type": "`null` \\| `string`",
                "description": "The ID of the order edit that the item may belong to.",
                "optional": true,
                "defaultValue": "",
                "expandable": false,
                "children": []
              },
              {
                "name": "order_id",
                "type": "`null` \\| `string`",
                "description": "The ID of the order that the line item may belongs to.",
                "optional": false,
                "defaultValue": "",
                "expandable": false,
                "children": []
              },
              {
                "name": "original_item_id",
                "type": "`null` \\| `string`",
                "description": "The ID of the original line item. This is useful if the line item belongs to a resource that references an order, such as a return or an order edit.",
                "optional": true,
                "defaultValue": "",
                "expandable": false,
                "children": []
              },
              {
                "name": "original_tax_total",
                "type": "`null` \\| `number`",
                "description": "The original tax total amount of the line item",
                "optional": true,
                "defaultValue": "",
                "expandable": false,
                "children": []
              },
              {
                "name": "original_total",
                "type": "`null` \\| `number`",
                "description": "The original total amount of the line item",
                "optional": true,
                "defaultValue": "",
                "expandable": false,
                "children": []
              },
              {
                "name": "product_id",
                "type": "`null` \\| `string`",
                "description": "",
                "optional": false,
                "defaultValue": "",
                "expandable": false,
                "children": []
              },
              {
                "name": "quantity",
                "type": "`number`",
                "description": "The quantity of the content in the Line Item.",
                "optional": false,
                "defaultValue": "",
                "expandable": false,
                "children": []
              },
              {
                "name": "raw_discount_total",
                "type": "`null` \\| `number`",
                "description": "The total of discount of the line item",
                "optional": true,
                "defaultValue": "",
                "expandable": false,
                "children": []
              },
              {
                "name": "refundable",
                "type": "`null` \\| `number`",
                "description": "The amount that can be refunded from the given Line Item. Takes taxes and discounts into consideration.",
                "optional": true,
                "defaultValue": "",
                "expandable": false,
                "children": []
              },
              {
                "name": "returned_quantity",
                "type": "`null` \\| `number`",
                "description": "The quantity of the Line Item that has been returned.",
                "optional": false,
                "defaultValue": "",
                "expandable": false,
                "children": []
              },
              {
                "name": "shipped_quantity",
                "type": "`null` \\| `number`",
                "description": "The quantity of the Line Item that has been shipped.",
                "optional": false,
                "defaultValue": "",
                "expandable": false,
                "children": []
              },
              {
                "name": "should_merge",
                "type": "`boolean`",
                "description": "Flag to indicate if new Line Items with the same variant should be merged or added as an additional Line Item.",
                "optional": false,
                "defaultValue": "true",
                "expandable": false,
                "children": []
              },
              {
                "name": "subtotal",
                "type": "`null` \\| `number`",
                "description": "The subtotal of the line item",
                "optional": true,
                "defaultValue": "",
                "expandable": false,
                "children": []
              },
              {
                "name": "swap",
                "type": "[Swap](../../entities/classes/entities.Swap.mdx)",
                "description": "The details of the swap that the line item may belong to.",
                "optional": false,
                "defaultValue": "",
                "expandable": true,
                "children": []
              },
              {
                "name": "swap_id",
                "type": "`string`",
                "description": "The ID of the swap that the line item may belong to.",
                "optional": false,
                "defaultValue": "",
                "expandable": false,
                "children": []
              },
              {
                "name": "tax_lines",
                "type": "[LineItemTaxLine](../../entities/classes/entities.LineItemTaxLine.mdx)[]",
                "description": "The details of the item's tax lines.",
                "optional": false,
                "defaultValue": "",
                "expandable": true,
                "children": []
              },
              {
                "name": "tax_total",
                "type": "`null` \\| `number`",
                "description": "The total of tax of the line item",
                "optional": true,
                "defaultValue": "",
                "expandable": false,
                "children": []
              },
              {
                "name": "thumbnail",
                "type": "`null` \\| `string`",
                "description": "A URL string to a small image of the contents of the Line Item.",
                "optional": false,
                "defaultValue": "",
                "expandable": false,
                "children": []
              },
              {
                "name": "title",
                "type": "`string`",
                "description": "The title of the Line Item.",
                "optional": false,
                "defaultValue": "",
                "expandable": false,
                "children": []
              },
              {
                "name": "total",
                "type": "`null` \\| `number`",
                "description": "The total amount of the line item",
                "optional": true,
                "defaultValue": "",
                "expandable": false,
                "children": []
              },
              {
                "name": "unit_price",
                "type": "`number`",
                "description": "The price of one unit of the content in the Line Item. This should be in the currency defined by the Cart/Order/Swap/Claim that the Line Item belongs to.",
                "optional": false,
                "defaultValue": "",
                "expandable": false,
                "children": []
              },
              {
                "name": "updated_at",
                "type": "`Date`",
                "description": "The date with timezone at which the resource was updated.",
                "optional": false,
                "defaultValue": "",
                "expandable": false,
                "children": []
              },
              {
                "name": "variant",
                "type": "[ProductVariant](../../entities/classes/entities.ProductVariant.mdx)",
                "description": "The details of the product variant that this item was created from.",
                "optional": false,
                "defaultValue": "",
                "expandable": true,
                "children": []
              },
              {
                "name": "variant_id",
                "type": "`null` \\| `string`",
                "description": "The id of the Product Variant contained in the Line Item.",
                "optional": false,
                "defaultValue": "",
                "expandable": false,
                "children": []
              }
            ]
          },
          {
            "name": "metadata",
            "type": "`Record<string, unknown>`",
            "description": "An optional key-value map with additional details",
            "optional": false,
            "defaultValue": "",
            "expandable": false,
            "children": []
          },
          {
            "name": "no_notification",
            "type": "`boolean`",
            "description": "Flag for describing whether or not notifications related to this should be send.",
            "optional": false,
            "defaultValue": "",
            "expandable": false,
            "children": []
          },
          {
            "name": "object",
            "type": "`\"order\"`",
            "description": "",
            "optional": false,
            "defaultValue": "\"order\"",
            "expandable": false,
            "children": []
          },
          {
            "name": "paid_total",
            "type": "`number`",
            "description": "The total amount paid",
            "optional": false,
            "defaultValue": "",
            "expandable": false,
            "children": []
          },
          {
            "name": "payment_status",
            "type": "[PaymentStatus](../../entities/enums/entities.PaymentStatus.mdx)",
            "description": "The order's payment status",
            "optional": false,
            "defaultValue": "not_paid",
            "expandable": false,
            "children": [
              {
                "name": "AWAITING",
                "type": "`\"awaiting\"`",
                "description": "The order's payment is awaiting capturing.",
                "optional": true,
                "defaultValue": "",
                "expandable": false,
                "children": []
              },
              {
                "name": "CANCELED",
                "type": "`\"canceled\"`",
                "description": "The order's payment is canceled.",
                "optional": true,
                "defaultValue": "",
                "expandable": false,
                "children": []
              },
              {
                "name": "CAPTURED",
                "type": "`\"captured\"`",
                "description": "The order's payment is captured.",
                "optional": true,
                "defaultValue": "",
                "expandable": false,
                "children": []
              },
              {
                "name": "NOT_PAID",
                "type": "`\"not_paid\"`",
                "description": "The order's payment is not paid.",
                "optional": true,
                "defaultValue": "",
                "expandable": false,
                "children": []
              },
              {
                "name": "PARTIALLY_REFUNDED",
                "type": "`\"partially_refunded\"`",
                "description": "Some of the order's payment amount is refunded.",
                "optional": true,
                "defaultValue": "",
                "expandable": false,
                "children": []
              },
              {
                "name": "REFUNDED",
                "type": "`\"refunded\"`",
                "description": "The order's payment amount is refunded.",
                "optional": true,
                "defaultValue": "",
                "expandable": false,
                "children": []
              },
              {
                "name": "REQUIRES_ACTION",
                "type": "`\"requires_action\"`",
                "description": "The order's payment requires action.",
                "optional": true,
                "defaultValue": "",
                "expandable": false,
                "children": []
              }
            ]
          },
          {
            "name": "payments",
            "type": "[Payment](../../entities/classes/entities.Payment.mdx)[]",
            "description": "The details of the payments used in the order.",
            "optional": false,
            "defaultValue": "",
            "expandable": true,
            "children": [
              {
                "name": "amount",
                "type": "`number`",
                "description": "The amount that the Payment has been authorized for.",
                "optional": false,
                "defaultValue": "",
                "expandable": false,
                "children": []
              },
              {
                "name": "amount_refunded",
                "type": "`number`",
                "description": "The amount of the original Payment amount that has been refunded back to the Customer.",
                "optional": false,
                "defaultValue": "0",
                "expandable": false,
                "children": []
              },
              {
                "name": "canceled_at",
                "type": "`string` \\| `Date`",
                "description": "The date with timezone at which the Payment was canceled.",
                "optional": false,
                "defaultValue": "",
                "expandable": false,
                "children": []
              },
              {
                "name": "captured_at",
                "type": "`string` \\| `Date`",
                "description": "The date with timezone at which the Payment was captured.",
                "optional": false,
                "defaultValue": "",
                "expandable": false,
                "children": []
              },
              {
                "name": "cart",
                "type": "[Cart](../../entities/classes/entities.Cart.mdx)",
                "description": "The details of the cart that the payment session was potentially created for.",
                "optional": false,
                "defaultValue": "",
                "expandable": true,
                "children": []
              },
              {
                "name": "cart_id",
                "type": "`string`",
                "description": "The ID of the cart that the payment session was potentially created for.",
                "optional": false,
                "defaultValue": "",
                "expandable": false,
                "children": []
              },
              {
                "name": "created_at",
                "type": "`Date`",
                "description": "The date with timezone at which the resource was created.",
                "optional": false,
                "defaultValue": "",
                "expandable": false,
                "children": []
              },
              {
                "name": "currency",
                "type": "[Currency](../../entities/classes/entities.Currency.mdx)",
                "description": "The details of the currency of the payment.",
                "optional": false,
                "defaultValue": "",
                "expandable": true,
                "children": []
              },
              {
                "name": "currency_code",
                "type": "`string`",
                "description": "The 3 character ISO currency code of the payment.",
                "optional": false,
                "defaultValue": "",
                "expandable": false,
                "children": []
              },
              {
                "name": "data",
                "type": "`Record<string, unknown>`",
                "description": "The data required for the Payment Provider to identify, modify and process the Payment. Typically this will be an object that holds an id to the external payment session, but can be an empty object if the Payment Provider doesn't hold any state.",
                "optional": false,
                "defaultValue": "",
                "expandable": false,
                "children": []
              },
              {
                "name": "id",
                "type": "`string`",
                "description": "The payment's ID",
                "optional": false,
                "defaultValue": "",
                "expandable": false,
                "children": []
              },
              {
                "name": "idempotency_key",
                "type": "`string`",
                "description": "Randomly generated key used to continue the completion of a payment in case of failure.",
                "optional": false,
                "defaultValue": "",
                "expandable": false,
                "children": []
              },
              {
                "name": "metadata",
                "type": "`Record<string, unknown>`",
                "description": "An optional key-value map with additional details",
                "optional": false,
                "defaultValue": "",
                "expandable": false,
                "children": []
              },
              {
                "name": "order",
                "type": "[Order](../../entities/classes/entities.Order.mdx)",
                "description": "The details of the order that the payment session was potentially created for.",
                "optional": false,
                "defaultValue": "",
                "expandable": true,
                "children": []
              },
              {
                "name": "order_id",
                "type": "`string`",
                "description": "The ID of the order that the payment session was potentially created for.",
                "optional": false,
                "defaultValue": "",
                "expandable": false,
                "children": []
              },
              {
                "name": "provider_id",
                "type": "`string`",
                "description": "The id of the Payment Provider that is responsible for the Payment",
                "optional": false,
                "defaultValue": "",
                "expandable": false,
                "children": []
              },
              {
                "name": "swap",
                "type": "[Swap](../../entities/classes/entities.Swap.mdx)",
                "description": "The details of the swap that this payment was potentially created for.",
                "optional": false,
                "defaultValue": "",
                "expandable": true,
                "children": []
              },
              {
                "name": "swap_id",
                "type": "`string`",
                "description": "The ID of the swap that this payment was potentially created for.",
                "optional": false,
                "defaultValue": "",
                "expandable": false,
                "children": []
              },
              {
                "name": "updated_at",
                "type": "`Date`",
                "description": "The date with timezone at which the resource was updated.",
                "optional": false,
                "defaultValue": "",
                "expandable": false,
                "children": []
              }
            ]
          },
          {
            "name": "raw_discount_total",
            "type": "`number`",
            "description": "The total of discount",
            "optional": false,
            "defaultValue": "",
            "expandable": false,
            "children": []
          },
          {
            "name": "refundable_amount",
            "type": "`number`",
            "description": "The amount that can be refunded",
            "optional": false,
            "defaultValue": "",
            "expandable": false,
            "children": []
          },
          {
            "name": "refunded_total",
            "type": "`number`",
            "description": "The total amount refunded if the order is returned.",
            "optional": false,
            "defaultValue": "",
            "expandable": false,
            "children": []
          },
          {
            "name": "refunds",
            "type": "[Refund](../../entities/classes/entities.Refund.mdx)[]",
            "description": "The details of the refunds created for the order.",
            "optional": false,
            "defaultValue": "",
            "expandable": true,
            "children": [
              {
                "name": "amount",
                "type": "`number`",
                "description": "The amount that has be refunded to the Customer.",
                "optional": false,
                "defaultValue": "",
                "expandable": false,
                "children": []
              },
              {
                "name": "created_at",
                "type": "`Date`",
                "description": "The date with timezone at which the resource was created.",
                "optional": false,
                "defaultValue": "",
                "expandable": false,
                "children": []
              },
              {
                "name": "id",
                "type": "`string`",
                "description": "The refund's ID",
                "optional": false,
                "defaultValue": "",
                "expandable": false,
                "children": []
              },
              {
                "name": "idempotency_key",
                "type": "`string`",
                "description": "Randomly generated key used to continue the completion of the refund in case of failure.",
                "optional": false,
                "defaultValue": "",
                "expandable": false,
                "children": []
              },
              {
                "name": "metadata",
                "type": "`Record<string, unknown>`",
                "description": "An optional key-value map with additional details",
                "optional": false,
                "defaultValue": "",
                "expandable": false,
                "children": []
              },
              {
                "name": "note",
                "type": "`string`",
                "description": "An optional note explaining why the amount was refunded.",
                "optional": false,
                "defaultValue": "",
                "expandable": false,
                "children": []
              },
              {
                "name": "order",
                "type": "[Order](../../entities/classes/entities.Order.mdx)",
                "description": "The details of the order this refund was created for.",
                "optional": false,
                "defaultValue": "",
                "expandable": true,
                "children": []
              },
              {
                "name": "order_id",
                "type": "`string`",
                "description": "The ID of the order this refund was created for.",
                "optional": false,
                "defaultValue": "",
                "expandable": false,
                "children": []
              },
              {
                "name": "payment",
                "type": "[Payment](../../entities/classes/entities.Payment.mdx)",
                "description": "The details of the payment associated with the refund.",
                "optional": false,
                "defaultValue": "",
                "expandable": true,
                "children": []
              },
              {
                "name": "payment_id",
                "type": "`string`",
                "description": "The payment's ID, if available.",
                "optional": false,
                "defaultValue": "",
                "expandable": false,
                "children": []
              },
              {
                "name": "reason",
                "type": "`string`",
                "description": "The reason given for the Refund, will automatically be set when processed as part of a Swap, Claim or Return.",
                "optional": false,
                "defaultValue": "",
                "expandable": false,
                "children": []
              },
              {
                "name": "updated_at",
                "type": "`Date`",
                "description": "The date with timezone at which the resource was updated.",
                "optional": false,
                "defaultValue": "",
                "expandable": false,
                "children": []
              }
            ]
          },
          {
            "name": "region",
            "type": "[Region](../../entities/classes/entities.Region.mdx)",
            "description": "The details of the region this order was created in.",
            "optional": false,
            "defaultValue": "",
            "expandable": true,
            "children": [
              {
                "name": "automatic_taxes",
                "type": "`boolean`",
                "description": "Whether taxes should be automated in this region.",
                "optional": false,
                "defaultValue": "true",
                "expandable": false,
                "children": []
              },
              {
                "name": "countries",
                "type": "[Country](../../entities/classes/entities.Country.mdx)[]",
                "description": "The details of the countries included in this region.",
                "optional": false,
                "defaultValue": "",
                "expandable": true,
                "children": []
              },
              {
                "name": "created_at",
                "type": "`Date`",
                "description": "The date with timezone at which the resource was created.",
                "optional": false,
                "defaultValue": "",
                "expandable": false,
                "children": []
              },
              {
                "name": "currency",
                "type": "[Currency](../../entities/classes/entities.Currency.mdx)",
                "description": "The details of the currency used in the region.",
                "optional": false,
                "defaultValue": "",
                "expandable": true,
                "children": []
              },
              {
                "name": "currency_code",
                "type": "`string`",
                "description": "The three character currency code used in the region.",
                "optional": false,
                "defaultValue": "",
                "expandable": false,
                "children": []
              },
              {
                "name": "deleted_at",
                "type": "`null` \\| `Date`",
                "description": "The date with timezone at which the resource was deleted.",
                "optional": false,
                "defaultValue": "",
                "expandable": false,
                "children": []
              },
              {
                "name": "fulfillment_providers",
                "type": "[FulfillmentProvider](../../entities/classes/entities.FulfillmentProvider.mdx)[]",
                "description": "The details of the fulfillment providers that can be used to fulfill items of orders and similar resources in the region.",
                "optional": false,
                "defaultValue": "",
                "expandable": true,
                "children": []
              },
              {
                "name": "gift_cards_taxable",
                "type": "`boolean`",
                "description": "Whether the gift cards are taxable or not in this region.",
                "optional": false,
                "defaultValue": "true",
                "expandable": false,
                "children": []
              },
              {
                "name": "id",
                "type": "`string`",
                "description": "The region's ID",
                "optional": false,
                "defaultValue": "",
                "expandable": false,
                "children": []
              },
              {
                "name": "includes_tax",
                "type": "`boolean`",
                "description": "Whether the prices for the region include tax",
                "optional": false,
                "defaultValue": "false",
                "expandable": false,
                "featureFlag": "tax_inclusive_pricing",
                "children": []
              },
              {
                "name": "metadata",
                "type": "`Record<string, unknown>`",
                "description": "An optional key-value map with additional details",
                "optional": false,
                "defaultValue": "",
                "expandable": false,
                "children": []
              },
              {
                "name": "name",
                "type": "`string`",
                "description": "The name of the region as displayed to the customer. If the Region only has one country it is recommended to write the country name.",
                "optional": false,
                "defaultValue": "",
                "expandable": false,
                "children": []
              },
              {
                "name": "payment_providers",
                "type": "[PaymentProvider](../../entities/classes/entities.PaymentProvider.mdx)[]",
                "description": "The details of the payment providers that can be used to process payments in the region.",
                "optional": false,
                "defaultValue": "",
                "expandable": true,
                "children": []
              },
              {
                "name": "tax_code",
                "type": "`string`",
                "description": "The tax code used on purchases in the Region. This may be used by other systems for accounting purposes.",
                "optional": false,
                "defaultValue": "",
                "expandable": false,
                "children": []
              },
              {
                "name": "tax_provider",
                "type": "[TaxProvider](../../entities/classes/entities.TaxProvider.mdx)",
                "description": "The details of the tax provider used in the region.",
                "optional": false,
                "defaultValue": "",
                "expandable": true,
                "children": []
              },
              {
                "name": "tax_provider_id",
                "type": "`null` \\| `string`",
                "description": "The ID of the tax provider used in this region",
                "optional": false,
                "defaultValue": "",
                "expandable": false,
                "children": []
              },
              {
                "name": "tax_rate",
                "type": "`number`",
                "description": "The tax rate that should be charged on purchases in the Region.",
                "optional": false,
                "defaultValue": "",
                "expandable": false,
                "children": []
              },
              {
                "name": "tax_rates",
                "type": "`null` \\| [TaxRate](../../entities/classes/entities.TaxRate.mdx)[]",
                "description": "The details of the tax rates used in the region, aside from the default rate.",
                "optional": false,
                "defaultValue": "",
                "expandable": true,
                "children": []
              },
              {
                "name": "updated_at",
                "type": "`Date`",
                "description": "The date with timezone at which the resource was updated.",
                "optional": false,
                "defaultValue": "",
                "expandable": false,
                "children": []
              }
            ]
          },
          {
            "name": "region_id",
            "type": "`string`",
            "description": "The ID of the region this order was created in.",
            "optional": false,
            "defaultValue": "",
            "expandable": false,
            "children": []
          },
          {
            "name": "returnable_items",
            "type": "[LineItem](../../entities/classes/entities.LineItem.mdx)[]",
            "description": "The details of the line items that are returnable as part of the order, swaps, or claims",
            "optional": true,
            "defaultValue": "",
            "expandable": true,
            "children": [
              {
                "name": "adjustments",
                "type": "[LineItemAdjustment](../../entities/classes/entities.LineItemAdjustment.mdx)[]",
                "description": "The details of the item's adjustments, which are available when a discount is applied on the item.",
                "optional": false,
                "defaultValue": "",
                "expandable": true,
                "children": []
              },
              {
                "name": "allow_discounts",
                "type": "`boolean`",
                "description": "Flag to indicate if the Line Item should be included when doing discount calculations.",
                "optional": false,
                "defaultValue": "true",
                "expandable": false,
                "children": []
              },
              {
                "name": "cart",
                "type": "[Cart](../../entities/classes/entities.Cart.mdx)",
                "description": "The details of the cart that the line item may belongs to.",
                "optional": false,
                "defaultValue": "",
                "expandable": true,
                "children": []
              },
              {
                "name": "cart_id",
                "type": "`string`",
                "description": "The ID of the cart that the line item may belongs to.",
                "optional": false,
                "defaultValue": "",
                "expandable": false,
                "children": []
              },
              {
                "name": "claim_order",
                "type": "[ClaimOrder](../../entities/classes/entities.ClaimOrder.mdx)",
                "description": "The details of the claim that the line item may belong to.",
                "optional": false,
                "defaultValue": "",
                "expandable": true,
                "children": []
              },
              {
                "name": "claim_order_id",
                "type": "`string`",
                "description": "The ID of the claim that the line item may belong to.",
                "optional": false,
                "defaultValue": "",
                "expandable": false,
                "children": []
              },
              {
                "name": "created_at",
                "type": "`Date`",
                "description": "The date with timezone at which the resource was created.",
                "optional": false,
                "defaultValue": "",
                "expandable": false,
                "children": []
              },
              {
                "name": "description",
                "type": "`null` \\| `string`",
                "description": "A more detailed description of the contents of the Line Item.",
                "optional": false,
                "defaultValue": "",
                "expandable": false,
                "children": []
              },
              {
                "name": "discount_total",
                "type": "`null` \\| `number`",
                "description": "The total of discount of the line item rounded",
                "optional": true,
                "defaultValue": "",
                "expandable": false,
                "children": []
              },
              {
                "name": "fulfilled_quantity",
                "type": "`null` \\| `number`",
                "description": "The quantity of the Line Item that has been fulfilled.",
                "optional": false,
                "defaultValue": "",
                "expandable": false,
                "children": []
              },
              {
                "name": "gift_card_total",
                "type": "`null` \\| `number`",
                "description": "The total of the gift card of the line item",
                "optional": true,
                "defaultValue": "",
                "expandable": false,
                "children": []
              },
              {
                "name": "has_shipping",
                "type": "`null` \\| `boolean`",
                "description": "Flag to indicate if the Line Item has fulfillment associated with it.",
                "optional": false,
                "defaultValue": "",
                "expandable": false,
                "children": []
              },
              {
                "name": "id",
                "type": "`string`",
                "description": "The line item's ID",
                "optional": false,
                "defaultValue": "",
                "expandable": false,
                "children": []
              },
              {
                "name": "includes_tax",
                "type": "`boolean`",
                "description": "Indicates if the line item unit\\_price include tax",
                "optional": false,
                "defaultValue": "false",
                "expandable": false,
                "featureFlag": "tax_inclusive_pricing",
                "children": []
              },
              {
                "name": "is_giftcard",
                "type": "`boolean`",
                "description": "Flag to indicate if the Line Item is a Gift Card.",
                "optional": false,
                "defaultValue": "false",
                "expandable": false,
                "children": []
              },
              {
                "name": "is_return",
                "type": "`boolean`",
                "description": "Is the item being returned",
                "optional": false,
                "defaultValue": "false",
                "expandable": false,
                "children": []
              },
              {
                "name": "metadata",
                "type": "`Record<string, unknown>`",
                "description": "An optional key-value map with additional details",
                "optional": false,
                "defaultValue": "",
                "expandable": false,
                "children": []
              },
              {
                "name": "order",
                "type": "[Order](../../entities/classes/entities.Order.mdx)",
                "description": "The details of the order that the line item may belongs to.",
                "optional": false,
                "defaultValue": "",
                "expandable": true,
                "children": []
              },
              {
                "name": "order_edit",
                "type": "`null` \\| [OrderEdit](../../entities/classes/entities.OrderEdit.mdx)",
                "description": "The details of the order edit.",
                "optional": true,
                "defaultValue": "",
                "expandable": true,
                "children": []
              },
              {
                "name": "order_edit_id",
                "type": "`null` \\| `string`",
                "description": "The ID of the order edit that the item may belong to.",
                "optional": true,
                "defaultValue": "",
                "expandable": false,
                "children": []
              },
              {
                "name": "order_id",
                "type": "`null` \\| `string`",
                "description": "The ID of the order that the line item may belongs to.",
                "optional": false,
                "defaultValue": "",
                "expandable": false,
                "children": []
              },
              {
                "name": "original_item_id",
                "type": "`null` \\| `string`",
                "description": "The ID of the original line item. This is useful if the line item belongs to a resource that references an order, such as a return or an order edit.",
                "optional": true,
                "defaultValue": "",
                "expandable": false,
                "children": []
              },
              {
                "name": "original_tax_total",
                "type": "`null` \\| `number`",
                "description": "The original tax total amount of the line item",
                "optional": true,
                "defaultValue": "",
                "expandable": false,
                "children": []
              },
              {
                "name": "original_total",
                "type": "`null` \\| `number`",
                "description": "The original total amount of the line item",
                "optional": true,
                "defaultValue": "",
                "expandable": false,
                "children": []
              },
              {
                "name": "product_id",
                "type": "`null` \\| `string`",
                "description": "",
                "optional": false,
                "defaultValue": "",
                "expandable": false,
                "children": []
              },
              {
                "name": "quantity",
                "type": "`number`",
                "description": "The quantity of the content in the Line Item.",
                "optional": false,
                "defaultValue": "",
                "expandable": false,
                "children": []
              },
              {
                "name": "raw_discount_total",
                "type": "`null` \\| `number`",
                "description": "The total of discount of the line item",
                "optional": true,
                "defaultValue": "",
                "expandable": false,
                "children": []
              },
              {
                "name": "refundable",
                "type": "`null` \\| `number`",
                "description": "The amount that can be refunded from the given Line Item. Takes taxes and discounts into consideration.",
                "optional": true,
                "defaultValue": "",
                "expandable": false,
                "children": []
              },
              {
                "name": "returned_quantity",
                "type": "`null` \\| `number`",
                "description": "The quantity of the Line Item that has been returned.",
                "optional": false,
                "defaultValue": "",
                "expandable": false,
                "children": []
              },
              {
                "name": "shipped_quantity",
                "type": "`null` \\| `number`",
                "description": "The quantity of the Line Item that has been shipped.",
                "optional": false,
                "defaultValue": "",
                "expandable": false,
                "children": []
              },
              {
                "name": "should_merge",
                "type": "`boolean`",
                "description": "Flag to indicate if new Line Items with the same variant should be merged or added as an additional Line Item.",
                "optional": false,
                "defaultValue": "true",
                "expandable": false,
                "children": []
              },
              {
                "name": "subtotal",
                "type": "`null` \\| `number`",
                "description": "The subtotal of the line item",
                "optional": true,
                "defaultValue": "",
                "expandable": false,
                "children": []
              },
              {
                "name": "swap",
                "type": "[Swap](../../entities/classes/entities.Swap.mdx)",
                "description": "The details of the swap that the line item may belong to.",
                "optional": false,
                "defaultValue": "",
                "expandable": true,
                "children": []
              },
              {
                "name": "swap_id",
                "type": "`string`",
                "description": "The ID of the swap that the line item may belong to.",
                "optional": false,
                "defaultValue": "",
                "expandable": false,
                "children": []
              },
              {
                "name": "tax_lines",
                "type": "[LineItemTaxLine](../../entities/classes/entities.LineItemTaxLine.mdx)[]",
                "description": "The details of the item's tax lines.",
                "optional": false,
                "defaultValue": "",
                "expandable": true,
                "children": []
              },
              {
                "name": "tax_total",
                "type": "`null` \\| `number`",
                "description": "The total of tax of the line item",
                "optional": true,
                "defaultValue": "",
                "expandable": false,
                "children": []
              },
              {
                "name": "thumbnail",
                "type": "`null` \\| `string`",
                "description": "A URL string to a small image of the contents of the Line Item.",
                "optional": false,
                "defaultValue": "",
                "expandable": false,
                "children": []
              },
              {
                "name": "title",
                "type": "`string`",
                "description": "The title of the Line Item.",
                "optional": false,
                "defaultValue": "",
                "expandable": false,
                "children": []
              },
              {
                "name": "total",
                "type": "`null` \\| `number`",
                "description": "The total amount of the line item",
                "optional": true,
                "defaultValue": "",
                "expandable": false,
                "children": []
              },
              {
                "name": "unit_price",
                "type": "`number`",
                "description": "The price of one unit of the content in the Line Item. This should be in the currency defined by the Cart/Order/Swap/Claim that the Line Item belongs to.",
                "optional": false,
                "defaultValue": "",
                "expandable": false,
                "children": []
              },
              {
                "name": "updated_at",
                "type": "`Date`",
                "description": "The date with timezone at which the resource was updated.",
                "optional": false,
                "defaultValue": "",
                "expandable": false,
                "children": []
              },
              {
                "name": "variant",
                "type": "[ProductVariant](../../entities/classes/entities.ProductVariant.mdx)",
                "description": "The details of the product variant that this item was created from.",
                "optional": false,
                "defaultValue": "",
                "expandable": true,
                "children": []
              },
              {
                "name": "variant_id",
                "type": "`null` \\| `string`",
                "description": "The id of the Product Variant contained in the Line Item.",
                "optional": false,
                "defaultValue": "",
                "expandable": false,
                "children": []
              }
            ]
          },
          {
            "name": "returns",
            "type": "[Return](../../entities/classes/entities.Return.mdx)[]",
            "description": "The details of the returns created for the order.",
            "optional": false,
            "defaultValue": "",
            "expandable": true,
            "children": [
              {
                "name": "claim_order",
                "type": "[ClaimOrder](../../entities/classes/entities.ClaimOrder.mdx)",
                "description": "The details of the claim that the return may belong to.",
                "optional": false,
                "defaultValue": "",
                "expandable": true,
                "children": []
              },
              {
                "name": "claim_order_id",
                "type": "`null` \\| `string`",
                "description": "The ID of the claim that the return may belong to.",
                "optional": false,
                "defaultValue": "",
                "expandable": false,
                "children": []
              },
              {
                "name": "created_at",
                "type": "`Date`",
                "description": "The date with timezone at which the resource was created.",
                "optional": false,
                "defaultValue": "",
                "expandable": false,
                "children": []
              },
              {
                "name": "id",
                "type": "`string`",
                "description": "The return's ID",
                "optional": false,
                "defaultValue": "",
                "expandable": false,
                "children": []
              },
              {
                "name": "idempotency_key",
                "type": "`null` \\| `string`",
                "description": "Randomly generated key used to continue the completion of the return in case of failure.",
                "optional": false,
                "defaultValue": "",
                "expandable": false,
                "children": []
              },
              {
                "name": "items",
                "type": "[ReturnItem](../../entities/classes/entities.ReturnItem.mdx)[]",
                "description": "The details of the items that the customer is returning.",
                "optional": false,
                "defaultValue": "",
                "expandable": true,
                "children": []
              },
              {
                "name": "location_id",
                "type": "`null` \\| `string`",
                "description": "The ID of the stock location the return will be added back.",
                "optional": false,
                "defaultValue": "",
                "expandable": false,
                "children": []
              },
              {
                "name": "metadata",
                "type": "`null` \\| `Record<string, unknown>`",
                "description": "An optional key-value map with additional details",
                "optional": false,
                "defaultValue": "",
                "expandable": false,
                "children": []
              },
              {
                "name": "no_notification",
                "type": "`null` \\| `boolean`",
                "description": "When set to true, no notification will be sent related to this return.",
                "optional": false,
                "defaultValue": "",
                "expandable": false,
                "children": []
              },
              {
                "name": "order",
                "type": "[Order](../../entities/classes/entities.Order.mdx)",
                "description": "The details of the order that the return was created for.",
                "optional": false,
                "defaultValue": "",
                "expandable": true,
                "children": []
              },
              {
                "name": "order_id",
                "type": "`null` \\| `string`",
                "description": "The ID of the order that the return was created for.",
                "optional": false,
                "defaultValue": "",
                "expandable": false,
                "children": []
              },
              {
                "name": "received_at",
                "type": "`Date`",
                "description": "The date with timezone at which the return was received.",
                "optional": false,
                "defaultValue": "",
                "expandable": false,
                "children": []
              },
              {
                "name": "refund_amount",
                "type": "`number`",
                "description": "The amount that should be refunded as a result of the return.",
                "optional": false,
                "defaultValue": "",
                "expandable": false,
                "children": []
              },
              {
                "name": "shipping_data",
                "type": "`Record<string, unknown>`",
                "description": "Data about the return shipment as provided by the Fulfilment Provider that handles the return shipment.",
                "optional": false,
                "defaultValue": "",
                "expandable": false,
                "children": []
              },
              {
                "name": "shipping_method",
                "type": "[ShippingMethod](../../entities/classes/entities.ShippingMethod.mdx)",
                "description": "The details of the Shipping Method that will be used to send the Return back. Can be null if the Customer will handle the return shipment themselves.",
                "optional": false,
                "defaultValue": "",
                "expandable": true,
                "children": []
              },
              {
                "name": "status",
                "type": "[ReturnStatus](../../entities/enums/entities.ReturnStatus.mdx)",
                "description": "Status of the Return.",
                "optional": false,
                "defaultValue": "requested",
                "expandable": false,
                "children": []
              },
              {
                "name": "swap",
                "type": "[Swap](../../entities/classes/entities.Swap.mdx)",
                "description": "The details of the swap that the return may belong to.",
                "optional": false,
                "defaultValue": "",
                "expandable": true,
                "children": []
              },
              {
                "name": "swap_id",
                "type": "`null` \\| `string`",
                "description": "The ID of the swap that the return may belong to.",
                "optional": false,
                "defaultValue": "",
                "expandable": false,
                "children": []
              },
              {
                "name": "updated_at",
                "type": "`Date`",
                "description": "The date with timezone at which the resource was updated.",
                "optional": false,
                "defaultValue": "",
                "expandable": false,
                "children": []
              }
            ]
          },
          {
            "name": "sales_channel",
            "type": "[SalesChannel](../../entities/classes/entities.SalesChannel.mdx)",
            "description": "The details of the sales channel this order belongs to.",
            "optional": false,
            "defaultValue": "",
            "expandable": true,
            "children": [
              {
                "name": "created_at",
                "type": "`Date`",
                "description": "The date with timezone at which the resource was created.",
                "optional": false,
                "defaultValue": "",
                "expandable": false,
                "children": []
              },
              {
                "name": "deleted_at",
                "type": "`null` \\| `Date`",
                "description": "The date with timezone at which the resource was deleted.",
                "optional": false,
                "defaultValue": "",
                "expandable": false,
                "children": []
              },
              {
                "name": "description",
                "type": "`null` \\| `string`",
                "description": "The description of the sales channel.",
                "optional": false,
                "defaultValue": "",
                "expandable": false,
                "children": []
              },
              {
                "name": "id",
                "type": "`string`",
                "description": "The sales channel's ID",
                "optional": false,
                "defaultValue": "",
                "expandable": false,
                "children": []
              },
              {
                "name": "is_disabled",
                "type": "`boolean`",
                "description": "Specify if the sales channel is enabled or disabled.",
                "optional": false,
                "defaultValue": "false",
                "expandable": false,
                "children": []
              },
              {
                "name": "locations",
                "type": "[SalesChannelLocation](../../entities/classes/entities.SalesChannelLocation.mdx)[]",
                "description": "The details of the stock locations related to the sales channel.",
                "optional": false,
                "defaultValue": "",
                "expandable": true,
                "children": []
              },
              {
                "name": "metadata",
                "type": "`null` \\| `Record<string, unknown>`",
                "description": "An optional key-value map with additional details",
                "optional": false,
                "defaultValue": "",
                "expandable": false,
                "children": []
              },
              {
                "name": "name",
                "type": "`string`",
                "description": "The name of the sales channel.",
                "optional": false,
                "defaultValue": "",
                "expandable": false,
                "children": []
              },
              {
                "name": "updated_at",
                "type": "`Date`",
                "description": "The date with timezone at which the resource was updated.",
                "optional": false,
                "defaultValue": "",
                "expandable": false,
                "children": []
              }
            ]
          },
          {
            "name": "sales_channel_id",
            "type": "`null` \\| `string`",
            "description": "The ID of the sales channel this order belongs to.",
            "optional": false,
            "defaultValue": "",
            "expandable": false,
            "children": []
          },
          {
            "name": "shipping_address",
            "type": "[Address](../../entities/classes/entities.Address.mdx)",
            "description": "The details of the shipping address associated with the order.",
            "optional": false,
            "defaultValue": "",
            "expandable": true,
            "children": [
              {
                "name": "address_1",
                "type": "`null` \\| `string`",
                "description": "Address line 1",
                "optional": false,
                "defaultValue": "",
                "expandable": false,
                "children": []
              },
              {
                "name": "address_2",
                "type": "`null` \\| `string`",
                "description": "Address line 2",
                "optional": false,
                "defaultValue": "",
                "expandable": false,
                "children": []
              },
              {
                "name": "city",
                "type": "`null` \\| `string`",
                "description": "City",
                "optional": false,
                "defaultValue": "",
                "expandable": false,
                "children": []
              },
              {
                "name": "company",
                "type": "`null` \\| `string`",
                "description": "Company name",
                "optional": false,
                "defaultValue": "",
                "expandable": false,
                "children": []
              },
              {
                "name": "country",
                "type": "`null` \\| [Country](../../entities/classes/entities.Country.mdx)",
                "description": "A country object.",
                "optional": false,
                "defaultValue": "",
                "expandable": true,
                "children": []
              },
              {
                "name": "country_code",
                "type": "`null` \\| `string`",
                "description": "The 2 character ISO code of the country in lower case",
                "optional": false,
                "defaultValue": "",
                "expandable": false,
                "children": []
              },
              {
                "name": "created_at",
                "type": "`Date`",
                "description": "The date with timezone at which the resource was created.",
                "optional": false,
                "defaultValue": "",
                "expandable": false,
                "children": []
              },
              {
                "name": "customer",
                "type": "`null` \\| [Customer](../../entities/classes/entities.Customer.mdx)",
                "description": "Available if the relation `customer` is expanded.",
                "optional": false,
                "defaultValue": "",
                "expandable": false,
                "children": []
              },
              {
                "name": "customer_id",
                "type": "`null` \\| `string`",
                "description": "ID of the customer this address belongs to",
                "optional": false,
                "defaultValue": "",
                "expandable": false,
                "children": []
              },
              {
                "name": "deleted_at",
                "type": "`null` \\| `Date`",
                "description": "The date with timezone at which the resource was deleted.",
                "optional": false,
                "defaultValue": "",
                "expandable": false,
                "children": []
              },
              {
                "name": "first_name",
                "type": "`null` \\| `string`",
                "description": "First name",
                "optional": false,
                "defaultValue": "",
                "expandable": false,
                "children": []
              },
              {
                "name": "id",
                "type": "`string`",
                "description": "ID of the address",
                "optional": false,
                "defaultValue": "",
                "expandable": false,
                "children": []
              },
              {
                "name": "last_name",
                "type": "`null` \\| `string`",
                "description": "Last name",
                "optional": false,
                "defaultValue": "",
                "expandable": false,
                "children": []
              },
              {
                "name": "metadata",
                "type": "`Record<string, unknown>`",
                "description": "An optional key-value map with additional details",
                "optional": false,
                "defaultValue": "",
                "expandable": false,
                "children": []
              },
              {
                "name": "phone",
                "type": "`null` \\| `string`",
                "description": "Phone Number",
                "optional": false,
                "defaultValue": "",
                "expandable": false,
                "children": []
              },
              {
                "name": "postal_code",
                "type": "`null` \\| `string`",
                "description": "Postal Code",
                "optional": false,
                "defaultValue": "",
                "expandable": false,
                "children": []
              },
              {
                "name": "province",
                "type": "`null` \\| `string`",
                "description": "Province",
                "optional": false,
                "defaultValue": "",
                "expandable": false,
                "children": []
              },
              {
                "name": "updated_at",
                "type": "`Date`",
                "description": "The date with timezone at which the resource was updated.",
                "optional": false,
                "defaultValue": "",
                "expandable": false,
                "children": []
              }
            ]
          },
          {
            "name": "shipping_address_id",
            "type": "`string`",
            "description": "The ID of the shipping address associated with the order",
            "optional": false,
            "defaultValue": "",
            "expandable": false,
            "children": []
          },
          {
            "name": "shipping_methods",
            "type": "[ShippingMethod](../../entities/classes/entities.ShippingMethod.mdx)[]",
            "description": "The details of the shipping methods used in the order.",
            "optional": false,
            "defaultValue": "",
            "expandable": true,
            "children": [
              {
                "name": "cart",
                "type": "[Cart](../../entities/classes/entities.Cart.mdx)",
                "description": "The details of the cart that the shipping method is used in.",
                "optional": false,
                "defaultValue": "",
                "expandable": true,
                "children": []
              },
              {
                "name": "cart_id",
                "type": "`string`",
                "description": "The ID of the cart that the shipping method is used in.",
                "optional": false,
                "defaultValue": "",
                "expandable": false,
                "children": []
              },
              {
                "name": "claim_order",
                "type": "[ClaimOrder](../../entities/classes/entities.ClaimOrder.mdx)",
                "description": "The details of the claim that the shipping method is used in.",
                "optional": false,
                "defaultValue": "",
                "expandable": true,
                "children": []
              },
              {
                "name": "claim_order_id",
                "type": "`null` \\| `string`",
                "description": "The ID of the claim that the shipping method is used in.",
                "optional": false,
                "defaultValue": "",
                "expandable": false,
                "children": []
              },
              {
                "name": "data",
                "type": "`Record<string, unknown>`",
                "description": "Additional data that the Fulfillment Provider needs to fulfill the shipment. This is used in combination with the Shipping Options data, and may contain information such as a drop point id.",
                "optional": false,
                "defaultValue": "",
                "expandable": false,
                "children": []
              },
              {
                "name": "id",
                "type": "`string`",
                "description": "The shipping method's ID",
                "optional": false,
                "defaultValue": "",
                "expandable": false,
                "children": []
              },
              {
                "name": "includes_tax",
                "type": "`boolean`",
                "description": "Whether the shipping method price include tax",
                "optional": false,
                "defaultValue": "false",
                "expandable": false,
                "featureFlag": "tax_inclusive_pricing",
                "children": []
              },
              {
                "name": "order",
                "type": "[Order](../../entities/classes/entities.Order.mdx)",
                "description": "The details of the order that the shipping method is used in.",
                "optional": false,
                "defaultValue": "",
                "expandable": true,
                "children": []
              },
              {
                "name": "order_id",
                "type": "`string`",
                "description": "The ID of the order that the shipping method is used in.",
                "optional": false,
                "defaultValue": "",
                "expandable": false,
                "children": []
              },
              {
                "name": "price",
                "type": "`number`",
                "description": "The amount to charge for the Shipping Method. The currency of the price is defined by the Region that the Order that the Shipping Method belongs to is a part of.",
                "optional": false,
                "defaultValue": "",
                "expandable": false,
                "children": []
              },
              {
                "name": "return_id",
                "type": "`string`",
                "description": "The ID of the return that the shipping method is used in.",
                "optional": false,
                "defaultValue": "",
                "expandable": false,
                "children": []
              },
              {
                "name": "return_order",
                "type": "[Return](../../entities/classes/entities.Return.mdx)",
                "description": "The details of the return that the shipping method is used in.",
                "optional": false,
                "defaultValue": "",
                "expandable": true,
                "children": []
              },
              {
                "name": "shipping_option",
                "type": "[ShippingOption](../../entities/classes/entities.ShippingOption.mdx)",
                "description": "The details of the shipping option the method was created from.",
                "optional": false,
                "defaultValue": "",
                "expandable": true,
                "children": []
              },
              {
                "name": "shipping_option_id",
                "type": "`string`",
                "description": "The ID of the Shipping Option that the Shipping Method is built from.",
                "optional": false,
                "defaultValue": "",
                "expandable": false,
                "children": []
              },
              {
                "name": "subtotal",
                "type": "`number`",
                "description": "The subtotal of the shipping",
                "optional": true,
                "defaultValue": "",
                "expandable": false,
                "children": []
              },
              {
                "name": "swap",
                "type": "[Swap](../../entities/classes/entities.Swap.mdx)",
                "description": "The details of the swap that the shipping method is used in.",
                "optional": false,
                "defaultValue": "",
                "expandable": true,
                "children": []
              },
              {
                "name": "swap_id",
                "type": "`string`",
                "description": "The ID of the swap that the shipping method is used in.",
                "optional": false,
                "defaultValue": "",
                "expandable": false,
                "children": []
              },
              {
                "name": "tax_lines",
                "type": "[ShippingMethodTaxLine](../../entities/classes/entities.ShippingMethodTaxLine.mdx)[]",
                "description": "The details of the tax lines applied on the shipping method.",
                "optional": false,
                "defaultValue": "",
                "expandable": true,
                "children": []
              },
              {
                "name": "tax_total",
                "type": "`number`",
                "description": "The total of tax",
                "optional": true,
                "defaultValue": "",
                "expandable": false,
                "children": []
              },
              {
                "name": "total",
                "type": "`number`",
                "description": "The total amount of the shipping",
                "optional": true,
                "defaultValue": "",
                "expandable": false,
                "children": []
              }
            ]
          },
          {
            "name": "shipping_tax_total",
            "type": "`null` \\| `number`",
            "description": "The tax total applied on shipping",
            "optional": false,
            "defaultValue": "",
            "expandable": false,
            "children": []
          },
          {
            "name": "shipping_total",
            "type": "`number`",
            "description": "The total of shipping",
            "optional": false,
            "defaultValue": "",
            "expandable": false,
            "children": []
          },
          {
            "name": "status",
            "type": "[OrderStatus](../../entities/enums/entities.OrderStatus.mdx)",
            "description": "The order's status",
            "optional": false,
            "defaultValue": "pending",
            "expandable": false,
            "children": [
              {
                "name": "ARCHIVED",
                "type": "`\"archived\"`",
                "description": "The order is archived.",
                "optional": true,
                "defaultValue": "",
                "expandable": false,
                "children": []
              },
              {
                "name": "CANCELED",
                "type": "`\"canceled\"`",
                "description": "The order is canceled.",
                "optional": true,
                "defaultValue": "",
                "expandable": false,
                "children": []
              },
              {
                "name": "COMPLETED",
                "type": "`\"completed\"`",
                "description": "The order is completed, meaning that \nthe items have been fulfilled and the payment\nhas been captured.",
                "optional": true,
                "defaultValue": "",
                "expandable": false,
                "children": []
              },
              {
                "name": "PENDING",
                "type": "`\"pending\"`",
                "description": "The order is pending.",
                "optional": true,
                "defaultValue": "",
                "expandable": false,
                "children": []
              },
              {
                "name": "REQUIRES_ACTION",
                "type": "`\"requires_action\"`",
                "description": "The order requires action.",
                "optional": true,
                "defaultValue": "",
                "expandable": false,
                "children": []
              }
            ]
          },
          {
            "name": "subtotal",
            "type": "`number`",
            "description": "The subtotal of the order",
            "optional": false,
            "defaultValue": "",
            "expandable": false,
            "children": []
          },
          {
            "name": "swaps",
            "type": "[Swap](../../entities/classes/entities.Swap.mdx)[]",
            "description": "The details of the swaps created for the order.",
            "optional": false,
            "defaultValue": "",
            "expandable": true,
            "children": [
              {
                "name": "additional_items",
                "type": "[LineItem](../../entities/classes/entities.LineItem.mdx)[]",
                "description": "The details of the new products to send to the customer, represented as line items.",
                "optional": false,
                "defaultValue": "",
                "expandable": true,
                "children": []
              },
              {
                "name": "allow_backorder",
                "type": "`boolean`",
                "description": "If true, swaps can be completed with items out of stock",
                "optional": false,
                "defaultValue": "false",
                "expandable": false,
                "children": []
              },
              {
                "name": "canceled_at",
                "type": "`Date`",
                "description": "The date with timezone at which the Swap was canceled.",
                "optional": false,
                "defaultValue": "",
                "expandable": false,
                "children": []
              },
              {
                "name": "cart",
                "type": "[Cart](../../entities/classes/entities.Cart.mdx)",
                "description": "The details of the cart that the customer uses to complete the swap.",
                "optional": false,
                "defaultValue": "",
                "expandable": true,
                "children": []
              },
              {
                "name": "cart_id",
                "type": "`string`",
                "description": "The ID of the cart that the customer uses to complete the swap.",
                "optional": false,
                "defaultValue": "",
                "expandable": false,
                "children": []
              },
              {
                "name": "confirmed_at",
                "type": "`Date`",
                "description": "The date with timezone at which the Swap was confirmed by the Customer.",
                "optional": false,
                "defaultValue": "",
                "expandable": false,
                "children": []
              },
              {
                "name": "created_at",
                "type": "`Date`",
                "description": "The date with timezone at which the resource was created.",
                "optional": false,
                "defaultValue": "",
                "expandable": false,
                "children": []
              },
              {
                "name": "deleted_at",
                "type": "`null` \\| `Date`",
                "description": "The date with timezone at which the resource was deleted.",
                "optional": false,
                "defaultValue": "",
                "expandable": false,
                "children": []
              },
              {
                "name": "difference_due",
                "type": "`number`",
                "description": "The difference amount between the order’s original total and the new total imposed by the swap. If its value is negative, a refund must be issues to the customer. If it's positive, additional payment must be authorized by the customer. Otherwise, no payment processing is required.",
                "optional": false,
                "defaultValue": "",
                "expandable": false,
                "children": []
              },
              {
                "name": "fulfillment_status",
                "type": "[SwapFulfillmentStatus](../../entities/enums/entities.SwapFulfillmentStatus.mdx)",
                "description": "The status of the Fulfillment of the Swap.",
                "optional": false,
                "defaultValue": "",
                "expandable": false,
                "children": []
              },
              {
                "name": "fulfillments",
                "type": "[Fulfillment](../../entities/classes/entities.Fulfillment.mdx)[]",
                "description": "The details of the fulfillments that are used to send the new items to the customer.",
                "optional": false,
                "defaultValue": "",
                "expandable": true,
                "children": []
              },
              {
                "name": "id",
                "type": "`string`",
                "description": "The swap's ID",
                "optional": false,
                "defaultValue": "",
                "expandable": false,
                "children": []
              },
              {
                "name": "idempotency_key",
                "type": "`string`",
                "description": "Randomly generated key used to continue the completion of the swap in case of failure.",
                "optional": false,
                "defaultValue": "",
                "expandable": false,
                "children": []
              },
              {
                "name": "metadata",
                "type": "`Record<string, unknown>`",
                "description": "An optional key-value map with additional details",
                "optional": false,
                "defaultValue": "",
                "expandable": false,
                "children": []
              },
              {
                "name": "no_notification",
                "type": "`boolean`",
                "description": "If set to true, no notification will be sent related to this swap",
                "optional": false,
                "defaultValue": "",
                "expandable": false,
                "children": []
              },
              {
                "name": "order",
                "type": "[Order](../../entities/classes/entities.Order.mdx)",
                "description": "The details of the order that the swap belongs to.",
                "optional": false,
                "defaultValue": "",
                "expandable": true,
                "children": []
              },
              {
                "name": "order_id",
                "type": "`string`",
                "description": "The ID of the order that the swap belongs to.",
                "optional": false,
                "defaultValue": "",
                "expandable": false,
                "children": []
              },
              {
                "name": "payment",
                "type": "[Payment](../../entities/classes/entities.Payment.mdx)",
                "description": "The details of the additional payment authorized by the customer when `difference\\_due` is positive.",
                "optional": false,
                "defaultValue": "",
                "expandable": true,
                "children": []
              },
              {
                "name": "payment_status",
                "type": "[SwapPaymentStatus](../../entities/enums/entities.SwapPaymentStatus.mdx)",
                "description": "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.",
                "optional": false,
                "defaultValue": "",
                "expandable": false,
                "children": []
              },
              {
                "name": "return_order",
                "type": "[Return](../../entities/classes/entities.Return.mdx)",
                "description": "The details of the return that belongs to the swap, which holds the details on the items being returned.",
                "optional": false,
                "defaultValue": "",
                "expandable": true,
                "children": []
              },
              {
                "name": "shipping_address",
                "type": "[Address](../../entities/classes/entities.Address.mdx)",
                "description": "The details of the shipping address that the new items should be sent to.",
                "optional": false,
                "defaultValue": "",
                "expandable": true,
                "children": []
              },
              {
                "name": "shipping_address_id",
                "type": "`string`",
                "description": "The Address to send the new Line Items to - in most cases this will be the same as the shipping address on the Order.",
                "optional": false,
                "defaultValue": "",
                "expandable": false,
                "children": []
              },
              {
                "name": "shipping_methods",
                "type": "[ShippingMethod](../../entities/classes/entities.ShippingMethod.mdx)[]",
                "description": "The details of the shipping methods used to fulfill the additional items purchased.",
                "optional": false,
                "defaultValue": "",
                "expandable": true,
                "children": []
              },
              {
                "name": "updated_at",
                "type": "`Date`",
                "description": "The date with timezone at which the resource was updated.",
                "optional": false,
                "defaultValue": "",
                "expandable": false,
                "children": []
              }
            ]
          },
          {
            "name": "tax_rate",
            "type": "`null` \\| `number`",
            "description": "The order's tax rate",
            "optional": false,
            "defaultValue": "",
            "expandable": false,
            "children": []
          },
          {
            "name": "tax_total",
            "type": "`null` \\| `number`",
            "description": "The total of tax",
            "optional": false,
            "defaultValue": "",
            "expandable": false,
            "children": []
          },
          {
            "name": "total",
            "type": "`number`",
            "description": "The total amount of the order",
            "optional": false,
            "defaultValue": "",
            "expandable": false,
            "children": []
          },
          {
            "name": "updated_at",
            "type": "`Date`",
            "description": "The date with timezone at which the resource was updated.",
            "optional": false,
            "defaultValue": "",
            "expandable": false,
            "children": []
          }
        ]
      }
    ]
  }
]} />

___

### requestCustomerOrders

Allow the logged-in customer to claim ownership of one or more orders. This generates a token that can be used later on to verify the claim using the [confirmRequest](js_client.OrdersResource.mdx#confirmrequest) method.
This also emits the event `order-update-token.created`. So, if you have a notification provider installed that handles this event and sends the customer a notification, such as an email,
the customer should receive instructions on how to finalize their claim ownership.

#### Example

```ts
import Medusa from "@medusajs/medusa-js"
const medusa = new Medusa({ baseUrl: MEDUSA_BACKEND_URL, maxRetries: 3 })
// must be previously logged in or use api token
medusa.orders.requestCustomerOrders({
  order_ids,
})
.then(() => {
  // successful
})
.catch(() => {
  // an error occurred
})
```

#### Parameters

<ParameterTypes parameters={[
  {
    "name": "payload",
    "type": "[StorePostCustomersCustomerOrderClaimReq](../../medusa/classes/medusa.StorePostCustomersCustomerOrderClaimReq.mdx)",
    "description": "The orders to claim.",
    "optional": false,
    "defaultValue": "",
    "expandable": false,
    "children": [
      {
        "name": "order_ids",
        "type": "`string`[]",
        "description": "The ID of the orders to claim",
        "optional": false,
        "defaultValue": "",
        "expandable": false,
        "children": []
      }
    ]
  },
  {
    "name": "customHeaders",
    "type": "`Record<string, any>`",
    "description": "Custom headers to attach to the request.",
    "optional": false,
    "defaultValue": "{}",
    "expandable": false,
    "children": []
  }
]} expandUrl="https://docs.medusajs.com/js-client/overview#expanding-fields"/>

#### Returns

<ParameterTypes parameters={[
  {
    "name": "ResponsePromise",
    "type": "`ResponsePromise`",
    "optional": false,
    "defaultValue": "",
    "description": "Resolves when the request is created successfully.",
    "expandable": false,
    "children": []
  }
]} />

___

### retrieve

Retrieve an Order's details.

#### Example

```ts
import Medusa from "@medusajs/medusa-js"
const medusa = new Medusa({ baseUrl: MEDUSA_BACKEND_URL, maxRetries: 3 })
medusa.orders.retrieve(orderId)
.then(({ order }) => {
  console.log(order.id);
})
```

#### Parameters

<ParameterTypes parameters={[
  {
    "name": "id",
    "type": "`string`",
    "description": "The order's ID.",
    "optional": false,
    "defaultValue": "",
    "expandable": false,
    "children": []
  },
  {
    "name": "customHeaders",
    "type": "`Record<string, any>`",
    "description": "Custom headers to attach to the request.",
    "optional": false,
    "defaultValue": "{}",
    "expandable": false,
    "children": []
  }
]} expandUrl="https://docs.medusajs.com/js-client/overview#expanding-fields"/>

#### Returns

<ParameterTypes parameters={[
  {
    "name": "ResponsePromise",
    "type": "ResponsePromise&#60;StoreOrdersRes&#62;",
    "optional": false,
    "defaultValue": "",
    "description": "Resolves to the details of the order.",
    "expandable": false,
    "children": [
      {
        "name": "order",
        "type": "[Order](../../entities/classes/entities.Order.mdx)",
        "description": "Order details.",
        "optional": false,
        "defaultValue": "",
        "expandable": false,
        "children": [
          {
            "name": "billing_address",
            "type": "[Address](../../entities/classes/entities.Address.mdx)",
            "description": "The details of the billing address associated with the order.",
            "optional": false,
            "defaultValue": "",
            "expandable": true,
            "children": [
              {
                "name": "address_1",
                "type": "`null` \\| `string`",
                "description": "Address line 1",
                "optional": false,
                "defaultValue": "",
                "expandable": false,
                "children": []
              },
              {
                "name": "address_2",
                "type": "`null` \\| `string`",
                "description": "Address line 2",
                "optional": false,
                "defaultValue": "",
                "expandable": false,
                "children": []
              },
              {
                "name": "city",
                "type": "`null` \\| `string`",
                "description": "City",
                "optional": false,
                "defaultValue": "",
                "expandable": false,
                "children": []
              },
              {
                "name": "company",
                "type": "`null` \\| `string`",
                "description": "Company name",
                "optional": false,
                "defaultValue": "",
                "expandable": false,
                "children": []
              },
              {
                "name": "country",
                "type": "`null` \\| [Country](../../entities/classes/entities.Country.mdx)",
                "description": "A country object.",
                "optional": false,
                "defaultValue": "",
                "expandable": true,
                "children": []
              },
              {
                "name": "country_code",
                "type": "`null` \\| `string`",
                "description": "The 2 character ISO code of the country in lower case",
                "optional": false,
                "defaultValue": "",
                "expandable": false,
                "children": []
              },
              {
                "name": "created_at",
                "type": "`Date`",
                "description": "The date with timezone at which the resource was created.",
                "optional": false,
                "defaultValue": "",
                "expandable": false,
                "children": []
              },
              {
                "name": "customer",
                "type": "`null` \\| [Customer](../../entities/classes/entities.Customer.mdx)",
                "description": "Available if the relation `customer` is expanded.",
                "optional": false,
                "defaultValue": "",
                "expandable": false,
                "children": []
              },
              {
                "name": "customer_id",
                "type": "`null` \\| `string`",
                "description": "ID of the customer this address belongs to",
                "optional": false,
                "defaultValue": "",
                "expandable": false,
                "children": []
              },
              {
                "name": "deleted_at",
                "type": "`null` \\| `Date`",
                "description": "The date with timezone at which the resource was deleted.",
                "optional": false,
                "defaultValue": "",
                "expandable": false,
                "children": []
              },
              {
                "name": "first_name",
                "type": "`null` \\| `string`",
                "description": "First name",
                "optional": false,
                "defaultValue": "",
                "expandable": false,
                "children": []
              },
              {
                "name": "id",
                "type": "`string`",
                "description": "ID of the address",
                "optional": false,
                "defaultValue": "",
                "expandable": false,
                "children": []
              },
              {
                "name": "last_name",
                "type": "`null` \\| `string`",
                "description": "Last name",
                "optional": false,
                "defaultValue": "",
                "expandable": false,
                "children": []
              },
              {
                "name": "metadata",
                "type": "`Record<string, unknown>`",
                "description": "An optional key-value map with additional details",
                "optional": false,
                "defaultValue": "",
                "expandable": false,
                "children": []
              },
              {
                "name": "phone",
                "type": "`null` \\| `string`",
                "description": "Phone Number",
                "optional": false,
                "defaultValue": "",
                "expandable": false,
                "children": []
              },
              {
                "name": "postal_code",
                "type": "`null` \\| `string`",
                "description": "Postal Code",
                "optional": false,
                "defaultValue": "",
                "expandable": false,
                "children": []
              },
              {
                "name": "province",
                "type": "`null` \\| `string`",
                "description": "Province",
                "optional": false,
                "defaultValue": "",
                "expandable": false,
                "children": []
              },
              {
                "name": "updated_at",
                "type": "`Date`",
                "description": "The date with timezone at which the resource was updated.",
                "optional": false,
                "defaultValue": "",
                "expandable": false,
                "children": []
              }
            ]
          },
          {
            "name": "billing_address_id",
            "type": "`string`",
            "description": "The ID of the billing address associated with the order",
            "optional": false,
            "defaultValue": "",
            "expandable": false,
            "children": []
          },
          {
            "name": "canceled_at",
            "type": "`Date`",
            "description": "The date the order was canceled on.",
            "optional": false,
            "defaultValue": "",
            "expandable": false,
            "children": []
          },
          {
            "name": "cart",
            "type": "[Cart](../../entities/classes/entities.Cart.mdx)",
            "description": "The details of the cart associated with the order.",
            "optional": false,
            "defaultValue": "",
            "expandable": true,
            "children": [
              {
                "name": "billing_address",
                "type": "[Address](../../entities/classes/entities.Address.mdx)",
                "description": "The details of the billing address associated with the cart.",
                "optional": false,
                "defaultValue": "",
                "expandable": true,
                "children": []
              },
              {
                "name": "billing_address_id",
                "type": "`string`",
                "description": "The billing address's ID",
                "optional": false,
                "defaultValue": "",
                "expandable": false,
                "children": []
              },
              {
                "name": "completed_at",
                "type": "`Date`",
                "description": "The date with timezone at which the cart was completed.",
                "optional": false,
                "defaultValue": "",
                "expandable": false,
                "children": []
              },
              {
                "name": "context",
                "type": "`Record<string, unknown>`",
                "description": "The context of the cart which can include info like IP or user agent.",
                "optional": false,
                "defaultValue": "",
                "expandable": false,
                "children": []
              },
              {
                "name": "created_at",
                "type": "`Date`",
                "description": "The date with timezone at which the resource was created.",
                "optional": false,
                "defaultValue": "",
                "expandable": false,
                "children": []
              },
              {
                "name": "customer",
                "type": "[Customer](../../entities/classes/entities.Customer.mdx)",
                "description": "The details of the customer the cart belongs to.",
                "optional": false,
                "defaultValue": "",
                "expandable": true,
                "children": []
              },
              {
                "name": "customer_id",
                "type": "`string`",
                "description": "The customer's ID",
                "optional": false,
                "defaultValue": "",
                "expandable": false,
                "children": []
              },
              {
                "name": "deleted_at",
                "type": "`null` \\| `Date`",
                "description": "The date with timezone at which the resource was deleted.",
                "optional": false,
                "defaultValue": "",
                "expandable": false,
                "children": []
              },
              {
                "name": "discount_total",
                "type": "`number`",
                "description": "The total of discount rounded",
                "optional": true,
                "defaultValue": "",
                "expandable": false,
                "children": []
              },
              {
                "name": "discounts",
                "type": "[Discount](../../entities/classes/entities.Discount.mdx)[]",
                "description": "An array of details of all discounts applied to the cart.",
                "optional": false,
                "defaultValue": "",
                "expandable": true,
                "children": []
              },
              {
                "name": "email",
                "type": "`string`",
                "description": "The email associated with the cart",
                "optional": false,
                "defaultValue": "",
                "expandable": false,
                "children": []
              },
              {
                "name": "gift_card_tax_total",
                "type": "`number`",
                "description": "The total of gift cards with taxes",
                "optional": true,
                "defaultValue": "",
                "expandable": false,
                "children": []
              },
              {
                "name": "gift_card_total",
                "type": "`number`",
                "description": "The total of gift cards",
                "optional": true,
                "defaultValue": "",
                "expandable": false,
                "children": []
              },
              {
                "name": "gift_cards",
                "type": "[GiftCard](../../entities/classes/entities.GiftCard.mdx)[]",
                "description": "An array of details of all gift cards applied to the cart.",
                "optional": false,
                "defaultValue": "",
                "expandable": true,
                "children": []
              },
              {
                "name": "id",
                "type": "`string`",
                "description": "The cart's ID",
                "optional": false,
                "defaultValue": "",
                "expandable": false,
                "children": []
              },
              {
                "name": "idempotency_key",
                "type": "`string`",
                "description": "Randomly generated key used to continue the completion of a cart in case of failure.",
                "optional": false,
                "defaultValue": "",
                "expandable": false,
                "children": []
              },
              {
                "name": "item_tax_total",
                "type": "`null` \\| `number`",
                "description": "The total of items with taxes",
                "optional": true,
                "defaultValue": "",
                "expandable": false,
                "children": []
              },
              {
                "name": "items",
                "type": "[LineItem](../../entities/classes/entities.LineItem.mdx)[]",
                "description": "The line items added to the cart.",
                "optional": false,
                "defaultValue": "",
                "expandable": true,
                "children": []
              },
              {
                "name": "metadata",
                "type": "`Record<string, unknown>`",
                "description": "An optional key-value map with additional details",
                "optional": false,
                "defaultValue": "",
                "expandable": false,
                "children": []
              },
              {
                "name": "object",
                "type": "`\"cart\"`",
                "description": "",
                "optional": false,
                "defaultValue": "\"cart\"",
                "expandable": false,
                "children": []
              },
              {
                "name": "payment",
                "type": "[Payment](../../entities/classes/entities.Payment.mdx)",
                "description": "The details of the payment associated with the cart.",
                "optional": false,
                "defaultValue": "",
                "expandable": true,
                "children": []
              },
              {
                "name": "payment_authorized_at",
                "type": "`Date`",
                "description": "The date with timezone at which the payment was authorized.",
                "optional": false,
                "defaultValue": "",
                "expandable": false,
                "children": []
              },
              {
                "name": "payment_id",
                "type": "`string`",
                "description": "The payment's ID if available",
                "optional": false,
                "defaultValue": "",
                "expandable": false,
                "children": []
              },
              {
                "name": "payment_session",
                "type": "`null` \\| [PaymentSession](../../entities/classes/entities.PaymentSession.mdx)",
                "description": "The details of the selected payment session in the cart.",
                "optional": false,
                "defaultValue": "",
                "expandable": true,
                "children": []
              },
              {
                "name": "payment_sessions",
                "type": "[PaymentSession](../../entities/classes/entities.PaymentSession.mdx)[]",
                "description": "The details of all payment sessions created on the cart.",
                "optional": false,
                "defaultValue": "",
                "expandable": true,
                "children": []
              },
              {
                "name": "raw_discount_total",
                "type": "`number`",
                "description": "The total of discount",
                "optional": true,
                "defaultValue": "",
                "expandable": false,
                "children": []
              },
              {
                "name": "refundable_amount",
                "type": "`number`",
                "description": "The amount that can be refunded",
                "optional": true,
                "defaultValue": "",
                "expandable": false,
                "children": []
              },
              {
                "name": "refunded_total",
                "type": "`number`",
                "description": "The total amount refunded if the order associated with this cart is returned.",
                "optional": true,
                "defaultValue": "",
                "expandable": false,
                "children": []
              },
              {
                "name": "region",
                "type": "[Region](../../entities/classes/entities.Region.mdx)",
                "description": "The details of the region associated with the cart.",
                "optional": false,
                "defaultValue": "",
                "expandable": true,
                "children": []
              },
              {
                "name": "region_id",
                "type": "`string`",
                "description": "The region's ID",
                "optional": false,
                "defaultValue": "",
                "expandable": false,
                "children": []
              },
              {
                "name": "sales_channel",
                "type": "[SalesChannel](../../entities/classes/entities.SalesChannel.mdx)",
                "description": "The details of the sales channel associated with the cart.",
                "optional": false,
                "defaultValue": "",
                "expandable": true,
                "children": []
              },
              {
                "name": "sales_channel_id",
                "type": "`null` \\| `string`",
                "description": "The sales channel ID the cart is associated with.",
                "optional": false,
                "defaultValue": "",
                "expandable": false,
                "children": []
              },
              {
                "name": "shipping_address",
                "type": "`null` \\| [Address](../../entities/classes/entities.Address.mdx)",
                "description": "The details of the shipping address associated with the cart.",
                "optional": false,
                "defaultValue": "",
                "expandable": true,
                "children": []
              },
              {
                "name": "shipping_address_id",
                "type": "`string`",
                "description": "The shipping address's ID",
                "optional": false,
                "defaultValue": "",
                "expandable": false,
                "children": []
              },
              {
                "name": "shipping_methods",
                "type": "[ShippingMethod](../../entities/classes/entities.ShippingMethod.mdx)[]",
                "description": "The details of the shipping methods added to the cart.",
                "optional": false,
                "defaultValue": "",
                "expandable": true,
                "children": []
              },
              {
                "name": "shipping_tax_total",
                "type": "`null` \\| `number`",
                "description": "The total of shipping with taxes",
                "optional": true,
                "defaultValue": "",
                "expandable": false,
                "children": []
              },
              {
                "name": "shipping_total",
                "type": "`number`",
                "description": "The total of shipping",
                "optional": true,
                "defaultValue": "",
                "expandable": false,
                "children": []
              },
              {
                "name": "subtotal",
                "type": "`number`",
                "description": "The subtotal of the cart",
                "optional": true,
                "defaultValue": "",
                "expandable": false,
                "children": []
              },
              {
                "name": "tax_total",
                "type": "`null` \\| `number`",
                "description": "The total of tax",
                "optional": true,
                "defaultValue": "",
                "expandable": false,
                "children": []
              },
              {
                "name": "total",
                "type": "`number`",
                "description": "The total amount of the cart",
                "optional": true,
                "defaultValue": "",
                "expandable": false,
                "children": []
              },
              {
                "name": "type",
                "type": "[CartType](../../entities/enums/entities.CartType.mdx)",
                "description": "The cart's type.",
                "optional": false,
                "defaultValue": "default",
                "expandable": false,
                "children": []
              },
              {
                "name": "updated_at",
                "type": "`Date`",
                "description": "The date with timezone at which the resource was updated.",
                "optional": false,
                "defaultValue": "",
                "expandable": false,
                "children": []
              }
            ]
          },
          {
            "name": "cart_id",
            "type": "`string`",
            "description": "The ID of the cart associated with the order",
            "optional": false,
            "defaultValue": "",
            "expandable": false,
            "children": []
          },
          {
            "name": "claims",
            "type": "[ClaimOrder](../../entities/classes/entities.ClaimOrder.mdx)[]",
            "description": "The details of the claims created for the order.",
            "optional": false,
            "defaultValue": "",
            "expandable": true,
            "children": [
              {
                "name": "additional_items",
                "type": "[LineItem](../../entities/classes/entities.LineItem.mdx)[]",
                "description": "The details of the new items to be shipped when the claim's type is `replace`",
                "optional": false,
                "defaultValue": "",
                "expandable": true,
                "children": []
              },
              {
                "name": "canceled_at",
                "type": "`Date`",
                "description": "The date with timezone at which the claim was canceled.",
                "optional": false,
                "defaultValue": "",
                "expandable": false,
                "children": []
              },
              {
                "name": "claim_items",
                "type": "[ClaimItem](../../entities/classes/entities.ClaimItem.mdx)[]",
                "description": "The details of the items that should be replaced or refunded.",
                "optional": false,
                "defaultValue": "",
                "expandable": true,
                "children": []
              },
              {
                "name": "created_at",
                "type": "`Date`",
                "description": "The date with timezone at which the resource was created.",
                "optional": false,
                "defaultValue": "",
                "expandable": false,
                "children": []
              },
              {
                "name": "deleted_at",
                "type": "`Date`",
                "description": "The date with timezone at which the resource was deleted.",
                "optional": false,
                "defaultValue": "",
                "expandable": false,
                "children": []
              },
              {
                "name": "fulfillment_status",
                "type": "[ClaimFulfillmentStatus](../../entities/enums/entities.ClaimFulfillmentStatus.mdx)",
                "description": "The claim's fulfillment status",
                "optional": false,
                "defaultValue": "not_fulfilled",
                "expandable": false,
                "children": []
              },
              {
                "name": "fulfillments",
                "type": "[Fulfillment](../../entities/classes/entities.Fulfillment.mdx)[]",
                "description": "The fulfillments of the new items to be shipped",
                "optional": false,
                "defaultValue": "",
                "expandable": true,
                "children": []
              },
              {
                "name": "id",
                "type": "`string`",
                "description": "The claim's ID",
                "optional": false,
                "defaultValue": "",
                "expandable": false,
                "children": []
              },
              {
                "name": "idempotency_key",
                "type": "`string`",
                "description": "Randomly generated key used to continue the completion of the cart associated with the claim in case of failure.",
                "optional": false,
                "defaultValue": "",
                "expandable": false,
                "children": []
              },
              {
                "name": "metadata",
                "type": "`Record<string, unknown>`",
                "description": "An optional key-value map with additional details",
                "optional": false,
                "defaultValue": "",
                "expandable": false,
                "children": []
              },
              {
                "name": "no_notification",
                "type": "`boolean`",
                "description": "Flag for describing whether or not notifications related to this should be send.",
                "optional": false,
                "defaultValue": "",
                "expandable": false,
                "children": []
              },
              {
                "name": "order",
                "type": "[Order](../../entities/classes/entities.Order.mdx)",
                "description": "The details of the order that this claim was created for.",
                "optional": false,
                "defaultValue": "",
                "expandable": true,
                "children": []
              },
              {
                "name": "order_id",
                "type": "`string`",
                "description": "The ID of the order that the claim comes from.",
                "optional": false,
                "defaultValue": "",
                "expandable": false,
                "children": []
              },
              {
                "name": "payment_status",
                "type": "[ClaimPaymentStatus](../../entities/enums/entities.ClaimPaymentStatus.mdx)",
                "description": "The status of the claim's payment",
                "optional": false,
                "defaultValue": "na",
                "expandable": false,
                "children": []
              },
              {
                "name": "refund_amount",
                "type": "`number`",
                "description": "The amount that will be refunded in conjunction with the claim",
                "optional": false,
                "defaultValue": "",
                "expandable": false,
                "children": []
              },
              {
                "name": "return_order",
                "type": "[Return](../../entities/classes/entities.Return.mdx)",
                "description": "The details of the return associated with the claim if the claim's type is `replace`.",
                "optional": false,
                "defaultValue": "",
                "expandable": true,
                "children": []
              },
              {
                "name": "shipping_address",
                "type": "[Address](../../entities/classes/entities.Address.mdx)",
                "description": "The details of the address that new items should be shipped to.",
                "optional": false,
                "defaultValue": "",
                "expandable": true,
                "children": []
              },
              {
                "name": "shipping_address_id",
                "type": "`string`",
                "description": "The ID of the address that the new items should be shipped to",
                "optional": false,
                "defaultValue": "",
                "expandable": false,
                "children": []
              },
              {
                "name": "shipping_methods",
                "type": "[ShippingMethod](../../entities/classes/entities.ShippingMethod.mdx)[]",
                "description": "The details of the shipping methods that the claim order will be shipped with.",
                "optional": false,
                "defaultValue": "",
                "expandable": true,
                "children": []
              },
              {
                "name": "type",
                "type": "[ClaimType](../../entities/enums/entities.ClaimType.mdx)",
                "description": "The claim's type",
                "optional": false,
                "defaultValue": "",
                "expandable": false,
                "children": []
              },
              {
                "name": "updated_at",
                "type": "`Date`",
                "description": "The date with timezone at which the resource was updated.",
                "optional": false,
                "defaultValue": "",
                "expandable": false,
                "children": []
              }
            ]
          },
          {
            "name": "created_at",
            "type": "`Date`",
            "description": "The date with timezone at which the resource was created.",
            "optional": false,
            "defaultValue": "",
            "expandable": false,
            "children": []
          },
          {
            "name": "currency",
            "type": "[Currency](../../entities/classes/entities.Currency.mdx)",
            "description": "The details of the currency used in the order.",
            "optional": false,
            "defaultValue": "",
            "expandable": true,
            "children": [
              {
                "name": "code",
                "type": "`string`",
                "description": "The 3 character ISO code for the currency.",
                "optional": false,
                "defaultValue": "",
                "expandable": false,
                "children": []
              },
              {
                "name": "includes_tax",
                "type": "`boolean`",
                "description": "Whether the currency prices include tax",
                "optional": true,
                "defaultValue": "false",
                "expandable": false,
                "featureFlag": "tax_inclusive_pricing",
                "children": []
              },
              {
                "name": "name",
                "type": "`string`",
                "description": "The written name of the currency",
                "optional": false,
                "defaultValue": "",
                "expandable": false,
                "children": []
              },
              {
                "name": "symbol",
                "type": "`string`",
                "description": "The symbol used to indicate the currency.",
                "optional": false,
                "defaultValue": "",
                "expandable": false,
                "children": []
              },
              {
                "name": "symbol_native",
                "type": "`string`",
                "description": "The native symbol used to indicate the currency.",
                "optional": false,
                "defaultValue": "",
                "expandable": false,
                "children": []
              }
            ]
          },
          {
            "name": "currency_code",
            "type": "`string`",
            "description": "The 3 character currency code that is used in the order",
            "optional": false,
            "defaultValue": "",
            "expandable": false,
            "children": []
          },
          {
            "name": "customer",
            "type": "[Customer](../../entities/classes/entities.Customer.mdx)",
            "description": "The details of the customer associated with the order.",
            "optional": false,
            "defaultValue": "",
            "expandable": true,
            "children": [
              {
                "name": "billing_address",
                "type": "[Address](../../entities/classes/entities.Address.mdx)",
                "description": "The details of the billing address associated with the customer.",
                "optional": false,
                "defaultValue": "",
                "expandable": true,
                "children": []
              },
              {
                "name": "billing_address_id",
                "type": "`null` \\| `string`",
                "description": "The customer's billing address ID",
                "optional": false,
                "defaultValue": "",
                "expandable": false,
                "children": []
              },
              {
                "name": "created_at",
                "type": "`Date`",
                "description": "The date with timezone at which the resource was created.",
                "optional": false,
                "defaultValue": "",
                "expandable": false,
                "children": []
              },
              {
                "name": "deleted_at",
                "type": "`null` \\| `Date`",
                "description": "The date with timezone at which the resource was deleted.",
                "optional": false,
                "defaultValue": "",
                "expandable": false,
                "children": []
              },
              {
                "name": "email",
                "type": "`string`",
                "description": "The customer's email",
                "optional": false,
                "defaultValue": "",
                "expandable": false,
                "children": []
              },
              {
                "name": "first_name",
                "type": "`string`",
                "description": "The customer's first name",
                "optional": false,
                "defaultValue": "",
                "expandable": false,
                "children": []
              },
              {
                "name": "groups",
                "type": "[CustomerGroup](../../entities/classes/entities.CustomerGroup.mdx)[]",
                "description": "The customer groups the customer belongs to.",
                "optional": false,
                "defaultValue": "",
                "expandable": true,
                "children": []
              },
              {
                "name": "has_account",
                "type": "`boolean`",
                "description": "Whether the customer has an account or not",
                "optional": false,
                "defaultValue": "false",
                "expandable": false,
                "children": []
              },
              {
                "name": "id",
                "type": "`string`",
                "description": "The customer's ID",
                "optional": false,
                "defaultValue": "",
                "expandable": false,
                "children": []
              },
              {
                "name": "last_name",
                "type": "`string`",
                "description": "The customer's last name",
                "optional": false,
                "defaultValue": "",
                "expandable": false,
                "children": []
              },
              {
                "name": "metadata",
                "type": "`Record<string, unknown>`",
                "description": "An optional key-value map with additional details",
                "optional": false,
                "defaultValue": "",
                "expandable": false,
                "children": []
              },
              {
                "name": "orders",
                "type": "[Order](../../entities/classes/entities.Order.mdx)[]",
                "description": "The details of the orders this customer placed.",
                "optional": false,
                "defaultValue": "",
                "expandable": true,
                "children": []
              },
              {
                "name": "password_hash",
                "type": "`string`",
                "description": "",
                "optional": false,
                "defaultValue": "",
                "expandable": false,
                "children": []
              },
              {
                "name": "phone",
                "type": "`string`",
                "description": "The customer's phone number",
                "optional": false,
                "defaultValue": "",
                "expandable": false,
                "children": []
              },
              {
                "name": "shipping_addresses",
                "type": "[Address](../../entities/classes/entities.Address.mdx)[]",
                "description": "The details of the shipping addresses associated with the customer.",
                "optional": false,
                "defaultValue": "",
                "expandable": true,
                "children": []
              },
              {
                "name": "updated_at",
                "type": "`Date`",
                "description": "The date with timezone at which the resource was updated.",
                "optional": false,
                "defaultValue": "",
                "expandable": false,
                "children": []
              }
            ]
          },
          {
            "name": "customer_id",
            "type": "`string`",
            "description": "The ID of the customer associated with the order",
            "optional": false,
            "defaultValue": "",
            "expandable": false,
            "children": []
          },
          {
            "name": "discount_total",
            "type": "`number`",
            "description": "The total of discount rounded",
            "optional": false,
            "defaultValue": "",
            "expandable": false,
            "children": []
          },
          {
            "name": "discounts",
            "type": "[Discount](../../entities/classes/entities.Discount.mdx)[]",
            "description": "The details of the discounts applied on the order.",
            "optional": false,
            "defaultValue": "",
            "expandable": true,
            "children": [
              {
                "name": "code",
                "type": "`string`",
                "description": "A unique code for the discount - this will be used by the customer to apply the discount",
                "optional": false,
                "defaultValue": "",
                "expandable": false,
                "children": []
              },
              {
                "name": "created_at",
                "type": "`Date`",
                "description": "The date with timezone at which the resource was created.",
                "optional": false,
                "defaultValue": "",
                "expandable": false,
                "children": []
              },
              {
                "name": "deleted_at",
                "type": "`null` \\| `Date`",
                "description": "The date with timezone at which the resource was deleted.",
                "optional": false,
                "defaultValue": "",
                "expandable": false,
                "children": []
              },
              {
                "name": "ends_at",
                "type": "`null` \\| `Date`",
                "description": "The time at which the discount can no longer be used.",
                "optional": false,
                "defaultValue": "",
                "expandable": false,
                "children": []
              },
              {
                "name": "id",
                "type": "`string`",
                "description": "The discount's ID",
                "optional": false,
                "defaultValue": "",
                "expandable": false,
                "children": []
              },
              {
                "name": "is_disabled",
                "type": "`boolean`",
                "description": "Whether the Discount has been disabled. Disabled discounts cannot be applied to carts",
                "optional": false,
                "defaultValue": "",
                "expandable": false,
                "children": []
              },
              {
                "name": "is_dynamic",
                "type": "`boolean`",
                "description": "A flag to indicate if multiple instances of the discount can be generated. I.e. for newsletter discounts",
                "optional": false,
                "defaultValue": "",
                "expandable": false,
                "children": []
              },
              {
                "name": "metadata",
                "type": "`Record<string, unknown>`",
                "description": "An optional key-value map with additional details",
                "optional": false,
                "defaultValue": "",
                "expandable": false,
                "children": []
              },
              {
                "name": "parent_discount",
                "type": "[Discount](../../entities/classes/entities.Discount.mdx)",
                "description": "The details of the parent discount that this discount was created from.",
                "optional": false,
                "defaultValue": "",
                "expandable": true,
                "children": []
              },
              {
                "name": "parent_discount_id",
                "type": "`string`",
                "description": "The Discount that the discount was created from. This will always be a dynamic discount",
                "optional": false,
                "defaultValue": "",
                "expandable": false,
                "children": []
              },
              {
                "name": "regions",
                "type": "[Region](../../entities/classes/entities.Region.mdx)[]",
                "description": "The details of the regions in which the Discount can be used.",
                "optional": false,
                "defaultValue": "",
                "expandable": true,
                "children": []
              },
              {
                "name": "rule",
                "type": "[DiscountRule](../../entities/classes/entities.DiscountRule.mdx)",
                "description": "The details of the discount rule that defines how the discount will be applied to a cart..",
                "optional": false,
                "defaultValue": "",
                "expandable": true,
                "children": []
              },
              {
                "name": "rule_id",
                "type": "`string`",
                "description": "The ID of the discount rule that defines how the discount will be applied to a cart.",
                "optional": false,
                "defaultValue": "",
                "expandable": false,
                "children": []
              },
              {
                "name": "starts_at",
                "type": "`Date`",
                "description": "The time at which the discount can be used.",
                "optional": false,
                "defaultValue": "",
                "expandable": false,
                "children": []
              },
              {
                "name": "updated_at",
                "type": "`Date`",
                "description": "The date with timezone at which the resource was updated.",
                "optional": false,
                "defaultValue": "",
                "expandable": false,
                "children": []
              },
              {
                "name": "usage_count",
                "type": "`number`",
                "description": "The number of times a discount has been used.",
                "optional": false,
                "defaultValue": "0",
                "expandable": false,
                "children": []
              },
              {
                "name": "usage_limit",
                "type": "`null` \\| `number`",
                "description": "The maximum number of times that a discount can be used.",
                "optional": false,
                "defaultValue": "",
                "expandable": false,
                "children": []
              },
              {
                "name": "valid_duration",
                "type": "`null` \\| `string`",
                "description": "Duration the discount runs between",
                "optional": false,
                "defaultValue": "",
                "expandable": false,
                "children": []
              }
            ]
          },
          {
            "name": "display_id",
            "type": "`number`",
            "description": "The order's display ID",
            "optional": false,
            "defaultValue": "",
            "expandable": false,
            "children": []
          },
          {
            "name": "draft_order",
            "type": "[DraftOrder](../../entities/classes/entities.DraftOrder.mdx)",
            "description": "The details of the draft order this order was created from.",
            "optional": false,
            "defaultValue": "",
            "expandable": true,
            "children": [
              {
                "name": "canceled_at",
                "type": "`Date`",
                "description": "The date the draft order was canceled at.",
                "optional": false,
                "defaultValue": "",
                "expandable": false,
                "children": []
              },
              {
                "name": "cart",
                "type": "[Cart](../../entities/classes/entities.Cart.mdx)",
                "description": "The details of the cart associated with the draft order.",
                "optional": false,
                "defaultValue": "",
                "expandable": true,
                "children": []
              },
              {
                "name": "cart_id",
                "type": "`string`",
                "description": "The ID of the cart associated with the draft order.",
                "optional": false,
                "defaultValue": "",
                "expandable": false,
                "children": []
              },
              {
                "name": "completed_at",
                "type": "`Date`",
                "description": "The date the draft order was completed at.",
                "optional": false,
                "defaultValue": "",
                "expandable": false,
                "children": []
              },
              {
                "name": "created_at",
                "type": "`Date`",
                "description": "The date with timezone at which the resource was created.",
                "optional": false,
                "defaultValue": "",
                "expandable": false,
                "children": []
              },
              {
                "name": "display_id",
                "type": "`number`",
                "description": "The draft order's display ID",
                "optional": false,
                "defaultValue": "",
                "expandable": false,
                "children": []
              },
              {
                "name": "id",
                "type": "`string`",
                "description": "The draft order's ID",
                "optional": false,
                "defaultValue": "",
                "expandable": false,
                "children": []
              },
              {
                "name": "idempotency_key",
                "type": "`string`",
                "description": "Randomly generated key used to continue the completion of the cart associated with the draft order in case of failure.",
                "optional": false,
                "defaultValue": "",
                "expandable": false,
                "children": []
              },
              {
                "name": "metadata",
                "type": "`Record<string, unknown>`",
                "description": "An optional key-value map with additional details",
                "optional": false,
                "defaultValue": "",
                "expandable": false,
                "children": []
              },
              {
                "name": "no_notification_order",
                "type": "`boolean`",
                "description": "Whether to send the customer notifications regarding order updates.",
                "optional": false,
                "defaultValue": "",
                "expandable": false,
                "children": []
              },
              {
                "name": "order",
                "type": "[Order](../../entities/classes/entities.Order.mdx)",
                "description": "The details of the order created from the draft order when its payment is captured.",
                "optional": false,
                "defaultValue": "",
                "expandable": true,
                "children": []
              },
              {
                "name": "order_id",
                "type": "`string`",
                "description": "The ID of the order created from the draft order when its payment is captured.",
                "optional": false,
                "defaultValue": "",
                "expandable": false,
                "children": []
              },
              {
                "name": "status",
                "type": "[DraftOrderStatus](../../entities/enums/entities.DraftOrderStatus.mdx)",
                "description": "The status of the draft order. It's changed to `completed` when it's transformed to an order.",
                "optional": false,
                "defaultValue": "open",
                "expandable": false,
                "children": []
              },
              {
                "name": "updated_at",
                "type": "`Date`",
                "description": "The date with timezone at which the resource was updated.",
                "optional": false,
                "defaultValue": "",
                "expandable": false,
                "children": []
              }
            ]
          },
          {
            "name": "draft_order_id",
            "type": "`string`",
            "description": "The ID of the draft order this order was created from.",
            "optional": false,
            "defaultValue": "",
            "expandable": false,
            "children": []
          },
          {
            "name": "edits",
            "type": "[OrderEdit](../../entities/classes/entities.OrderEdit.mdx)[]",
            "description": "The details of the order edits done on the order.",
            "optional": false,
            "defaultValue": "",
            "expandable": true,
            "children": [
              {
                "name": "canceled_at",
                "type": "`Date`",
                "description": "The date with timezone at which the edit was cancelled.",
                "optional": true,
                "defaultValue": "",
                "expandable": false,
                "children": []
              },
              {
                "name": "canceled_by",
                "type": "`string`",
                "description": "The unique identifier of the user or customer who cancelled the order edit.",
                "optional": true,
                "defaultValue": "",
                "expandable": false,
                "children": []
              },
              {
                "name": "changes",
                "type": "[OrderItemChange](../../entities/classes/entities.OrderItemChange.mdx)[]",
                "description": "The details of all the changes on the original order's line items.",
                "optional": false,
                "defaultValue": "",
                "expandable": true,
                "children": []
              },
              {
                "name": "confirmed_at",
                "type": "`Date`",
                "description": "The date with timezone at which the edit was confirmed.",
                "optional": true,
                "defaultValue": "",
                "expandable": false,
                "children": []
              },
              {
                "name": "confirmed_by",
                "type": "`string`",
                "description": "The unique identifier of the user or customer who confirmed the order edit.",
                "optional": true,
                "defaultValue": "",
                "expandable": false,
                "children": []
              },
              {
                "name": "created_at",
                "type": "`Date`",
                "description": "The date with timezone at which the resource was created.",
                "optional": false,
                "defaultValue": "",
                "expandable": false,
                "children": []
              },
              {
                "name": "created_by",
                "type": "`string`",
                "description": "The unique identifier of the user or customer who created the order edit.",
                "optional": false,
                "defaultValue": "",
                "expandable": false,
                "children": []
              },
              {
                "name": "declined_at",
                "type": "`Date`",
                "description": "The date with timezone at which the edit was declined.",
                "optional": true,
                "defaultValue": "",
                "expandable": false,
                "children": []
              },
              {
                "name": "declined_by",
                "type": "`string`",
                "description": "The unique identifier of the user or customer who declined the order edit.",
                "optional": true,
                "defaultValue": "",
                "expandable": false,
                "children": []
              },
              {
                "name": "declined_reason",
                "type": "`string`",
                "description": "An optional note why  the order edit is declined.",
                "optional": true,
                "defaultValue": "",
                "expandable": false,
                "children": []
              },
              {
                "name": "difference_due",
                "type": "`number`",
                "description": "The difference between the total amount of the order and total amount of edited order.",
                "optional": false,
                "defaultValue": "",
                "expandable": false,
                "children": []
              },
              {
                "name": "discount_total",
                "type": "`number`",
                "description": "The total of discount",
                "optional": false,
                "defaultValue": "",
                "expandable": false,
                "children": []
              },
              {
                "name": "gift_card_tax_total",
                "type": "`number`",
                "description": "The total of the gift card tax amount",
                "optional": false,
                "defaultValue": "",
                "expandable": false,
                "children": []
              },
              {
                "name": "gift_card_total",
                "type": "`number`",
                "description": "The total of the gift card amount",
                "optional": false,
                "defaultValue": "",
                "expandable": false,
                "children": []
              },
              {
                "name": "id",
                "type": "`string`",
                "description": "The order edit's ID",
                "optional": false,
                "defaultValue": "",
                "expandable": false,
                "children": []
              },
              {
                "name": "internal_note",
                "type": "`string`",
                "description": "An optional note with additional details about the order edit.",
                "optional": true,
                "defaultValue": "",
                "expandable": false,
                "children": []
              },
              {
                "name": "items",
                "type": "[LineItem](../../entities/classes/entities.LineItem.mdx)[]",
                "description": "The details of the cloned items from the original order with the new changes. Once the order edit is confirmed, these line items are associated with the original order.",
                "optional": false,
                "defaultValue": "",
                "expandable": true,
                "children": []
              },
              {
                "name": "order",
                "type": "[Order](../../entities/classes/entities.Order.mdx)",
                "description": "The details of the order that this order edit was created for.",
                "optional": false,
                "defaultValue": "",
                "expandable": true,
                "children": []
              },
              {
                "name": "order_id",
                "type": "`string`",
                "description": "The ID of the order that is edited",
                "optional": false,
                "defaultValue": "",
                "expandable": false,
                "children": []
              },
              {
                "name": "payment_collection",
                "type": "[PaymentCollection](../../entities/classes/entities.PaymentCollection.mdx)",
                "description": "The details of the payment collection used to authorize additional payment if necessary.",
                "optional": false,
                "defaultValue": "",
                "expandable": true,
                "children": []
              },
              {
                "name": "payment_collection_id",
                "type": "`string`",
                "description": "The ID of the payment collection",
                "optional": false,
                "defaultValue": "",
                "expandable": false,
                "children": []
              },
              {
                "name": "requested_at",
                "type": "`Date`",
                "description": "The date with timezone at which the edit was requested.",
                "optional": true,
                "defaultValue": "",
                "expandable": false,
                "children": []
              },
              {
                "name": "requested_by",
                "type": "`string`",
                "description": "The unique identifier of the user or customer who requested the order edit.",
                "optional": true,
                "defaultValue": "",
                "expandable": false,
                "children": []
              },
              {
                "name": "shipping_total",
                "type": "`number`",
                "description": "The total of the shipping amount",
                "optional": false,
                "defaultValue": "",
                "expandable": false,
                "children": []
              },
              {
                "name": "status",
                "type": "[OrderEditStatus](../../entities/enums/entities.OrderEditStatus.mdx)",
                "description": "The status of the order edit.",
                "optional": false,
                "defaultValue": "",
                "expandable": false,
                "children": []
              },
              {
                "name": "subtotal",
                "type": "`number`",
                "description": "The total of subtotal",
                "optional": false,
                "defaultValue": "",
                "expandable": false,
                "children": []
              },
              {
                "name": "tax_total",
                "type": "`null` \\| `number`",
                "description": "The total of tax",
                "optional": false,
                "defaultValue": "",
                "expandable": false,
                "children": []
              },
              {
                "name": "total",
                "type": "`number`",
                "description": "The total amount of the edited order.",
                "optional": false,
                "defaultValue": "",
                "expandable": false,
                "children": []
              },
              {
                "name": "updated_at",
                "type": "`Date`",
                "description": "The date with timezone at which the resource was updated.",
                "optional": false,
                "defaultValue": "",
                "expandable": false,
                "children": []
              }
            ]
          },
          {
            "name": "email",
            "type": "`string`",
            "description": "The email associated with the order",
            "optional": false,
            "defaultValue": "",
            "expandable": false,
            "children": []
          },
          {
            "name": "external_id",
            "type": "`null` \\| `string`",
            "description": "The ID of an external order.",
            "optional": false,
            "defaultValue": "",
            "expandable": false,
            "children": []
          },
          {
            "name": "fulfillment_status",
            "type": "[FulfillmentStatus](../../entities/enums/entities.FulfillmentStatus.mdx)",
            "description": "The order's fulfillment status",
            "optional": false,
            "defaultValue": "not_fulfilled",
            "expandable": false,
            "children": [
              {
                "name": "CANCELED",
                "type": "`\"canceled\"`",
                "description": "The order's fulfillments are canceled.",
                "optional": true,
                "defaultValue": "",
                "expandable": false,
                "children": []
              },
              {
                "name": "FULFILLED",
                "type": "`\"fulfilled\"`",
                "description": "The order's items are fulfilled.",
                "optional": true,
                "defaultValue": "",
                "expandable": false,
                "children": []
              },
              {
                "name": "NOT_FULFILLED",
                "type": "`\"not_fulfilled\"`",
                "description": "The order's items are not fulfilled.",
                "optional": true,
                "defaultValue": "",
                "expandable": false,
                "children": []
              },
              {
                "name": "PARTIALLY_FULFILLED",
                "type": "`\"partially_fulfilled\"`",
                "description": "Some of the order's items, but not all, are fulfilled.",
                "optional": true,
                "defaultValue": "",
                "expandable": false,
                "children": []
              },
              {
                "name": "PARTIALLY_RETURNED",
                "type": "`\"partially_returned\"`",
                "description": "Some of the order's items, but not all, are returned.",
                "optional": true,
                "defaultValue": "",
                "expandable": false,
                "children": []
              },
              {
                "name": "PARTIALLY_SHIPPED",
                "type": "`\"partially_shipped\"`",
                "description": "Some of the order's items, but not all, are shipped.",
                "optional": true,
                "defaultValue": "",
                "expandable": false,
                "children": []
              },
              {
                "name": "REQUIRES_ACTION",
                "type": "`\"requires_action\"`",
                "description": "The order's fulfillment requires action.",
                "optional": true,
                "defaultValue": "",
                "expandable": false,
                "children": []
              },
              {
                "name": "RETURNED",
                "type": "`\"returned\"`",
                "description": "The order's items are returned.",
                "optional": true,
                "defaultValue": "",
                "expandable": false,
                "children": []
              },
              {
                "name": "SHIPPED",
                "type": "`\"shipped\"`",
                "description": "The order's items are shipped.",
                "optional": true,
                "defaultValue": "",
                "expandable": false,
                "children": []
              }
            ]
          },
          {
            "name": "fulfillments",
            "type": "[Fulfillment](../../entities/classes/entities.Fulfillment.mdx)[]",
            "description": "The details of the fulfillments created for the order.",
            "optional": false,
            "defaultValue": "",
            "expandable": true,
            "children": [
              {
                "name": "canceled_at",
                "type": "`Date`",
                "description": "The date with timezone at which the Fulfillment was canceled.",
                "optional": false,
                "defaultValue": "",
                "expandable": false,
                "children": []
              },
              {
                "name": "claim_order",
                "type": "[ClaimOrder](../../entities/classes/entities.ClaimOrder.mdx)",
                "description": "The details of the claim that the fulfillment may belong to.",
                "optional": false,
                "defaultValue": "",
                "expandable": true,
                "children": []
              },
              {
                "name": "claim_order_id",
                "type": "`string`",
                "description": "The ID of the Claim that the Fulfillment belongs to.",
                "optional": false,
                "defaultValue": "",
                "expandable": false,
                "children": []
              },
              {
                "name": "created_at",
                "type": "`Date`",
                "description": "The date with timezone at which the resource was created.",
                "optional": false,
                "defaultValue": "",
                "expandable": false,
                "children": []
              },
              {
                "name": "data",
                "type": "`Record<string, unknown>`",
                "description": "This contains all the data necessary for the Fulfillment provider to handle the fulfillment.",
                "optional": false,
                "defaultValue": "",
                "expandable": false,
                "children": []
              },
              {
                "name": "id",
                "type": "`string`",
                "description": "The fulfillment's ID",
                "optional": false,
                "defaultValue": "",
                "expandable": false,
                "children": []
              },
              {
                "name": "idempotency_key",
                "type": "`string`",
                "description": "Randomly generated key used to continue the completion of the fulfillment in case of failure.",
                "optional": false,
                "defaultValue": "",
                "expandable": false,
                "children": []
              },
              {
                "name": "items",
                "type": "[FulfillmentItem](../../entities/classes/entities.FulfillmentItem.mdx)[]",
                "description": "The Fulfillment Items in the Fulfillment. These hold information about how many of each Line Item has been fulfilled.",
                "optional": false,
                "defaultValue": "",
                "expandable": true,
                "children": []
              },
              {
                "name": "location_id",
                "type": "`null` \\| `string`",
                "description": "The ID of the stock location the fulfillment will be shipped from",
                "optional": false,
                "defaultValue": "",
                "expandable": false,
                "children": []
              },
              {
                "name": "metadata",
                "type": "`Record<string, unknown>`",
                "description": "An optional key-value map with additional details",
                "optional": false,
                "defaultValue": "",
                "expandable": false,
                "children": []
              },
              {
                "name": "no_notification",
                "type": "`boolean`",
                "description": "Flag for describing whether or not notifications related to this should be sent.",
                "optional": false,
                "defaultValue": "",
                "expandable": false,
                "children": []
              },
              {
                "name": "order",
                "type": "[Order](../../entities/classes/entities.Order.mdx)",
                "description": "The details of the order that the fulfillment may belong to.",
                "optional": false,
                "defaultValue": "",
                "expandable": true,
                "children": []
              },
              {
                "name": "order_id",
                "type": "`string`",
                "description": "The ID of the Order that the Fulfillment belongs to.",
                "optional": false,
                "defaultValue": "",
                "expandable": false,
                "children": []
              },
              {
                "name": "provider",
                "type": "[FulfillmentProvider](../../entities/classes/entities.FulfillmentProvider.mdx)",
                "description": "The details of the fulfillment provider responsible for handling the fulfillment.",
                "optional": false,
                "defaultValue": "",
                "expandable": true,
                "children": []
              },
              {
                "name": "provider_id",
                "type": "`string`",
                "description": "The ID of the Fulfillment Provider responsible for handling the fulfillment.",
                "optional": false,
                "defaultValue": "",
                "expandable": false,
                "children": []
              },
              {
                "name": "shipped_at",
                "type": "`Date`",
                "description": "The date with timezone at which the Fulfillment was shipped.",
                "optional": false,
                "defaultValue": "",
                "expandable": false,
                "children": []
              },
              {
                "name": "swap",
                "type": "[Swap](../../entities/classes/entities.Swap.mdx)",
                "description": "The details of the swap that the fulfillment may belong to.",
                "optional": false,
                "defaultValue": "",
                "expandable": true,
                "children": []
              },
              {
                "name": "swap_id",
                "type": "`string`",
                "description": "The ID of the Swap that the Fulfillment belongs to.",
                "optional": false,
                "defaultValue": "",
                "expandable": false,
                "children": []
              },
              {
                "name": "tracking_links",
                "type": "[TrackingLink](../../entities/classes/entities.TrackingLink.mdx)[]",
                "description": "The Tracking Links that can be used to track the status of the Fulfillment. These will usually be provided by the Fulfillment Provider.",
                "optional": false,
                "defaultValue": "",
                "expandable": true,
                "children": []
              },
              {
                "name": "tracking_numbers",
                "type": "`string`[]",
                "description": "The tracking numbers that can be used to track the status of the fulfillment.",
                "optional": false,
                "defaultValue": "",
                "expandable": false,
                "children": []
              },
              {
                "name": "updated_at",
                "type": "`Date`",
                "description": "The date with timezone at which the resource was updated.",
                "optional": false,
                "defaultValue": "",
                "expandable": false,
                "children": []
              }
            ]
          },
          {
            "name": "gift_card_tax_total",
            "type": "`number`",
            "description": "The total of gift cards with taxes",
            "optional": false,
            "defaultValue": "",
            "expandable": false,
            "children": []
          },
          {
            "name": "gift_card_total",
            "type": "`number`",
            "description": "The total of gift cards",
            "optional": false,
            "defaultValue": "",
            "expandable": false,
            "children": []
          },
          {
            "name": "gift_card_transactions",
            "type": "[GiftCardTransaction](../../entities/classes/entities.GiftCardTransaction.mdx)[]",
            "description": "The gift card transactions made in the order.",
            "optional": false,
            "defaultValue": "",
            "expandable": true,
            "children": [
              {
                "name": "amount",
                "type": "`number`",
                "description": "The amount that was used from the Gift Card.",
                "optional": false,
                "defaultValue": "",
                "expandable": false,
                "children": []
              },
              {
                "name": "created_at",
                "type": "`Date`",
                "description": "The date with timezone at which the resource was created.",
                "optional": false,
                "defaultValue": "",
                "expandable": false,
                "children": []
              },
              {
                "name": "gift_card",
                "type": "[GiftCard](../../entities/classes/entities.GiftCard.mdx)",
                "description": "The details of the gift card associated used in this transaction.",
                "optional": false,
                "defaultValue": "",
                "expandable": true,
                "children": []
              },
              {
                "name": "gift_card_id",
                "type": "`string`",
                "description": "The ID of the Gift Card that was used in the transaction.",
                "optional": false,
                "defaultValue": "",
                "expandable": false,
                "children": []
              },
              {
                "name": "id",
                "type": "`string`",
                "description": "The gift card transaction's ID",
                "optional": false,
                "defaultValue": "",
                "expandable": false,
                "children": []
              },
              {
                "name": "is_taxable",
                "type": "`boolean`",
                "description": "Whether the transaction is taxable or not.",
                "optional": false,
                "defaultValue": "",
                "expandable": false,
                "children": []
              },
              {
                "name": "order",
                "type": "[Order](../../entities/classes/entities.Order.mdx)",
                "description": "The details of the order that the gift card was used for payment.",
                "optional": false,
                "defaultValue": "",
                "expandable": true,
                "children": []
              },
              {
                "name": "order_id",
                "type": "`string`",
                "description": "The ID of the order that the gift card was used for payment.",
                "optional": false,
                "defaultValue": "",
                "expandable": false,
                "children": []
              },
              {
                "name": "tax_rate",
                "type": "`null` \\| `number`",
                "description": "The tax rate of the transaction",
                "optional": false,
                "defaultValue": "",
                "expandable": false,
                "children": []
              }
            ]
          },
          {
            "name": "gift_cards",
            "type": "[GiftCard](../../entities/classes/entities.GiftCard.mdx)[]",
            "description": "The details of the gift card used in the order.",
            "optional": false,
            "defaultValue": "",
            "expandable": true,
            "children": [
              {
                "name": "balance",
                "type": "`number`",
                "description": "The remaining value on the Gift Card.",
                "optional": false,
                "defaultValue": "",
                "expandable": false,
                "children": []
              },
              {
                "name": "code",
                "type": "`string`",
                "description": "The unique code that identifies the Gift Card. This is used by the Customer to redeem the value of the Gift Card.",
                "optional": false,
                "defaultValue": "",
                "expandable": false,
                "children": []
              },
              {
                "name": "created_at",
                "type": "`Date`",
                "description": "The date with timezone at which the resource was created.",
                "optional": false,
                "defaultValue": "",
                "expandable": false,
                "children": []
              },
              {
                "name": "deleted_at",
                "type": "`null` \\| `Date`",
                "description": "The date with timezone at which the resource was deleted.",
                "optional": false,
                "defaultValue": "",
                "expandable": false,
                "children": []
              },
              {
                "name": "ends_at",
                "type": "`Date`",
                "description": "The time at which the Gift Card can no longer be used.",
                "optional": false,
                "defaultValue": "",
                "expandable": false,
                "children": []
              },
              {
                "name": "id",
                "type": "`string`",
                "description": "The gift card's ID",
                "optional": false,
                "defaultValue": "",
                "expandable": false,
                "children": []
              },
              {
                "name": "is_disabled",
                "type": "`boolean`",
                "description": "Whether the Gift Card has been disabled. Disabled Gift Cards cannot be applied to carts.",
                "optional": false,
                "defaultValue": "false",
                "expandable": false,
                "children": []
              },
              {
                "name": "metadata",
                "type": "`Record<string, unknown>`",
                "description": "An optional key-value map with additional details",
                "optional": false,
                "defaultValue": "",
                "expandable": false,
                "children": []
              },
              {
                "name": "order",
                "type": "[Order](../../entities/classes/entities.Order.mdx)",
                "description": "The details of the order that the gift card was purchased in.",
                "optional": false,
                "defaultValue": "",
                "expandable": true,
                "children": []
              },
              {
                "name": "order_id",
                "type": "`string`",
                "description": "The ID of the order that the gift card was purchased in.",
                "optional": false,
                "defaultValue": "",
                "expandable": false,
                "children": []
              },
              {
                "name": "region",
                "type": "[Region](../../entities/classes/entities.Region.mdx)",
                "description": "The details of the region this gift card is available in.",
                "optional": false,
                "defaultValue": "",
                "expandable": true,
                "children": []
              },
              {
                "name": "region_id",
                "type": "`string`",
                "description": "The ID of the region this gift card is available in.",
                "optional": false,
                "defaultValue": "",
                "expandable": false,
                "children": []
              },
              {
                "name": "tax_rate",
                "type": "`null` \\| `number`",
                "description": "The gift card's tax rate that will be applied on calculating totals",
                "optional": false,
                "defaultValue": "",
                "expandable": false,
                "children": []
              },
              {
                "name": "updated_at",
                "type": "`Date`",
                "description": "The date with timezone at which the resource was updated.",
                "optional": false,
                "defaultValue": "",
                "expandable": false,
                "children": []
              },
              {
                "name": "value",
                "type": "`number`",
                "description": "The value that the Gift Card represents.",
                "optional": false,
                "defaultValue": "",
                "expandable": false,
                "children": []
              }
            ]
          },
          {
            "name": "id",
            "type": "`string`",
            "description": "The order's ID",
            "optional": false,
            "defaultValue": "",
            "expandable": false,
            "children": []
          },
          {
            "name": "idempotency_key",
            "type": "`string`",
            "description": "Randomly generated key used to continue the processing of the order in case of failure.",
            "optional": false,
            "defaultValue": "",
            "expandable": false,
            "children": []
          },
          {
            "name": "item_tax_total",
            "type": "`null` \\| `number`",
            "description": "The tax total applied on items",
            "optional": false,
            "defaultValue": "",
            "expandable": false,
            "children": []
          },
          {
            "name": "items",
            "type": "[LineItem](../../entities/classes/entities.LineItem.mdx)[]",
            "description": "The details of the line items that belong to the order.",
            "optional": false,
            "defaultValue": "",
            "expandable": true,
            "children": [
              {
                "name": "adjustments",
                "type": "[LineItemAdjustment](../../entities/classes/entities.LineItemAdjustment.mdx)[]",
                "description": "The details of the item's adjustments, which are available when a discount is applied on the item.",
                "optional": false,
                "defaultValue": "",
                "expandable": true,
                "children": []
              },
              {
                "name": "allow_discounts",
                "type": "`boolean`",
                "description": "Flag to indicate if the Line Item should be included when doing discount calculations.",
                "optional": false,
                "defaultValue": "true",
                "expandable": false,
                "children": []
              },
              {
                "name": "cart",
                "type": "[Cart](../../entities/classes/entities.Cart.mdx)",
                "description": "The details of the cart that the line item may belongs to.",
                "optional": false,
                "defaultValue": "",
                "expandable": true,
                "children": []
              },
              {
                "name": "cart_id",
                "type": "`string`",
                "description": "The ID of the cart that the line item may belongs to.",
                "optional": false,
                "defaultValue": "",
                "expandable": false,
                "children": []
              },
              {
                "name": "claim_order",
                "type": "[ClaimOrder](../../entities/classes/entities.ClaimOrder.mdx)",
                "description": "The details of the claim that the line item may belong to.",
                "optional": false,
                "defaultValue": "",
                "expandable": true,
                "children": []
              },
              {
                "name": "claim_order_id",
                "type": "`string`",
                "description": "The ID of the claim that the line item may belong to.",
                "optional": false,
                "defaultValue": "",
                "expandable": false,
                "children": []
              },
              {
                "name": "created_at",
                "type": "`Date`",
                "description": "The date with timezone at which the resource was created.",
                "optional": false,
                "defaultValue": "",
                "expandable": false,
                "children": []
              },
              {
                "name": "description",
                "type": "`null` \\| `string`",
                "description": "A more detailed description of the contents of the Line Item.",
                "optional": false,
                "defaultValue": "",
                "expandable": false,
                "children": []
              },
              {
                "name": "discount_total",
                "type": "`null` \\| `number`",
                "description": "The total of discount of the line item rounded",
                "optional": true,
                "defaultValue": "",
                "expandable": false,
                "children": []
              },
              {
                "name": "fulfilled_quantity",
                "type": "`null` \\| `number`",
                "description": "The quantity of the Line Item that has been fulfilled.",
                "optional": false,
                "defaultValue": "",
                "expandable": false,
                "children": []
              },
              {
                "name": "gift_card_total",
                "type": "`null` \\| `number`",
                "description": "The total of the gift card of the line item",
                "optional": true,
                "defaultValue": "",
                "expandable": false,
                "children": []
              },
              {
                "name": "has_shipping",
                "type": "`null` \\| `boolean`",
                "description": "Flag to indicate if the Line Item has fulfillment associated with it.",
                "optional": false,
                "defaultValue": "",
                "expandable": false,
                "children": []
              },
              {
                "name": "id",
                "type": "`string`",
                "description": "The line item's ID",
                "optional": false,
                "defaultValue": "",
                "expandable": false,
                "children": []
              },
              {
                "name": "includes_tax",
                "type": "`boolean`",
                "description": "Indicates if the line item unit\\_price include tax",
                "optional": false,
                "defaultValue": "false",
                "expandable": false,
                "featureFlag": "tax_inclusive_pricing",
                "children": []
              },
              {
                "name": "is_giftcard",
                "type": "`boolean`",
                "description": "Flag to indicate if the Line Item is a Gift Card.",
                "optional": false,
                "defaultValue": "false",
                "expandable": false,
                "children": []
              },
              {
                "name": "is_return",
                "type": "`boolean`",
                "description": "Is the item being returned",
                "optional": false,
                "defaultValue": "false",
                "expandable": false,
                "children": []
              },
              {
                "name": "metadata",
                "type": "`Record<string, unknown>`",
                "description": "An optional key-value map with additional details",
                "optional": false,
                "defaultValue": "",
                "expandable": false,
                "children": []
              },
              {
                "name": "order",
                "type": "[Order](../../entities/classes/entities.Order.mdx)",
                "description": "The details of the order that the line item may belongs to.",
                "optional": false,
                "defaultValue": "",
                "expandable": true,
                "children": []
              },
              {
                "name": "order_edit",
                "type": "`null` \\| [OrderEdit](../../entities/classes/entities.OrderEdit.mdx)",
                "description": "The details of the order edit.",
                "optional": true,
                "defaultValue": "",
                "expandable": true,
                "children": []
              },
              {
                "name": "order_edit_id",
                "type": "`null` \\| `string`",
                "description": "The ID of the order edit that the item may belong to.",
                "optional": true,
                "defaultValue": "",
                "expandable": false,
                "children": []
              },
              {
                "name": "order_id",
                "type": "`null` \\| `string`",
                "description": "The ID of the order that the line item may belongs to.",
                "optional": false,
                "defaultValue": "",
                "expandable": false,
                "children": []
              },
              {
                "name": "original_item_id",
                "type": "`null` \\| `string`",
                "description": "The ID of the original line item. This is useful if the line item belongs to a resource that references an order, such as a return or an order edit.",
                "optional": true,
                "defaultValue": "",
                "expandable": false,
                "children": []
              },
              {
                "name": "original_tax_total",
                "type": "`null` \\| `number`",
                "description": "The original tax total amount of the line item",
                "optional": true,
                "defaultValue": "",
                "expandable": false,
                "children": []
              },
              {
                "name": "original_total",
                "type": "`null` \\| `number`",
                "description": "The original total amount of the line item",
                "optional": true,
                "defaultValue": "",
                "expandable": false,
                "children": []
              },
              {
                "name": "product_id",
                "type": "`null` \\| `string`",
                "description": "",
                "optional": false,
                "defaultValue": "",
                "expandable": false,
                "children": []
              },
              {
                "name": "quantity",
                "type": "`number`",
                "description": "The quantity of the content in the Line Item.",
                "optional": false,
                "defaultValue": "",
                "expandable": false,
                "children": []
              },
              {
                "name": "raw_discount_total",
                "type": "`null` \\| `number`",
                "description": "The total of discount of the line item",
                "optional": true,
                "defaultValue": "",
                "expandable": false,
                "children": []
              },
              {
                "name": "refundable",
                "type": "`null` \\| `number`",
                "description": "The amount that can be refunded from the given Line Item. Takes taxes and discounts into consideration.",
                "optional": true,
                "defaultValue": "",
                "expandable": false,
                "children": []
              },
              {
                "name": "returned_quantity",
                "type": "`null` \\| `number`",
                "description": "The quantity of the Line Item that has been returned.",
                "optional": false,
                "defaultValue": "",
                "expandable": false,
                "children": []
              },
              {
                "name": "shipped_quantity",
                "type": "`null` \\| `number`",
                "description": "The quantity of the Line Item that has been shipped.",
                "optional": false,
                "defaultValue": "",
                "expandable": false,
                "children": []
              },
              {
                "name": "should_merge",
                "type": "`boolean`",
                "description": "Flag to indicate if new Line Items with the same variant should be merged or added as an additional Line Item.",
                "optional": false,
                "defaultValue": "true",
                "expandable": false,
                "children": []
              },
              {
                "name": "subtotal",
                "type": "`null` \\| `number`",
                "description": "The subtotal of the line item",
                "optional": true,
                "defaultValue": "",
                "expandable": false,
                "children": []
              },
              {
                "name": "swap",
                "type": "[Swap](../../entities/classes/entities.Swap.mdx)",
                "description": "The details of the swap that the line item may belong to.",
                "optional": false,
                "defaultValue": "",
                "expandable": true,
                "children": []
              },
              {
                "name": "swap_id",
                "type": "`string`",
                "description": "The ID of the swap that the line item may belong to.",
                "optional": false,
                "defaultValue": "",
                "expandable": false,
                "children": []
              },
              {
                "name": "tax_lines",
                "type": "[LineItemTaxLine](../../entities/classes/entities.LineItemTaxLine.mdx)[]",
                "description": "The details of the item's tax lines.",
                "optional": false,
                "defaultValue": "",
                "expandable": true,
                "children": []
              },
              {
                "name": "tax_total",
                "type": "`null` \\| `number`",
                "description": "The total of tax of the line item",
                "optional": true,
                "defaultValue": "",
                "expandable": false,
                "children": []
              },
              {
                "name": "thumbnail",
                "type": "`null` \\| `string`",
                "description": "A URL string to a small image of the contents of the Line Item.",
                "optional": false,
                "defaultValue": "",
                "expandable": false,
                "children": []
              },
              {
                "name": "title",
                "type": "`string`",
                "description": "The title of the Line Item.",
                "optional": false,
                "defaultValue": "",
                "expandable": false,
                "children": []
              },
              {
                "name": "total",
                "type": "`null` \\| `number`",
                "description": "The total amount of the line item",
                "optional": true,
                "defaultValue": "",
                "expandable": false,
                "children": []
              },
              {
                "name": "unit_price",
                "type": "`number`",
                "description": "The price of one unit of the content in the Line Item. This should be in the currency defined by the Cart/Order/Swap/Claim that the Line Item belongs to.",
                "optional": false,
                "defaultValue": "",
                "expandable": false,
                "children": []
              },
              {
                "name": "updated_at",
                "type": "`Date`",
                "description": "The date with timezone at which the resource was updated.",
                "optional": false,
                "defaultValue": "",
                "expandable": false,
                "children": []
              },
              {
                "name": "variant",
                "type": "[ProductVariant](../../entities/classes/entities.ProductVariant.mdx)",
                "description": "The details of the product variant that this item was created from.",
                "optional": false,
                "defaultValue": "",
                "expandable": true,
                "children": []
              },
              {
                "name": "variant_id",
                "type": "`null` \\| `string`",
                "description": "The id of the Product Variant contained in the Line Item.",
                "optional": false,
                "defaultValue": "",
                "expandable": false,
                "children": []
              }
            ]
          },
          {
            "name": "metadata",
            "type": "`Record<string, unknown>`",
            "description": "An optional key-value map with additional details",
            "optional": false,
            "defaultValue": "",
            "expandable": false,
            "children": []
          },
          {
            "name": "no_notification",
            "type": "`boolean`",
            "description": "Flag for describing whether or not notifications related to this should be send.",
            "optional": false,
            "defaultValue": "",
            "expandable": false,
            "children": []
          },
          {
            "name": "object",
            "type": "`\"order\"`",
            "description": "",
            "optional": false,
            "defaultValue": "\"order\"",
            "expandable": false,
            "children": []
          },
          {
            "name": "paid_total",
            "type": "`number`",
            "description": "The total amount paid",
            "optional": false,
            "defaultValue": "",
            "expandable": false,
            "children": []
          },
          {
            "name": "payment_status",
            "type": "[PaymentStatus](../../entities/enums/entities.PaymentStatus.mdx)",
            "description": "The order's payment status",
            "optional": false,
            "defaultValue": "not_paid",
            "expandable": false,
            "children": [
              {
                "name": "AWAITING",
                "type": "`\"awaiting\"`",
                "description": "The order's payment is awaiting capturing.",
                "optional": true,
                "defaultValue": "",
                "expandable": false,
                "children": []
              },
              {
                "name": "CANCELED",
                "type": "`\"canceled\"`",
                "description": "The order's payment is canceled.",
                "optional": true,
                "defaultValue": "",
                "expandable": false,
                "children": []
              },
              {
                "name": "CAPTURED",
                "type": "`\"captured\"`",
                "description": "The order's payment is captured.",
                "optional": true,
                "defaultValue": "",
                "expandable": false,
                "children": []
              },
              {
                "name": "NOT_PAID",
                "type": "`\"not_paid\"`",
                "description": "The order's payment is not paid.",
                "optional": true,
                "defaultValue": "",
                "expandable": false,
                "children": []
              },
              {
                "name": "PARTIALLY_REFUNDED",
                "type": "`\"partially_refunded\"`",
                "description": "Some of the order's payment amount is refunded.",
                "optional": true,
                "defaultValue": "",
                "expandable": false,
                "children": []
              },
              {
                "name": "REFUNDED",
                "type": "`\"refunded\"`",
                "description": "The order's payment amount is refunded.",
                "optional": true,
                "defaultValue": "",
                "expandable": false,
                "children": []
              },
              {
                "name": "REQUIRES_ACTION",
                "type": "`\"requires_action\"`",
                "description": "The order's payment requires action.",
                "optional": true,
                "defaultValue": "",
                "expandable": false,
                "children": []
              }
            ]
          },
          {
            "name": "payments",
            "type": "[Payment](../../entities/classes/entities.Payment.mdx)[]",
            "description": "The details of the payments used in the order.",
            "optional": false,
            "defaultValue": "",
            "expandable": true,
            "children": [
              {
                "name": "amount",
                "type": "`number`",
                "description": "The amount that the Payment has been authorized for.",
                "optional": false,
                "defaultValue": "",
                "expandable": false,
                "children": []
              },
              {
                "name": "amount_refunded",
                "type": "`number`",
                "description": "The amount of the original Payment amount that has been refunded back to the Customer.",
                "optional": false,
                "defaultValue": "0",
                "expandable": false,
                "children": []
              },
              {
                "name": "canceled_at",
                "type": "`string` \\| `Date`",
                "description": "The date with timezone at which the Payment was canceled.",
                "optional": false,
                "defaultValue": "",
                "expandable": false,
                "children": []
              },
              {
                "name": "captured_at",
                "type": "`string` \\| `Date`",
                "description": "The date with timezone at which the Payment was captured.",
                "optional": false,
                "defaultValue": "",
                "expandable": false,
                "children": []
              },
              {
                "name": "cart",
                "type": "[Cart](../../entities/classes/entities.Cart.mdx)",
                "description": "The details of the cart that the payment session was potentially created for.",
                "optional": false,
                "defaultValue": "",
                "expandable": true,
                "children": []
              },
              {
                "name": "cart_id",
                "type": "`string`",
                "description": "The ID of the cart that the payment session was potentially created for.",
                "optional": false,
                "defaultValue": "",
                "expandable": false,
                "children": []
              },
              {
                "name": "created_at",
                "type": "`Date`",
                "description": "The date with timezone at which the resource was created.",
                "optional": false,
                "defaultValue": "",
                "expandable": false,
                "children": []
              },
              {
                "name": "currency",
                "type": "[Currency](../../entities/classes/entities.Currency.mdx)",
                "description": "The details of the currency of the payment.",
                "optional": false,
                "defaultValue": "",
                "expandable": true,
                "children": []
              },
              {
                "name": "currency_code",
                "type": "`string`",
                "description": "The 3 character ISO currency code of the payment.",
                "optional": false,
                "defaultValue": "",
                "expandable": false,
                "children": []
              },
              {
                "name": "data",
                "type": "`Record<string, unknown>`",
                "description": "The data required for the Payment Provider to identify, modify and process the Payment. Typically this will be an object that holds an id to the external payment session, but can be an empty object if the Payment Provider doesn't hold any state.",
                "optional": false,
                "defaultValue": "",
                "expandable": false,
                "children": []
              },
              {
                "name": "id",
                "type": "`string`",
                "description": "The payment's ID",
                "optional": false,
                "defaultValue": "",
                "expandable": false,
                "children": []
              },
              {
                "name": "idempotency_key",
                "type": "`string`",
                "description": "Randomly generated key used to continue the completion of a payment in case of failure.",
                "optional": false,
                "defaultValue": "",
                "expandable": false,
                "children": []
              },
              {
                "name": "metadata",
                "type": "`Record<string, unknown>`",
                "description": "An optional key-value map with additional details",
                "optional": false,
                "defaultValue": "",
                "expandable": false,
                "children": []
              },
              {
                "name": "order",
                "type": "[Order](../../entities/classes/entities.Order.mdx)",
                "description": "The details of the order that the payment session was potentially created for.",
                "optional": false,
                "defaultValue": "",
                "expandable": true,
                "children": []
              },
              {
                "name": "order_id",
                "type": "`string`",
                "description": "The ID of the order that the payment session was potentially created for.",
                "optional": false,
                "defaultValue": "",
                "expandable": false,
                "children": []
              },
              {
                "name": "provider_id",
                "type": "`string`",
                "description": "The id of the Payment Provider that is responsible for the Payment",
                "optional": false,
                "defaultValue": "",
                "expandable": false,
                "children": []
              },
              {
                "name": "swap",
                "type": "[Swap](../../entities/classes/entities.Swap.mdx)",
                "description": "The details of the swap that this payment was potentially created for.",
                "optional": false,
                "defaultValue": "",
                "expandable": true,
                "children": []
              },
              {
                "name": "swap_id",
                "type": "`string`",
                "description": "The ID of the swap that this payment was potentially created for.",
                "optional": false,
                "defaultValue": "",
                "expandable": false,
                "children": []
              },
              {
                "name": "updated_at",
                "type": "`Date`",
                "description": "The date with timezone at which the resource was updated.",
                "optional": false,
                "defaultValue": "",
                "expandable": false,
                "children": []
              }
            ]
          },
          {
            "name": "raw_discount_total",
            "type": "`number`",
            "description": "The total of discount",
            "optional": false,
            "defaultValue": "",
            "expandable": false,
            "children": []
          },
          {
            "name": "refundable_amount",
            "type": "`number`",
            "description": "The amount that can be refunded",
            "optional": false,
            "defaultValue": "",
            "expandable": false,
            "children": []
          },
          {
            "name": "refunded_total",
            "type": "`number`",
            "description": "The total amount refunded if the order is returned.",
            "optional": false,
            "defaultValue": "",
            "expandable": false,
            "children": []
          },
          {
            "name": "refunds",
            "type": "[Refund](../../entities/classes/entities.Refund.mdx)[]",
            "description": "The details of the refunds created for the order.",
            "optional": false,
            "defaultValue": "",
            "expandable": true,
            "children": [
              {
                "name": "amount",
                "type": "`number`",
                "description": "The amount that has be refunded to the Customer.",
                "optional": false,
                "defaultValue": "",
                "expandable": false,
                "children": []
              },
              {
                "name": "created_at",
                "type": "`Date`",
                "description": "The date with timezone at which the resource was created.",
                "optional": false,
                "defaultValue": "",
                "expandable": false,
                "children": []
              },
              {
                "name": "id",
                "type": "`string`",
                "description": "The refund's ID",
                "optional": false,
                "defaultValue": "",
                "expandable": false,
                "children": []
              },
              {
                "name": "idempotency_key",
                "type": "`string`",
                "description": "Randomly generated key used to continue the completion of the refund in case of failure.",
                "optional": false,
                "defaultValue": "",
                "expandable": false,
                "children": []
              },
              {
                "name": "metadata",
                "type": "`Record<string, unknown>`",
                "description": "An optional key-value map with additional details",
                "optional": false,
                "defaultValue": "",
                "expandable": false,
                "children": []
              },
              {
                "name": "note",
                "type": "`string`",
                "description": "An optional note explaining why the amount was refunded.",
                "optional": false,
                "defaultValue": "",
                "expandable": false,
                "children": []
              },
              {
                "name": "order",
                "type": "[Order](../../entities/classes/entities.Order.mdx)",
                "description": "The details of the order this refund was created for.",
                "optional": false,
                "defaultValue": "",
                "expandable": true,
                "children": []
              },
              {
                "name": "order_id",
                "type": "`string`",
                "description": "The ID of the order this refund was created for.",
                "optional": false,
                "defaultValue": "",
                "expandable": false,
                "children": []
              },
              {
                "name": "payment",
                "type": "[Payment](../../entities/classes/entities.Payment.mdx)",
                "description": "The details of the payment associated with the refund.",
                "optional": false,
                "defaultValue": "",
                "expandable": true,
                "children": []
              },
              {
                "name": "payment_id",
                "type": "`string`",
                "description": "The payment's ID, if available.",
                "optional": false,
                "defaultValue": "",
                "expandable": false,
                "children": []
              },
              {
                "name": "reason",
                "type": "`string`",
                "description": "The reason given for the Refund, will automatically be set when processed as part of a Swap, Claim or Return.",
                "optional": false,
                "defaultValue": "",
                "expandable": false,
                "children": []
              },
              {
                "name": "updated_at",
                "type": "`Date`",
                "description": "The date with timezone at which the resource was updated.",
                "optional": false,
                "defaultValue": "",
                "expandable": false,
                "children": []
              }
            ]
          },
          {
            "name": "region",
            "type": "[Region](../../entities/classes/entities.Region.mdx)",
            "description": "The details of the region this order was created in.",
            "optional": false,
            "defaultValue": "",
            "expandable": true,
            "children": [
              {
                "name": "automatic_taxes",
                "type": "`boolean`",
                "description": "Whether taxes should be automated in this region.",
                "optional": false,
                "defaultValue": "true",
                "expandable": false,
                "children": []
              },
              {
                "name": "countries",
                "type": "[Country](../../entities/classes/entities.Country.mdx)[]",
                "description": "The details of the countries included in this region.",
                "optional": false,
                "defaultValue": "",
                "expandable": true,
                "children": []
              },
              {
                "name": "created_at",
                "type": "`Date`",
                "description": "The date with timezone at which the resource was created.",
                "optional": false,
                "defaultValue": "",
                "expandable": false,
                "children": []
              },
              {
                "name": "currency",
                "type": "[Currency](../../entities/classes/entities.Currency.mdx)",
                "description": "The details of the currency used in the region.",
                "optional": false,
                "defaultValue": "",
                "expandable": true,
                "children": []
              },
              {
                "name": "currency_code",
                "type": "`string`",
                "description": "The three character currency code used in the region.",
                "optional": false,
                "defaultValue": "",
                "expandable": false,
                "children": []
              },
              {
                "name": "deleted_at",
                "type": "`null` \\| `Date`",
                "description": "The date with timezone at which the resource was deleted.",
                "optional": false,
                "defaultValue": "",
                "expandable": false,
                "children": []
              },
              {
                "name": "fulfillment_providers",
                "type": "[FulfillmentProvider](../../entities/classes/entities.FulfillmentProvider.mdx)[]",
                "description": "The details of the fulfillment providers that can be used to fulfill items of orders and similar resources in the region.",
                "optional": false,
                "defaultValue": "",
                "expandable": true,
                "children": []
              },
              {
                "name": "gift_cards_taxable",
                "type": "`boolean`",
                "description": "Whether the gift cards are taxable or not in this region.",
                "optional": false,
                "defaultValue": "true",
                "expandable": false,
                "children": []
              },
              {
                "name": "id",
                "type": "`string`",
                "description": "The region's ID",
                "optional": false,
                "defaultValue": "",
                "expandable": false,
                "children": []
              },
              {
                "name": "includes_tax",
                "type": "`boolean`",
                "description": "Whether the prices for the region include tax",
                "optional": false,
                "defaultValue": "false",
                "expandable": false,
                "featureFlag": "tax_inclusive_pricing",
                "children": []
              },
              {
                "name": "metadata",
                "type": "`Record<string, unknown>`",
                "description": "An optional key-value map with additional details",
                "optional": false,
                "defaultValue": "",
                "expandable": false,
                "children": []
              },
              {
                "name": "name",
                "type": "`string`",
                "description": "The name of the region as displayed to the customer. If the Region only has one country it is recommended to write the country name.",
                "optional": false,
                "defaultValue": "",
                "expandable": false,
                "children": []
              },
              {
                "name": "payment_providers",
                "type": "[PaymentProvider](../../entities/classes/entities.PaymentProvider.mdx)[]",
                "description": "The details of the payment providers that can be used to process payments in the region.",
                "optional": false,
                "defaultValue": "",
                "expandable": true,
                "children": []
              },
              {
                "name": "tax_code",
                "type": "`string`",
                "description": "The tax code used on purchases in the Region. This may be used by other systems for accounting purposes.",
                "optional": false,
                "defaultValue": "",
                "expandable": false,
                "children": []
              },
              {
                "name": "tax_provider",
                "type": "[TaxProvider](../../entities/classes/entities.TaxProvider.mdx)",
                "description": "The details of the tax provider used in the region.",
                "optional": false,
                "defaultValue": "",
                "expandable": true,
                "children": []
              },
              {
                "name": "tax_provider_id",
                "type": "`null` \\| `string`",
                "description": "The ID of the tax provider used in this region",
                "optional": false,
                "defaultValue": "",
                "expandable": false,
                "children": []
              },
              {
                "name": "tax_rate",
                "type": "`number`",
                "description": "The tax rate that should be charged on purchases in the Region.",
                "optional": false,
                "defaultValue": "",
                "expandable": false,
                "children": []
              },
              {
                "name": "tax_rates",
                "type": "`null` \\| [TaxRate](../../entities/classes/entities.TaxRate.mdx)[]",
                "description": "The details of the tax rates used in the region, aside from the default rate.",
                "optional": false,
                "defaultValue": "",
                "expandable": true,
                "children": []
              },
              {
                "name": "updated_at",
                "type": "`Date`",
                "description": "The date with timezone at which the resource was updated.",
                "optional": false,
                "defaultValue": "",
                "expandable": false,
                "children": []
              }
            ]
          },
          {
            "name": "region_id",
            "type": "`string`",
            "description": "The ID of the region this order was created in.",
            "optional": false,
            "defaultValue": "",
            "expandable": false,
            "children": []
          },
          {
            "name": "returnable_items",
            "type": "[LineItem](../../entities/classes/entities.LineItem.mdx)[]",
            "description": "The details of the line items that are returnable as part of the order, swaps, or claims",
            "optional": true,
            "defaultValue": "",
            "expandable": true,
            "children": [
              {
                "name": "adjustments",
                "type": "[LineItemAdjustment](../../entities/classes/entities.LineItemAdjustment.mdx)[]",
                "description": "The details of the item's adjustments, which are available when a discount is applied on the item.",
                "optional": false,
                "defaultValue": "",
                "expandable": true,
                "children": []
              },
              {
                "name": "allow_discounts",
                "type": "`boolean`",
                "description": "Flag to indicate if the Line Item should be included when doing discount calculations.",
                "optional": false,
                "defaultValue": "true",
                "expandable": false,
                "children": []
              },
              {
                "name": "cart",
                "type": "[Cart](../../entities/classes/entities.Cart.mdx)",
                "description": "The details of the cart that the line item may belongs to.",
                "optional": false,
                "defaultValue": "",
                "expandable": true,
                "children": []
              },
              {
                "name": "cart_id",
                "type": "`string`",
                "description": "The ID of the cart that the line item may belongs to.",
                "optional": false,
                "defaultValue": "",
                "expandable": false,
                "children": []
              },
              {
                "name": "claim_order",
                "type": "[ClaimOrder](../../entities/classes/entities.ClaimOrder.mdx)",
                "description": "The details of the claim that the line item may belong to.",
                "optional": false,
                "defaultValue": "",
                "expandable": true,
                "children": []
              },
              {
                "name": "claim_order_id",
                "type": "`string`",
                "description": "The ID of the claim that the line item may belong to.",
                "optional": false,
                "defaultValue": "",
                "expandable": false,
                "children": []
              },
              {
                "name": "created_at",
                "type": "`Date`",
                "description": "The date with timezone at which the resource was created.",
                "optional": false,
                "defaultValue": "",
                "expandable": false,
                "children": []
              },
              {
                "name": "description",
                "type": "`null` \\| `string`",
                "description": "A more detailed description of the contents of the Line Item.",
                "optional": false,
                "defaultValue": "",
                "expandable": false,
                "children": []
              },
              {
                "name": "discount_total",
                "type": "`null` \\| `number`",
                "description": "The total of discount of the line item rounded",
                "optional": true,
                "defaultValue": "",
                "expandable": false,
                "children": []
              },
              {
                "name": "fulfilled_quantity",
                "type": "`null` \\| `number`",
                "description": "The quantity of the Line Item that has been fulfilled.",
                "optional": false,
                "defaultValue": "",
                "expandable": false,
                "children": []
              },
              {
                "name": "gift_card_total",
                "type": "`null` \\| `number`",
                "description": "The total of the gift card of the line item",
                "optional": true,
                "defaultValue": "",
                "expandable": false,
                "children": []
              },
              {
                "name": "has_shipping",
                "type": "`null` \\| `boolean`",
                "description": "Flag to indicate if the Line Item has fulfillment associated with it.",
                "optional": false,
                "defaultValue": "",
                "expandable": false,
                "children": []
              },
              {
                "name": "id",
                "type": "`string`",
                "description": "The line item's ID",
                "optional": false,
                "defaultValue": "",
                "expandable": false,
                "children": []
              },
              {
                "name": "includes_tax",
                "type": "`boolean`",
                "description": "Indicates if the line item unit\\_price include tax",
                "optional": false,
                "defaultValue": "false",
                "expandable": false,
                "featureFlag": "tax_inclusive_pricing",
                "children": []
              },
              {
                "name": "is_giftcard",
                "type": "`boolean`",
                "description": "Flag to indicate if the Line Item is a Gift Card.",
                "optional": false,
                "defaultValue": "false",
                "expandable": false,
                "children": []
              },
              {
                "name": "is_return",
                "type": "`boolean`",
                "description": "Is the item being returned",
                "optional": false,
                "defaultValue": "false",
                "expandable": false,
                "children": []
              },
              {
                "name": "metadata",
                "type": "`Record<string, unknown>`",
                "description": "An optional key-value map with additional details",
                "optional": false,
                "defaultValue": "",
                "expandable": false,
                "children": []
              },
              {
                "name": "order",
                "type": "[Order](../../entities/classes/entities.Order.mdx)",
                "description": "The details of the order that the line item may belongs to.",
                "optional": false,
                "defaultValue": "",
                "expandable": true,
                "children": []
              },
              {
                "name": "order_edit",
                "type": "`null` \\| [OrderEdit](../../entities/classes/entities.OrderEdit.mdx)",
                "description": "The details of the order edit.",
                "optional": true,
                "defaultValue": "",
                "expandable": true,
                "children": []
              },
              {
                "name": "order_edit_id",
                "type": "`null` \\| `string`",
                "description": "The ID of the order edit that the item may belong to.",
                "optional": true,
                "defaultValue": "",
                "expandable": false,
                "children": []
              },
              {
                "name": "order_id",
                "type": "`null` \\| `string`",
                "description": "The ID of the order that the line item may belongs to.",
                "optional": false,
                "defaultValue": "",
                "expandable": false,
                "children": []
              },
              {
                "name": "original_item_id",
                "type": "`null` \\| `string`",
                "description": "The ID of the original line item. This is useful if the line item belongs to a resource that references an order, such as a return or an order edit.",
                "optional": true,
                "defaultValue": "",
                "expandable": false,
                "children": []
              },
              {
                "name": "original_tax_total",
                "type": "`null` \\| `number`",
                "description": "The original tax total amount of the line item",
                "optional": true,
                "defaultValue": "",
                "expandable": false,
                "children": []
              },
              {
                "name": "original_total",
                "type": "`null` \\| `number`",
                "description": "The original total amount of the line item",
                "optional": true,
                "defaultValue": "",
                "expandable": false,
                "children": []
              },
              {
                "name": "product_id",
                "type": "`null` \\| `string`",
                "description": "",
                "optional": false,
                "defaultValue": "",
                "expandable": false,
                "children": []
              },
              {
                "name": "quantity",
                "type": "`number`",
                "description": "The quantity of the content in the Line Item.",
                "optional": false,
                "defaultValue": "",
                "expandable": false,
                "children": []
              },
              {
                "name": "raw_discount_total",
                "type": "`null` \\| `number`",
                "description": "The total of discount of the line item",
                "optional": true,
                "defaultValue": "",
                "expandable": false,
                "children": []
              },
              {
                "name": "refundable",
                "type": "`null` \\| `number`",
                "description": "The amount that can be refunded from the given Line Item. Takes taxes and discounts into consideration.",
                "optional": true,
                "defaultValue": "",
                "expandable": false,
                "children": []
              },
              {
                "name": "returned_quantity",
                "type": "`null` \\| `number`",
                "description": "The quantity of the Line Item that has been returned.",
                "optional": false,
                "defaultValue": "",
                "expandable": false,
                "children": []
              },
              {
                "name": "shipped_quantity",
                "type": "`null` \\| `number`",
                "description": "The quantity of the Line Item that has been shipped.",
                "optional": false,
                "defaultValue": "",
                "expandable": false,
                "children": []
              },
              {
                "name": "should_merge",
                "type": "`boolean`",
                "description": "Flag to indicate if new Line Items with the same variant should be merged or added as an additional Line Item.",
                "optional": false,
                "defaultValue": "true",
                "expandable": false,
                "children": []
              },
              {
                "name": "subtotal",
                "type": "`null` \\| `number`",
                "description": "The subtotal of the line item",
                "optional": true,
                "defaultValue": "",
                "expandable": false,
                "children": []
              },
              {
                "name": "swap",
                "type": "[Swap](../../entities/classes/entities.Swap.mdx)",
                "description": "The details of the swap that the line item may belong to.",
                "optional": false,
                "defaultValue": "",
                "expandable": true,
                "children": []
              },
              {
                "name": "swap_id",
                "type": "`string`",
                "description": "The ID of the swap that the line item may belong to.",
                "optional": false,
                "defaultValue": "",
                "expandable": false,
                "children": []
              },
              {
                "name": "tax_lines",
                "type": "[LineItemTaxLine](../../entities/classes/entities.LineItemTaxLine.mdx)[]",
                "description": "The details of the item's tax lines.",
                "optional": false,
                "defaultValue": "",
                "expandable": true,
                "children": []
              },
              {
                "name": "tax_total",
                "type": "`null` \\| `number`",
                "description": "The total of tax of the line item",
                "optional": true,
                "defaultValue": "",
                "expandable": false,
                "children": []
              },
              {
                "name": "thumbnail",
                "type": "`null` \\| `string`",
                "description": "A URL string to a small image of the contents of the Line Item.",
                "optional": false,
                "defaultValue": "",
                "expandable": false,
                "children": []
              },
              {
                "name": "title",
                "type": "`string`",
                "description": "The title of the Line Item.",
                "optional": false,
                "defaultValue": "",
                "expandable": false,
                "children": []
              },
              {
                "name": "total",
                "type": "`null` \\| `number`",
                "description": "The total amount of the line item",
                "optional": true,
                "defaultValue": "",
                "expandable": false,
                "children": []
              },
              {
                "name": "unit_price",
                "type": "`number`",
                "description": "The price of one unit of the content in the Line Item. This should be in the currency defined by the Cart/Order/Swap/Claim that the Line Item belongs to.",
                "optional": false,
                "defaultValue": "",
                "expandable": false,
                "children": []
              },
              {
                "name": "updated_at",
                "type": "`Date`",
                "description": "The date with timezone at which the resource was updated.",
                "optional": false,
                "defaultValue": "",
                "expandable": false,
                "children": []
              },
              {
                "name": "variant",
                "type": "[ProductVariant](../../entities/classes/entities.ProductVariant.mdx)",
                "description": "The details of the product variant that this item was created from.",
                "optional": false,
                "defaultValue": "",
                "expandable": true,
                "children": []
              },
              {
                "name": "variant_id",
                "type": "`null` \\| `string`",
                "description": "The id of the Product Variant contained in the Line Item.",
                "optional": false,
                "defaultValue": "",
                "expandable": false,
                "children": []
              }
            ]
          },
          {
            "name": "returns",
            "type": "[Return](../../entities/classes/entities.Return.mdx)[]",
            "description": "The details of the returns created for the order.",
            "optional": false,
            "defaultValue": "",
            "expandable": true,
            "children": [
              {
                "name": "claim_order",
                "type": "[ClaimOrder](../../entities/classes/entities.ClaimOrder.mdx)",
                "description": "The details of the claim that the return may belong to.",
                "optional": false,
                "defaultValue": "",
                "expandable": true,
                "children": []
              },
              {
                "name": "claim_order_id",
                "type": "`null` \\| `string`",
                "description": "The ID of the claim that the return may belong to.",
                "optional": false,
                "defaultValue": "",
                "expandable": false,
                "children": []
              },
              {
                "name": "created_at",
                "type": "`Date`",
                "description": "The date with timezone at which the resource was created.",
                "optional": false,
                "defaultValue": "",
                "expandable": false,
                "children": []
              },
              {
                "name": "id",
                "type": "`string`",
                "description": "The return's ID",
                "optional": false,
                "defaultValue": "",
                "expandable": false,
                "children": []
              },
              {
                "name": "idempotency_key",
                "type": "`null` \\| `string`",
                "description": "Randomly generated key used to continue the completion of the return in case of failure.",
                "optional": false,
                "defaultValue": "",
                "expandable": false,
                "children": []
              },
              {
                "name": "items",
                "type": "[ReturnItem](../../entities/classes/entities.ReturnItem.mdx)[]",
                "description": "The details of the items that the customer is returning.",
                "optional": false,
                "defaultValue": "",
                "expandable": true,
                "children": []
              },
              {
                "name": "location_id",
                "type": "`null` \\| `string`",
                "description": "The ID of the stock location the return will be added back.",
                "optional": false,
                "defaultValue": "",
                "expandable": false,
                "children": []
              },
              {
                "name": "metadata",
                "type": "`null` \\| `Record<string, unknown>`",
                "description": "An optional key-value map with additional details",
                "optional": false,
                "defaultValue": "",
                "expandable": false,
                "children": []
              },
              {
                "name": "no_notification",
                "type": "`null` \\| `boolean`",
                "description": "When set to true, no notification will be sent related to this return.",
                "optional": false,
                "defaultValue": "",
                "expandable": false,
                "children": []
              },
              {
                "name": "order",
                "type": "[Order](../../entities/classes/entities.Order.mdx)",
                "description": "The details of the order that the return was created for.",
                "optional": false,
                "defaultValue": "",
                "expandable": true,
                "children": []
              },
              {
                "name": "order_id",
                "type": "`null` \\| `string`",
                "description": "The ID of the order that the return was created for.",
                "optional": false,
                "defaultValue": "",
                "expandable": false,
                "children": []
              },
              {
                "name": "received_at",
                "type": "`Date`",
                "description": "The date with timezone at which the return was received.",
                "optional": false,
                "defaultValue": "",
                "expandable": false,
                "children": []
              },
              {
                "name": "refund_amount",
                "type": "`number`",
                "description": "The amount that should be refunded as a result of the return.",
                "optional": false,
                "defaultValue": "",
                "expandable": false,
                "children": []
              },
              {
                "name": "shipping_data",
                "type": "`Record<string, unknown>`",
                "description": "Data about the return shipment as provided by the Fulfilment Provider that handles the return shipment.",
                "optional": false,
                "defaultValue": "",
                "expandable": false,
                "children": []
              },
              {
                "name": "shipping_method",
                "type": "[ShippingMethod](../../entities/classes/entities.ShippingMethod.mdx)",
                "description": "The details of the Shipping Method that will be used to send the Return back. Can be null if the Customer will handle the return shipment themselves.",
                "optional": false,
                "defaultValue": "",
                "expandable": true,
                "children": []
              },
              {
                "name": "status",
                "type": "[ReturnStatus](../../entities/enums/entities.ReturnStatus.mdx)",
                "description": "Status of the Return.",
                "optional": false,
                "defaultValue": "requested",
                "expandable": false,
                "children": []
              },
              {
                "name": "swap",
                "type": "[Swap](../../entities/classes/entities.Swap.mdx)",
                "description": "The details of the swap that the return may belong to.",
                "optional": false,
                "defaultValue": "",
                "expandable": true,
                "children": []
              },
              {
                "name": "swap_id",
                "type": "`null` \\| `string`",
                "description": "The ID of the swap that the return may belong to.",
                "optional": false,
                "defaultValue": "",
                "expandable": false,
                "children": []
              },
              {
                "name": "updated_at",
                "type": "`Date`",
                "description": "The date with timezone at which the resource was updated.",
                "optional": false,
                "defaultValue": "",
                "expandable": false,
                "children": []
              }
            ]
          },
          {
            "name": "sales_channel",
            "type": "[SalesChannel](../../entities/classes/entities.SalesChannel.mdx)",
            "description": "The details of the sales channel this order belongs to.",
            "optional": false,
            "defaultValue": "",
            "expandable": true,
            "children": [
              {
                "name": "created_at",
                "type": "`Date`",
                "description": "The date with timezone at which the resource was created.",
                "optional": false,
                "defaultValue": "",
                "expandable": false,
                "children": []
              },
              {
                "name": "deleted_at",
                "type": "`null` \\| `Date`",
                "description": "The date with timezone at which the resource was deleted.",
                "optional": false,
                "defaultValue": "",
                "expandable": false,
                "children": []
              },
              {
                "name": "description",
                "type": "`null` \\| `string`",
                "description": "The description of the sales channel.",
                "optional": false,
                "defaultValue": "",
                "expandable": false,
                "children": []
              },
              {
                "name": "id",
                "type": "`string`",
                "description": "The sales channel's ID",
                "optional": false,
                "defaultValue": "",
                "expandable": false,
                "children": []
              },
              {
                "name": "is_disabled",
                "type": "`boolean`",
                "description": "Specify if the sales channel is enabled or disabled.",
                "optional": false,
                "defaultValue": "false",
                "expandable": false,
                "children": []
              },
              {
                "name": "locations",
                "type": "[SalesChannelLocation](../../entities/classes/entities.SalesChannelLocation.mdx)[]",
                "description": "The details of the stock locations related to the sales channel.",
                "optional": false,
                "defaultValue": "",
                "expandable": true,
                "children": []
              },
              {
                "name": "metadata",
                "type": "`null` \\| `Record<string, unknown>`",
                "description": "An optional key-value map with additional details",
                "optional": false,
                "defaultValue": "",
                "expandable": false,
                "children": []
              },
              {
                "name": "name",
                "type": "`string`",
                "description": "The name of the sales channel.",
                "optional": false,
                "defaultValue": "",
                "expandable": false,
                "children": []
              },
              {
                "name": "updated_at",
                "type": "`Date`",
                "description": "The date with timezone at which the resource was updated.",
                "optional": false,
                "defaultValue": "",
                "expandable": false,
                "children": []
              }
            ]
          },
          {
            "name": "sales_channel_id",
            "type": "`null` \\| `string`",
            "description": "The ID of the sales channel this order belongs to.",
            "optional": false,
            "defaultValue": "",
            "expandable": false,
            "children": []
          },
          {
            "name": "shipping_address",
            "type": "[Address](../../entities/classes/entities.Address.mdx)",
            "description": "The details of the shipping address associated with the order.",
            "optional": false,
            "defaultValue": "",
            "expandable": true,
            "children": [
              {
                "name": "address_1",
                "type": "`null` \\| `string`",
                "description": "Address line 1",
                "optional": false,
                "defaultValue": "",
                "expandable": false,
                "children": []
              },
              {
                "name": "address_2",
                "type": "`null` \\| `string`",
                "description": "Address line 2",
                "optional": false,
                "defaultValue": "",
                "expandable": false,
                "children": []
              },
              {
                "name": "city",
                "type": "`null` \\| `string`",
                "description": "City",
                "optional": false,
                "defaultValue": "",
                "expandable": false,
                "children": []
              },
              {
                "name": "company",
                "type": "`null` \\| `string`",
                "description": "Company name",
                "optional": false,
                "defaultValue": "",
                "expandable": false,
                "children": []
              },
              {
                "name": "country",
                "type": "`null` \\| [Country](../../entities/classes/entities.Country.mdx)",
                "description": "A country object.",
                "optional": false,
                "defaultValue": "",
                "expandable": true,
                "children": []
              },
              {
                "name": "country_code",
                "type": "`null` \\| `string`",
                "description": "The 2 character ISO code of the country in lower case",
                "optional": false,
                "defaultValue": "",
                "expandable": false,
                "children": []
              },
              {
                "name": "created_at",
                "type": "`Date`",
                "description": "The date with timezone at which the resource was created.",
                "optional": false,
                "defaultValue": "",
                "expandable": false,
                "children": []
              },
              {
                "name": "customer",
                "type": "`null` \\| [Customer](../../entities/classes/entities.Customer.mdx)",
                "description": "Available if the relation `customer` is expanded.",
                "optional": false,
                "defaultValue": "",
                "expandable": false,
                "children": []
              },
              {
                "name": "customer_id",
                "type": "`null` \\| `string`",
                "description": "ID of the customer this address belongs to",
                "optional": false,
                "defaultValue": "",
                "expandable": false,
                "children": []
              },
              {
                "name": "deleted_at",
                "type": "`null` \\| `Date`",
                "description": "The date with timezone at which the resource was deleted.",
                "optional": false,
                "defaultValue": "",
                "expandable": false,
                "children": []
              },
              {
                "name": "first_name",
                "type": "`null` \\| `string`",
                "description": "First name",
                "optional": false,
                "defaultValue": "",
                "expandable": false,
                "children": []
              },
              {
                "name": "id",
                "type": "`string`",
                "description": "ID of the address",
                "optional": false,
                "defaultValue": "",
                "expandable": false,
                "children": []
              },
              {
                "name": "last_name",
                "type": "`null` \\| `string`",
                "description": "Last name",
                "optional": false,
                "defaultValue": "",
                "expandable": false,
                "children": []
              },
              {
                "name": "metadata",
                "type": "`Record<string, unknown>`",
                "description": "An optional key-value map with additional details",
                "optional": false,
                "defaultValue": "",
                "expandable": false,
                "children": []
              },
              {
                "name": "phone",
                "type": "`null` \\| `string`",
                "description": "Phone Number",
                "optional": false,
                "defaultValue": "",
                "expandable": false,
                "children": []
              },
              {
                "name": "postal_code",
                "type": "`null` \\| `string`",
                "description": "Postal Code",
                "optional": false,
                "defaultValue": "",
                "expandable": false,
                "children": []
              },
              {
                "name": "province",
                "type": "`null` \\| `string`",
                "description": "Province",
                "optional": false,
                "defaultValue": "",
                "expandable": false,
                "children": []
              },
              {
                "name": "updated_at",
                "type": "`Date`",
                "description": "The date with timezone at which the resource was updated.",
                "optional": false,
                "defaultValue": "",
                "expandable": false,
                "children": []
              }
            ]
          },
          {
            "name": "shipping_address_id",
            "type": "`string`",
            "description": "The ID of the shipping address associated with the order",
            "optional": false,
            "defaultValue": "",
            "expandable": false,
            "children": []
          },
          {
            "name": "shipping_methods",
            "type": "[ShippingMethod](../../entities/classes/entities.ShippingMethod.mdx)[]",
            "description": "The details of the shipping methods used in the order.",
            "optional": false,
            "defaultValue": "",
            "expandable": true,
            "children": [
              {
                "name": "cart",
                "type": "[Cart](../../entities/classes/entities.Cart.mdx)",
                "description": "The details of the cart that the shipping method is used in.",
                "optional": false,
                "defaultValue": "",
                "expandable": true,
                "children": []
              },
              {
                "name": "cart_id",
                "type": "`string`",
                "description": "The ID of the cart that the shipping method is used in.",
                "optional": false,
                "defaultValue": "",
                "expandable": false,
                "children": []
              },
              {
                "name": "claim_order",
                "type": "[ClaimOrder](../../entities/classes/entities.ClaimOrder.mdx)",
                "description": "The details of the claim that the shipping method is used in.",
                "optional": false,
                "defaultValue": "",
                "expandable": true,
                "children": []
              },
              {
                "name": "claim_order_id",
                "type": "`null` \\| `string`",
                "description": "The ID of the claim that the shipping method is used in.",
                "optional": false,
                "defaultValue": "",
                "expandable": false,
                "children": []
              },
              {
                "name": "data",
                "type": "`Record<string, unknown>`",
                "description": "Additional data that the Fulfillment Provider needs to fulfill the shipment. This is used in combination with the Shipping Options data, and may contain information such as a drop point id.",
                "optional": false,
                "defaultValue": "",
                "expandable": false,
                "children": []
              },
              {
                "name": "id",
                "type": "`string`",
                "description": "The shipping method's ID",
                "optional": false,
                "defaultValue": "",
                "expandable": false,
                "children": []
              },
              {
                "name": "includes_tax",
                "type": "`boolean`",
                "description": "Whether the shipping method price include tax",
                "optional": false,
                "defaultValue": "false",
                "expandable": false,
                "featureFlag": "tax_inclusive_pricing",
                "children": []
              },
              {
                "name": "order",
                "type": "[Order](../../entities/classes/entities.Order.mdx)",
                "description": "The details of the order that the shipping method is used in.",
                "optional": false,
                "defaultValue": "",
                "expandable": true,
                "children": []
              },
              {
                "name": "order_id",
                "type": "`string`",
                "description": "The ID of the order that the shipping method is used in.",
                "optional": false,
                "defaultValue": "",
                "expandable": false,
                "children": []
              },
              {
                "name": "price",
                "type": "`number`",
                "description": "The amount to charge for the Shipping Method. The currency of the price is defined by the Region that the Order that the Shipping Method belongs to is a part of.",
                "optional": false,
                "defaultValue": "",
                "expandable": false,
                "children": []
              },
              {
                "name": "return_id",
                "type": "`string`",
                "description": "The ID of the return that the shipping method is used in.",
                "optional": false,
                "defaultValue": "",
                "expandable": false,
                "children": []
              },
              {
                "name": "return_order",
                "type": "[Return](../../entities/classes/entities.Return.mdx)",
                "description": "The details of the return that the shipping method is used in.",
                "optional": false,
                "defaultValue": "",
                "expandable": true,
                "children": []
              },
              {
                "name": "shipping_option",
                "type": "[ShippingOption](../../entities/classes/entities.ShippingOption.mdx)",
                "description": "The details of the shipping option the method was created from.",
                "optional": false,
                "defaultValue": "",
                "expandable": true,
                "children": []
              },
              {
                "name": "shipping_option_id",
                "type": "`string`",
                "description": "The ID of the Shipping Option that the Shipping Method is built from.",
                "optional": false,
                "defaultValue": "",
                "expandable": false,
                "children": []
              },
              {
                "name": "subtotal",
                "type": "`number`",
                "description": "The subtotal of the shipping",
                "optional": true,
                "defaultValue": "",
                "expandable": false,
                "children": []
              },
              {
                "name": "swap",
                "type": "[Swap](../../entities/classes/entities.Swap.mdx)",
                "description": "The details of the swap that the shipping method is used in.",
                "optional": false,
                "defaultValue": "",
                "expandable": true,
                "children": []
              },
              {
                "name": "swap_id",
                "type": "`string`",
                "description": "The ID of the swap that the shipping method is used in.",
                "optional": false,
                "defaultValue": "",
                "expandable": false,
                "children": []
              },
              {
                "name": "tax_lines",
                "type": "[ShippingMethodTaxLine](../../entities/classes/entities.ShippingMethodTaxLine.mdx)[]",
                "description": "The details of the tax lines applied on the shipping method.",
                "optional": false,
                "defaultValue": "",
                "expandable": true,
                "children": []
              },
              {
                "name": "tax_total",
                "type": "`number`",
                "description": "The total of tax",
                "optional": true,
                "defaultValue": "",
                "expandable": false,
                "children": []
              },
              {
                "name": "total",
                "type": "`number`",
                "description": "The total amount of the shipping",
                "optional": true,
                "defaultValue": "",
                "expandable": false,
                "children": []
              }
            ]
          },
          {
            "name": "shipping_tax_total",
            "type": "`null` \\| `number`",
            "description": "The tax total applied on shipping",
            "optional": false,
            "defaultValue": "",
            "expandable": false,
            "children": []
          },
          {
            "name": "shipping_total",
            "type": "`number`",
            "description": "The total of shipping",
            "optional": false,
            "defaultValue": "",
            "expandable": false,
            "children": []
          },
          {
            "name": "status",
            "type": "[OrderStatus](../../entities/enums/entities.OrderStatus.mdx)",
            "description": "The order's status",
            "optional": false,
            "defaultValue": "pending",
            "expandable": false,
            "children": [
              {
                "name": "ARCHIVED",
                "type": "`\"archived\"`",
                "description": "The order is archived.",
                "optional": true,
                "defaultValue": "",
                "expandable": false,
                "children": []
              },
              {
                "name": "CANCELED",
                "type": "`\"canceled\"`",
                "description": "The order is canceled.",
                "optional": true,
                "defaultValue": "",
                "expandable": false,
                "children": []
              },
              {
                "name": "COMPLETED",
                "type": "`\"completed\"`",
                "description": "The order is completed, meaning that \nthe items have been fulfilled and the payment\nhas been captured.",
                "optional": true,
                "defaultValue": "",
                "expandable": false,
                "children": []
              },
              {
                "name": "PENDING",
                "type": "`\"pending\"`",
                "description": "The order is pending.",
                "optional": true,
                "defaultValue": "",
                "expandable": false,
                "children": []
              },
              {
                "name": "REQUIRES_ACTION",
                "type": "`\"requires_action\"`",
                "description": "The order requires action.",
                "optional": true,
                "defaultValue": "",
                "expandable": false,
                "children": []
              }
            ]
          },
          {
            "name": "subtotal",
            "type": "`number`",
            "description": "The subtotal of the order",
            "optional": false,
            "defaultValue": "",
            "expandable": false,
            "children": []
          },
          {
            "name": "swaps",
            "type": "[Swap](../../entities/classes/entities.Swap.mdx)[]",
            "description": "The details of the swaps created for the order.",
            "optional": false,
            "defaultValue": "",
            "expandable": true,
            "children": [
              {
                "name": "additional_items",
                "type": "[LineItem](../../entities/classes/entities.LineItem.mdx)[]",
                "description": "The details of the new products to send to the customer, represented as line items.",
                "optional": false,
                "defaultValue": "",
                "expandable": true,
                "children": []
              },
              {
                "name": "allow_backorder",
                "type": "`boolean`",
                "description": "If true, swaps can be completed with items out of stock",
                "optional": false,
                "defaultValue": "false",
                "expandable": false,
                "children": []
              },
              {
                "name": "canceled_at",
                "type": "`Date`",
                "description": "The date with timezone at which the Swap was canceled.",
                "optional": false,
                "defaultValue": "",
                "expandable": false,
                "children": []
              },
              {
                "name": "cart",
                "type": "[Cart](../../entities/classes/entities.Cart.mdx)",
                "description": "The details of the cart that the customer uses to complete the swap.",
                "optional": false,
                "defaultValue": "",
                "expandable": true,
                "children": []
              },
              {
                "name": "cart_id",
                "type": "`string`",
                "description": "The ID of the cart that the customer uses to complete the swap.",
                "optional": false,
                "defaultValue": "",
                "expandable": false,
                "children": []
              },
              {
                "name": "confirmed_at",
                "type": "`Date`",
                "description": "The date with timezone at which the Swap was confirmed by the Customer.",
                "optional": false,
                "defaultValue": "",
                "expandable": false,
                "children": []
              },
              {
                "name": "created_at",
                "type": "`Date`",
                "description": "The date with timezone at which the resource was created.",
                "optional": false,
                "defaultValue": "",
                "expandable": false,
                "children": []
              },
              {
                "name": "deleted_at",
                "type": "`null` \\| `Date`",
                "description": "The date with timezone at which the resource was deleted.",
                "optional": false,
                "defaultValue": "",
                "expandable": false,
                "children": []
              },
              {
                "name": "difference_due",
                "type": "`number`",
                "description": "The difference amount between the order’s original total and the new total imposed by the swap. If its value is negative, a refund must be issues to the customer. If it's positive, additional payment must be authorized by the customer. Otherwise, no payment processing is required.",
                "optional": false,
                "defaultValue": "",
                "expandable": false,
                "children": []
              },
              {
                "name": "fulfillment_status",
                "type": "[SwapFulfillmentStatus](../../entities/enums/entities.SwapFulfillmentStatus.mdx)",
                "description": "The status of the Fulfillment of the Swap.",
                "optional": false,
                "defaultValue": "",
                "expandable": false,
                "children": []
              },
              {
                "name": "fulfillments",
                "type": "[Fulfillment](../../entities/classes/entities.Fulfillment.mdx)[]",
                "description": "The details of the fulfillments that are used to send the new items to the customer.",
                "optional": false,
                "defaultValue": "",
                "expandable": true,
                "children": []
              },
              {
                "name": "id",
                "type": "`string`",
                "description": "The swap's ID",
                "optional": false,
                "defaultValue": "",
                "expandable": false,
                "children": []
              },
              {
                "name": "idempotency_key",
                "type": "`string`",
                "description": "Randomly generated key used to continue the completion of the swap in case of failure.",
                "optional": false,
                "defaultValue": "",
                "expandable": false,
                "children": []
              },
              {
                "name": "metadata",
                "type": "`Record<string, unknown>`",
                "description": "An optional key-value map with additional details",
                "optional": false,
                "defaultValue": "",
                "expandable": false,
                "children": []
              },
              {
                "name": "no_notification",
                "type": "`boolean`",
                "description": "If set to true, no notification will be sent related to this swap",
                "optional": false,
                "defaultValue": "",
                "expandable": false,
                "children": []
              },
              {
                "name": "order",
                "type": "[Order](../../entities/classes/entities.Order.mdx)",
                "description": "The details of the order that the swap belongs to.",
                "optional": false,
                "defaultValue": "",
                "expandable": true,
                "children": []
              },
              {
                "name": "order_id",
                "type": "`string`",
                "description": "The ID of the order that the swap belongs to.",
                "optional": false,
                "defaultValue": "",
                "expandable": false,
                "children": []
              },
              {
                "name": "payment",
                "type": "[Payment](../../entities/classes/entities.Payment.mdx)",
                "description": "The details of the additional payment authorized by the customer when `difference\\_due` is positive.",
                "optional": false,
                "defaultValue": "",
                "expandable": true,
                "children": []
              },
              {
                "name": "payment_status",
                "type": "[SwapPaymentStatus](../../entities/enums/entities.SwapPaymentStatus.mdx)",
                "description": "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.",
                "optional": false,
                "defaultValue": "",
                "expandable": false,
                "children": []
              },
              {
                "name": "return_order",
                "type": "[Return](../../entities/classes/entities.Return.mdx)",
                "description": "The details of the return that belongs to the swap, which holds the details on the items being returned.",
                "optional": false,
                "defaultValue": "",
                "expandable": true,
                "children": []
              },
              {
                "name": "shipping_address",
                "type": "[Address](../../entities/classes/entities.Address.mdx)",
                "description": "The details of the shipping address that the new items should be sent to.",
                "optional": false,
                "defaultValue": "",
                "expandable": true,
                "children": []
              },
              {
                "name": "shipping_address_id",
                "type": "`string`",
                "description": "The Address to send the new Line Items to - in most cases this will be the same as the shipping address on the Order.",
                "optional": false,
                "defaultValue": "",
                "expandable": false,
                "children": []
              },
              {
                "name": "shipping_methods",
                "type": "[ShippingMethod](../../entities/classes/entities.ShippingMethod.mdx)[]",
                "description": "The details of the shipping methods used to fulfill the additional items purchased.",
                "optional": false,
                "defaultValue": "",
                "expandable": true,
                "children": []
              },
              {
                "name": "updated_at",
                "type": "`Date`",
                "description": "The date with timezone at which the resource was updated.",
                "optional": false,
                "defaultValue": "",
                "expandable": false,
                "children": []
              }
            ]
          },
          {
            "name": "tax_rate",
            "type": "`null` \\| `number`",
            "description": "The order's tax rate",
            "optional": false,
            "defaultValue": "",
            "expandable": false,
            "children": []
          },
          {
            "name": "tax_total",
            "type": "`null` \\| `number`",
            "description": "The total of tax",
            "optional": false,
            "defaultValue": "",
            "expandable": false,
            "children": []
          },
          {
            "name": "total",
            "type": "`number`",
            "description": "The total amount of the order",
            "optional": false,
            "defaultValue": "",
            "expandable": false,
            "children": []
          },
          {
            "name": "updated_at",
            "type": "`Date`",
            "description": "The date with timezone at which the resource was updated.",
            "optional": false,
            "defaultValue": "",
            "expandable": false,
            "children": []
          }
        ]
      }
    ]
  }
]} />

___

### retrieveByCartId

Retrieve an order's details by the ID of the cart that was used to create the order.

#### Example

```ts
import Medusa from "@medusajs/medusa-js"
const medusa = new Medusa({ baseUrl: MEDUSA_BACKEND_URL, maxRetries: 3 })
medusa.orders.retrieveByCartId(cartId)
.then(({ order }) => {
  console.log(order.id);
})
```

#### Parameters

<ParameterTypes parameters={[
  {
    "name": "cart_id",
    "type": "`string`",
    "description": "The cart's ID.",
    "optional": false,
    "defaultValue": "",
    "expandable": false,
    "children": []
  },
  {
    "name": "customHeaders",
    "type": "`Record<string, any>`",
    "description": "Custom headers to attach to the request.",
    "optional": false,
    "defaultValue": "{}",
    "expandable": false,
    "children": []
  }
]} expandUrl="https://docs.medusajs.com/js-client/overview#expanding-fields"/>

#### Returns

<ParameterTypes parameters={[
  {
    "name": "ResponsePromise",
    "type": "ResponsePromise&#60;StoreOrdersRes&#62;",
    "optional": false,
    "defaultValue": "",
    "description": "Resolves to the details of the order.",
    "expandable": false,
    "children": [
      {
        "name": "order",
        "type": "[Order](../../entities/classes/entities.Order.mdx)",
        "description": "Order details.",
        "optional": false,
        "defaultValue": "",
        "expandable": false,
        "children": [
          {
            "name": "billing_address",
            "type": "[Address](../../entities/classes/entities.Address.mdx)",
            "description": "The details of the billing address associated with the order.",
            "optional": false,
            "defaultValue": "",
            "expandable": true,
            "children": [
              {
                "name": "address_1",
                "type": "`null` \\| `string`",
                "description": "Address line 1",
                "optional": false,
                "defaultValue": "",
                "expandable": false,
                "children": []
              },
              {
                "name": "address_2",
                "type": "`null` \\| `string`",
                "description": "Address line 2",
                "optional": false,
                "defaultValue": "",
                "expandable": false,
                "children": []
              },
              {
                "name": "city",
                "type": "`null` \\| `string`",
                "description": "City",
                "optional": false,
                "defaultValue": "",
                "expandable": false,
                "children": []
              },
              {
                "name": "company",
                "type": "`null` \\| `string`",
                "description": "Company name",
                "optional": false,
                "defaultValue": "",
                "expandable": false,
                "children": []
              },
              {
                "name": "country",
                "type": "`null` \\| [Country](../../entities/classes/entities.Country.mdx)",
                "description": "A country object.",
                "optional": false,
                "defaultValue": "",
                "expandable": true,
                "children": []
              },
              {
                "name": "country_code",
                "type": "`null` \\| `string`",
                "description": "The 2 character ISO code of the country in lower case",
                "optional": false,
                "defaultValue": "",
                "expandable": false,
                "children": []
              },
              {
                "name": "created_at",
                "type": "`Date`",
                "description": "The date with timezone at which the resource was created.",
                "optional": false,
                "defaultValue": "",
                "expandable": false,
                "children": []
              },
              {
                "name": "customer",
                "type": "`null` \\| [Customer](../../entities/classes/entities.Customer.mdx)",
                "description": "Available if the relation `customer` is expanded.",
                "optional": false,
                "defaultValue": "",
                "expandable": false,
                "children": []
              },
              {
                "name": "customer_id",
                "type": "`null` \\| `string`",
                "description": "ID of the customer this address belongs to",
                "optional": false,
                "defaultValue": "",
                "expandable": false,
                "children": []
              },
              {
                "name": "deleted_at",
                "type": "`null` \\| `Date`",
                "description": "The date with timezone at which the resource was deleted.",
                "optional": false,
                "defaultValue": "",
                "expandable": false,
                "children": []
              },
              {
                "name": "first_name",
                "type": "`null` \\| `string`",
                "description": "First name",
                "optional": false,
                "defaultValue": "",
                "expandable": false,
                "children": []
              },
              {
                "name": "id",
                "type": "`string`",
                "description": "ID of the address",
                "optional": false,
                "defaultValue": "",
                "expandable": false,
                "children": []
              },
              {
                "name": "last_name",
                "type": "`null` \\| `string`",
                "description": "Last name",
                "optional": false,
                "defaultValue": "",
                "expandable": false,
                "children": []
              },
              {
                "name": "metadata",
                "type": "`Record<string, unknown>`",
                "description": "An optional key-value map with additional details",
                "optional": false,
                "defaultValue": "",
                "expandable": false,
                "children": []
              },
              {
                "name": "phone",
                "type": "`null` \\| `string`",
                "description": "Phone Number",
                "optional": false,
                "defaultValue": "",
                "expandable": false,
                "children": []
              },
              {
                "name": "postal_code",
                "type": "`null` \\| `string`",
                "description": "Postal Code",
                "optional": false,
                "defaultValue": "",
                "expandable": false,
                "children": []
              },
              {
                "name": "province",
                "type": "`null` \\| `string`",
                "description": "Province",
                "optional": false,
                "defaultValue": "",
                "expandable": false,
                "children": []
              },
              {
                "name": "updated_at",
                "type": "`Date`",
                "description": "The date with timezone at which the resource was updated.",
                "optional": false,
                "defaultValue": "",
                "expandable": false,
                "children": []
              }
            ]
          },
          {
            "name": "billing_address_id",
            "type": "`string`",
            "description": "The ID of the billing address associated with the order",
            "optional": false,
            "defaultValue": "",
            "expandable": false,
            "children": []
          },
          {
            "name": "canceled_at",
            "type": "`Date`",
            "description": "The date the order was canceled on.",
            "optional": false,
            "defaultValue": "",
            "expandable": false,
            "children": []
          },
          {
            "name": "cart",
            "type": "[Cart](../../entities/classes/entities.Cart.mdx)",
            "description": "The details of the cart associated with the order.",
            "optional": false,
            "defaultValue": "",
            "expandable": true,
            "children": [
              {
                "name": "billing_address",
                "type": "[Address](../../entities/classes/entities.Address.mdx)",
                "description": "The details of the billing address associated with the cart.",
                "optional": false,
                "defaultValue": "",
                "expandable": true,
                "children": []
              },
              {
                "name": "billing_address_id",
                "type": "`string`",
                "description": "The billing address's ID",
                "optional": false,
                "defaultValue": "",
                "expandable": false,
                "children": []
              },
              {
                "name": "completed_at",
                "type": "`Date`",
                "description": "The date with timezone at which the cart was completed.",
                "optional": false,
                "defaultValue": "",
                "expandable": false,
                "children": []
              },
              {
                "name": "context",
                "type": "`Record<string, unknown>`",
                "description": "The context of the cart which can include info like IP or user agent.",
                "optional": false,
                "defaultValue": "",
                "expandable": false,
                "children": []
              },
              {
                "name": "created_at",
                "type": "`Date`",
                "description": "The date with timezone at which the resource was created.",
                "optional": false,
                "defaultValue": "",
                "expandable": false,
                "children": []
              },
              {
                "name": "customer",
                "type": "[Customer](../../entities/classes/entities.Customer.mdx)",
                "description": "The details of the customer the cart belongs to.",
                "optional": false,
                "defaultValue": "",
                "expandable": true,
                "children": []
              },
              {
                "name": "customer_id",
                "type": "`string`",
                "description": "The customer's ID",
                "optional": false,
                "defaultValue": "",
                "expandable": false,
                "children": []
              },
              {
                "name": "deleted_at",
                "type": "`null` \\| `Date`",
                "description": "The date with timezone at which the resource was deleted.",
                "optional": false,
                "defaultValue": "",
                "expandable": false,
                "children": []
              },
              {
                "name": "discount_total",
                "type": "`number`",
                "description": "The total of discount rounded",
                "optional": true,
                "defaultValue": "",
                "expandable": false,
                "children": []
              },
              {
                "name": "discounts",
                "type": "[Discount](../../entities/classes/entities.Discount.mdx)[]",
                "description": "An array of details of all discounts applied to the cart.",
                "optional": false,
                "defaultValue": "",
                "expandable": true,
                "children": []
              },
              {
                "name": "email",
                "type": "`string`",
                "description": "The email associated with the cart",
                "optional": false,
                "defaultValue": "",
                "expandable": false,
                "children": []
              },
              {
                "name": "gift_card_tax_total",
                "type": "`number`",
                "description": "The total of gift cards with taxes",
                "optional": true,
                "defaultValue": "",
                "expandable": false,
                "children": []
              },
              {
                "name": "gift_card_total",
                "type": "`number`",
                "description": "The total of gift cards",
                "optional": true,
                "defaultValue": "",
                "expandable": false,
                "children": []
              },
              {
                "name": "gift_cards",
                "type": "[GiftCard](../../entities/classes/entities.GiftCard.mdx)[]",
                "description": "An array of details of all gift cards applied to the cart.",
                "optional": false,
                "defaultValue": "",
                "expandable": true,
                "children": []
              },
              {
                "name": "id",
                "type": "`string`",
                "description": "The cart's ID",
                "optional": false,
                "defaultValue": "",
                "expandable": false,
                "children": []
              },
              {
                "name": "idempotency_key",
                "type": "`string`",
                "description": "Randomly generated key used to continue the completion of a cart in case of failure.",
                "optional": false,
                "defaultValue": "",
                "expandable": false,
                "children": []
              },
              {
                "name": "item_tax_total",
                "type": "`null` \\| `number`",
                "description": "The total of items with taxes",
                "optional": true,
                "defaultValue": "",
                "expandable": false,
                "children": []
              },
              {
                "name": "items",
                "type": "[LineItem](../../entities/classes/entities.LineItem.mdx)[]",
                "description": "The line items added to the cart.",
                "optional": false,
                "defaultValue": "",
                "expandable": true,
                "children": []
              },
              {
                "name": "metadata",
                "type": "`Record<string, unknown>`",
                "description": "An optional key-value map with additional details",
                "optional": false,
                "defaultValue": "",
                "expandable": false,
                "children": []
              },
              {
                "name": "object",
                "type": "`\"cart\"`",
                "description": "",
                "optional": false,
                "defaultValue": "\"cart\"",
                "expandable": false,
                "children": []
              },
              {
                "name": "payment",
                "type": "[Payment](../../entities/classes/entities.Payment.mdx)",
                "description": "The details of the payment associated with the cart.",
                "optional": false,
                "defaultValue": "",
                "expandable": true,
                "children": []
              },
              {
                "name": "payment_authorized_at",
                "type": "`Date`",
                "description": "The date with timezone at which the payment was authorized.",
                "optional": false,
                "defaultValue": "",
                "expandable": false,
                "children": []
              },
              {
                "name": "payment_id",
                "type": "`string`",
                "description": "The payment's ID if available",
                "optional": false,
                "defaultValue": "",
                "expandable": false,
                "children": []
              },
              {
                "name": "payment_session",
                "type": "`null` \\| [PaymentSession](../../entities/classes/entities.PaymentSession.mdx)",
                "description": "The details of the selected payment session in the cart.",
                "optional": false,
                "defaultValue": "",
                "expandable": true,
                "children": []
              },
              {
                "name": "payment_sessions",
                "type": "[PaymentSession](../../entities/classes/entities.PaymentSession.mdx)[]",
                "description": "The details of all payment sessions created on the cart.",
                "optional": false,
                "defaultValue": "",
                "expandable": true,
                "children": []
              },
              {
                "name": "raw_discount_total",
                "type": "`number`",
                "description": "The total of discount",
                "optional": true,
                "defaultValue": "",
                "expandable": false,
                "children": []
              },
              {
                "name": "refundable_amount",
                "type": "`number`",
                "description": "The amount that can be refunded",
                "optional": true,
                "defaultValue": "",
                "expandable": false,
                "children": []
              },
              {
                "name": "refunded_total",
                "type": "`number`",
                "description": "The total amount refunded if the order associated with this cart is returned.",
                "optional": true,
                "defaultValue": "",
                "expandable": false,
                "children": []
              },
              {
                "name": "region",
                "type": "[Region](../../entities/classes/entities.Region.mdx)",
                "description": "The details of the region associated with the cart.",
                "optional": false,
                "defaultValue": "",
                "expandable": true,
                "children": []
              },
              {
                "name": "region_id",
                "type": "`string`",
                "description": "The region's ID",
                "optional": false,
                "defaultValue": "",
                "expandable": false,
                "children": []
              },
              {
                "name": "sales_channel",
                "type": "[SalesChannel](../../entities/classes/entities.SalesChannel.mdx)",
                "description": "The details of the sales channel associated with the cart.",
                "optional": false,
                "defaultValue": "",
                "expandable": true,
                "children": []
              },
              {
                "name": "sales_channel_id",
                "type": "`null` \\| `string`",
                "description": "The sales channel ID the cart is associated with.",
                "optional": false,
                "defaultValue": "",
                "expandable": false,
                "children": []
              },
              {
                "name": "shipping_address",
                "type": "`null` \\| [Address](../../entities/classes/entities.Address.mdx)",
                "description": "The details of the shipping address associated with the cart.",
                "optional": false,
                "defaultValue": "",
                "expandable": true,
                "children": []
              },
              {
                "name": "shipping_address_id",
                "type": "`string`",
                "description": "The shipping address's ID",
                "optional": false,
                "defaultValue": "",
                "expandable": false,
                "children": []
              },
              {
                "name": "shipping_methods",
                "type": "[ShippingMethod](../../entities/classes/entities.ShippingMethod.mdx)[]",
                "description": "The details of the shipping methods added to the cart.",
                "optional": false,
                "defaultValue": "",
                "expandable": true,
                "children": []
              },
              {
                "name": "shipping_tax_total",
                "type": "`null` \\| `number`",
                "description": "The total of shipping with taxes",
                "optional": true,
                "defaultValue": "",
                "expandable": false,
                "children": []
              },
              {
                "name": "shipping_total",
                "type": "`number`",
                "description": "The total of shipping",
                "optional": true,
                "defaultValue": "",
                "expandable": false,
                "children": []
              },
              {
                "name": "subtotal",
                "type": "`number`",
                "description": "The subtotal of the cart",
                "optional": true,
                "defaultValue": "",
                "expandable": false,
                "children": []
              },
              {
                "name": "tax_total",
                "type": "`null` \\| `number`",
                "description": "The total of tax",
                "optional": true,
                "defaultValue": "",
                "expandable": false,
                "children": []
              },
              {
                "name": "total",
                "type": "`number`",
                "description": "The total amount of the cart",
                "optional": true,
                "defaultValue": "",
                "expandable": false,
                "children": []
              },
              {
                "name": "type",
                "type": "[CartType](../../entities/enums/entities.CartType.mdx)",
                "description": "The cart's type.",
                "optional": false,
                "defaultValue": "default",
                "expandable": false,
                "children": []
              },
              {
                "name": "updated_at",
                "type": "`Date`",
                "description": "The date with timezone at which the resource was updated.",
                "optional": false,
                "defaultValue": "",
                "expandable": false,
                "children": []
              }
            ]
          },
          {
            "name": "cart_id",
            "type": "`string`",
            "description": "The ID of the cart associated with the order",
            "optional": false,
            "defaultValue": "",
            "expandable": false,
            "children": []
          },
          {
            "name": "claims",
            "type": "[ClaimOrder](../../entities/classes/entities.ClaimOrder.mdx)[]",
            "description": "The details of the claims created for the order.",
            "optional": false,
            "defaultValue": "",
            "expandable": true,
            "children": [
              {
                "name": "additional_items",
                "type": "[LineItem](../../entities/classes/entities.LineItem.mdx)[]",
                "description": "The details of the new items to be shipped when the claim's type is `replace`",
                "optional": false,
                "defaultValue": "",
                "expandable": true,
                "children": []
              },
              {
                "name": "canceled_at",
                "type": "`Date`",
                "description": "The date with timezone at which the claim was canceled.",
                "optional": false,
                "defaultValue": "",
                "expandable": false,
                "children": []
              },
              {
                "name": "claim_items",
                "type": "[ClaimItem](../../entities/classes/entities.ClaimItem.mdx)[]",
                "description": "The details of the items that should be replaced or refunded.",
                "optional": false,
                "defaultValue": "",
                "expandable": true,
                "children": []
              },
              {
                "name": "created_at",
                "type": "`Date`",
                "description": "The date with timezone at which the resource was created.",
                "optional": false,
                "defaultValue": "",
                "expandable": false,
                "children": []
              },
              {
                "name": "deleted_at",
                "type": "`Date`",
                "description": "The date with timezone at which the resource was deleted.",
                "optional": false,
                "defaultValue": "",
                "expandable": false,
                "children": []
              },
              {
                "name": "fulfillment_status",
                "type": "[ClaimFulfillmentStatus](../../entities/enums/entities.ClaimFulfillmentStatus.mdx)",
                "description": "The claim's fulfillment status",
                "optional": false,
                "defaultValue": "not_fulfilled",
                "expandable": false,
                "children": []
              },
              {
                "name": "fulfillments",
                "type": "[Fulfillment](../../entities/classes/entities.Fulfillment.mdx)[]",
                "description": "The fulfillments of the new items to be shipped",
                "optional": false,
                "defaultValue": "",
                "expandable": true,
                "children": []
              },
              {
                "name": "id",
                "type": "`string`",
                "description": "The claim's ID",
                "optional": false,
                "defaultValue": "",
                "expandable": false,
                "children": []
              },
              {
                "name": "idempotency_key",
                "type": "`string`",
                "description": "Randomly generated key used to continue the completion of the cart associated with the claim in case of failure.",
                "optional": false,
                "defaultValue": "",
                "expandable": false,
                "children": []
              },
              {
                "name": "metadata",
                "type": "`Record<string, unknown>`",
                "description": "An optional key-value map with additional details",
                "optional": false,
                "defaultValue": "",
                "expandable": false,
                "children": []
              },
              {
                "name": "no_notification",
                "type": "`boolean`",
                "description": "Flag for describing whether or not notifications related to this should be send.",
                "optional": false,
                "defaultValue": "",
                "expandable": false,
                "children": []
              },
              {
                "name": "order",
                "type": "[Order](../../entities/classes/entities.Order.mdx)",
                "description": "The details of the order that this claim was created for.",
                "optional": false,
                "defaultValue": "",
                "expandable": true,
                "children": []
              },
              {
                "name": "order_id",
                "type": "`string`",
                "description": "The ID of the order that the claim comes from.",
                "optional": false,
                "defaultValue": "",
                "expandable": false,
                "children": []
              },
              {
                "name": "payment_status",
                "type": "[ClaimPaymentStatus](../../entities/enums/entities.ClaimPaymentStatus.mdx)",
                "description": "The status of the claim's payment",
                "optional": false,
                "defaultValue": "na",
                "expandable": false,
                "children": []
              },
              {
                "name": "refund_amount",
                "type": "`number`",
                "description": "The amount that will be refunded in conjunction with the claim",
                "optional": false,
                "defaultValue": "",
                "expandable": false,
                "children": []
              },
              {
                "name": "return_order",
                "type": "[Return](../../entities/classes/entities.Return.mdx)",
                "description": "The details of the return associated with the claim if the claim's type is `replace`.",
                "optional": false,
                "defaultValue": "",
                "expandable": true,
                "children": []
              },
              {
                "name": "shipping_address",
                "type": "[Address](../../entities/classes/entities.Address.mdx)",
                "description": "The details of the address that new items should be shipped to.",
                "optional": false,
                "defaultValue": "",
                "expandable": true,
                "children": []
              },
              {
                "name": "shipping_address_id",
                "type": "`string`",
                "description": "The ID of the address that the new items should be shipped to",
                "optional": false,
                "defaultValue": "",
                "expandable": false,
                "children": []
              },
              {
                "name": "shipping_methods",
                "type": "[ShippingMethod](../../entities/classes/entities.ShippingMethod.mdx)[]",
                "description": "The details of the shipping methods that the claim order will be shipped with.",
                "optional": false,
                "defaultValue": "",
                "expandable": true,
                "children": []
              },
              {
                "name": "type",
                "type": "[ClaimType](../../entities/enums/entities.ClaimType.mdx)",
                "description": "The claim's type",
                "optional": false,
                "defaultValue": "",
                "expandable": false,
                "children": []
              },
              {
                "name": "updated_at",
                "type": "`Date`",
                "description": "The date with timezone at which the resource was updated.",
                "optional": false,
                "defaultValue": "",
                "expandable": false,
                "children": []
              }
            ]
          },
          {
            "name": "created_at",
            "type": "`Date`",
            "description": "The date with timezone at which the resource was created.",
            "optional": false,
            "defaultValue": "",
            "expandable": false,
            "children": []
          },
          {
            "name": "currency",
            "type": "[Currency](../../entities/classes/entities.Currency.mdx)",
            "description": "The details of the currency used in the order.",
            "optional": false,
            "defaultValue": "",
            "expandable": true,
            "children": [
              {
                "name": "code",
                "type": "`string`",
                "description": "The 3 character ISO code for the currency.",
                "optional": false,
                "defaultValue": "",
                "expandable": false,
                "children": []
              },
              {
                "name": "includes_tax",
                "type": "`boolean`",
                "description": "Whether the currency prices include tax",
                "optional": true,
                "defaultValue": "false",
                "expandable": false,
                "featureFlag": "tax_inclusive_pricing",
                "children": []
              },
              {
                "name": "name",
                "type": "`string`",
                "description": "The written name of the currency",
                "optional": false,
                "defaultValue": "",
                "expandable": false,
                "children": []
              },
              {
                "name": "symbol",
                "type": "`string`",
                "description": "The symbol used to indicate the currency.",
                "optional": false,
                "defaultValue": "",
                "expandable": false,
                "children": []
              },
              {
                "name": "symbol_native",
                "type": "`string`",
                "description": "The native symbol used to indicate the currency.",
                "optional": false,
                "defaultValue": "",
                "expandable": false,
                "children": []
              }
            ]
          },
          {
            "name": "currency_code",
            "type": "`string`",
            "description": "The 3 character currency code that is used in the order",
            "optional": false,
            "defaultValue": "",
            "expandable": false,
            "children": []
          },
          {
            "name": "customer",
            "type": "[Customer](../../entities/classes/entities.Customer.mdx)",
            "description": "The details of the customer associated with the order.",
            "optional": false,
            "defaultValue": "",
            "expandable": true,
            "children": [
              {
                "name": "billing_address",
                "type": "[Address](../../entities/classes/entities.Address.mdx)",
                "description": "The details of the billing address associated with the customer.",
                "optional": false,
                "defaultValue": "",
                "expandable": true,
                "children": []
              },
              {
                "name": "billing_address_id",
                "type": "`null` \\| `string`",
                "description": "The customer's billing address ID",
                "optional": false,
                "defaultValue": "",
                "expandable": false,
                "children": []
              },
              {
                "name": "created_at",
                "type": "`Date`",
                "description": "The date with timezone at which the resource was created.",
                "optional": false,
                "defaultValue": "",
                "expandable": false,
                "children": []
              },
              {
                "name": "deleted_at",
                "type": "`null` \\| `Date`",
                "description": "The date with timezone at which the resource was deleted.",
                "optional": false,
                "defaultValue": "",
                "expandable": false,
                "children": []
              },
              {
                "name": "email",
                "type": "`string`",
                "description": "The customer's email",
                "optional": false,
                "defaultValue": "",
                "expandable": false,
                "children": []
              },
              {
                "name": "first_name",
                "type": "`string`",
                "description": "The customer's first name",
                "optional": false,
                "defaultValue": "",
                "expandable": false,
                "children": []
              },
              {
                "name": "groups",
                "type": "[CustomerGroup](../../entities/classes/entities.CustomerGroup.mdx)[]",
                "description": "The customer groups the customer belongs to.",
                "optional": false,
                "defaultValue": "",
                "expandable": true,
                "children": []
              },
              {
                "name": "has_account",
                "type": "`boolean`",
                "description": "Whether the customer has an account or not",
                "optional": false,
                "defaultValue": "false",
                "expandable": false,
                "children": []
              },
              {
                "name": "id",
                "type": "`string`",
                "description": "The customer's ID",
                "optional": false,
                "defaultValue": "",
                "expandable": false,
                "children": []
              },
              {
                "name": "last_name",
                "type": "`string`",
                "description": "The customer's last name",
                "optional": false,
                "defaultValue": "",
                "expandable": false,
                "children": []
              },
              {
                "name": "metadata",
                "type": "`Record<string, unknown>`",
                "description": "An optional key-value map with additional details",
                "optional": false,
                "defaultValue": "",
                "expandable": false,
                "children": []
              },
              {
                "name": "orders",
                "type": "[Order](../../entities/classes/entities.Order.mdx)[]",
                "description": "The details of the orders this customer placed.",
                "optional": false,
                "defaultValue": "",
                "expandable": true,
                "children": []
              },
              {
                "name": "password_hash",
                "type": "`string`",
                "description": "",
                "optional": false,
                "defaultValue": "",
                "expandable": false,
                "children": []
              },
              {
                "name": "phone",
                "type": "`string`",
                "description": "The customer's phone number",
                "optional": false,
                "defaultValue": "",
                "expandable": false,
                "children": []
              },
              {
                "name": "shipping_addresses",
                "type": "[Address](../../entities/classes/entities.Address.mdx)[]",
                "description": "The details of the shipping addresses associated with the customer.",
                "optional": false,
                "defaultValue": "",
                "expandable": true,
                "children": []
              },
              {
                "name": "updated_at",
                "type": "`Date`",
                "description": "The date with timezone at which the resource was updated.",
                "optional": false,
                "defaultValue": "",
                "expandable": false,
                "children": []
              }
            ]
          },
          {
            "name": "customer_id",
            "type": "`string`",
            "description": "The ID of the customer associated with the order",
            "optional": false,
            "defaultValue": "",
            "expandable": false,
            "children": []
          },
          {
            "name": "discount_total",
            "type": "`number`",
            "description": "The total of discount rounded",
            "optional": false,
            "defaultValue": "",
            "expandable": false,
            "children": []
          },
          {
            "name": "discounts",
            "type": "[Discount](../../entities/classes/entities.Discount.mdx)[]",
            "description": "The details of the discounts applied on the order.",
            "optional": false,
            "defaultValue": "",
            "expandable": true,
            "children": [
              {
                "name": "code",
                "type": "`string`",
                "description": "A unique code for the discount - this will be used by the customer to apply the discount",
                "optional": false,
                "defaultValue": "",
                "expandable": false,
                "children": []
              },
              {
                "name": "created_at",
                "type": "`Date`",
                "description": "The date with timezone at which the resource was created.",
                "optional": false,
                "defaultValue": "",
                "expandable": false,
                "children": []
              },
              {
                "name": "deleted_at",
                "type": "`null` \\| `Date`",
                "description": "The date with timezone at which the resource was deleted.",
                "optional": false,
                "defaultValue": "",
                "expandable": false,
                "children": []
              },
              {
                "name": "ends_at",
                "type": "`null` \\| `Date`",
                "description": "The time at which the discount can no longer be used.",
                "optional": false,
                "defaultValue": "",
                "expandable": false,
                "children": []
              },
              {
                "name": "id",
                "type": "`string`",
                "description": "The discount's ID",
                "optional": false,
                "defaultValue": "",
                "expandable": false,
                "children": []
              },
              {
                "name": "is_disabled",
                "type": "`boolean`",
                "description": "Whether the Discount has been disabled. Disabled discounts cannot be applied to carts",
                "optional": false,
                "defaultValue": "",
                "expandable": false,
                "children": []
              },
              {
                "name": "is_dynamic",
                "type": "`boolean`",
                "description": "A flag to indicate if multiple instances of the discount can be generated. I.e. for newsletter discounts",
                "optional": false,
                "defaultValue": "",
                "expandable": false,
                "children": []
              },
              {
                "name": "metadata",
                "type": "`Record<string, unknown>`",
                "description": "An optional key-value map with additional details",
                "optional": false,
                "defaultValue": "",
                "expandable": false,
                "children": []
              },
              {
                "name": "parent_discount",
                "type": "[Discount](../../entities/classes/entities.Discount.mdx)",
                "description": "The details of the parent discount that this discount was created from.",
                "optional": false,
                "defaultValue": "",
                "expandable": true,
                "children": []
              },
              {
                "name": "parent_discount_id",
                "type": "`string`",
                "description": "The Discount that the discount was created from. This will always be a dynamic discount",
                "optional": false,
                "defaultValue": "",
                "expandable": false,
                "children": []
              },
              {
                "name": "regions",
                "type": "[Region](../../entities/classes/entities.Region.mdx)[]",
                "description": "The details of the regions in which the Discount can be used.",
                "optional": false,
                "defaultValue": "",
                "expandable": true,
                "children": []
              },
              {
                "name": "rule",
                "type": "[DiscountRule](../../entities/classes/entities.DiscountRule.mdx)",
                "description": "The details of the discount rule that defines how the discount will be applied to a cart..",
                "optional": false,
                "defaultValue": "",
                "expandable": true,
                "children": []
              },
              {
                "name": "rule_id",
                "type": "`string`",
                "description": "The ID of the discount rule that defines how the discount will be applied to a cart.",
                "optional": false,
                "defaultValue": "",
                "expandable": false,
                "children": []
              },
              {
                "name": "starts_at",
                "type": "`Date`",
                "description": "The time at which the discount can be used.",
                "optional": false,
                "defaultValue": "",
                "expandable": false,
                "children": []
              },
              {
                "name": "updated_at",
                "type": "`Date`",
                "description": "The date with timezone at which the resource was updated.",
                "optional": false,
                "defaultValue": "",
                "expandable": false,
                "children": []
              },
              {
                "name": "usage_count",
                "type": "`number`",
                "description": "The number of times a discount has been used.",
                "optional": false,
                "defaultValue": "0",
                "expandable": false,
                "children": []
              },
              {
                "name": "usage_limit",
                "type": "`null` \\| `number`",
                "description": "The maximum number of times that a discount can be used.",
                "optional": false,
                "defaultValue": "",
                "expandable": false,
                "children": []
              },
              {
                "name": "valid_duration",
                "type": "`null` \\| `string`",
                "description": "Duration the discount runs between",
                "optional": false,
                "defaultValue": "",
                "expandable": false,
                "children": []
              }
            ]
          },
          {
            "name": "display_id",
            "type": "`number`",
            "description": "The order's display ID",
            "optional": false,
            "defaultValue": "",
            "expandable": false,
            "children": []
          },
          {
            "name": "draft_order",
            "type": "[DraftOrder](../../entities/classes/entities.DraftOrder.mdx)",
            "description": "The details of the draft order this order was created from.",
            "optional": false,
            "defaultValue": "",
            "expandable": true,
            "children": [
              {
                "name": "canceled_at",
                "type": "`Date`",
                "description": "The date the draft order was canceled at.",
                "optional": false,
                "defaultValue": "",
                "expandable": false,
                "children": []
              },
              {
                "name": "cart",
                "type": "[Cart](../../entities/classes/entities.Cart.mdx)",
                "description": "The details of the cart associated with the draft order.",
                "optional": false,
                "defaultValue": "",
                "expandable": true,
                "children": []
              },
              {
                "name": "cart_id",
                "type": "`string`",
                "description": "The ID of the cart associated with the draft order.",
                "optional": false,
                "defaultValue": "",
                "expandable": false,
                "children": []
              },
              {
                "name": "completed_at",
                "type": "`Date`",
                "description": "The date the draft order was completed at.",
                "optional": false,
                "defaultValue": "",
                "expandable": false,
                "children": []
              },
              {
                "name": "created_at",
                "type": "`Date`",
                "description": "The date with timezone at which the resource was created.",
                "optional": false,
                "defaultValue": "",
                "expandable": false,
                "children": []
              },
              {
                "name": "display_id",
                "type": "`number`",
                "description": "The draft order's display ID",
                "optional": false,
                "defaultValue": "",
                "expandable": false,
                "children": []
              },
              {
                "name": "id",
                "type": "`string`",
                "description": "The draft order's ID",
                "optional": false,
                "defaultValue": "",
                "expandable": false,
                "children": []
              },
              {
                "name": "idempotency_key",
                "type": "`string`",
                "description": "Randomly generated key used to continue the completion of the cart associated with the draft order in case of failure.",
                "optional": false,
                "defaultValue": "",
                "expandable": false,
                "children": []
              },
              {
                "name": "metadata",
                "type": "`Record<string, unknown>`",
                "description": "An optional key-value map with additional details",
                "optional": false,
                "defaultValue": "",
                "expandable": false,
                "children": []
              },
              {
                "name": "no_notification_order",
                "type": "`boolean`",
                "description": "Whether to send the customer notifications regarding order updates.",
                "optional": false,
                "defaultValue": "",
                "expandable": false,
                "children": []
              },
              {
                "name": "order",
                "type": "[Order](../../entities/classes/entities.Order.mdx)",
                "description": "The details of the order created from the draft order when its payment is captured.",
                "optional": false,
                "defaultValue": "",
                "expandable": true,
                "children": []
              },
              {
                "name": "order_id",
                "type": "`string`",
                "description": "The ID of the order created from the draft order when its payment is captured.",
                "optional": false,
                "defaultValue": "",
                "expandable": false,
                "children": []
              },
              {
                "name": "status",
                "type": "[DraftOrderStatus](../../entities/enums/entities.DraftOrderStatus.mdx)",
                "description": "The status of the draft order. It's changed to `completed` when it's transformed to an order.",
                "optional": false,
                "defaultValue": "open",
                "expandable": false,
                "children": []
              },
              {
                "name": "updated_at",
                "type": "`Date`",
                "description": "The date with timezone at which the resource was updated.",
                "optional": false,
                "defaultValue": "",
                "expandable": false,
                "children": []
              }
            ]
          },
          {
            "name": "draft_order_id",
            "type": "`string`",
            "description": "The ID of the draft order this order was created from.",
            "optional": false,
            "defaultValue": "",
            "expandable": false,
            "children": []
          },
          {
            "name": "edits",
            "type": "[OrderEdit](../../entities/classes/entities.OrderEdit.mdx)[]",
            "description": "The details of the order edits done on the order.",
            "optional": false,
            "defaultValue": "",
            "expandable": true,
            "children": [
              {
                "name": "canceled_at",
                "type": "`Date`",
                "description": "The date with timezone at which the edit was cancelled.",
                "optional": true,
                "defaultValue": "",
                "expandable": false,
                "children": []
              },
              {
                "name": "canceled_by",
                "type": "`string`",
                "description": "The unique identifier of the user or customer who cancelled the order edit.",
                "optional": true,
                "defaultValue": "",
                "expandable": false,
                "children": []
              },
              {
                "name": "changes",
                "type": "[OrderItemChange](../../entities/classes/entities.OrderItemChange.mdx)[]",
                "description": "The details of all the changes on the original order's line items.",
                "optional": false,
                "defaultValue": "",
                "expandable": true,
                "children": []
              },
              {
                "name": "confirmed_at",
                "type": "`Date`",
                "description": "The date with timezone at which the edit was confirmed.",
                "optional": true,
                "defaultValue": "",
                "expandable": false,
                "children": []
              },
              {
                "name": "confirmed_by",
                "type": "`string`",
                "description": "The unique identifier of the user or customer who confirmed the order edit.",
                "optional": true,
                "defaultValue": "",
                "expandable": false,
                "children": []
              },
              {
                "name": "created_at",
                "type": "`Date`",
                "description": "The date with timezone at which the resource was created.",
                "optional": false,
                "defaultValue": "",
                "expandable": false,
                "children": []
              },
              {
                "name": "created_by",
                "type": "`string`",
                "description": "The unique identifier of the user or customer who created the order edit.",
                "optional": false,
                "defaultValue": "",
                "expandable": false,
                "children": []
              },
              {
                "name": "declined_at",
                "type": "`Date`",
                "description": "The date with timezone at which the edit was declined.",
                "optional": true,
                "defaultValue": "",
                "expandable": false,
                "children": []
              },
              {
                "name": "declined_by",
                "type": "`string`",
                "description": "The unique identifier of the user or customer who declined the order edit.",
                "optional": true,
                "defaultValue": "",
                "expandable": false,
                "children": []
              },
              {
                "name": "declined_reason",
                "type": "`string`",
                "description": "An optional note why  the order edit is declined.",
                "optional": true,
                "defaultValue": "",
                "expandable": false,
                "children": []
              },
              {
                "name": "difference_due",
                "type": "`number`",
                "description": "The difference between the total amount of the order and total amount of edited order.",
                "optional": false,
                "defaultValue": "",
                "expandable": false,
                "children": []
              },
              {
                "name": "discount_total",
                "type": "`number`",
                "description": "The total of discount",
                "optional": false,
                "defaultValue": "",
                "expandable": false,
                "children": []
              },
              {
                "name": "gift_card_tax_total",
                "type": "`number`",
                "description": "The total of the gift card tax amount",
                "optional": false,
                "defaultValue": "",
                "expandable": false,
                "children": []
              },
              {
                "name": "gift_card_total",
                "type": "`number`",
                "description": "The total of the gift card amount",
                "optional": false,
                "defaultValue": "",
                "expandable": false,
                "children": []
              },
              {
                "name": "id",
                "type": "`string`",
                "description": "The order edit's ID",
                "optional": false,
                "defaultValue": "",
                "expandable": false,
                "children": []
              },
              {
                "name": "internal_note",
                "type": "`string`",
                "description": "An optional note with additional details about the order edit.",
                "optional": true,
                "defaultValue": "",
                "expandable": false,
                "children": []
              },
              {
                "name": "items",
                "type": "[LineItem](../../entities/classes/entities.LineItem.mdx)[]",
                "description": "The details of the cloned items from the original order with the new changes. Once the order edit is confirmed, these line items are associated with the original order.",
                "optional": false,
                "defaultValue": "",
                "expandable": true,
                "children": []
              },
              {
                "name": "order",
                "type": "[Order](../../entities/classes/entities.Order.mdx)",
                "description": "The details of the order that this order edit was created for.",
                "optional": false,
                "defaultValue": "",
                "expandable": true,
                "children": []
              },
              {
                "name": "order_id",
                "type": "`string`",
                "description": "The ID of the order that is edited",
                "optional": false,
                "defaultValue": "",
                "expandable": false,
                "children": []
              },
              {
                "name": "payment_collection",
                "type": "[PaymentCollection](../../entities/classes/entities.PaymentCollection.mdx)",
                "description": "The details of the payment collection used to authorize additional payment if necessary.",
                "optional": false,
                "defaultValue": "",
                "expandable": true,
                "children": []
              },
              {
                "name": "payment_collection_id",
                "type": "`string`",
                "description": "The ID of the payment collection",
                "optional": false,
                "defaultValue": "",
                "expandable": false,
                "children": []
              },
              {
                "name": "requested_at",
                "type": "`Date`",
                "description": "The date with timezone at which the edit was requested.",
                "optional": true,
                "defaultValue": "",
                "expandable": false,
                "children": []
              },
              {
                "name": "requested_by",
                "type": "`string`",
                "description": "The unique identifier of the user or customer who requested the order edit.",
                "optional": true,
                "defaultValue": "",
                "expandable": false,
                "children": []
              },
              {
                "name": "shipping_total",
                "type": "`number`",
                "description": "The total of the shipping amount",
                "optional": false,
                "defaultValue": "",
                "expandable": false,
                "children": []
              },
              {
                "name": "status",
                "type": "[OrderEditStatus](../../entities/enums/entities.OrderEditStatus.mdx)",
                "description": "The status of the order edit.",
                "optional": false,
                "defaultValue": "",
                "expandable": false,
                "children": []
              },
              {
                "name": "subtotal",
                "type": "`number`",
                "description": "The total of subtotal",
                "optional": false,
                "defaultValue": "",
                "expandable": false,
                "children": []
              },
              {
                "name": "tax_total",
                "type": "`null` \\| `number`",
                "description": "The total of tax",
                "optional": false,
                "defaultValue": "",
                "expandable": false,
                "children": []
              },
              {
                "name": "total",
                "type": "`number`",
                "description": "The total amount of the edited order.",
                "optional": false,
                "defaultValue": "",
                "expandable": false,
                "children": []
              },
              {
                "name": "updated_at",
                "type": "`Date`",
                "description": "The date with timezone at which the resource was updated.",
                "optional": false,
                "defaultValue": "",
                "expandable": false,
                "children": []
              }
            ]
          },
          {
            "name": "email",
            "type": "`string`",
            "description": "The email associated with the order",
            "optional": false,
            "defaultValue": "",
            "expandable": false,
            "children": []
          },
          {
            "name": "external_id",
            "type": "`null` \\| `string`",
            "description": "The ID of an external order.",
            "optional": false,
            "defaultValue": "",
            "expandable": false,
            "children": []
          },
          {
            "name": "fulfillment_status",
            "type": "[FulfillmentStatus](../../entities/enums/entities.FulfillmentStatus.mdx)",
            "description": "The order's fulfillment status",
            "optional": false,
            "defaultValue": "not_fulfilled",
            "expandable": false,
            "children": [
              {
                "name": "CANCELED",
                "type": "`\"canceled\"`",
                "description": "The order's fulfillments are canceled.",
                "optional": true,
                "defaultValue": "",
                "expandable": false,
                "children": []
              },
              {
                "name": "FULFILLED",
                "type": "`\"fulfilled\"`",
                "description": "The order's items are fulfilled.",
                "optional": true,
                "defaultValue": "",
                "expandable": false,
                "children": []
              },
              {
                "name": "NOT_FULFILLED",
                "type": "`\"not_fulfilled\"`",
                "description": "The order's items are not fulfilled.",
                "optional": true,
                "defaultValue": "",
                "expandable": false,
                "children": []
              },
              {
                "name": "PARTIALLY_FULFILLED",
                "type": "`\"partially_fulfilled\"`",
                "description": "Some of the order's items, but not all, are fulfilled.",
                "optional": true,
                "defaultValue": "",
                "expandable": false,
                "children": []
              },
              {
                "name": "PARTIALLY_RETURNED",
                "type": "`\"partially_returned\"`",
                "description": "Some of the order's items, but not all, are returned.",
                "optional": true,
                "defaultValue": "",
                "expandable": false,
                "children": []
              },
              {
                "name": "PARTIALLY_SHIPPED",
                "type": "`\"partially_shipped\"`",
                "description": "Some of the order's items, but not all, are shipped.",
                "optional": true,
                "defaultValue": "",
                "expandable": false,
                "children": []
              },
              {
                "name": "REQUIRES_ACTION",
                "type": "`\"requires_action\"`",
                "description": "The order's fulfillment requires action.",
                "optional": true,
                "defaultValue": "",
                "expandable": false,
                "children": []
              },
              {
                "name": "RETURNED",
                "type": "`\"returned\"`",
                "description": "The order's items are returned.",
                "optional": true,
                "defaultValue": "",
                "expandable": false,
                "children": []
              },
              {
                "name": "SHIPPED",
                "type": "`\"shipped\"`",
                "description": "The order's items are shipped.",
                "optional": true,
                "defaultValue": "",
                "expandable": false,
                "children": []
              }
            ]
          },
          {
            "name": "fulfillments",
            "type": "[Fulfillment](../../entities/classes/entities.Fulfillment.mdx)[]",
            "description": "The details of the fulfillments created for the order.",
            "optional": false,
            "defaultValue": "",
            "expandable": true,
            "children": [
              {
                "name": "canceled_at",
                "type": "`Date`",
                "description": "The date with timezone at which the Fulfillment was canceled.",
                "optional": false,
                "defaultValue": "",
                "expandable": false,
                "children": []
              },
              {
                "name": "claim_order",
                "type": "[ClaimOrder](../../entities/classes/entities.ClaimOrder.mdx)",
                "description": "The details of the claim that the fulfillment may belong to.",
                "optional": false,
                "defaultValue": "",
                "expandable": true,
                "children": []
              },
              {
                "name": "claim_order_id",
                "type": "`string`",
                "description": "The ID of the Claim that the Fulfillment belongs to.",
                "optional": false,
                "defaultValue": "",
                "expandable": false,
                "children": []
              },
              {
                "name": "created_at",
                "type": "`Date`",
                "description": "The date with timezone at which the resource was created.",
                "optional": false,
                "defaultValue": "",
                "expandable": false,
                "children": []
              },
              {
                "name": "data",
                "type": "`Record<string, unknown>`",
                "description": "This contains all the data necessary for the Fulfillment provider to handle the fulfillment.",
                "optional": false,
                "defaultValue": "",
                "expandable": false,
                "children": []
              },
              {
                "name": "id",
                "type": "`string`",
                "description": "The fulfillment's ID",
                "optional": false,
                "defaultValue": "",
                "expandable": false,
                "children": []
              },
              {
                "name": "idempotency_key",
                "type": "`string`",
                "description": "Randomly generated key used to continue the completion of the fulfillment in case of failure.",
                "optional": false,
                "defaultValue": "",
                "expandable": false,
                "children": []
              },
              {
                "name": "items",
                "type": "[FulfillmentItem](../../entities/classes/entities.FulfillmentItem.mdx)[]",
                "description": "The Fulfillment Items in the Fulfillment. These hold information about how many of each Line Item has been fulfilled.",
                "optional": false,
                "defaultValue": "",
                "expandable": true,
                "children": []
              },
              {
                "name": "location_id",
                "type": "`null` \\| `string`",
                "description": "The ID of the stock location the fulfillment will be shipped from",
                "optional": false,
                "defaultValue": "",
                "expandable": false,
                "children": []
              },
              {
                "name": "metadata",
                "type": "`Record<string, unknown>`",
                "description": "An optional key-value map with additional details",
                "optional": false,
                "defaultValue": "",
                "expandable": false,
                "children": []
              },
              {
                "name": "no_notification",
                "type": "`boolean`",
                "description": "Flag for describing whether or not notifications related to this should be sent.",
                "optional": false,
                "defaultValue": "",
                "expandable": false,
                "children": []
              },
              {
                "name": "order",
                "type": "[Order](../../entities/classes/entities.Order.mdx)",
                "description": "The details of the order that the fulfillment may belong to.",
                "optional": false,
                "defaultValue": "",
                "expandable": true,
                "children": []
              },
              {
                "name": "order_id",
                "type": "`string`",
                "description": "The ID of the Order that the Fulfillment belongs to.",
                "optional": false,
                "defaultValue": "",
                "expandable": false,
                "children": []
              },
              {
                "name": "provider",
                "type": "[FulfillmentProvider](../../entities/classes/entities.FulfillmentProvider.mdx)",
                "description": "The details of the fulfillment provider responsible for handling the fulfillment.",
                "optional": false,
                "defaultValue": "",
                "expandable": true,
                "children": []
              },
              {
                "name": "provider_id",
                "type": "`string`",
                "description": "The ID of the Fulfillment Provider responsible for handling the fulfillment.",
                "optional": false,
                "defaultValue": "",
                "expandable": false,
                "children": []
              },
              {
                "name": "shipped_at",
                "type": "`Date`",
                "description": "The date with timezone at which the Fulfillment was shipped.",
                "optional": false,
                "defaultValue": "",
                "expandable": false,
                "children": []
              },
              {
                "name": "swap",
                "type": "[Swap](../../entities/classes/entities.Swap.mdx)",
                "description": "The details of the swap that the fulfillment may belong to.",
                "optional": false,
                "defaultValue": "",
                "expandable": true,
                "children": []
              },
              {
                "name": "swap_id",
                "type": "`string`",
                "description": "The ID of the Swap that the Fulfillment belongs to.",
                "optional": false,
                "defaultValue": "",
                "expandable": false,
                "children": []
              },
              {
                "name": "tracking_links",
                "type": "[TrackingLink](../../entities/classes/entities.TrackingLink.mdx)[]",
                "description": "The Tracking Links that can be used to track the status of the Fulfillment. These will usually be provided by the Fulfillment Provider.",
                "optional": false,
                "defaultValue": "",
                "expandable": true,
                "children": []
              },
              {
                "name": "tracking_numbers",
                "type": "`string`[]",
                "description": "The tracking numbers that can be used to track the status of the fulfillment.",
                "optional": false,
                "defaultValue": "",
                "expandable": false,
                "children": []
              },
              {
                "name": "updated_at",
                "type": "`Date`",
                "description": "The date with timezone at which the resource was updated.",
                "optional": false,
                "defaultValue": "",
                "expandable": false,
                "children": []
              }
            ]
          },
          {
            "name": "gift_card_tax_total",
            "type": "`number`",
            "description": "The total of gift cards with taxes",
            "optional": false,
            "defaultValue": "",
            "expandable": false,
            "children": []
          },
          {
            "name": "gift_card_total",
            "type": "`number`",
            "description": "The total of gift cards",
            "optional": false,
            "defaultValue": "",
            "expandable": false,
            "children": []
          },
          {
            "name": "gift_card_transactions",
            "type": "[GiftCardTransaction](../../entities/classes/entities.GiftCardTransaction.mdx)[]",
            "description": "The gift card transactions made in the order.",
            "optional": false,
            "defaultValue": "",
            "expandable": true,
            "children": [
              {
                "name": "amount",
                "type": "`number`",
                "description": "The amount that was used from the Gift Card.",
                "optional": false,
                "defaultValue": "",
                "expandable": false,
                "children": []
              },
              {
                "name": "created_at",
                "type": "`Date`",
                "description": "The date with timezone at which the resource was created.",
                "optional": false,
                "defaultValue": "",
                "expandable": false,
                "children": []
              },
              {
                "name": "gift_card",
                "type": "[GiftCard](../../entities/classes/entities.GiftCard.mdx)",
                "description": "The details of the gift card associated used in this transaction.",
                "optional": false,
                "defaultValue": "",
                "expandable": true,
                "children": []
              },
              {
                "name": "gift_card_id",
                "type": "`string`",
                "description": "The ID of the Gift Card that was used in the transaction.",
                "optional": false,
                "defaultValue": "",
                "expandable": false,
                "children": []
              },
              {
                "name": "id",
                "type": "`string`",
                "description": "The gift card transaction's ID",
                "optional": false,
                "defaultValue": "",
                "expandable": false,
                "children": []
              },
              {
                "name": "is_taxable",
                "type": "`boolean`",
                "description": "Whether the transaction is taxable or not.",
                "optional": false,
                "defaultValue": "",
                "expandable": false,
                "children": []
              },
              {
                "name": "order",
                "type": "[Order](../../entities/classes/entities.Order.mdx)",
                "description": "The details of the order that the gift card was used for payment.",
                "optional": false,
                "defaultValue": "",
                "expandable": true,
                "children": []
              },
              {
                "name": "order_id",
                "type": "`string`",
                "description": "The ID of the order that the gift card was used for payment.",
                "optional": false,
                "defaultValue": "",
                "expandable": false,
                "children": []
              },
              {
                "name": "tax_rate",
                "type": "`null` \\| `number`",
                "description": "The tax rate of the transaction",
                "optional": false,
                "defaultValue": "",
                "expandable": false,
                "children": []
              }
            ]
          },
          {
            "name": "gift_cards",
            "type": "[GiftCard](../../entities/classes/entities.GiftCard.mdx)[]",
            "description": "The details of the gift card used in the order.",
            "optional": false,
            "defaultValue": "",
            "expandable": true,
            "children": [
              {
                "name": "balance",
                "type": "`number`",
                "description": "The remaining value on the Gift Card.",
                "optional": false,
                "defaultValue": "",
                "expandable": false,
                "children": []
              },
              {
                "name": "code",
                "type": "`string`",
                "description": "The unique code that identifies the Gift Card. This is used by the Customer to redeem the value of the Gift Card.",
                "optional": false,
                "defaultValue": "",
                "expandable": false,
                "children": []
              },
              {
                "name": "created_at",
                "type": "`Date`",
                "description": "The date with timezone at which the resource was created.",
                "optional": false,
                "defaultValue": "",
                "expandable": false,
                "children": []
              },
              {
                "name": "deleted_at",
                "type": "`null` \\| `Date`",
                "description": "The date with timezone at which the resource was deleted.",
                "optional": false,
                "defaultValue": "",
                "expandable": false,
                "children": []
              },
              {
                "name": "ends_at",
                "type": "`Date`",
                "description": "The time at which the Gift Card can no longer be used.",
                "optional": false,
                "defaultValue": "",
                "expandable": false,
                "children": []
              },
              {
                "name": "id",
                "type": "`string`",
                "description": "The gift card's ID",
                "optional": false,
                "defaultValue": "",
                "expandable": false,
                "children": []
              },
              {
                "name": "is_disabled",
                "type": "`boolean`",
                "description": "Whether the Gift Card has been disabled. Disabled Gift Cards cannot be applied to carts.",
                "optional": false,
                "defaultValue": "false",
                "expandable": false,
                "children": []
              },
              {
                "name": "metadata",
                "type": "`Record<string, unknown>`",
                "description": "An optional key-value map with additional details",
                "optional": false,
                "defaultValue": "",
                "expandable": false,
                "children": []
              },
              {
                "name": "order",
                "type": "[Order](../../entities/classes/entities.Order.mdx)",
                "description": "The details of the order that the gift card was purchased in.",
                "optional": false,
                "defaultValue": "",
                "expandable": true,
                "children": []
              },
              {
                "name": "order_id",
                "type": "`string`",
                "description": "The ID of the order that the gift card was purchased in.",
                "optional": false,
                "defaultValue": "",
                "expandable": false,
                "children": []
              },
              {
                "name": "region",
                "type": "[Region](../../entities/classes/entities.Region.mdx)",
                "description": "The details of the region this gift card is available in.",
                "optional": false,
                "defaultValue": "",
                "expandable": true,
                "children": []
              },
              {
                "name": "region_id",
                "type": "`string`",
                "description": "The ID of the region this gift card is available in.",
                "optional": false,
                "defaultValue": "",
                "expandable": false,
                "children": []
              },
              {
                "name": "tax_rate",
                "type": "`null` \\| `number`",
                "description": "The gift card's tax rate that will be applied on calculating totals",
                "optional": false,
                "defaultValue": "",
                "expandable": false,
                "children": []
              },
              {
                "name": "updated_at",
                "type": "`Date`",
                "description": "The date with timezone at which the resource was updated.",
                "optional": false,
                "defaultValue": "",
                "expandable": false,
                "children": []
              },
              {
                "name": "value",
                "type": "`number`",
                "description": "The value that the Gift Card represents.",
                "optional": false,
                "defaultValue": "",
                "expandable": false,
                "children": []
              }
            ]
          },
          {
            "name": "id",
            "type": "`string`",
            "description": "The order's ID",
            "optional": false,
            "defaultValue": "",
            "expandable": false,
            "children": []
          },
          {
            "name": "idempotency_key",
            "type": "`string`",
            "description": "Randomly generated key used to continue the processing of the order in case of failure.",
            "optional": false,
            "defaultValue": "",
            "expandable": false,
            "children": []
          },
          {
            "name": "item_tax_total",
            "type": "`null` \\| `number`",
            "description": "The tax total applied on items",
            "optional": false,
            "defaultValue": "",
            "expandable": false,
            "children": []
          },
          {
            "name": "items",
            "type": "[LineItem](../../entities/classes/entities.LineItem.mdx)[]",
            "description": "The details of the line items that belong to the order.",
            "optional": false,
            "defaultValue": "",
            "expandable": true,
            "children": [
              {
                "name": "adjustments",
                "type": "[LineItemAdjustment](../../entities/classes/entities.LineItemAdjustment.mdx)[]",
                "description": "The details of the item's adjustments, which are available when a discount is applied on the item.",
                "optional": false,
                "defaultValue": "",
                "expandable": true,
                "children": []
              },
              {
                "name": "allow_discounts",
                "type": "`boolean`",
                "description": "Flag to indicate if the Line Item should be included when doing discount calculations.",
                "optional": false,
                "defaultValue": "true",
                "expandable": false,
                "children": []
              },
              {
                "name": "cart",
                "type": "[Cart](../../entities/classes/entities.Cart.mdx)",
                "description": "The details of the cart that the line item may belongs to.",
                "optional": false,
                "defaultValue": "",
                "expandable": true,
                "children": []
              },
              {
                "name": "cart_id",
                "type": "`string`",
                "description": "The ID of the cart that the line item may belongs to.",
                "optional": false,
                "defaultValue": "",
                "expandable": false,
                "children": []
              },
              {
                "name": "claim_order",
                "type": "[ClaimOrder](../../entities/classes/entities.ClaimOrder.mdx)",
                "description": "The details of the claim that the line item may belong to.",
                "optional": false,
                "defaultValue": "",
                "expandable": true,
                "children": []
              },
              {
                "name": "claim_order_id",
                "type": "`string`",
                "description": "The ID of the claim that the line item may belong to.",
                "optional": false,
                "defaultValue": "",
                "expandable": false,
                "children": []
              },
              {
                "name": "created_at",
                "type": "`Date`",
                "description": "The date with timezone at which the resource was created.",
                "optional": false,
                "defaultValue": "",
                "expandable": false,
                "children": []
              },
              {
                "name": "description",
                "type": "`null` \\| `string`",
                "description": "A more detailed description of the contents of the Line Item.",
                "optional": false,
                "defaultValue": "",
                "expandable": false,
                "children": []
              },
              {
                "name": "discount_total",
                "type": "`null` \\| `number`",
                "description": "The total of discount of the line item rounded",
                "optional": true,
                "defaultValue": "",
                "expandable": false,
                "children": []
              },
              {
                "name": "fulfilled_quantity",
                "type": "`null` \\| `number`",
                "description": "The quantity of the Line Item that has been fulfilled.",
                "optional": false,
                "defaultValue": "",
                "expandable": false,
                "children": []
              },
              {
                "name": "gift_card_total",
                "type": "`null` \\| `number`",
                "description": "The total of the gift card of the line item",
                "optional": true,
                "defaultValue": "",
                "expandable": false,
                "children": []
              },
              {
                "name": "has_shipping",
                "type": "`null` \\| `boolean`",
                "description": "Flag to indicate if the Line Item has fulfillment associated with it.",
                "optional": false,
                "defaultValue": "",
                "expandable": false,
                "children": []
              },
              {
                "name": "id",
                "type": "`string`",
                "description": "The line item's ID",
                "optional": false,
                "defaultValue": "",
                "expandable": false,
                "children": []
              },
              {
                "name": "includes_tax",
                "type": "`boolean`",
                "description": "Indicates if the line item unit\\_price include tax",
                "optional": false,
                "defaultValue": "false",
                "expandable": false,
                "featureFlag": "tax_inclusive_pricing",
                "children": []
              },
              {
                "name": "is_giftcard",
                "type": "`boolean`",
                "description": "Flag to indicate if the Line Item is a Gift Card.",
                "optional": false,
                "defaultValue": "false",
                "expandable": false,
                "children": []
              },
              {
                "name": "is_return",
                "type": "`boolean`",
                "description": "Is the item being returned",
                "optional": false,
                "defaultValue": "false",
                "expandable": false,
                "children": []
              },
              {
                "name": "metadata",
                "type": "`Record<string, unknown>`",
                "description": "An optional key-value map with additional details",
                "optional": false,
                "defaultValue": "",
                "expandable": false,
                "children": []
              },
              {
                "name": "order",
                "type": "[Order](../../entities/classes/entities.Order.mdx)",
                "description": "The details of the order that the line item may belongs to.",
                "optional": false,
                "defaultValue": "",
                "expandable": true,
                "children": []
              },
              {
                "name": "order_edit",
                "type": "`null` \\| [OrderEdit](../../entities/classes/entities.OrderEdit.mdx)",
                "description": "The details of the order edit.",
                "optional": true,
                "defaultValue": "",
                "expandable": true,
                "children": []
              },
              {
                "name": "order_edit_id",
                "type": "`null` \\| `string`",
                "description": "The ID of the order edit that the item may belong to.",
                "optional": true,
                "defaultValue": "",
                "expandable": false,
                "children": []
              },
              {
                "name": "order_id",
                "type": "`null` \\| `string`",
                "description": "The ID of the order that the line item may belongs to.",
                "optional": false,
                "defaultValue": "",
                "expandable": false,
                "children": []
              },
              {
                "name": "original_item_id",
                "type": "`null` \\| `string`",
                "description": "The ID of the original line item. This is useful if the line item belongs to a resource that references an order, such as a return or an order edit.",
                "optional": true,
                "defaultValue": "",
                "expandable": false,
                "children": []
              },
              {
                "name": "original_tax_total",
                "type": "`null` \\| `number`",
                "description": "The original tax total amount of the line item",
                "optional": true,
                "defaultValue": "",
                "expandable": false,
                "children": []
              },
              {
                "name": "original_total",
                "type": "`null` \\| `number`",
                "description": "The original total amount of the line item",
                "optional": true,
                "defaultValue": "",
                "expandable": false,
                "children": []
              },
              {
                "name": "product_id",
                "type": "`null` \\| `string`",
                "description": "",
                "optional": false,
                "defaultValue": "",
                "expandable": false,
                "children": []
              },
              {
                "name": "quantity",
                "type": "`number`",
                "description": "The quantity of the content in the Line Item.",
                "optional": false,
                "defaultValue": "",
                "expandable": false,
                "children": []
              },
              {
                "name": "raw_discount_total",
                "type": "`null` \\| `number`",
                "description": "The total of discount of the line item",
                "optional": true,
                "defaultValue": "",
                "expandable": false,
                "children": []
              },
              {
                "name": "refundable",
                "type": "`null` \\| `number`",
                "description": "The amount that can be refunded from the given Line Item. Takes taxes and discounts into consideration.",
                "optional": true,
                "defaultValue": "",
                "expandable": false,
                "children": []
              },
              {
                "name": "returned_quantity",
                "type": "`null` \\| `number`",
                "description": "The quantity of the Line Item that has been returned.",
                "optional": false,
                "defaultValue": "",
                "expandable": false,
                "children": []
              },
              {
                "name": "shipped_quantity",
                "type": "`null` \\| `number`",
                "description": "The quantity of the Line Item that has been shipped.",
                "optional": false,
                "defaultValue": "",
                "expandable": false,
                "children": []
              },
              {
                "name": "should_merge",
                "type": "`boolean`",
                "description": "Flag to indicate if new Line Items with the same variant should be merged or added as an additional Line Item.",
                "optional": false,
                "defaultValue": "true",
                "expandable": false,
                "children": []
              },
              {
                "name": "subtotal",
                "type": "`null` \\| `number`",
                "description": "The subtotal of the line item",
                "optional": true,
                "defaultValue": "",
                "expandable": false,
                "children": []
              },
              {
                "name": "swap",
                "type": "[Swap](../../entities/classes/entities.Swap.mdx)",
                "description": "The details of the swap that the line item may belong to.",
                "optional": false,
                "defaultValue": "",
                "expandable": true,
                "children": []
              },
              {
                "name": "swap_id",
                "type": "`string`",
                "description": "The ID of the swap that the line item may belong to.",
                "optional": false,
                "defaultValue": "",
                "expandable": false,
                "children": []
              },
              {
                "name": "tax_lines",
                "type": "[LineItemTaxLine](../../entities/classes/entities.LineItemTaxLine.mdx)[]",
                "description": "The details of the item's tax lines.",
                "optional": false,
                "defaultValue": "",
                "expandable": true,
                "children": []
              },
              {
                "name": "tax_total",
                "type": "`null` \\| `number`",
                "description": "The total of tax of the line item",
                "optional": true,
                "defaultValue": "",
                "expandable": false,
                "children": []
              },
              {
                "name": "thumbnail",
                "type": "`null` \\| `string`",
                "description": "A URL string to a small image of the contents of the Line Item.",
                "optional": false,
                "defaultValue": "",
                "expandable": false,
                "children": []
              },
              {
                "name": "title",
                "type": "`string`",
                "description": "The title of the Line Item.",
                "optional": false,
                "defaultValue": "",
                "expandable": false,
                "children": []
              },
              {
                "name": "total",
                "type": "`null` \\| `number`",
                "description": "The total amount of the line item",
                "optional": true,
                "defaultValue": "",
                "expandable": false,
                "children": []
              },
              {
                "name": "unit_price",
                "type": "`number`",
                "description": "The price of one unit of the content in the Line Item. This should be in the currency defined by the Cart/Order/Swap/Claim that the Line Item belongs to.",
                "optional": false,
                "defaultValue": "",
                "expandable": false,
                "children": []
              },
              {
                "name": "updated_at",
                "type": "`Date`",
                "description": "The date with timezone at which the resource was updated.",
                "optional": false,
                "defaultValue": "",
                "expandable": false,
                "children": []
              },
              {
                "name": "variant",
                "type": "[ProductVariant](../../entities/classes/entities.ProductVariant.mdx)",
                "description": "The details of the product variant that this item was created from.",
                "optional": false,
                "defaultValue": "",
                "expandable": true,
                "children": []
              },
              {
                "name": "variant_id",
                "type": "`null` \\| `string`",
                "description": "The id of the Product Variant contained in the Line Item.",
                "optional": false,
                "defaultValue": "",
                "expandable": false,
                "children": []
              }
            ]
          },
          {
            "name": "metadata",
            "type": "`Record<string, unknown>`",
            "description": "An optional key-value map with additional details",
            "optional": false,
            "defaultValue": "",
            "expandable": false,
            "children": []
          },
          {
            "name": "no_notification",
            "type": "`boolean`",
            "description": "Flag for describing whether or not notifications related to this should be send.",
            "optional": false,
            "defaultValue": "",
            "expandable": false,
            "children": []
          },
          {
            "name": "object",
            "type": "`\"order\"`",
            "description": "",
            "optional": false,
            "defaultValue": "\"order\"",
            "expandable": false,
            "children": []
          },
          {
            "name": "paid_total",
            "type": "`number`",
            "description": "The total amount paid",
            "optional": false,
            "defaultValue": "",
            "expandable": false,
            "children": []
          },
          {
            "name": "payment_status",
            "type": "[PaymentStatus](../../entities/enums/entities.PaymentStatus.mdx)",
            "description": "The order's payment status",
            "optional": false,
            "defaultValue": "not_paid",
            "expandable": false,
            "children": [
              {
                "name": "AWAITING",
                "type": "`\"awaiting\"`",
                "description": "The order's payment is awaiting capturing.",
                "optional": true,
                "defaultValue": "",
                "expandable": false,
                "children": []
              },
              {
                "name": "CANCELED",
                "type": "`\"canceled\"`",
                "description": "The order's payment is canceled.",
                "optional": true,
                "defaultValue": "",
                "expandable": false,
                "children": []
              },
              {
                "name": "CAPTURED",
                "type": "`\"captured\"`",
                "description": "The order's payment is captured.",
                "optional": true,
                "defaultValue": "",
                "expandable": false,
                "children": []
              },
              {
                "name": "NOT_PAID",
                "type": "`\"not_paid\"`",
                "description": "The order's payment is not paid.",
                "optional": true,
                "defaultValue": "",
                "expandable": false,
                "children": []
              },
              {
                "name": "PARTIALLY_REFUNDED",
                "type": "`\"partially_refunded\"`",
                "description": "Some of the order's payment amount is refunded.",
                "optional": true,
                "defaultValue": "",
                "expandable": false,
                "children": []
              },
              {
                "name": "REFUNDED",
                "type": "`\"refunded\"`",
                "description": "The order's payment amount is refunded.",
                "optional": true,
                "defaultValue": "",
                "expandable": false,
                "children": []
              },
              {
                "name": "REQUIRES_ACTION",
                "type": "`\"requires_action\"`",
                "description": "The order's payment requires action.",
                "optional": true,
                "defaultValue": "",
                "expandable": false,
                "children": []
              }
            ]
          },
          {
            "name": "payments",
            "type": "[Payment](../../entities/classes/entities.Payment.mdx)[]",
            "description": "The details of the payments used in the order.",
            "optional": false,
            "defaultValue": "",
            "expandable": true,
            "children": [
              {
                "name": "amount",
                "type": "`number`",
                "description": "The amount that the Payment has been authorized for.",
                "optional": false,
                "defaultValue": "",
                "expandable": false,
                "children": []
              },
              {
                "name": "amount_refunded",
                "type": "`number`",
                "description": "The amount of the original Payment amount that has been refunded back to the Customer.",
                "optional": false,
                "defaultValue": "0",
                "expandable": false,
                "children": []
              },
              {
                "name": "canceled_at",
                "type": "`string` \\| `Date`",
                "description": "The date with timezone at which the Payment was canceled.",
                "optional": false,
                "defaultValue": "",
                "expandable": false,
                "children": []
              },
              {
                "name": "captured_at",
                "type": "`string` \\| `Date`",
                "description": "The date with timezone at which the Payment was captured.",
                "optional": false,
                "defaultValue": "",
                "expandable": false,
                "children": []
              },
              {
                "name": "cart",
                "type": "[Cart](../../entities/classes/entities.Cart.mdx)",
                "description": "The details of the cart that the payment session was potentially created for.",
                "optional": false,
                "defaultValue": "",
                "expandable": true,
                "children": []
              },
              {
                "name": "cart_id",
                "type": "`string`",
                "description": "The ID of the cart that the payment session was potentially created for.",
                "optional": false,
                "defaultValue": "",
                "expandable": false,
                "children": []
              },
              {
                "name": "created_at",
                "type": "`Date`",
                "description": "The date with timezone at which the resource was created.",
                "optional": false,
                "defaultValue": "",
                "expandable": false,
                "children": []
              },
              {
                "name": "currency",
                "type": "[Currency](../../entities/classes/entities.Currency.mdx)",
                "description": "The details of the currency of the payment.",
                "optional": false,
                "defaultValue": "",
                "expandable": true,
                "children": []
              },
              {
                "name": "currency_code",
                "type": "`string`",
                "description": "The 3 character ISO currency code of the payment.",
                "optional": false,
                "defaultValue": "",
                "expandable": false,
                "children": []
              },
              {
                "name": "data",
                "type": "`Record<string, unknown>`",
                "description": "The data required for the Payment Provider to identify, modify and process the Payment. Typically this will be an object that holds an id to the external payment session, but can be an empty object if the Payment Provider doesn't hold any state.",
                "optional": false,
                "defaultValue": "",
                "expandable": false,
                "children": []
              },
              {
                "name": "id",
                "type": "`string`",
                "description": "The payment's ID",
                "optional": false,
                "defaultValue": "",
                "expandable": false,
                "children": []
              },
              {
                "name": "idempotency_key",
                "type": "`string`",
                "description": "Randomly generated key used to continue the completion of a payment in case of failure.",
                "optional": false,
                "defaultValue": "",
                "expandable": false,
                "children": []
              },
              {
                "name": "metadata",
                "type": "`Record<string, unknown>`",
                "description": "An optional key-value map with additional details",
                "optional": false,
                "defaultValue": "",
                "expandable": false,
                "children": []
              },
              {
                "name": "order",
                "type": "[Order](../../entities/classes/entities.Order.mdx)",
                "description": "The details of the order that the payment session was potentially created for.",
                "optional": false,
                "defaultValue": "",
                "expandable": true,
                "children": []
              },
              {
                "name": "order_id",
                "type": "`string`",
                "description": "The ID of the order that the payment session was potentially created for.",
                "optional": false,
                "defaultValue": "",
                "expandable": false,
                "children": []
              },
              {
                "name": "provider_id",
                "type": "`string`",
                "description": "The id of the Payment Provider that is responsible for the Payment",
                "optional": false,
                "defaultValue": "",
                "expandable": false,
                "children": []
              },
              {
                "name": "swap",
                "type": "[Swap](../../entities/classes/entities.Swap.mdx)",
                "description": "The details of the swap that this payment was potentially created for.",
                "optional": false,
                "defaultValue": "",
                "expandable": true,
                "children": []
              },
              {
                "name": "swap_id",
                "type": "`string`",
                "description": "The ID of the swap that this payment was potentially created for.",
                "optional": false,
                "defaultValue": "",
                "expandable": false,
                "children": []
              },
              {
                "name": "updated_at",
                "type": "`Date`",
                "description": "The date with timezone at which the resource was updated.",
                "optional": false,
                "defaultValue": "",
                "expandable": false,
                "children": []
              }
            ]
          },
          {
            "name": "raw_discount_total",
            "type": "`number`",
            "description": "The total of discount",
            "optional": false,
            "defaultValue": "",
            "expandable": false,
            "children": []
          },
          {
            "name": "refundable_amount",
            "type": "`number`",
            "description": "The amount that can be refunded",
            "optional": false,
            "defaultValue": "",
            "expandable": false,
            "children": []
          },
          {
            "name": "refunded_total",
            "type": "`number`",
            "description": "The total amount refunded if the order is returned.",
            "optional": false,
            "defaultValue": "",
            "expandable": false,
            "children": []
          },
          {
            "name": "refunds",
            "type": "[Refund](../../entities/classes/entities.Refund.mdx)[]",
            "description": "The details of the refunds created for the order.",
            "optional": false,
            "defaultValue": "",
            "expandable": true,
            "children": [
              {
                "name": "amount",
                "type": "`number`",
                "description": "The amount that has be refunded to the Customer.",
                "optional": false,
                "defaultValue": "",
                "expandable": false,
                "children": []
              },
              {
                "name": "created_at",
                "type": "`Date`",
                "description": "The date with timezone at which the resource was created.",
                "optional": false,
                "defaultValue": "",
                "expandable": false,
                "children": []
              },
              {
                "name": "id",
                "type": "`string`",
                "description": "The refund's ID",
                "optional": false,
                "defaultValue": "",
                "expandable": false,
                "children": []
              },
              {
                "name": "idempotency_key",
                "type": "`string`",
                "description": "Randomly generated key used to continue the completion of the refund in case of failure.",
                "optional": false,
                "defaultValue": "",
                "expandable": false,
                "children": []
              },
              {
                "name": "metadata",
                "type": "`Record<string, unknown>`",
                "description": "An optional key-value map with additional details",
                "optional": false,
                "defaultValue": "",
                "expandable": false,
                "children": []
              },
              {
                "name": "note",
                "type": "`string`",
                "description": "An optional note explaining why the amount was refunded.",
                "optional": false,
                "defaultValue": "",
                "expandable": false,
                "children": []
              },
              {
                "name": "order",
                "type": "[Order](../../entities/classes/entities.Order.mdx)",
                "description": "The details of the order this refund was created for.",
                "optional": false,
                "defaultValue": "",
                "expandable": true,
                "children": []
              },
              {
                "name": "order_id",
                "type": "`string`",
                "description": "The ID of the order this refund was created for.",
                "optional": false,
                "defaultValue": "",
                "expandable": false,
                "children": []
              },
              {
                "name": "payment",
                "type": "[Payment](../../entities/classes/entities.Payment.mdx)",
                "description": "The details of the payment associated with the refund.",
                "optional": false,
                "defaultValue": "",
                "expandable": true,
                "children": []
              },
              {
                "name": "payment_id",
                "type": "`string`",
                "description": "The payment's ID, if available.",
                "optional": false,
                "defaultValue": "",
                "expandable": false,
                "children": []
              },
              {
                "name": "reason",
                "type": "`string`",
                "description": "The reason given for the Refund, will automatically be set when processed as part of a Swap, Claim or Return.",
                "optional": false,
                "defaultValue": "",
                "expandable": false,
                "children": []
              },
              {
                "name": "updated_at",
                "type": "`Date`",
                "description": "The date with timezone at which the resource was updated.",
                "optional": false,
                "defaultValue": "",
                "expandable": false,
                "children": []
              }
            ]
          },
          {
            "name": "region",
            "type": "[Region](../../entities/classes/entities.Region.mdx)",
            "description": "The details of the region this order was created in.",
            "optional": false,
            "defaultValue": "",
            "expandable": true,
            "children": [
              {
                "name": "automatic_taxes",
                "type": "`boolean`",
                "description": "Whether taxes should be automated in this region.",
                "optional": false,
                "defaultValue": "true",
                "expandable": false,
                "children": []
              },
              {
                "name": "countries",
                "type": "[Country](../../entities/classes/entities.Country.mdx)[]",
                "description": "The details of the countries included in this region.",
                "optional": false,
                "defaultValue": "",
                "expandable": true,
                "children": []
              },
              {
                "name": "created_at",
                "type": "`Date`",
                "description": "The date with timezone at which the resource was created.",
                "optional": false,
                "defaultValue": "",
                "expandable": false,
                "children": []
              },
              {
                "name": "currency",
                "type": "[Currency](../../entities/classes/entities.Currency.mdx)",
                "description": "The details of the currency used in the region.",
                "optional": false,
                "defaultValue": "",
                "expandable": true,
                "children": []
              },
              {
                "name": "currency_code",
                "type": "`string`",
                "description": "The three character currency code used in the region.",
                "optional": false,
                "defaultValue": "",
                "expandable": false,
                "children": []
              },
              {
                "name": "deleted_at",
                "type": "`null` \\| `Date`",
                "description": "The date with timezone at which the resource was deleted.",
                "optional": false,
                "defaultValue": "",
                "expandable": false,
                "children": []
              },
              {
                "name": "fulfillment_providers",
                "type": "[FulfillmentProvider](../../entities/classes/entities.FulfillmentProvider.mdx)[]",
                "description": "The details of the fulfillment providers that can be used to fulfill items of orders and similar resources in the region.",
                "optional": false,
                "defaultValue": "",
                "expandable": true,
                "children": []
              },
              {
                "name": "gift_cards_taxable",
                "type": "`boolean`",
                "description": "Whether the gift cards are taxable or not in this region.",
                "optional": false,
                "defaultValue": "true",
                "expandable": false,
                "children": []
              },
              {
                "name": "id",
                "type": "`string`",
                "description": "The region's ID",
                "optional": false,
                "defaultValue": "",
                "expandable": false,
                "children": []
              },
              {
                "name": "includes_tax",
                "type": "`boolean`",
                "description": "Whether the prices for the region include tax",
                "optional": false,
                "defaultValue": "false",
                "expandable": false,
                "featureFlag": "tax_inclusive_pricing",
                "children": []
              },
              {
                "name": "metadata",
                "type": "`Record<string, unknown>`",
                "description": "An optional key-value map with additional details",
                "optional": false,
                "defaultValue": "",
                "expandable": false,
                "children": []
              },
              {
                "name": "name",
                "type": "`string`",
                "description": "The name of the region as displayed to the customer. If the Region only has one country it is recommended to write the country name.",
                "optional": false,
                "defaultValue": "",
                "expandable": false,
                "children": []
              },
              {
                "name": "payment_providers",
                "type": "[PaymentProvider](../../entities/classes/entities.PaymentProvider.mdx)[]",
                "description": "The details of the payment providers that can be used to process payments in the region.",
                "optional": false,
                "defaultValue": "",
                "expandable": true,
                "children": []
              },
              {
                "name": "tax_code",
                "type": "`string`",
                "description": "The tax code used on purchases in the Region. This may be used by other systems for accounting purposes.",
                "optional": false,
                "defaultValue": "",
                "expandable": false,
                "children": []
              },
              {
                "name": "tax_provider",
                "type": "[TaxProvider](../../entities/classes/entities.TaxProvider.mdx)",
                "description": "The details of the tax provider used in the region.",
                "optional": false,
                "defaultValue": "",
                "expandable": true,
                "children": []
              },
              {
                "name": "tax_provider_id",
                "type": "`null` \\| `string`",
                "description": "The ID of the tax provider used in this region",
                "optional": false,
                "defaultValue": "",
                "expandable": false,
                "children": []
              },
              {
                "name": "tax_rate",
                "type": "`number`",
                "description": "The tax rate that should be charged on purchases in the Region.",
                "optional": false,
                "defaultValue": "",
                "expandable": false,
                "children": []
              },
              {
                "name": "tax_rates",
                "type": "`null` \\| [TaxRate](../../entities/classes/entities.TaxRate.mdx)[]",
                "description": "The details of the tax rates used in the region, aside from the default rate.",
                "optional": false,
                "defaultValue": "",
                "expandable": true,
                "children": []
              },
              {
                "name": "updated_at",
                "type": "`Date`",
                "description": "The date with timezone at which the resource was updated.",
                "optional": false,
                "defaultValue": "",
                "expandable": false,
                "children": []
              }
            ]
          },
          {
            "name": "region_id",
            "type": "`string`",
            "description": "The ID of the region this order was created in.",
            "optional": false,
            "defaultValue": "",
            "expandable": false,
            "children": []
          },
          {
            "name": "returnable_items",
            "type": "[LineItem](../../entities/classes/entities.LineItem.mdx)[]",
            "description": "The details of the line items that are returnable as part of the order, swaps, or claims",
            "optional": true,
            "defaultValue": "",
            "expandable": true,
            "children": [
              {
                "name": "adjustments",
                "type": "[LineItemAdjustment](../../entities/classes/entities.LineItemAdjustment.mdx)[]",
                "description": "The details of the item's adjustments, which are available when a discount is applied on the item.",
                "optional": false,
                "defaultValue": "",
                "expandable": true,
                "children": []
              },
              {
                "name": "allow_discounts",
                "type": "`boolean`",
                "description": "Flag to indicate if the Line Item should be included when doing discount calculations.",
                "optional": false,
                "defaultValue": "true",
                "expandable": false,
                "children": []
              },
              {
                "name": "cart",
                "type": "[Cart](../../entities/classes/entities.Cart.mdx)",
                "description": "The details of the cart that the line item may belongs to.",
                "optional": false,
                "defaultValue": "",
                "expandable": true,
                "children": []
              },
              {
                "name": "cart_id",
                "type": "`string`",
                "description": "The ID of the cart that the line item may belongs to.",
                "optional": false,
                "defaultValue": "",
                "expandable": false,
                "children": []
              },
              {
                "name": "claim_order",
                "type": "[ClaimOrder](../../entities/classes/entities.ClaimOrder.mdx)",
                "description": "The details of the claim that the line item may belong to.",
                "optional": false,
                "defaultValue": "",
                "expandable": true,
                "children": []
              },
              {
                "name": "claim_order_id",
                "type": "`string`",
                "description": "The ID of the claim that the line item may belong to.",
                "optional": false,
                "defaultValue": "",
                "expandable": false,
                "children": []
              },
              {
                "name": "created_at",
                "type": "`Date`",
                "description": "The date with timezone at which the resource was created.",
                "optional": false,
                "defaultValue": "",
                "expandable": false,
                "children": []
              },
              {
                "name": "description",
                "type": "`null` \\| `string`",
                "description": "A more detailed description of the contents of the Line Item.",
                "optional": false,
                "defaultValue": "",
                "expandable": false,
                "children": []
              },
              {
                "name": "discount_total",
                "type": "`null` \\| `number`",
                "description": "The total of discount of the line item rounded",
                "optional": true,
                "defaultValue": "",
                "expandable": false,
                "children": []
              },
              {
                "name": "fulfilled_quantity",
                "type": "`null` \\| `number`",
                "description": "The quantity of the Line Item that has been fulfilled.",
                "optional": false,
                "defaultValue": "",
                "expandable": false,
                "children": []
              },
              {
                "name": "gift_card_total",
                "type": "`null` \\| `number`",
                "description": "The total of the gift card of the line item",
                "optional": true,
                "defaultValue": "",
                "expandable": false,
                "children": []
              },
              {
                "name": "has_shipping",
                "type": "`null` \\| `boolean`",
                "description": "Flag to indicate if the Line Item has fulfillment associated with it.",
                "optional": false,
                "defaultValue": "",
                "expandable": false,
                "children": []
              },
              {
                "name": "id",
                "type": "`string`",
                "description": "The line item's ID",
                "optional": false,
                "defaultValue": "",
                "expandable": false,
                "children": []
              },
              {
                "name": "includes_tax",
                "type": "`boolean`",
                "description": "Indicates if the line item unit\\_price include tax",
                "optional": false,
                "defaultValue": "false",
                "expandable": false,
                "featureFlag": "tax_inclusive_pricing",
                "children": []
              },
              {
                "name": "is_giftcard",
                "type": "`boolean`",
                "description": "Flag to indicate if the Line Item is a Gift Card.",
                "optional": false,
                "defaultValue": "false",
                "expandable": false,
                "children": []
              },
              {
                "name": "is_return",
                "type": "`boolean`",
                "description": "Is the item being returned",
                "optional": false,
                "defaultValue": "false",
                "expandable": false,
                "children": []
              },
              {
                "name": "metadata",
                "type": "`Record<string, unknown>`",
                "description": "An optional key-value map with additional details",
                "optional": false,
                "defaultValue": "",
                "expandable": false,
                "children": []
              },
              {
                "name": "order",
                "type": "[Order](../../entities/classes/entities.Order.mdx)",
                "description": "The details of the order that the line item may belongs to.",
                "optional": false,
                "defaultValue": "",
                "expandable": true,
                "children": []
              },
              {
                "name": "order_edit",
                "type": "`null` \\| [OrderEdit](../../entities/classes/entities.OrderEdit.mdx)",
                "description": "The details of the order edit.",
                "optional": true,
                "defaultValue": "",
                "expandable": true,
                "children": []
              },
              {
                "name": "order_edit_id",
                "type": "`null` \\| `string`",
                "description": "The ID of the order edit that the item may belong to.",
                "optional": true,
                "defaultValue": "",
                "expandable": false,
                "children": []
              },
              {
                "name": "order_id",
                "type": "`null` \\| `string`",
                "description": "The ID of the order that the line item may belongs to.",
                "optional": false,
                "defaultValue": "",
                "expandable": false,
                "children": []
              },
              {
                "name": "original_item_id",
                "type": "`null` \\| `string`",
                "description": "The ID of the original line item. This is useful if the line item belongs to a resource that references an order, such as a return or an order edit.",
                "optional": true,
                "defaultValue": "",
                "expandable": false,
                "children": []
              },
              {
                "name": "original_tax_total",
                "type": "`null` \\| `number`",
                "description": "The original tax total amount of the line item",
                "optional": true,
                "defaultValue": "",
                "expandable": false,
                "children": []
              },
              {
                "name": "original_total",
                "type": "`null` \\| `number`",
                "description": "The original total amount of the line item",
                "optional": true,
                "defaultValue": "",
                "expandable": false,
                "children": []
              },
              {
                "name": "product_id",
                "type": "`null` \\| `string`",
                "description": "",
                "optional": false,
                "defaultValue": "",
                "expandable": false,
                "children": []
              },
              {
                "name": "quantity",
                "type": "`number`",
                "description": "The quantity of the content in the Line Item.",
                "optional": false,
                "defaultValue": "",
                "expandable": false,
                "children": []
              },
              {
                "name": "raw_discount_total",
                "type": "`null` \\| `number`",
                "description": "The total of discount of the line item",
                "optional": true,
                "defaultValue": "",
                "expandable": false,
                "children": []
              },
              {
                "name": "refundable",
                "type": "`null` \\| `number`",
                "description": "The amount that can be refunded from the given Line Item. Takes taxes and discounts into consideration.",
                "optional": true,
                "defaultValue": "",
                "expandable": false,
                "children": []
              },
              {
                "name": "returned_quantity",
                "type": "`null` \\| `number`",
                "description": "The quantity of the Line Item that has been returned.",
                "optional": false,
                "defaultValue": "",
                "expandable": false,
                "children": []
              },
              {
                "name": "shipped_quantity",
                "type": "`null` \\| `number`",
                "description": "The quantity of the Line Item that has been shipped.",
                "optional": false,
                "defaultValue": "",
                "expandable": false,
                "children": []
              },
              {
                "name": "should_merge",
                "type": "`boolean`",
                "description": "Flag to indicate if new Line Items with the same variant should be merged or added as an additional Line Item.",
                "optional": false,
                "defaultValue": "true",
                "expandable": false,
                "children": []
              },
              {
                "name": "subtotal",
                "type": "`null` \\| `number`",
                "description": "The subtotal of the line item",
                "optional": true,
                "defaultValue": "",
                "expandable": false,
                "children": []
              },
              {
                "name": "swap",
                "type": "[Swap](../../entities/classes/entities.Swap.mdx)",
                "description": "The details of the swap that the line item may belong to.",
                "optional": false,
                "defaultValue": "",
                "expandable": true,
                "children": []
              },
              {
                "name": "swap_id",
                "type": "`string`",
                "description": "The ID of the swap that the line item may belong to.",
                "optional": false,
                "defaultValue": "",
                "expandable": false,
                "children": []
              },
              {
                "name": "tax_lines",
                "type": "[LineItemTaxLine](../../entities/classes/entities.LineItemTaxLine.mdx)[]",
                "description": "The details of the item's tax lines.",
                "optional": false,
                "defaultValue": "",
                "expandable": true,
                "children": []
              },
              {
                "name": "tax_total",
                "type": "`null` \\| `number`",
                "description": "The total of tax of the line item",
                "optional": true,
                "defaultValue": "",
                "expandable": false,
                "children": []
              },
              {
                "name": "thumbnail",
                "type": "`null` \\| `string`",
                "description": "A URL string to a small image of the contents of the Line Item.",
                "optional": false,
                "defaultValue": "",
                "expandable": false,
                "children": []
              },
              {
                "name": "title",
                "type": "`string`",
                "description": "The title of the Line Item.",
                "optional": false,
                "defaultValue": "",
                "expandable": false,
                "children": []
              },
              {
                "name": "total",
                "type": "`null` \\| `number`",
                "description": "The total amount of the line item",
                "optional": true,
                "defaultValue": "",
                "expandable": false,
                "children": []
              },
              {
                "name": "unit_price",
                "type": "`number`",
                "description": "The price of one unit of the content in the Line Item. This should be in the currency defined by the Cart/Order/Swap/Claim that the Line Item belongs to.",
                "optional": false,
                "defaultValue": "",
                "expandable": false,
                "children": []
              },
              {
                "name": "updated_at",
                "type": "`Date`",
                "description": "The date with timezone at which the resource was updated.",
                "optional": false,
                "defaultValue": "",
                "expandable": false,
                "children": []
              },
              {
                "name": "variant",
                "type": "[ProductVariant](../../entities/classes/entities.ProductVariant.mdx)",
                "description": "The details of the product variant that this item was created from.",
                "optional": false,
                "defaultValue": "",
                "expandable": true,
                "children": []
              },
              {
                "name": "variant_id",
                "type": "`null` \\| `string`",
                "description": "The id of the Product Variant contained in the Line Item.",
                "optional": false,
                "defaultValue": "",
                "expandable": false,
                "children": []
              }
            ]
          },
          {
            "name": "returns",
            "type": "[Return](../../entities/classes/entities.Return.mdx)[]",
            "description": "The details of the returns created for the order.",
            "optional": false,
            "defaultValue": "",
            "expandable": true,
            "children": [
              {
                "name": "claim_order",
                "type": "[ClaimOrder](../../entities/classes/entities.ClaimOrder.mdx)",
                "description": "The details of the claim that the return may belong to.",
                "optional": false,
                "defaultValue": "",
                "expandable": true,
                "children": []
              },
              {
                "name": "claim_order_id",
                "type": "`null` \\| `string`",
                "description": "The ID of the claim that the return may belong to.",
                "optional": false,
                "defaultValue": "",
                "expandable": false,
                "children": []
              },
              {
                "name": "created_at",
                "type": "`Date`",
                "description": "The date with timezone at which the resource was created.",
                "optional": false,
                "defaultValue": "",
                "expandable": false,
                "children": []
              },
              {
                "name": "id",
                "type": "`string`",
                "description": "The return's ID",
                "optional": false,
                "defaultValue": "",
                "expandable": false,
                "children": []
              },
              {
                "name": "idempotency_key",
                "type": "`null` \\| `string`",
                "description": "Randomly generated key used to continue the completion of the return in case of failure.",
                "optional": false,
                "defaultValue": "",
                "expandable": false,
                "children": []
              },
              {
                "name": "items",
                "type": "[ReturnItem](../../entities/classes/entities.ReturnItem.mdx)[]",
                "description": "The details of the items that the customer is returning.",
                "optional": false,
                "defaultValue": "",
                "expandable": true,
                "children": []
              },
              {
                "name": "location_id",
                "type": "`null` \\| `string`",
                "description": "The ID of the stock location the return will be added back.",
                "optional": false,
                "defaultValue": "",
                "expandable": false,
                "children": []
              },
              {
                "name": "metadata",
                "type": "`null` \\| `Record<string, unknown>`",
                "description": "An optional key-value map with additional details",
                "optional": false,
                "defaultValue": "",
                "expandable": false,
                "children": []
              },
              {
                "name": "no_notification",
                "type": "`null` \\| `boolean`",
                "description": "When set to true, no notification will be sent related to this return.",
                "optional": false,
                "defaultValue": "",
                "expandable": false,
                "children": []
              },
              {
                "name": "order",
                "type": "[Order](../../entities/classes/entities.Order.mdx)",
                "description": "The details of the order that the return was created for.",
                "optional": false,
                "defaultValue": "",
                "expandable": true,
                "children": []
              },
              {
                "name": "order_id",
                "type": "`null` \\| `string`",
                "description": "The ID of the order that the return was created for.",
                "optional": false,
                "defaultValue": "",
                "expandable": false,
                "children": []
              },
              {
                "name": "received_at",
                "type": "`Date`",
                "description": "The date with timezone at which the return was received.",
                "optional": false,
                "defaultValue": "",
                "expandable": false,
                "children": []
              },
              {
                "name": "refund_amount",
                "type": "`number`",
                "description": "The amount that should be refunded as a result of the return.",
                "optional": false,
                "defaultValue": "",
                "expandable": false,
                "children": []
              },
              {
                "name": "shipping_data",
                "type": "`Record<string, unknown>`",
                "description": "Data about the return shipment as provided by the Fulfilment Provider that handles the return shipment.",
                "optional": false,
                "defaultValue": "",
                "expandable": false,
                "children": []
              },
              {
                "name": "shipping_method",
                "type": "[ShippingMethod](../../entities/classes/entities.ShippingMethod.mdx)",
                "description": "The details of the Shipping Method that will be used to send the Return back. Can be null if the Customer will handle the return shipment themselves.",
                "optional": false,
                "defaultValue": "",
                "expandable": true,
                "children": []
              },
              {
                "name": "status",
                "type": "[ReturnStatus](../../entities/enums/entities.ReturnStatus.mdx)",
                "description": "Status of the Return.",
                "optional": false,
                "defaultValue": "requested",
                "expandable": false,
                "children": []
              },
              {
                "name": "swap",
                "type": "[Swap](../../entities/classes/entities.Swap.mdx)",
                "description": "The details of the swap that the return may belong to.",
                "optional": false,
                "defaultValue": "",
                "expandable": true,
                "children": []
              },
              {
                "name": "swap_id",
                "type": "`null` \\| `string`",
                "description": "The ID of the swap that the return may belong to.",
                "optional": false,
                "defaultValue": "",
                "expandable": false,
                "children": []
              },
              {
                "name": "updated_at",
                "type": "`Date`",
                "description": "The date with timezone at which the resource was updated.",
                "optional": false,
                "defaultValue": "",
                "expandable": false,
                "children": []
              }
            ]
          },
          {
            "name": "sales_channel",
            "type": "[SalesChannel](../../entities/classes/entities.SalesChannel.mdx)",
            "description": "The details of the sales channel this order belongs to.",
            "optional": false,
            "defaultValue": "",
            "expandable": true,
            "children": [
              {
                "name": "created_at",
                "type": "`Date`",
                "description": "The date with timezone at which the resource was created.",
                "optional": false,
                "defaultValue": "",
                "expandable": false,
                "children": []
              },
              {
                "name": "deleted_at",
                "type": "`null` \\| `Date`",
                "description": "The date with timezone at which the resource was deleted.",
                "optional": false,
                "defaultValue": "",
                "expandable": false,
                "children": []
              },
              {
                "name": "description",
                "type": "`null` \\| `string`",
                "description": "The description of the sales channel.",
                "optional": false,
                "defaultValue": "",
                "expandable": false,
                "children": []
              },
              {
                "name": "id",
                "type": "`string`",
                "description": "The sales channel's ID",
                "optional": false,
                "defaultValue": "",
                "expandable": false,
                "children": []
              },
              {
                "name": "is_disabled",
                "type": "`boolean`",
                "description": "Specify if the sales channel is enabled or disabled.",
                "optional": false,
                "defaultValue": "false",
                "expandable": false,
                "children": []
              },
              {
                "name": "locations",
                "type": "[SalesChannelLocation](../../entities/classes/entities.SalesChannelLocation.mdx)[]",
                "description": "The details of the stock locations related to the sales channel.",
                "optional": false,
                "defaultValue": "",
                "expandable": true,
                "children": []
              },
              {
                "name": "metadata",
                "type": "`null` \\| `Record<string, unknown>`",
                "description": "An optional key-value map with additional details",
                "optional": false,
                "defaultValue": "",
                "expandable": false,
                "children": []
              },
              {
                "name": "name",
                "type": "`string`",
                "description": "The name of the sales channel.",
                "optional": false,
                "defaultValue": "",
                "expandable": false,
                "children": []
              },
              {
                "name": "updated_at",
                "type": "`Date`",
                "description": "The date with timezone at which the resource was updated.",
                "optional": false,
                "defaultValue": "",
                "expandable": false,
                "children": []
              }
            ]
          },
          {
            "name": "sales_channel_id",
            "type": "`null` \\| `string`",
            "description": "The ID of the sales channel this order belongs to.",
            "optional": false,
            "defaultValue": "",
            "expandable": false,
            "children": []
          },
          {
            "name": "shipping_address",
            "type": "[Address](../../entities/classes/entities.Address.mdx)",
            "description": "The details of the shipping address associated with the order.",
            "optional": false,
            "defaultValue": "",
            "expandable": true,
            "children": [
              {
                "name": "address_1",
                "type": "`null` \\| `string`",
                "description": "Address line 1",
                "optional": false,
                "defaultValue": "",
                "expandable": false,
                "children": []
              },
              {
                "name": "address_2",
                "type": "`null` \\| `string`",
                "description": "Address line 2",
                "optional": false,
                "defaultValue": "",
                "expandable": false,
                "children": []
              },
              {
                "name": "city",
                "type": "`null` \\| `string`",
                "description": "City",
                "optional": false,
                "defaultValue": "",
                "expandable": false,
                "children": []
              },
              {
                "name": "company",
                "type": "`null` \\| `string`",
                "description": "Company name",
                "optional": false,
                "defaultValue": "",
                "expandable": false,
                "children": []
              },
              {
                "name": "country",
                "type": "`null` \\| [Country](../../entities/classes/entities.Country.mdx)",
                "description": "A country object.",
                "optional": false,
                "defaultValue": "",
                "expandable": true,
                "children": []
              },
              {
                "name": "country_code",
                "type": "`null` \\| `string`",
                "description": "The 2 character ISO code of the country in lower case",
                "optional": false,
                "defaultValue": "",
                "expandable": false,
                "children": []
              },
              {
                "name": "created_at",
                "type": "`Date`",
                "description": "The date with timezone at which the resource was created.",
                "optional": false,
                "defaultValue": "",
                "expandable": false,
                "children": []
              },
              {
                "name": "customer",
                "type": "`null` \\| [Customer](../../entities/classes/entities.Customer.mdx)",
                "description": "Available if the relation `customer` is expanded.",
                "optional": false,
                "defaultValue": "",
                "expandable": false,
                "children": []
              },
              {
                "name": "customer_id",
                "type": "`null` \\| `string`",
                "description": "ID of the customer this address belongs to",
                "optional": false,
                "defaultValue": "",
                "expandable": false,
                "children": []
              },
              {
                "name": "deleted_at",
                "type": "`null` \\| `Date`",
                "description": "The date with timezone at which the resource was deleted.",
                "optional": false,
                "defaultValue": "",
                "expandable": false,
                "children": []
              },
              {
                "name": "first_name",
                "type": "`null` \\| `string`",
                "description": "First name",
                "optional": false,
                "defaultValue": "",
                "expandable": false,
                "children": []
              },
              {
                "name": "id",
                "type": "`string`",
                "description": "ID of the address",
                "optional": false,
                "defaultValue": "",
                "expandable": false,
                "children": []
              },
              {
                "name": "last_name",
                "type": "`null` \\| `string`",
                "description": "Last name",
                "optional": false,
                "defaultValue": "",
                "expandable": false,
                "children": []
              },
              {
                "name": "metadata",
                "type": "`Record<string, unknown>`",
                "description": "An optional key-value map with additional details",
                "optional": false,
                "defaultValue": "",
                "expandable": false,
                "children": []
              },
              {
                "name": "phone",
                "type": "`null` \\| `string`",
                "description": "Phone Number",
                "optional": false,
                "defaultValue": "",
                "expandable": false,
                "children": []
              },
              {
                "name": "postal_code",
                "type": "`null` \\| `string`",
                "description": "Postal Code",
                "optional": false,
                "defaultValue": "",
                "expandable": false,
                "children": []
              },
              {
                "name": "province",
                "type": "`null` \\| `string`",
                "description": "Province",
                "optional": false,
                "defaultValue": "",
                "expandable": false,
                "children": []
              },
              {
                "name": "updated_at",
                "type": "`Date`",
                "description": "The date with timezone at which the resource was updated.",
                "optional": false,
                "defaultValue": "",
                "expandable": false,
                "children": []
              }
            ]
          },
          {
            "name": "shipping_address_id",
            "type": "`string`",
            "description": "The ID of the shipping address associated with the order",
            "optional": false,
            "defaultValue": "",
            "expandable": false,
            "children": []
          },
          {
            "name": "shipping_methods",
            "type": "[ShippingMethod](../../entities/classes/entities.ShippingMethod.mdx)[]",
            "description": "The details of the shipping methods used in the order.",
            "optional": false,
            "defaultValue": "",
            "expandable": true,
            "children": [
              {
                "name": "cart",
                "type": "[Cart](../../entities/classes/entities.Cart.mdx)",
                "description": "The details of the cart that the shipping method is used in.",
                "optional": false,
                "defaultValue": "",
                "expandable": true,
                "children": []
              },
              {
                "name": "cart_id",
                "type": "`string`",
                "description": "The ID of the cart that the shipping method is used in.",
                "optional": false,
                "defaultValue": "",
                "expandable": false,
                "children": []
              },
              {
                "name": "claim_order",
                "type": "[ClaimOrder](../../entities/classes/entities.ClaimOrder.mdx)",
                "description": "The details of the claim that the shipping method is used in.",
                "optional": false,
                "defaultValue": "",
                "expandable": true,
                "children": []
              },
              {
                "name": "claim_order_id",
                "type": "`null` \\| `string`",
                "description": "The ID of the claim that the shipping method is used in.",
                "optional": false,
                "defaultValue": "",
                "expandable": false,
                "children": []
              },
              {
                "name": "data",
                "type": "`Record<string, unknown>`",
                "description": "Additional data that the Fulfillment Provider needs to fulfill the shipment. This is used in combination with the Shipping Options data, and may contain information such as a drop point id.",
                "optional": false,
                "defaultValue": "",
                "expandable": false,
                "children": []
              },
              {
                "name": "id",
                "type": "`string`",
                "description": "The shipping method's ID",
                "optional": false,
                "defaultValue": "",
                "expandable": false,
                "children": []
              },
              {
                "name": "includes_tax",
                "type": "`boolean`",
                "description": "Whether the shipping method price include tax",
                "optional": false,
                "defaultValue": "false",
                "expandable": false,
                "featureFlag": "tax_inclusive_pricing",
                "children": []
              },
              {
                "name": "order",
                "type": "[Order](../../entities/classes/entities.Order.mdx)",
                "description": "The details of the order that the shipping method is used in.",
                "optional": false,
                "defaultValue": "",
                "expandable": true,
                "children": []
              },
              {
                "name": "order_id",
                "type": "`string`",
                "description": "The ID of the order that the shipping method is used in.",
                "optional": false,
                "defaultValue": "",
                "expandable": false,
                "children": []
              },
              {
                "name": "price",
                "type": "`number`",
                "description": "The amount to charge for the Shipping Method. The currency of the price is defined by the Region that the Order that the Shipping Method belongs to is a part of.",
                "optional": false,
                "defaultValue": "",
                "expandable": false,
                "children": []
              },
              {
                "name": "return_id",
                "type": "`string`",
                "description": "The ID of the return that the shipping method is used in.",
                "optional": false,
                "defaultValue": "",
                "expandable": false,
                "children": []
              },
              {
                "name": "return_order",
                "type": "[Return](../../entities/classes/entities.Return.mdx)",
                "description": "The details of the return that the shipping method is used in.",
                "optional": false,
                "defaultValue": "",
                "expandable": true,
                "children": []
              },
              {
                "name": "shipping_option",
                "type": "[ShippingOption](../../entities/classes/entities.ShippingOption.mdx)",
                "description": "The details of the shipping option the method was created from.",
                "optional": false,
                "defaultValue": "",
                "expandable": true,
                "children": []
              },
              {
                "name": "shipping_option_id",
                "type": "`string`",
                "description": "The ID of the Shipping Option that the Shipping Method is built from.",
                "optional": false,
                "defaultValue": "",
                "expandable": false,
                "children": []
              },
              {
                "name": "subtotal",
                "type": "`number`",
                "description": "The subtotal of the shipping",
                "optional": true,
                "defaultValue": "",
                "expandable": false,
                "children": []
              },
              {
                "name": "swap",
                "type": "[Swap](../../entities/classes/entities.Swap.mdx)",
                "description": "The details of the swap that the shipping method is used in.",
                "optional": false,
                "defaultValue": "",
                "expandable": true,
                "children": []
              },
              {
                "name": "swap_id",
                "type": "`string`",
                "description": "The ID of the swap that the shipping method is used in.",
                "optional": false,
                "defaultValue": "",
                "expandable": false,
                "children": []
              },
              {
                "name": "tax_lines",
                "type": "[ShippingMethodTaxLine](../../entities/classes/entities.ShippingMethodTaxLine.mdx)[]",
                "description": "The details of the tax lines applied on the shipping method.",
                "optional": false,
                "defaultValue": "",
                "expandable": true,
                "children": []
              },
              {
                "name": "tax_total",
                "type": "`number`",
                "description": "The total of tax",
                "optional": true,
                "defaultValue": "",
                "expandable": false,
                "children": []
              },
              {
                "name": "total",
                "type": "`number`",
                "description": "The total amount of the shipping",
                "optional": true,
                "defaultValue": "",
                "expandable": false,
                "children": []
              }
            ]
          },
          {
            "name": "shipping_tax_total",
            "type": "`null` \\| `number`",
            "description": "The tax total applied on shipping",
            "optional": false,
            "defaultValue": "",
            "expandable": false,
            "children": []
          },
          {
            "name": "shipping_total",
            "type": "`number`",
            "description": "The total of shipping",
            "optional": false,
            "defaultValue": "",
            "expandable": false,
            "children": []
          },
          {
            "name": "status",
            "type": "[OrderStatus](../../entities/enums/entities.OrderStatus.mdx)",
            "description": "The order's status",
            "optional": false,
            "defaultValue": "pending",
            "expandable": false,
            "children": [
              {
                "name": "ARCHIVED",
                "type": "`\"archived\"`",
                "description": "The order is archived.",
                "optional": true,
                "defaultValue": "",
                "expandable": false,
                "children": []
              },
              {
                "name": "CANCELED",
                "type": "`\"canceled\"`",
                "description": "The order is canceled.",
                "optional": true,
                "defaultValue": "",
                "expandable": false,
                "children": []
              },
              {
                "name": "COMPLETED",
                "type": "`\"completed\"`",
                "description": "The order is completed, meaning that \nthe items have been fulfilled and the payment\nhas been captured.",
                "optional": true,
                "defaultValue": "",
                "expandable": false,
                "children": []
              },
              {
                "name": "PENDING",
                "type": "`\"pending\"`",
                "description": "The order is pending.",
                "optional": true,
                "defaultValue": "",
                "expandable": false,
                "children": []
              },
              {
                "name": "REQUIRES_ACTION",
                "type": "`\"requires_action\"`",
                "description": "The order requires action.",
                "optional": true,
                "defaultValue": "",
                "expandable": false,
                "children": []
              }
            ]
          },
          {
            "name": "subtotal",
            "type": "`number`",
            "description": "The subtotal of the order",
            "optional": false,
            "defaultValue": "",
            "expandable": false,
            "children": []
          },
          {
            "name": "swaps",
            "type": "[Swap](../../entities/classes/entities.Swap.mdx)[]",
            "description": "The details of the swaps created for the order.",
            "optional": false,
            "defaultValue": "",
            "expandable": true,
            "children": [
              {
                "name": "additional_items",
                "type": "[LineItem](../../entities/classes/entities.LineItem.mdx)[]",
                "description": "The details of the new products to send to the customer, represented as line items.",
                "optional": false,
                "defaultValue": "",
                "expandable": true,
                "children": []
              },
              {
                "name": "allow_backorder",
                "type": "`boolean`",
                "description": "If true, swaps can be completed with items out of stock",
                "optional": false,
                "defaultValue": "false",
                "expandable": false,
                "children": []
              },
              {
                "name": "canceled_at",
                "type": "`Date`",
                "description": "The date with timezone at which the Swap was canceled.",
                "optional": false,
                "defaultValue": "",
                "expandable": false,
                "children": []
              },
              {
                "name": "cart",
                "type": "[Cart](../../entities/classes/entities.Cart.mdx)",
                "description": "The details of the cart that the customer uses to complete the swap.",
                "optional": false,
                "defaultValue": "",
                "expandable": true,
                "children": []
              },
              {
                "name": "cart_id",
                "type": "`string`",
                "description": "The ID of the cart that the customer uses to complete the swap.",
                "optional": false,
                "defaultValue": "",
                "expandable": false,
                "children": []
              },
              {
                "name": "confirmed_at",
                "type": "`Date`",
                "description": "The date with timezone at which the Swap was confirmed by the Customer.",
                "optional": false,
                "defaultValue": "",
                "expandable": false,
                "children": []
              },
              {
                "name": "created_at",
                "type": "`Date`",
                "description": "The date with timezone at which the resource was created.",
                "optional": false,
                "defaultValue": "",
                "expandable": false,
                "children": []
              },
              {
                "name": "deleted_at",
                "type": "`null` \\| `Date`",
                "description": "The date with timezone at which the resource was deleted.",
                "optional": false,
                "defaultValue": "",
                "expandable": false,
                "children": []
              },
              {
                "name": "difference_due",
                "type": "`number`",
                "description": "The difference amount between the order’s original total and the new total imposed by the swap. If its value is negative, a refund must be issues to the customer. If it's positive, additional payment must be authorized by the customer. Otherwise, no payment processing is required.",
                "optional": false,
                "defaultValue": "",
                "expandable": false,
                "children": []
              },
              {
                "name": "fulfillment_status",
                "type": "[SwapFulfillmentStatus](../../entities/enums/entities.SwapFulfillmentStatus.mdx)",
                "description": "The status of the Fulfillment of the Swap.",
                "optional": false,
                "defaultValue": "",
                "expandable": false,
                "children": []
              },
              {
                "name": "fulfillments",
                "type": "[Fulfillment](../../entities/classes/entities.Fulfillment.mdx)[]",
                "description": "The details of the fulfillments that are used to send the new items to the customer.",
                "optional": false,
                "defaultValue": "",
                "expandable": true,
                "children": []
              },
              {
                "name": "id",
                "type": "`string`",
                "description": "The swap's ID",
                "optional": false,
                "defaultValue": "",
                "expandable": false,
                "children": []
              },
              {
                "name": "idempotency_key",
                "type": "`string`",
                "description": "Randomly generated key used to continue the completion of the swap in case of failure.",
                "optional": false,
                "defaultValue": "",
                "expandable": false,
                "children": []
              },
              {
                "name": "metadata",
                "type": "`Record<string, unknown>`",
                "description": "An optional key-value map with additional details",
                "optional": false,
                "defaultValue": "",
                "expandable": false,
                "children": []
              },
              {
                "name": "no_notification",
                "type": "`boolean`",
                "description": "If set to true, no notification will be sent related to this swap",
                "optional": false,
                "defaultValue": "",
                "expandable": false,
                "children": []
              },
              {
                "name": "order",
                "type": "[Order](../../entities/classes/entities.Order.mdx)",
                "description": "The details of the order that the swap belongs to.",
                "optional": false,
                "defaultValue": "",
                "expandable": true,
                "children": []
              },
              {
                "name": "order_id",
                "type": "`string`",
                "description": "The ID of the order that the swap belongs to.",
                "optional": false,
                "defaultValue": "",
                "expandable": false,
                "children": []
              },
              {
                "name": "payment",
                "type": "[Payment](../../entities/classes/entities.Payment.mdx)",
                "description": "The details of the additional payment authorized by the customer when `difference\\_due` is positive.",
                "optional": false,
                "defaultValue": "",
                "expandable": true,
                "children": []
              },
              {
                "name": "payment_status",
                "type": "[SwapPaymentStatus](../../entities/enums/entities.SwapPaymentStatus.mdx)",
                "description": "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.",
                "optional": false,
                "defaultValue": "",
                "expandable": false,
                "children": []
              },
              {
                "name": "return_order",
                "type": "[Return](../../entities/classes/entities.Return.mdx)",
                "description": "The details of the return that belongs to the swap, which holds the details on the items being returned.",
                "optional": false,
                "defaultValue": "",
                "expandable": true,
                "children": []
              },
              {
                "name": "shipping_address",
                "type": "[Address](../../entities/classes/entities.Address.mdx)",
                "description": "The details of the shipping address that the new items should be sent to.",
                "optional": false,
                "defaultValue": "",
                "expandable": true,
                "children": []
              },
              {
                "name": "shipping_address_id",
                "type": "`string`",
                "description": "The Address to send the new Line Items to - in most cases this will be the same as the shipping address on the Order.",
                "optional": false,
                "defaultValue": "",
                "expandable": false,
                "children": []
              },
              {
                "name": "shipping_methods",
                "type": "[ShippingMethod](../../entities/classes/entities.ShippingMethod.mdx)[]",
                "description": "The details of the shipping methods used to fulfill the additional items purchased.",
                "optional": false,
                "defaultValue": "",
                "expandable": true,
                "children": []
              },
              {
                "name": "updated_at",
                "type": "`Date`",
                "description": "The date with timezone at which the resource was updated.",
                "optional": false,
                "defaultValue": "",
                "expandable": false,
                "children": []
              }
            ]
          },
          {
            "name": "tax_rate",
            "type": "`null` \\| `number`",
            "description": "The order's tax rate",
            "optional": false,
            "defaultValue": "",
            "expandable": false,
            "children": []
          },
          {
            "name": "tax_total",
            "type": "`null` \\| `number`",
            "description": "The total of tax",
            "optional": false,
            "defaultValue": "",
            "expandable": false,
            "children": []
          },
          {
            "name": "total",
            "type": "`number`",
            "description": "The total amount of the order",
            "optional": false,
            "defaultValue": "",
            "expandable": false,
            "children": []
          },
          {
            "name": "updated_at",
            "type": "`Date`",
            "description": "The date with timezone at which the resource was updated.",
            "optional": false,
            "defaultValue": "",
            "expandable": false,
            "children": []
          }
        ]
      }
    ]
  }
]} />
