> ## 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.

# List all SKUs

> Returns a paginated list of SKUs. Sorts within the returned page. By default, simple products appear first, newest first; variant SKUs follow in no defined order.



## OpenAPI

````yaml https://openapi.commercengine.io/ce-pos.json get /pos/catalog/skus
openapi: 3.2.0
info:
  title: CE POS APIs
  description: >-
    The consolidated Point of Sale surface. Every operation is served under the
    storefront base URL; the POS backend proxies some of them to the admin
    service.
  version: '1.0'
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:
  - Authorization: []
tags:
  - name: section-identity
    summary: Identity
    kind: nav
  - name: Devices
    description: >-
      Set up the till: pair a device with the store using its pairing code, list
      the store's `PosLocation`s and `PosDevice`s, and claim a device for the
      signed-in user or release it.
    summary: Devices
    kind: nav
    parent: section-identity
  - name: Authentication
    description: >-
      Sign a staff member in on a paired device with a one-time password over
      SMS, WhatsApp or email, then refresh the access token or log out.
    summary: Authentication
    kind: nav
    parent: section-identity
  - name: Users
    description: >-
      The staff member signed in on the till, as a `PosUser` with their
      location, device and roles.
    summary: Users
    kind: nav
    parent: section-identity
  - name: section-customers
    summary: Customers
    kind: nav
  - name: Customers
    description: >-
      Look up the shopper at the till: list customers (`CustomerListItem`) and
      read one's full `CustomerDetail`.
    summary: Customers
    kind: nav
    parent: section-customers
  - name: Addresses
    description: >-
      A customer's saved addresses, as `Address` objects: list, add, update and
      remove them.
    summary: Addresses
    kind: nav
    parent: section-customers
  - name: section-catalog
    summary: Catalog
    kind: nav
  - name: Products
    description: >-
      Browse and search the catalog at the till: list `Product`s and SKUs, read
      a product and its variants, and show similar, up-sell and cross-sell
      items.
    summary: Products
    kind: nav
    parent: section-catalog
  - name: Reviews
    description: Read product reviews at the till.
    summary: Reviews
    kind: nav
    parent: section-catalog
  - name: Categories
    description: >-
      The store's categories, as `ProductCategory` objects with their child
      categories.
    summary: Categories
    kind: nav
    parent: section-catalog
  - name: Inventory
    description: >-
      Stock at the store's locations: list it by item, read an item's
      `InventoryDetail`, and follow the `InventoryActivity` that moved it.
    summary: Inventory
    kind: nav
    parent: section-catalog
  - name: section-shopping
    summary: Shopping
    kind: nav
  - name: Carts
    description: >-
      The till's `Cart`: create it, add, update or remove items, link the
      customer, set the address, and apply loyalty points or credit balance.
      Each update returns the full, updated `Cart`.
    summary: Carts
    kind: nav
    parent: section-shopping
  - name: Coupons & promotions
    description: >-
      The coupons and promotions a cart can use: list what the store offers, see
      which apply to a cart and why the rest don't, and apply or remove a
      coupon.
    summary: Coupons & promotions
    kind: nav
    parent: section-shopping
  - name: Fulfillment
    description: >-
      List the delivery and collect-in-store options for a cart, and save the
      cart's choice.
    summary: Fulfillment
    kind: nav
    parent: section-shopping
  - name: section-orders
    summary: Orders
    kind: nav
  - name: Orders
    description: >-
      Place an order from the till's cart and follow it: list orders, read an
      `OrderDetail` and its activity, check stock before it ships, and get its
      invoice, receipt and shipments.
    summary: Orders
    kind: nav
    parent: section-orders
  - name: Order payments
    description: >-
      Collect payment for an order: add payments toward what is left to pay,
      across one or more methods, poll the payment status, and retry a failed or
      expired payment.
    summary: Order payments
    kind: nav
    parent: section-orders
  - name: Shipments
    description: >-
      The shipments that fulfill orders: list them, read a `ShipmentDetail` with
      its activity and invoice, approve, reject or update one, send a
      replacement, and refund a shortfall.
    summary: Shipments
    kind: nav
    parent: section-orders
  - name: section-payments
    summary: Payments
    kind: nav
  - name: Payments
    description: >-
      The payment methods the till accepts and the checks around paying with
      them: card BIN details, VPA verification, and authenticating a payment
      with a direct OTP.
    summary: Payments
    kind: nav
    parent: section-payments
  - name: section-store
    summary: Store
    kind: nav
  - name: Locations
    description: States and pincodes for address forms.
    summary: Locations
    kind: nav
    parent: section-store
paths:
  /pos/catalog/skus:
    get:
      tags:
        - Products
      summary: List all SKUs
      description: >-
        Returns a paginated list of SKUs. Sorts within the returned page. By
        default, simple products appear first, newest first; variant SKUs follow
        in no defined order.
      operationId: pos-list-skus
      parameters:
        - $ref: '#/components/parameters/pageParam'
        - $ref: '#/components/parameters/pageLimitParam'
        - $ref: '#/components/parameters/CustomerGroupId'
        - name: category-id
          in: query
          description: Alias for `category_id`.
          schema:
            type: array
            items:
              type: string
          explode: true
          style: form
        - name: category-slug
          in: query
          description: Alias for `category_slug`.
          schema:
            type: array
            items:
              type: string
        - name: category_id
          in: query
          description: filter sku by categories
          schema:
            type: array
            items:
              type: string
          explode: true
          style: form
        - name: category_slug
          in: query
          description: filter products by categories slugs
          schema:
            type: array
            items:
              type: string
        - name: inventory
          in: query
          description: >-
            Determines whether to include or exclude inventory details in
            response json
          schema:
            type: boolean
        - name: product_id
          in: query
          description: >-
            Filter by product IDs. Products without variants are listed when no
            variant IDs are supplied.
          schema:
            type: array
            items:
              type: string
          explode: false
          style: form
        - name: product_type
          in: query
          description: Filter by product type. Only items with a SKU are listed.
          schema:
            type: array
            items:
              type: string
              enum:
                - physical
                - digital
                - bundle
          explode: false
          style: form
        - name: sku
          in: query
          description: array of sku
          schema:
            type: array
            items:
              type: string
          explode: false
          style: form
        - name: sort_by
          in: query
          description: >-
            Sort within the returned page by item fields using a JSON object of
            field names and directions. Use `asc` for string fields such as
            `sku`, `product_name` and `variant_name`; numeric fields such as
            `reviews_count` and `reviews_rating_sum` support `asc` and `desc`.
          required: false
          schema:
            type: string
            examples:
              - '{"sku":"asc"}'
        - name: variant_id
          in: query
          description: >-
            Filter by variant IDs. Variants are listed when no product IDs are
            supplied.
          schema:
            type: array
            items:
              type: string
          explode: false
          style: form
      responses:
        '200':
          description: Success response
          content:
            application/json:
              schema:
                type: object
                required:
                  - message
                  - success
                  - content
                properties:
                  message:
                    type: string
                    examples:
                      - SKUs retrieved successfully.
                  success:
                    type: boolean
                  content:
                    properties:
                      skus:
                        type: array
                        items:
                          $ref: '#/components/schemas/SkuListItem'
                        readOnly: true
                      pagination:
                        $ref: '#/components/schemas/Pagination'
                    required:
                      - skus
                      - pagination
                    type: object
          links:
            AddItemToCart:
              operationId: pos-update-cart
              requestBody:
                product_id: $response.body#/content/skus/0/product_id
                variant_id: $response.body#/content/skus/0/variant_id
              description: Add a SKU to a cart.
        '400':
          $ref: '#/components/responses/BadRequest'
          description: The request parameters or customer group are invalid.
        '401':
          $ref: '#/components/responses/Unauthorized'
        '403':
          $ref: '#/components/responses/Forbidden'
        '500':
          $ref: '#/components/responses/InternalServerError'
        '504':
          $ref: '#/components/responses/GatewayTimeout'
      security:
        - Authorization: []
      externalDocs:
        url: https://llm-docs.commercengine.io/admin-pos/operations/pos-list-skus
components:
  parameters:
    pageParam:
      name: page
      in: query
      required: false
      schema:
        type: integer
        default: 1
        minimum: 1
      description: >-
        Page number, starting at 1. Non-integer values and values below 1 return
        400.
    pageLimitParam:
      name: limit
      in: query
      required: false
      schema:
        type: integer
        default: 25
        maximum: 100
        minimum: 1
      description: >-
        Results per page. Values outside 1–100 are clamped to that range.
        Non-integer input returns 400.
    CustomerGroupId:
      name: x-customer-group-id
      in: header
      required: false
      schema:
        type: string
      description: >-
        This param is used to determine product pricing, promotions, and
        subscription rates.  If a valid customer group id is provided, pricing
        details will be retrieved accordingly.  If no matching data is found for
        the specified customer group id, the system will fall back to the
        default customer group id.  If no data is found for the default group
        either, the highest applicable price will be returned.
  schemas:
    SkuListItem:
      title: SkuListItem
      externalDocs:
        url: https://llm-docs.commercengine.io/admin-pos/schemas/SkuListItem
      allOf:
        - $ref: '#/components/schemas/CatalogListItem'
        - type: object
          required:
            - shipping
    Pagination:
      description: pagination metadata structure
      type: object
      externalDocs:
        url: https://llm-docs.commercengine.io/admin-pos/schemas/Pagination
      required:
        - total_records
        - total_pages
        - limit
        - next_page
        - previous_page
      properties:
        total_records:
          type: integer
        total_pages:
          type: integer
        previous_page:
          type:
            - integer
            - 'null'
        limit:
          type: integer
        next_page:
          type:
            - integer
            - 'null'
      examples:
        - total_records: 100
          total_pages: 4
          previous_page: null
          next_page: 2
          limit: 25
    CatalogListItem:
      title: CatalogListItem
      externalDocs:
        url: https://llm-docs.commercengine.io/admin-pos/schemas/CatalogListItem
      allOf:
        - $ref: '#/components/schemas/Item'
        - type: object
          required:
            - slug
            - product_slug
            - variant_slug
            - attributes
            - images
            - metadata
            - seo
            - hsn_code
            - categories
    Item:
      title: SKU
      type: object
      externalDocs:
        url: https://llm-docs.commercengine.io/admin-pos/schemas/Item
      required:
        - product_id
        - variant_id
        - sku
        - product_name
        - variant_name
        - product_type
        - short_description
        - active
        - stock_available
        - on_subscription
        - on_promotion
        - category_ids
        - tags
        - reviews_count
        - reviews_rating_sum
        - pricing
        - promotion
        - subscription
        - associated_options
      properties:
        product_id:
          type: string
        variant_id:
          type:
            - string
            - 'null'
        sku:
          type:
            - string
            - 'null'
        product_slug:
          type: string
        variant_slug:
          type:
            - string
            - 'null'
        product_name:
          type: string
        variant_name:
          type:
            - string
            - 'null'
        product_type:
          type: string
          enum:
            - physical
            - digital
            - bundle
          examples:
            - physical
        short_description:
          type:
            - string
            - 'null'
        active:
          type: boolean
        stock_available:
          type: boolean
        on_subscription:
          type: boolean
        on_promotion:
          type: boolean
        category_ids:
          type: array
          items:
            type: string
        categories:
          description: Expanded category objects.
          type: array
          items:
            $ref: '#/components/schemas/Category'
        tags:
          type:
            - array
            - 'null'
          items:
            type: string
        reviews_count:
          description: >-
            Number of approved reviews; pending, rejected and archived reviews
            are excluded.
          type: integer
        reviews_rating_sum:
          description: >-
            Sum of approved review ratings, preserving fractional ratings. Zero
            when there are no approved reviews. Divide by reviews_count when
            nonzero to compute the average.
          type:
            - number
            - 'null'
          format: double
        attributes:
          type: array
          items:
            $ref: '#/components/schemas/ProductAttribute'
        images:
          type: array
          items:
            $ref: '#/components/schemas/ProductImage'
        pricing:
          description: >-
            Pricing for the applicable customer group. `null` when no pricing is
            configured.
          oneOf:
            - $ref: '#/components/schemas/ProductPricing'
            - type: 'null'
        promotion:
          $ref: '#/components/schemas/ProductPromotion'
        subscription:
          type: array
          items:
            $ref: '#/components/schemas/ProductSubscription'
        associated_options:
          oneOf:
            - $ref: '#/components/schemas/AssociatedOption'
              description: Used when `variant_id` is not null.
            - type: 'null'
              description: Null when `variant_id` is null.
        shipping:
          $ref: '#/components/schemas/ProductShipping'
        slug:
          description: >-
            Slug of the returned entity (variant slug when `variant_id` is set,
            otherwise the product slug).
          type: string
        metadata:
          description: Freeform metadata key/value map.
          type:
            - object
            - 'null'
          additionalProperties:
            type: string
        seo:
          oneOf:
            - $ref: '#/components/schemas/Seo'
            - type: 'null'
        hsn_code:
          description: HSN/SAC tax classification code. `null` when not configured.
          type:
            - string
            - 'null'
        on_offer:
          description: >-
            Indicates whether the item currently has an active offer. Emitted by
            the search-result variant of this payload.
          type: boolean
        packaging:
          $ref: '#/components/schemas/Packaging'
          description: >-
            Packing dimensions. Emitted by the search-result variant of this
            payload; `null` when none configured.
        inventory:
          type: array
          items:
            $ref: '#/components/schemas/LotBatchDetail'
      examples: []
    Category:
      title: Category
      type: object
      externalDocs:
        url: https://llm-docs.commercengine.io/admin-pos/schemas/Category
      required:
        - id
        - name
        - slug
        - description
        - parent_category_id
        - product_count
        - active
      properties:
        id:
          type: string
          readOnly: true
        name:
          type: string
          readOnly: true
        slug:
          type: string
          readOnly: true
        description:
          type:
            - string
            - 'null'
        parent_category_id:
          type:
            - string
            - 'null'
          readOnly: true
        product_count:
          type: integer
        active:
          type: boolean
      examples: []
    ProductAttribute:
      externalDocs:
        url: https://llm-docs.commercengine.io/admin-pos/schemas/ProductAttribute
      discriminator:
        propertyName: type
        mapping:
          color: '#/components/schemas/ColorAttribute'
          single-select: '#/components/schemas/SingleSelectAttribute'
          multi-select: '#/components/schemas/MultiSelectAttribute'
          text: '#/components/schemas/TextAttribute'
          date: '#/components/schemas/DateAttribute'
          number: '#/components/schemas/NumberAttribute'
          boolean: '#/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
    ProductImage:
      title: ProductImage
      type: object
      externalDocs:
        url: https://llm-docs.commercengine.io/admin-pos/schemas/ProductImage
      required:
        - id
        - title
        - alternate_text
        - sort_order
        - url_tiny
        - url_thumbnail
        - url_standard
        - url_zoom
      properties:
        id:
          type: string
        title:
          type:
            - string
            - 'null'
        alternate_text:
          type:
            - string
            - 'null'
        sort_order:
          type: integer
        url_tiny:
          type: string
        url_thumbnail:
          type: string
        url_standard:
          type: string
        url_zoom:
          type: string
      examples: []
    ProductPricing:
      title: ProductPricing
      description: ' Selects the requested customer group price, then the default group price, then the highest selling price when neither is available.'
      type: object
      externalDocs:
        url: https://llm-docs.commercengine.io/admin-pos/schemas/ProductPricing
      required:
        - currency
        - tax_type
        - tax_rate
        - price_including_tax
        - listing_price
        - selling_price
        - min_order_quantity
        - max_order_quantity
        - incremental_quantity
        - selling_price_excluding_tax
      properties:
        currency:
          type: string
        tax_type:
          type: string
          default: GST
          enum:
            - GST
            - VAT
            - ECO
          examples:
            - GST
        tax_rate:
          type: number
          format: double
        price_including_tax:
          type: boolean
          examples:
            - false
        listing_price:
          type: number
          format: double
        selling_price:
          type: number
          format: double
        min_order_quantity:
          description: '`null` means no quantity constraint.'
          type:
            - integer
            - 'null'
          default: 1
        max_order_quantity:
          type:
            - integer
            - 'null'
        incremental_quantity:
          description: '`null` means no quantity constraint.'
          type:
            - integer
            - 'null'
          default: 1
        selling_price_excluding_tax:
          type: number
          format: double
      examples: []
    ProductPromotion:
      title: ProductPromotion
      description: >-
        Active promotion on a product. `null` when `on_promotion` is `false`.
        The `details` field uses `promotion_type` as discriminator to determine
        the promotion structure.
      type:
        - object
        - 'null'
      externalDocs:
        url: https://llm-docs.commercengine.io/admin-pos/schemas/ProductPromotion
      required:
        - id
        - starts_at
        - expires_at
        - details
      properties:
        id:
          type: string
        starts_at:
          type: string
          format: date-time
        expires_at:
          description: When the promotion ends. `null` for promotions with no expiry.
          type:
            - string
            - 'null'
          format: date-time
        details:
          description: >-
            Promotion rules and pricing. Use `promotion_type` to determine the
            structure: `discount` (percentage/flat off), `fixed-price` (override
            price), `volume-based` (a percent off by quantity tier),
            `volume-based-tier` (a unit price by quantity tier), or `free-goods`
            (buy X get Y free).
          discriminator:
            propertyName: promotion_type
            mapping:
              discount: '#/components/schemas/DiscountBasedPromotion'
              fixed-price: '#/components/schemas/FixedPricePromotion'
              volume-based: '#/components/schemas/VolumeBasedPromotion'
              free-goods: '#/components/schemas/FreeGoodsPromotion'
              volume-based-tier: '#/components/schemas/VolumeBasedTierPromotion'
          oneOf:
            - $ref: '#/components/schemas/DiscountBasedPromotion'
            - $ref: '#/components/schemas/FixedPricePromotion'
            - $ref: '#/components/schemas/VolumeBasedPromotion'
            - $ref: '#/components/schemas/VolumeBasedTierPromotion'
            - $ref: '#/components/schemas/FreeGoodsPromotion'
    ProductSubscription:
      title: ProductSubscription
      type: object
      externalDocs:
        url: >-
          https://llm-docs.commercengine.io/admin-pos/schemas/ProductSubscription
      required:
        - subscription_plan_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:
        subscription_plan_id:
          description: >-
            Stored subscription plan ID; null for older search entries without
            one.
          type:
            - string
            - 'null'
        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
            - Bimonthly
            - Monthly
            - Quarterly
            - Semiannually
            - Annually
          examples:
            - Monthly
        billing_limit:
          description: '`null` means unlimited billing cycles.'
          type:
            - integer
            - 'null'
        fulfill_separately:
          type: boolean
          default: false
        order_interval:
          description: >-
            order interval defines the frequency of when the subscription sends
            customers the product
          type:
            - integer
            - 'null'
        order_frequency:
          type:
            - string
            - 'null'
          enum:
            - Weekly
            - Bimonthly
            - Monthly
            - Quarterly
            - Semiannually
            - Annually
            - null
          examples:
            - Monthly
        order_limit:
          description: '`null` means unlimited fulfillment cycles.'
          type:
            - integer
            - 'null'
        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: []
    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/admin-pos/schemas/AssociatedOption
      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
    ProductShipping:
      title: ProductShipping
      type:
        - object
        - 'null'
      externalDocs:
        url: https://llm-docs.commercengine.io/admin-pos/schemas/ProductShipping
      required:
        - handling_charges_including_tax
        - handling_charges_excluding_tax
        - tax_type
        - tax_rate
      properties:
        handling_charges_including_tax:
          type: number
        handling_charges_excluding_tax:
          type: number
        tax_type:
          type: string
        tax_rate:
          type: number
    Seo:
      title: Seo
      type: object
      externalDocs:
        url: https://llm-docs.commercengine.io/admin-pos/schemas/Seo
      required:
        - title
        - description
        - keywords
      properties:
        title:
          type:
            - string
            - 'null'
        description:
          type:
            - string
            - 'null'
        keywords:
          type:
            - array
            - 'null'
          items:
            type: string
        slug:
          type: string
    Packaging:
      title: Packaging
      description: >-
        Packing dimensions for the returned product or variant; null when no
        packing dimensions are configured. Marketplace product details use the
        default variant’s dimensions when the product has variants. Individual
        marketplace variants return their own dimensions.
      type:
        - object
        - 'null'
      externalDocs:
        url: https://llm-docs.commercengine.io/admin-pos/schemas/Packaging
      required:
        - pack_width
        - pack_height
        - pack_length
        - pack_dry_weight
        - units_per_pack
        - vertical_rotation
        - shipper_width
        - shipper_height
        - shipper_length
        - shipper_dry_weight
        - units_per_shipper
      properties:
        pack_width:
          type: number
          format: float
        pack_height:
          type: number
          format: float
        pack_length:
          type: number
          format: float
        pack_dry_weight:
          type: number
          format: float
        units_per_pack:
          type: integer
          format: int32
        vertical_rotation:
          description: >-
            Indicates whether items can be rotated during packing or must be
            kept in a strictly vertical orientation.
          type: boolean
        shipper_width:
          type:
            - number
            - 'null'
          format: float
        shipper_height:
          type:
            - number
            - 'null'
          format: float
        shipper_length:
          type:
            - number
            - 'null'
          format: float
        shipper_dry_weight:
          type:
            - number
            - 'null'
          format: float
        units_per_shipper:
          type:
            - integer
            - 'null'
          format: int32
        product_id:
          type:
            - string
            - 'null'
        product_variant_id:
          type:
            - string
            - 'null'
        product_name:
          type:
            - string
            - 'null'
        variant_name:
          type:
            - string
            - 'null'
      x-tags:
        - Catalog
    LotBatchDetail:
      title: LotBatchDetail
      type: object
      externalDocs:
        url: https://llm-docs.commercengine.io/admin-pos/schemas/LotBatchDetail
      required:
        - lot_batch
        - mfg_date
        - exp_date
        - manufacturer
        - stock_quantity
      properties:
        lot_batch:
          description: '`null` groups stock without a lot or batch.'
          type:
            - string
            - 'null'
        mfg_date:
          type:
            - string
            - 'null'
          format: date
        exp_date:
          type:
            - string
            - 'null'
          format: date
        manufacturer:
          type:
            - string
            - 'null'
        stock_quantity:
          type: number
    ColorAttribute:
      title: ColorAttribute
      description: Attribute for colors
      type: object
      readOnly: true
      externalDocs:
        url: https://llm-docs.commercengine.io/admin-pos/schemas/ColorAttribute
      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
          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
          required:
            - name
            - hexcode
    SingleSelectAttribute:
      title: SingleSelectAttribute
      description: Attribute for single-select values
      type: object
      readOnly: true
      externalDocs:
        url: >-
          https://llm-docs.commercengine.io/admin-pos/schemas/SingleSelectAttribute
      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
          const: 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/admin-pos/schemas/MultiSelectAttribute
      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
          const: 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/admin-pos/schemas/TextAttribute
      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
          const: 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/admin-pos/schemas/DateAttribute
      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
          const: date
        value:
          description: >-
            `YYYY-MM-DD`, optionally followed by ` HH:MM`, ` HH:MM:SS`, or `
            HH:MM:SS.ffffff`.
          type: string
    NumberAttribute:
      title: NumberAttribute
      description: Attribute for numeric values
      type: object
      readOnly: true
      externalDocs:
        url: https://llm-docs.commercengine.io/admin-pos/schemas/NumberAttribute
      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
          const: 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/admin-pos/schemas/BooleanAttribute
      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
          const: boolean
        value:
          description: For boolean attributes
          type: boolean
    DiscountBasedPromotion:
      title: DiscountBasedPromotion
      type: object
      externalDocs:
        url: >-
          https://llm-docs.commercengine.io/admin-pos/schemas/DiscountBasedPromotion
      required:
        - promotion_type
        - discount_type
        - minimum_quantity
        - maximum_quantity
      properties:
        promotion_type:
          type: string
          const: discount
        discount_type:
          type: string
          enum:
            - percentage
            - fixed-amount
        discount_percent:
          description: Present only for percentage discounts.
          type: number
        discount_fixed_amount:
          description: Present only for fixed-amount discounts.
          type: integer
        minimum_quantity:
          type: integer
          minimum: 1
        maximum_quantity:
          type:
            - integer
            - 'null'
          minimum: 1
        maximum_discount_amount:
          description: >-
            Percentage discount cap; `null` means no cap. Omitted for
            fixed-amount discounts.
          type:
            - integer
            - 'null'
          minimum: 1
    FixedPricePromotion:
      title: FixedPricePromotion
      type: object
      externalDocs:
        url: >-
          https://llm-docs.commercengine.io/admin-pos/schemas/FixedPricePromotion
      required:
        - promotion_type
        - offer_price
        - minimum_quantity
        - maximum_quantity
      properties:
        promotion_type:
          type: string
          const: fixed-price
        offer_price:
          type: number
        minimum_quantity:
          type: integer
          minimum: 1
        maximum_quantity:
          type:
            - integer
            - 'null'
          minimum: 1
    VolumeBasedPromotion:
      title: VolumeBasedPromotion
      type: object
      externalDocs:
        url: >-
          https://llm-docs.commercengine.io/admin-pos/schemas/VolumeBasedPromotion
      required:
        - promotion_type
        - slabs
      properties:
        promotion_type:
          type: string
          const: volume-based
        slabs:
          type: array
          items:
            type: object
            required:
              - quantity
              - quantity_condition
              - discount_percent
            properties:
              quantity:
                type: integer
              quantity_condition:
                description: >-
                  `less-or-equal` and `less` make the tier "up to" `quantity`;
                  `greater-or-equal` and `greater` make it "from" `quantity`. A
                  line gets the highest "from" tier its quantity reaches; below
                  the first, the "up to" tier that covers it; otherwise the
                  product's price. A promotion has at most one "up to" tier,
                  ending below its first "from" tier, and no two tiers starting
                  from the same quantity.
                enum:
                  - less
                  - less-or-equal
                  - greater
                  - greater-or-equal
              discount_percent:
                type: number
    FreeGoodsPromotion:
      title: FreeGoodsPromotion
      description: Supply `slab` or `slabs` for the free-goods quantities.
      type: object
      externalDocs:
        url: https://llm-docs.commercengine.io/admin-pos/schemas/FreeGoodsPromotion
      required:
        - promotion_type
      properties:
        promotion_type:
          type: string
          const: free-goods
        auto_scale:
          type: boolean
        slab:
          $ref: '#/components/schemas/FreeGoodsSlab'
        slabs:
          type: array
          items:
            $ref: '#/components/schemas/FreeGoodsSlab'
          minItems: 1
    VolumeBasedTierPromotion:
      title: VolumeBasedTierPromotion
      description: >-
        Unit prices by quantity tier: a line pays the `rate` of the tier its
        quantity reaches.
      type: object
      externalDocs:
        url: >-
          https://llm-docs.commercengine.io/admin-pos/schemas/VolumeBasedTierPromotion
      required:
        - promotion_type
        - slabs
      properties:
        promotion_type:
          type: string
          const: volume-based-tier
        slabs:
          type: array
          items:
            type: object
            required:
              - quantity
              - quantity_condition
              - rate
            properties:
              quantity:
                type: integer
              quantity_condition:
                description: >-
                  `less-or-equal` and `less` make the tier "up to" `quantity`;
                  `greater-or-equal` and `greater` make it "from" `quantity`. A
                  line gets the highest "from" tier its quantity reaches; below
                  the first, the "up to" tier that covers it; otherwise the
                  product's price. A promotion has at most one "up to" tier,
                  ending below its first "from" tier, and no two tiers starting
                  from the same quantity.
                enum:
                  - less
                  - less-or-equal
                  - greater
                  - greater-or-equal
              rate:
                description: >-
                  The unit price of a line in this tier. Applies when lower than
                  the product's price.
                type: number
                minimum: 0.01
    ColorOption:
      title: ColorOption
      type: object
      externalDocs:
        url: https://llm-docs.commercengine.io/admin-pos/schemas/ColorOption
      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/admin-pos/schemas/SingleSelectOption
      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
    FreeGoodsSlab:
      title: FreeGoodsSlab
      type: object
      externalDocs:
        url: https://llm-docs.commercengine.io/admin-pos/schemas/FreeGoodsSlab
      required:
        - buy_quantity
        - get_quantity
        - quantity_condition
      properties:
        buy_quantity:
          type: integer
          minimum: 1
        get_quantity:
          type: integer
          minimum: 1
        quantity_condition:
          type: string
          enum:
            - less
            - less-or-equal
            - greater
            - greater-or-equal
  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
              errors:
                type: object
              details:
                type: string
    Unauthorized:
      description: >-
        Authentication failed. Codes include `token-required`, `token-expired`
        and `token_not_valid` for an invalid or expired token.
      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
              details:
                type: string
    Forbidden:
      description: >-
        Access denied. `token-required` requires an authenticated session;
        `permission-denied` means the caller cannot access this resource. On
        POS, `session-expired` requires signing in again.
      content:
        application/json:
          schema:
            type: object
            required:
              - code
              - message
              - success
            properties:
              code:
                type: string
              message:
                type: string
                x-speakeasy-error-message: true
              success:
                type: boolean
              details:
                type: string
    InternalServerError:
      description: The request failed because of an unexpected error.
      content:
        application/json:
          schema:
            type: object
            required:
              - code
              - message
              - success
            properties:
              code:
                type: string
              message:
                type: string
                x-speakeasy-error-message: true
              success:
                type: boolean
              details:
                type: string
    GatewayTimeout:
      description: The request timed out.
      content:
        application/json:
          schema:
            type: object
            required:
              - code
              - message
              - success
            properties:
              code:
                type: string
              message:
                type: string
                x-speakeasy-error-message: true
              success:
                type: boolean
              details:
                type: string
  securitySchemes:
    Authorization:
      type: http
      description: Access token
      scheme: bearer

````

This documentation is built and hosted on [Mintlify](https://mintlify.com), a developer documentation platform.