medusa-store/docs/api/admin/components/schemas/Cart.yaml

title: Cart
description: Represents a user cart
type: object
required:
  - billing_address_id
  - completed_at
  - context
  - created_at
  - customer_id
  - deleted_at
  - email
  - id
  - idempotency_key
  - metadata
  - payment_authorized_at
  - payment_id
  - payment_session
  - region_id
  - shipping_address_id
  - type
  - updated_at
properties:
  id:
    description: The cart's ID
    type: string
    example: cart_01G8ZH853Y6TFXWPG5EYE81X63
  email:
    description: The email associated with the cart
    nullable: true
    type: string
    format: email
  billing_address_id:
    description: The billing address's ID
    nullable: true
    type: string
    example: addr_01G8ZH853YPY9B94857DY91YGW
  billing_address:
    description: Available if the relation `billing_address` is expanded.
    nullable: true
    $ref: ./Address.yaml
  shipping_address_id:
    description: The shipping address's ID
    nullable: true
    type: string
    example: addr_01G8ZH853YPY9B94857DY91YGW
  shipping_address:
    description: Available if the relation `shipping_address` is expanded.
    nullable: true
    $ref: ./Address.yaml
  items:
    description: Available if the relation `items` is expanded.
    type: array
    items:
      $ref: ./LineItem.yaml
  region_id:
    description: The region's ID
    type: string
    example: reg_01G1G5V26T9H8Y0M4JNE3YGA4G
  region:
    description: A region object. Available if the relation `region` is expanded.
    nullable: true
    $ref: ./Region.yaml
  discounts:
    description: Available if the relation `discounts` is expanded.
    type: array
    items:
      $ref: ./Discount.yaml
  gift_cards:
    description: Available if the relation `gift_cards` is expanded.
    type: array
    items:
      $ref: ./GiftCard.yaml
  customer_id:
    description: The customer's ID
    nullable: true
    type: string
    example: cus_01G2SG30J8C85S4A5CHM2S1NS2
  customer:
    description: A customer object. Available if the relation `customer` is expanded.
    nullable: true
    type: object
  payment_session:
    description: The selected payment session in the cart.
    nullable: true
    type: object
  payment_sessions:
    description: The payment sessions created on the cart.
    type: array
    items:
      type: object
  payment_id:
    description: The payment's ID if available
    nullable: true
    type: string
    example: pay_01G8ZCC5W42ZNY842124G7P5R9
  payment:
    description: Available if the relation `payment` is expanded.
    nullable: true
    type: object
  shipping_methods:
    description: The shipping methods added to the cart.
    type: array
    items:
      $ref: ./ShippingMethod.yaml
  type:
    description: The cart's type.
    type: string
    enum:
      - default
      - swap
      - draft_order
      - payment_link
      - claim
    default: default
  completed_at:
    description: The date with timezone at which the cart was completed.
    nullable: true
    type: string
    format: date-time
  payment_authorized_at:
    description: The date with timezone at which the payment was authorized.
    nullable: true
    type: string
    format: date-time
  idempotency_key:
    description: >-
      Randomly generated key used to continue the completion of a cart in case
      of failure.
    nullable: true
    type: string
    externalDocs:
      url: >-
        https://docs.medusajs.com/advanced/backend/payment/overview#idempotency-key
      description: Learn more how to use the idempotency key.
  context:
    description: The context of the cart which can include info like IP or user agent.
    nullable: true
    type: object
    example:
      ip: '::1'
      user_agent: PostmanRuntime/7.29.2
  sales_channel_id:
    description: The sales channel ID the cart is associated with.
    nullable: true
    type: string
    example: null
  sales_channel:
    description: >-
      A sales channel object. Available if the relation `sales_channel` is
      expanded.
    nullable: true
    $ref: ./SalesChannel.yaml
  created_at:
    description: The date with timezone at which the resource was created.
    type: string
    format: date-time
  updated_at:
    description: The date with timezone at which the resource was updated.
    type: string
    format: date-time
  deleted_at:
    description: The date with timezone at which the resource was deleted.
    nullable: true
    type: string
    format: date-time
  metadata:
    description: An optional key-value map with additional details
    nullable: true
    type: object
    example:
      car: white
  shipping_total:
    description: The total of shipping
    type: integer
    example: 1000
  discount_total:
    description: The total of discount rounded
    type: integer
    example: 800
  raw_discount_total:
    description: The total of discount
    type: integer
    example: 800
  item_tax_total:
    description: The total of items with taxes
    type: integer
    example: 8000
  shipping_tax_total:
    description: The total of shipping with taxes
    type: integer
    example: 1000
  tax_total:
    description: The total of tax
    type: integer
    example: 0
  refunded_total:
    description: >-
      The total amount refunded if the order associated with this cart is
      returned.
    type: integer
    example: 0
  total:
    description: The total amount of the cart
    type: integer
    example: 8200
  subtotal:
    description: The subtotal of the cart
    type: integer
    example: 8000
  refundable_amount:
    description: The amount that can be refunded
    type: integer
    example: 8200
  gift_card_total:
    description: The total of gift cards
    type: integer
    example: 0
  gift_card_tax_total:
    description: The total of gift cards with taxes
    type: integer
    example: 0