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

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

# LineItemsResource

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

## Methods

### create

Generates a Line Item with a given Product Variant and adds it to the Cart

#### Example

```ts
import Medusa from "@medusajs/medusa-js"
const medusa = new Medusa({ baseUrl: MEDUSA_BACKEND_URL, maxRetries: 3 })
medusa.carts.lineItems.create(cart_id, {
  variant_id,
  quantity: 1
})
.then(({ cart }) => {
  console.log(cart.id);
})
```

#### Parameters

<ParameterTypes parameters={[
  {
    "name": "cart_id",
    "type": "`string`",
    "description": "The cart's ID.",
    "optional": false,
    "defaultValue": "",
    "expandable": false,
    "children": []
  },
  {
    "name": "payload",
    "type": "[StorePostCartsCartLineItemsReq](../../medusa/classes/medusa.StorePostCartsCartLineItemsReq.mdx)",
    "description": "The line item to be created.",
    "optional": false,
    "defaultValue": "",
    "expandable": false,
    "children": [
      {
        "name": "metadata",
        "type": "`Record<string, unknown>`",
        "description": "An optional key-value map with additional details about the Line Item.",
        "optional": true,
        "defaultValue": "",
        "expandable": false,
        "children": []
      },
      {
        "name": "quantity",
        "type": "`number`",
        "description": "The quantity of the Product Variant to add to the Line Item.",
        "optional": false,
        "defaultValue": "",
        "expandable": false,
        "children": []
      },
      {
        "name": "variant_id",
        "type": "`string`",
        "description": "The id of the Product Variant to generate the Line Item from.",
        "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;StoreCartsRes&#62;",
    "optional": false,
    "defaultValue": "",
    "description": "Resolves to the associated cart's details.",
    "expandable": false,
    "children": [
      {
        "name": "cart",
        "type": "Omit&#60;[Cart](../../entities/classes/entities.Cart.mdx), \"refundable_amount\" \\| \"refunded_total\"&#62;",
        "description": "Cart 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 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": "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": []
          }
        ]
      }
    ]
  }
]} />

___

### delete

Delete a line item from a cart. The payment sessions will be updated and the totals will be recalculated.

#### Example

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

#### Parameters

<ParameterTypes parameters={[
  {
    "name": "cart_id",
    "type": "`string`",
    "description": "The ID of the line item's cart.",
    "optional": false,
    "defaultValue": "",
    "expandable": false,
    "children": []
  },
  {
    "name": "line_id",
    "type": "`string`",
    "description": "The ID of the line item to delete.",
    "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;StoreCartsRes&#62;",
    "optional": false,
    "defaultValue": "",
    "description": "Resolves to the associated cart's details.",
    "expandable": false,
    "children": [
      {
        "name": "cart",
        "type": "Omit&#60;[Cart](../../entities/classes/entities.Cart.mdx), \"refundable_amount\" \\| \"refunded_total\"&#62;",
        "description": "Cart 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 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": "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": []
          }
        ]
      }
    ]
  }
]} />

___

### update

Update a line item's data.

#### Example

```ts
import Medusa from "@medusajs/medusa-js"
const medusa = new Medusa({ baseUrl: MEDUSA_BACKEND_URL, maxRetries: 3 })
medusa.carts.lineItems.update(cartId, lineId, {
  quantity: 1
})
.then(({ cart }) => {
  console.log(cart.id);
})
```

#### Parameters

<ParameterTypes parameters={[
  {
    "name": "cart_id",
    "type": "`string`",
    "description": "The ID of the line item's cart.",
    "optional": false,
    "defaultValue": "",
    "expandable": false,
    "children": []
  },
  {
    "name": "line_id",
    "type": "`string`",
    "description": "The ID of the line item to update.",
    "optional": false,
    "defaultValue": "",
    "expandable": false,
    "children": []
  },
  {
    "name": "payload",
    "type": "[StorePostCartsCartLineItemsItemReq](../../medusa/classes/medusa.StorePostCartsCartLineItemsItemReq.mdx)",
    "description": "The data to update 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 about the Line Item. If omitted, the metadata will remain unchanged.\"",
        "optional": true,
        "defaultValue": "",
        "expandable": false,
        "children": []
      },
      {
        "name": "quantity",
        "type": "`number`",
        "description": "The quantity of the line item in the cart.",
        "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;StoreCartsRes&#62;",
    "optional": false,
    "defaultValue": "",
    "description": "Resolves to the associated cart's details.",
    "expandable": false,
    "children": [
      {
        "name": "cart",
        "type": "Omit&#60;[Cart](../../entities/classes/entities.Cart.mdx), \"refundable_amount\" \\| \"refunded_total\"&#62;",
        "description": "Cart 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 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": "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": []
          }
        ]
      }
    ]
  }
]} />
