> ## Documentation Index
> Fetch the complete documentation index at: https://www.commercengine.io/docs/llms.txt
> Use this file to discover all available pages before exploring further.

# Remove loyalty points

> Remove loyalty points applied in cart



## OpenAPI

````yaml delete /carts/{id}/loyalty-points
openapi: 3.1.0
info:
  version: '1.0'
  title: CE Storefront APIs
  summary: Customer-facing e-commerce API for building exceptional shopping experiences
  description: >-
    Public-facing API for Commerce Engine storefronts, enabling seamless
    shopping experiences with product browsing, cart management, checkout
    processing, user accounts, and order tracking. Perfect for building web,
    mobile, and headless commerce applications.
  contact:
    name: Support
    email: support@commercengine.io
    url: https://www.commercengine.io/contact-us
  license:
    url: https://www.commercengine.io/contact-us
    name: All Rights Reserved
servers:
  - url: https://staging.api.commercengine.io/api/v1/{store_id}/storefront
    description: Staging Server
    variables:
      store_id:
        description: Store ID
        default: store_id
    x-speakeasy-server-id: staging
  - url: https://prod.api.commercengine.io/api/v1/{store_id}/storefront
    description: Prod Server
    variables:
      store_id:
        description: Store ID
        default: store_id
    x-speakeasy-server-id: prod
security: []
tags:
  - name: Analytics
    description: Analytics
  - name: Auth
    description: auth
  - name: Campaigns
    description: Campaigns
  - name: Carts
    description: Carts
  - name: Catalog
    description: Catalog
  - name: Common
    description: Common
  - name: Coupons & promotions
    description: Coupons & promotions
  - name: Customers
    description: Customers
  - name: Juspay
    description: Juspay Payments
  - name: KYC
    description: KYC
  - name: Marketplace
    description: Marketplace
  - name: Orders
    description: Orders
  - name: Others
    description: Others
  - name: Payments
    description: Payments
  - name: PayU
    description: PayU Payments
  - name: POS
    description: POS
  - name: Shipping
    description: Shipping
  - name: Store
    description: Store
  - name: Subscriptions
    description: Subscriptions
externalDocs:
  url: https://llm-docs.commercengine.io
  description: Commerce Engine API Reference Documentation
paths:
  /carts/{id}/loyalty-points:
    parameters:
      - name: id
        in: path
        description: Cart ID
        required: true
        schema:
          type: string
    delete:
      tags:
        - Carts
      summary: Remove loyalty points
      description: Remove loyalty points applied in cart
      operationId: remove-loyalty-points
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                type: object
                required:
                  - message
                  - success
                  - content
                properties:
                  message:
                    type: string
                  success:
                    type: boolean
                  content:
                    properties:
                      cart:
                        $ref: '#/components/schemas/Cart'
                    required:
                      - cart
                    type: object
        '400':
          $ref: '#/components/responses/BadRequest'
        '401':
          $ref: '#/components/responses/Unauthorized'
        '404':
          description: Not Found
      security:
        - Authorization: []
      externalDocs:
        url: >-
          https://llm-docs.commercengine.io/storefront/operations/remove-loyalty-points
        description: API reference for the remove-loyalty-points operation
components:
  schemas:
    Cart:
      title: Cart
      description: >-
        This cart model is structured to capture a wide range of details,
        facilitating accurate representation and management of user shopping
        carts in an e-commerce platform.
      type: object
      externalDocs:
        url: https://llm-docs.commercengine.io/storefront/schemas/Cart
        description: API reference for the Cart schema
      required:
        - id
        - active
        - customer_note
        - is_promotion_applied
        - is_coupon_applied
        - coupon_code
        - coupon_discount_amount
        - coupon_discount_percent
        - promotion_discount_amount
        - subtotal
        - items_tax_amount
        - subtotal_including_tax
        - shipping_estimated_cost
        - shipping_discount_amount
        - shipping_amount
        - shipping_tax_rate
        - shipping_tax_amount
        - shipping_amount_including_tax
        - estimated_delivery_days
        - handling_charge_excluding_tax
        - handling_charge_tax_amount
        - handling_charge_including_tax
        - total_tax
        - grand_total
        - credit_balance_used
        - to_be_paid
        - loyalty_points_redeemed
        - loyalty_points_earned
        - cart_items_count
        - cart_items
        - billing_address
        - shipping_address
        - currency
        - metadata
        - expires_at
        - applied_promotions
        - applied_coupons
        - shipments
        - promotion_savings
        - coupon_savings
        - other_savings
        - total_savings
        - free_shipping_threshold
        - status
        - status_error_message
      properties:
        id:
          description: Unique identifier for the cart.
          type: string
          pattern: ^[0123456789ABCDEFGHJKMNPQRSTVWXYZ]{26}$
        active:
          description: Indicates whether the cart is currently active or inactive.
          type: boolean
        customer_note:
          description: customer note for shipping or product customization.
          type:
            - string
            - 'null'
        is_promotion_applied:
          description: Indicates if a promotion is applied or not.
          type: boolean
        is_coupon_applied:
          description: Indicates if a coupon is applied or not.
          type: boolean
        coupon_code:
          description: Code of the applied coupon.
          type:
            - string
            - 'null'
        coupon_discount_amount:
          description: Discount amount due to the coupon.
          type: number
          format: double
          minimum: 0
        coupon_discount_percent:
          description: Discount amount due to the coupon.
          type: number
          format: double
          minimum: 0
        promotion_discount_amount:
          description: Discount amount due to promotions(If Applied).
          type: number
          format: double
          minimum: 0
        promotion_discount_percent:
          description: Discount amount due to promotions(If Applied).
          type: number
          format: double
          minimum: 0
        subtotal:
          description: Subtotal amount for items in the cart.
          type: number
          format: double
          minimum: 0
        items_tax_amount:
          description: Total tax amount for items.
          type: number
          format: double
          minimum: 0
        subtotal_including_tax:
          description: Subtotal including tax.
          type: number
          format: double
          minimum: 0
        shipping_estimated_cost:
          description: Estimated cost of shipping.
          type:
            - number
            - 'null'
        shipping_discount_amount:
          description: Discount applied on estimated shipping cost.
          type:
            - number
            - 'null'
        shipping_amount:
          description: Shipping amount chargable to customer.
          type:
            - number
            - 'null'
        shipping_tax_rate:
          description: Shipping tax rate applied on shipping amount.
          type:
            - number
            - 'null'
        shipping_tax_amount:
          description: Tax applied on shipping_amount.
          type:
            - number
            - 'null'
        shipping_amount_including_tax:
          description: Shipping amount including shipping tax.
          type:
            - number
            - 'null'
        fulfillment_preference:
          $ref: '#/components/schemas/FulfillmentPreference'
        estimated_delivery_days:
          type:
            - integer
            - 'null'
        handling_charge_excluding_tax:
          description: >-
            The additional charge applied to cover the costs associated with
            processing, packaging, and handling an order. This fee is separate
            from shipping charges and may include materials, or special handling
            requirements.
          type: number
          format: double
          minimum: 0
        handling_charge_tax_amount:
          type: number
          format: double
          minimum: 0
        handling_charge_including_tax:
          type: number
          format: double
          minimum: 0
        total_tax:
          description: Total tax amount for the entire cart.
          type: number
          format: double
          minimum: 0
        grand_total:
          description: Grand total amount for the cart.
          type: number
          format: double
          minimum: 0
        credit_balance_used:
          description: Amount of credit balance used.
          type: number
          format: double
          minimum: 0
        to_be_paid:
          description: Amount to be paid by the customer.
          type: number
          format: double
          minimum: 0
        loyalty_points_redeemed:
          description: Number of loyalty points redeemed.
          type: integer
          minimum: 0
        loyalty_points_earned:
          description: Number of loyalty points earned.
          type: integer
          minimum: 0
        cart_items_count:
          description: Number of items in the cart.
          type: integer
          minimum: 0
        cart_items:
          description: 'List containing detailed information about each item in the cart. '
          type: array
          items:
            $ref: '#/components/schemas/CartItem'
        billing_address:
          $ref: '#/components/schemas/CustomerAddress'
          description: Details of the billing address.
        shipping_address:
          $ref: '#/components/schemas/CustomerAddress'
          description: Details of the shipping address.
        currency:
          $ref: '#/components/schemas/Currency'
          description: >-
            Details about the currency being used, including `name`, `code`, and
            `symbol`.
        metadata:
          description: Additional metadata associated with the cart.
          type:
            - object
            - 'null'
          additionalProperties:
            type: string
        expires_at:
          description: >-
            ISO 8601 timestamp when this cart expires. After expiry, the cart is
            no longer valid and a new cart must be created.
          type:
            - string
            - 'null'
          format: date-time
        applied_promotions:
          description: >-
            Information about the promotional offers that have been applied to
            the cart.
          type: array
          items:
            $ref: '#/components/schemas/AppliedPromotion'
        applied_coupons:
          description: >-
            This key provides details about the savings in cart after coupon
            have been applied to the cart.
          type: array
          items:
            $ref: '#/components/schemas/AppliedCoupon'
        shipments:
          description: >-
            List containing detailed information about each shipment in the
            cart.
          type: array
          items:
            $ref: '#/components/schemas/CartShipment'
        promotion_savings:
          description: Total savings from auto-applied promotions.
          type: number
          minimum: 0
        coupon_savings:
          description: Total savings from the applied coupon code.
          type: number
          minimum: 0
        other_savings:
          description: >-
            Total savings from loyalty points, credit balance, and other
            non-promotion/coupon discounts.
          type: number
          minimum: 0
        total_savings:
          description: >-
            Combined savings across promotions, coupons, and other discounts
            (`promotion_savings` + `coupon_savings` + `other_savings`).
          type: number
          minimum: 0
        free_shipping_threshold:
          description: Free shipping threshold of the cart
          type:
            - number
            - 'null'
        status:
          description: >-
            Checkout readiness of the cart. A cart is `ready-for-payment` only
            when it has items, a valid address, and a fulfillment preference
            set. Use `status_error_message` for the specific reason when
            `not-ready-for-payment`.
          type: string
          default: not-ready-for-payment
          enum:
            - not-ready-for-payment
            - ready-for-payment
        status_error_message:
          description: >-
            Human-readable reason why the cart is not ready for payment. `null`
            when `status` is `ready-for-payment`.
          type:
            - string
            - 'null'
      examples: []
    FulfillmentPreference:
      title: FulfillmentPreference
      description: >-
        How the customer wants to receive their order. Discriminated by
        `fulfillment_type`: `delivery` for home delivery, `collect-in-store` for
        in-store pickup, or `partial-collect-and-delivery` for a mix of both.
      externalDocs:
        url: >-
          https://llm-docs.commercengine.io/storefront/schemas/FulfillmentPreference
        description: API reference for the FulfillmentPreference schema
      discriminator:
        propertyName: fulfillment_type
        mapping:
          collect-in-store:
            $ref: '#/components/schemas/CollectInStoreFulfillment'
          delivery:
            $ref: '#/components/schemas/DeliveryFulfillment'
          partial-collect-and-delivery:
            $ref: '#/components/schemas/PartialCollectAndDelivery'
      oneOf:
        - $ref: '#/components/schemas/CollectInStoreFulfillment'
        - $ref: '#/components/schemas/DeliveryFulfillment'
        - $ref: '#/components/schemas/PartialCollectAndDelivery'
      x-tags:
        - Carts
    CartItem:
      title: CartItem
      description: >-
        This Cart Item model captures the attributes of a cart item, including
        product details, pricing information, subscription details, and other
        relevant information related to Cart Item.
      type: object
      externalDocs:
        url: https://llm-docs.commercengine.io/storefront/schemas/CartItem
        description: API reference for the CartItem schema
      required:
        - product_id
        - variant_id
        - sku
        - slug
        - product_name
        - variant_name
        - product_type
        - product_image_url
        - stock_available
        - backorder
        - on_subscription
        - on_promotion
        - quantity
        - is_free_item
        - free_quantity
        - promotion_discount_amount
        - coupon_discount_amount
        - price_including_tax
        - listing_price
        - selling_price
        - selling_price_excluding_tax
        - min_order_quantity
        - max_order_quantity
        - incremental_quantity
        - handling_charge_excluding_tax
        - handling_charge_tax_rate
        - handling_charge_including_tax
        - tax_type
        - tax_rate
        - tax_amount
        - associated_options
        - attributes
        - subscriptions
      properties:
        product_id:
          description: Unique identifier for the product.
          type: string
          pattern: ^[0123456789ABCDEFGHJKMNPQRSTVWXYZ]{26}$
        variant_id:
          description: >-
            The product variant identifier. `null` if the product has no
            variants.
          type:
            - string
            - 'null'
          pattern: ^[0123456789ABCDEFGHJKMNPQRSTVWXYZ]{26}$
        sku:
          description: >-
            Stock Keeping Unit, a unique identifier for the product within
            inventory.
          type:
            - string
            - 'null'
          examples:
            - SKU1254
        slug:
          description: Unique slug for the product
          type: string
        product_name:
          description: Name of the product.
          type: string
        variant_name:
          description: Name of the variant.
          type:
            - string
            - 'null'
        product_type:
          type: string
          enum:
            - physical
            - digital
            - bundle
          examples:
            - physical
        product_image_url:
          description: URL pointing to the product image.
          type: string
        stock_available:
          description: Indicates whether the product is currently in stock.
          type: boolean
        backorder:
          description: >-
            Indicates whether the item is being fulfilled as a backorder. When
            true, the item is not currently in stock and will ship later once
            inventory is available. This may result in the order being split
            into multiple shipments, with delays for the backordered portion.
          type: boolean
        on_subscription:
          description: Indicates whether the product is currently on a subscription.
          type: boolean
        on_promotion:
          description: Indicates whether the product is part of a promotion.
          type: boolean
        quantity:
          description: The quantity of the product in the cart.
          type: integer
        is_free_item:
          description: Indicates if the product is offered for free.
          type: boolean
        free_quantity:
          description: Quantity of the product that is free.
          type: integer
        promotion_discount_amount:
          description: Discount amount due to promotions.
          type: number
          format: double
        coupon_discount_amount:
          description: Discount amount due to applied coupons.
          type: number
          format: double
        price_including_tax:
          description: Indicates whether the item price is inclusive of taxes.
          type: boolean
          examples:
            - false
        listing_price:
          type: number
          format: double
          example: 200
        selling_price:
          type: number
          format: double
          example: 199
        selling_price_excluding_tax:
          type: number
          format: double
        min_order_quantity:
          type: integer
          default: 1
        max_order_quantity:
          type:
            - integer
            - 'null'
        incremental_quantity:
          type: integer
          default: 1
        handling_charge_excluding_tax:
          description: Additional cost for shipping associated with the product.
          type: number
          minimum: 0
          readOnly: true
        handling_charge_tax_rate:
          description: Additional cost for shipping associated with the product.
          type: number
          minimum: 0
          readOnly: true
        handling_charge_including_tax:
          description: Additional cost for shipping associated with the product.
          type: number
          minimum: 0
          readOnly: true
        tax_type:
          description: Type of tax applied (e.g., GST).
          type: string
          default: GST
          const: GST
        tax_rate:
          description: The rate of tax applied to the product.
          type: number
          format: double
        tax_amount:
          description: The total tax amount for the product.
          type: number
          format: double
        associated_options:
          oneOf:
            - $ref: '#/components/schemas/AssociatedOption'
              description: Used when `variant_id` is not null.
            - type: 'null'
              description: Null when `variant_id` is null.
        attributes:
          type: array
          items:
            $ref: '#/components/schemas/ProductAttribute'
        subscriptions:
          type:
            - array
            - 'null'
          items:
            $ref: '#/components/schemas/ProductSubscription'
        seller_id:
          description: >-
            Seller ID. This field is relevant for marketplace type stores only.
            Will return null for b2b and b2c type stores.
          type:
            - string
            - 'null'
        seller_detail:
          description: >-
            Seller detail information. This field is relevant for marketplace
            type stores only. Will return null for b2b and b2c type stores.
          oneOf:
            - $ref: '#/components/schemas/SellerInfo'
            - type: 'null'
      examples: []
    CustomerAddress:
      title: CustomerAddress
      type:
        - object
        - 'null'
      externalDocs:
        url: https://llm-docs.commercengine.io/storefront/schemas/CustomerAddress
        description: API reference for the CustomerAddress schema
      required:
        - first_name
        - last_name
        - country_code
        - phone
        - email
        - address_line1
        - address_line2
        - landmark
        - pincode
        - city
        - state
        - country
        - tax_identification_number
        - business_name
        - is_phone_verified
        - is_email_verified
      properties:
        id:
          type:
            - string
            - 'null'
          pattern: ^[0123456789ABCDEFGHJKMNPQRSTVWXYZ]{26}$
          readOnly: true
        first_name:
          type: string
        last_name:
          type:
            - string
            - 'null'
        country_code:
          description: "Two-letter code begin with a plus sign prefix that identifies different countries. By default it will be +91 if not provided.\r\n"
          type: string
        phone:
          description: 10 digit phone number without country code.
          type: string
        email:
          type: string
        address_line1:
          type: string
        address_line2:
          type:
            - string
            - 'null'
        landmark:
          type:
            - string
            - 'null'
        pincode:
          type: string
        city:
          type: string
        state:
          type: string
        country:
          type: string
          const: India
        tax_identification_number:
          description: Tax Identification Number specific to the country of operation.
          type:
            - string
            - 'null'
          examples: []
        business_name:
          description: Use in billing & shipping details only.
          type:
            - string
            - 'null'
        is_default_billing:
          description: >-
            Indicates if the address is the default billing address for the
            customer.
          type: boolean
        is_default_shipping:
          description: >-
            Indicates if the address is the default shipping address for the
            customer.
          type: boolean
        is_phone_verified:
          type: boolean
          readOnly: true
        is_email_verified:
          type: boolean
          readOnly: true
        nickname:
          description: Nickname for the address.
          type:
            - string
            - 'null'
          default: null
      examples: []
    Currency:
      type: object
      externalDocs:
        url: https://llm-docs.commercengine.io/storefront/schemas/Currency
        description: API reference for the Currency schema
      required:
        - name
        - code
        - symbol
      properties:
        name:
          type: string
          examples:
            - Indian Rupee
        code:
          type: string
          examples:
            - INR
          maxLength: 3
          minLength: 3
        symbol:
          type: string
          examples:
            - ₹
    AppliedPromotion:
      title: AppliedPromotion
      description: Details about an active promotion applied to a cart/order
      type: object
      externalDocs:
        url: https://llm-docs.commercengine.io/storefront/schemas/AppliedPromotion
        description: API reference for the AppliedPromotion schema
      required:
        - promotion_id
        - promotion_type
        - savings
        - product_id
        - variant_id
        - product_name
        - variant_name
        - applied_sequence
        - scope
      properties:
        promotion_id:
          type: string
        promotion_type:
          enum:
            - discount
            - free-goods
            - free-shipping
            - buy-x-get-y
            - volume-based
        savings:
          type: number
        product_id:
          type:
            - string
            - 'null'
        variant_id:
          type:
            - string
            - 'null'
        product_name:
          type:
            - string
            - 'null'
        variant_name:
          type:
            - string
            - 'null'
        applied_sequence:
          type: number
        scope:
          type: string
    AppliedCoupon:
      title: AppliedPromotion
      description: Details about an active coupon applied to a cart/order
      type: object
      externalDocs:
        url: https://llm-docs.commercengine.io/storefront/schemas/AppliedCoupon
        description: API reference for the AppliedCoupon schema
      required:
        - coupon_id
        - coupon_type
        - savings
        - product_id
        - variant_id
        - product_name
        - variant_name
      properties:
        coupon_id:
          type: string
        coupon_type:
          enum:
            - discount
            - free-goods
            - fixed-price
            - free-shipping
            - buy-x-get-y
            - volume-based
            - accelerated-rewards
        savings:
          type: number
        product_id:
          type:
            - string
            - 'null'
        variant_id:
          type:
            - string
            - 'null'
        product_name:
          type:
            - string
            - 'null'
        variant_name:
          type:
            - string
            - 'null'
    CartShipment:
      title: CartShipment
      description: Cart shipment model
      type: object
      externalDocs:
        url: https://llm-docs.commercengine.io/storefront/schemas/CartShipment
        description: API reference for the CartShipment schema
      properties:
        id:
          type: string
        shipping_provider_id:
          type: string
        shipping_provider_name:
          type: string
        courier_company_id:
          type:
            - string
            - 'null'
        courier_company_name:
          type:
            - string
            - 'null'
        shipping_amount:
          type: number
          format: double
        shipping_tax_amount:
          type: number
          format: double
        shipping_amount_including_tax:
          type: number
          format: double
        shipment_items_count:
          type: integer
        shipment_items:
          type: array
          items:
            $ref: '#/components/schemas/ShipmentItem'
    CollectInStoreFulfillment:
      title: CollectInStoreFulfillment
      type: object
      externalDocs:
        url: >-
          https://llm-docs.commercengine.io/storefront/schemas/CollectInStoreFulfillment
        description: API reference for the CollectInStoreFulfillment schema
      required:
        - fulfillment_type
        - pickup_location_id
      properties:
        fulfillment_type:
          type: string
          const: collect-in-store
        preference_type:
          type: string
          enum:
            - user
            - auto
          readOnly: true
        pickup_location_id:
          type: string
        pickup_location_name:
          type: string
          readOnly: true
    DeliveryFulfillment:
      title: DeliveryFulfillment
      type: object
      externalDocs:
        url: >-
          https://llm-docs.commercengine.io/storefront/schemas/DeliveryFulfillment
        description: API reference for the DeliveryFulfillment schema
      required:
        - fulfillment_type
        - shipments
      properties:
        fulfillment_type:
          type: string
          const: delivery
        preference_type:
          type: string
          enum:
            - user
            - auto
          readOnly: true
        shipments:
          type: array
          items:
            type: object
            properties:
              id:
                type: string
              shipping_provider_id:
                type:
                  - string
              shipping_provider_name:
                type:
                  - string
                  - 'null'
                readOnly: true
              courier_company_id:
                type:
                  - string
                  - 'null'
              courier_company_name:
                type:
                  - string
                  - 'null'
                readOnly: true
            required:
              - id
              - shipping_provider_id
    PartialCollectAndDelivery:
      title: PartialCollectAndDelivery
      type: object
      externalDocs:
        url: >-
          https://llm-docs.commercengine.io/storefront/schemas/PartialCollectAndDelivery
        description: API reference for the PartialCollectAndDelivery schema
      required:
        - fulfillment_type
        - collect-in-store
        - delivery
      properties:
        fulfillment_type:
          type: string
          const: partial-collect-and-delivery
        preference_type:
          type: string
          enum:
            - user
            - auto
          readOnly: true
        collect-in-store:
          type: object
          properties:
            pickup_location_id:
              type: string
            pickup_location_name:
              type: string
              readOnly: true
            items:
              type: array
              items:
                $ref: '#/components/schemas/FulfillmentItem'
          required:
            - items
            - pickup_location_id
        delivery:
          type: object
          properties:
            shipping_provider_id:
              type: string
            shipping_provider_name:
              type:
                - string
                - 'null'
              readOnly: true
            courier_company_id:
              type:
                - string
                - 'null'
            courier_company_name:
              type:
                - string
                - 'null'
              readOnly: true
            items:
              type: array
              items:
                $ref: '#/components/schemas/FulfillmentItem'
          required:
            - shipping_provider_id
            - items
    AssociatedOption:
      title: AssociatedOption
      description: >-
        An object where each key is an option name, and the value describes the
        option details.
      type: object
      externalDocs:
        url: https://llm-docs.commercengine.io/storefront/schemas/AssociatedOption
        description: API reference for the AssociatedOption schema
      additionalProperties:
        oneOf:
          - $ref: '#/components/schemas/ColorOption'
          - $ref: '#/components/schemas/SingleSelectOption'
      examples:
        - background_color:
            name: Background Color
            value:
              name: Blue
              hexcode: '#0000FF'
            type: color
          size:
            name: Size
            value: Large
            type: single-select
    ProductAttribute:
      externalDocs:
        url: https://llm-docs.commercengine.io/storefront/schemas/ProductAttribute
        description: API reference for the ProductAttribute schema
      discriminator:
        propertyName: type
        mapping:
          color:
            $ref: '#/components/schemas/ColorAttribute'
          single-select:
            $ref: '#/components/schemas/SingleSelectAttribute'
          multi-select:
            $ref: '#/components/schemas/MultiSelectAttribute'
          text:
            $ref: '#/components/schemas/TextAttribute'
          date:
            $ref: '#/components/schemas/DateAttribute'
          number:
            $ref: '#/components/schemas/NumberAttribute'
          boolean:
            $ref: '#/components/schemas/BooleanAttribute'
      oneOf:
        - $ref: '#/components/schemas/ColorAttribute'
          type: object
        - $ref: '#/components/schemas/SingleSelectAttribute'
          type: object
        - $ref: '#/components/schemas/MultiSelectAttribute'
          type: object
        - $ref: '#/components/schemas/TextAttribute'
          type: object
        - $ref: '#/components/schemas/DateAttribute'
          type: object
        - $ref: '#/components/schemas/NumberAttribute'
          type: object
        - $ref: '#/components/schemas/BooleanAttribute'
          type: object
    ProductSubscription:
      title: ProductSubscription
      type: object
      externalDocs:
        url: >-
          https://llm-docs.commercengine.io/storefront/schemas/ProductSubscription
        description: API reference for the ProductSubscription schema
      required:
        - id
        - subscription_plan
        - subscription_price
        - billing_interval
        - billing_frequency
        - billing_limit
        - fulfill_separately
        - order_interval
        - order_frequency
        - order_limit
        - minimum_quantity
        - billing_trial_days
      properties:
        id:
          type: string
        subscription_plan:
          type: string
        subscription_price:
          type: number
          format: double
        billing_interval:
          description: >-
            Billing interval determines the frequency for which the customer is
            charged for the subscription itself.
          type: integer
        billing_frequency:
          type: string
          enum:
            - weekly
            - monthly
            - annually
          examples:
            - monthly
        billing_limit:
          description: >-
            Optionally limit the number of times this subscription will invoice
            the customer.
          type: integer
        fulfill_separately:
          type: boolean
          default: false
        order_interval:
          description: >-
            order interval defines the frequency of when the subscription sends
            customers the product
          type: integer
        order_frequency:
          type: string
          enum:
            - weekly
            - monthly
            - annully
          examples:
            - monthly
        order_limit:
          description: >-
            By default this is set to unlimited, meaning the subscription will
            fulfill indefinitely. Changing the Limit to 10 would force the
            subscription to end after the tenth interval had been fulfilled.
          type: integer
        minimum_quantity:
          description: The quantity of the plan to which the customer should be subscribed
          type: integer
        billing_trial_days:
          description: Use in digital product only for trial period
          type: integer
      examples: []
    SellerInfo:
      title: SellerInfo
      type: object
      externalDocs:
        url: https://llm-docs.commercengine.io/storefront/schemas/SellerInfo
        description: API reference for the SellerInfo schema
      required:
        - id
        - trade_name
        - legal_name
        - business_type
        - tax_identification_number
      properties:
        id:
          type: string
        trade_name:
          type: string
        legal_name:
          type: string
        business_type:
          type: string
        tax_identification_number:
          type: string
      examples: []
    ShipmentItem:
      title: ShipmentItem
      description: Shipment item model
      type: object
      externalDocs:
        url: https://llm-docs.commercengine.io/storefront/schemas/ShipmentItem
        description: API reference for the ShipmentItem schema
      properties:
        product_id:
          type: string
        product_name:
          type: string
        product_image_url:
          type:
            - string
            - 'null'
        variant_id:
          type: string
        variant_name:
          type: string
        sku:
          type: string
        quantity:
          type: integer
        free_quantity:
          type: integer
        is_free_item:
          type: boolean
    FulfillmentItem:
      title: FulfillmentItem
      type: object
      externalDocs:
        url: https://llm-docs.commercengine.io/storefront/schemas/FulfillmentItem
        description: API reference for the FulfillmentItem schema
      required:
        - product_id
        - product_name
        - variant_id
        - variant_name
        - quantity
      properties:
        product_id:
          type: string
        product_name:
          type: string
          readOnly: true
        variant_id:
          type:
            - string
            - 'null'
        variant_name:
          type:
            - string
            - 'null'
          readOnly: true
        quantity:
          type: integer
    ColorOption:
      title: ColorOption
      type: object
      externalDocs:
        url: https://llm-docs.commercengine.io/storefront/schemas/ColorOption
        description: API reference for the ColorOption schema
      required:
        - name
        - type
        - value
      properties:
        name:
          description: The name of the associated option.
          type: string
        type:
          description: The type of the associated option.
          const: color
        value:
          type: object
          properties:
            hexcode:
              description: 'The hex code of the color (e.g., #000000).'
              type: string
              format: color-hex
              pattern: ^#(?:[0-9a-fA-F]{3}){1,2}$
            name:
              type: string
              description: The name of the color.
          required:
            - name
            - hexcode
    SingleSelectOption:
      title: SingleSelectOption
      type: object
      externalDocs:
        url: >-
          https://llm-docs.commercengine.io/storefront/schemas/SingleSelectOption
        description: API reference for the SingleSelectOption schema
      required:
        - name
        - type
        - value
      properties:
        name:
          description: The name of the associated option.
          type: string
        type:
          description: The type of the associated option.
          const: single-select
        value:
          description: The value of the associated option
          type: string
    ColorAttribute:
      title: ColorAttribute
      description: Attribute for colors
      type: object
      readOnly: true
      externalDocs:
        url: https://llm-docs.commercengine.io/storefront/schemas/ColorAttribute
        description: API reference for the ColorAttribute schema
      required:
        - id
        - name
        - key
        - type
        - value
      properties:
        id:
          type: string
        name:
          type: string
        key:
          description: >-
            A lookup safe version of the name that is lowercased and spaces are
            replaced with underscores. For instance, if name is `Product Type`,
            key will be `product_type`
          type: string
        type:
          type: string
          example: color
        value:
          type: array
          items:
            type: object
            required:
              - name
              - hexcode
            properties:
              name:
                type: string
              hexcode:
                description: 'The hex code of the color (e.g., #000000).'
                type: string
                format: color-hex
                pattern: ^#(?:[0-9a-fA-F]{3}){1,2}$
    SingleSelectAttribute:
      title: SingleSelectAttribute
      description: Attribute for single-select values
      type: object
      readOnly: true
      externalDocs:
        url: >-
          https://llm-docs.commercengine.io/storefront/schemas/SingleSelectAttribute
        description: API reference for the SingleSelectAttribute schema
      required:
        - id
        - name
        - key
        - type
        - value
      properties:
        id:
          type: string
        name:
          type: string
        key:
          description: >-
            A lookup safe version of the name that is lowercased and spaces are
            replaced with underscores. For instance, if name is `Product Type`,
            key will be `product_type`
          type: string
        type:
          type: string
          example: single-select
        value:
          description: For single-select attributes
          type: string
    MultiSelectAttribute:
      title: MultiSelectAttribute
      description: Attribute for multi-select values
      type: object
      readOnly: true
      externalDocs:
        url: >-
          https://llm-docs.commercengine.io/storefront/schemas/MultiSelectAttribute
        description: API reference for the MultiSelectAttribute schema
      required:
        - id
        - name
        - key
        - type
        - value
      properties:
        id:
          type: string
        name:
          type: string
        key:
          description: >-
            A lookup safe version of the name that is lowercased and spaces are
            replaced with underscores. For instance, if name is `Product Type`,
            key will be `product_type`
          type: string
        type:
          type: string
          example: multi-select
        value:
          description: For multi-select attributes
          type: array
          items:
            type: string
    TextAttribute:
      title: TextAttribute
      description: Attribute for text values
      type: object
      readOnly: true
      externalDocs:
        url: https://llm-docs.commercengine.io/storefront/schemas/TextAttribute
        description: API reference for the TextAttribute schema
      required:
        - id
        - name
        - key
        - type
        - value
      properties:
        id:
          type: string
        name:
          type: string
        key:
          description: >-
            A lookup safe version of the name that is lowercased and spaces are
            replaced with underscores. For instance, if name is `Product Type`,
            key will be `product_type`
          type: string
        type:
          type: string
          example: text
        value:
          description: For text attributes
          type: string
    DateAttribute:
      title: DateAttribute
      description: Attribute for date values
      type: object
      readOnly: true
      externalDocs:
        url: https://llm-docs.commercengine.io/storefront/schemas/DateAttribute
        description: API reference for the DateAttribute schema
      required:
        - id
        - name
        - key
        - type
        - value
      properties:
        id:
          type: string
        name:
          type: string
        key:
          description: >-
            A lookup safe version of the name that is lowercased and spaces are
            replaced with underscores. For instance, if name is `Product Type`,
            key will be `product_type`
          type: string
        type:
          type: string
          example: date
        value:
          description: For date attributes
          type: string
          format: date-time
    NumberAttribute:
      title: NumberAttribute
      description: Attribute for numeric values
      type: object
      readOnly: true
      externalDocs:
        url: https://llm-docs.commercengine.io/storefront/schemas/NumberAttribute
        description: API reference for the NumberAttribute schema
      required:
        - id
        - name
        - key
        - type
        - value
      properties:
        id:
          type: string
        name:
          type: string
        key:
          description: >-
            A lookup safe version of the name that is lowercased and spaces are
            replaced with underscores. For instance, if name is `Product Type`,
            key will be `product_type`
          type: string
        type:
          type: string
          example: number
        value:
          description: For numeric attributes
          type: number
    BooleanAttribute:
      title: BooleanAttribute
      description: Attribute for boolean values
      type: object
      readOnly: true
      externalDocs:
        url: https://llm-docs.commercengine.io/storefront/schemas/BooleanAttribute
        description: API reference for the BooleanAttribute schema
      required:
        - id
        - name
        - key
        - type
        - value
      properties:
        id:
          type: string
        name:
          type: string
        key:
          description: >-
            A lookup safe version of the name that is lowercased and spaces are
            replaced with underscores. For instance, if name is `Product Type`,
            key will be `product_type`
          type: string
        type:
          type: string
          example: boolean
        value:
          description: For boolean attributes
          type: boolean
  responses:
    BadRequest:
      description: Bad request
      content:
        application/json:
          schema:
            type: object
            required:
              - message
              - success
              - code
            properties:
              message:
                type: string
                x-speakeasy-error-message: true
              success:
                type: boolean
              code:
                type: string
              error:
                type: object
    Unauthorized:
      description: Not authorized for given operation on the Resource
      content:
        application/json:
          schema:
            type: object
            required:
              - message
              - success
              - code
            properties:
              message:
                type: string
                examples:
                  - Not authorized for given operation on the Resource.
                x-speakeasy-error-message: true
              success:
                type: boolean
                default: false
              code:
                type: string
                examples:
                  - unauthorized
  securitySchemes:
    Authorization:
      type: http
      description: Access token
      scheme: bearer

````