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

# Preview Channel List Price

> Compute channel list price from a canonical list price using matching enabled rules (or a forced ruleId). Requires `price_books:read`.



## OpenAPI

````yaml /openapi.json post /api/v1/price-books/preview
openapi: 3.1.0
info:
  title: OmniCommerce API
  version: 1.0.0
  license:
    name: Proprietary
    url: https://omnicommerce.sg/terms
  description: >-
    OmniCommerce API surface for agents and developer integrations. Includes
    public endpoints (merchant discovery, product search, compare, catalog, ACO
    retrieval) and authenticated endpoints (product management via API key
    Bearer tokens).
servers:
  - url: https://omnicommerce.sg
    description: Production
  - url: http://localhost:3000
    description: Local development
security: []
tags:
  - name: agentic-checkout
    description: Merchant-fulfilled agentic checkout
    x-group: Agentic Checkout
  - name: commerce
    description: Root commerce discovery
    x-group: Commerce
  - name: developer-platform
    description: Authenticated developer platform APIs
    x-group: Developer Platform
  - name: looks
    description: AI-styled product looks
    x-group: Looks
  - name: oauth
    description: OAuth token endpoints
    x-group: OAuth
  - name: orders
    description: Workspace and agentic orders
    x-group: Orders
  - name: organizations
    description: Organization management
    x-group: Organizations
  - name: price-books
    description: Marketplace list-price markup rules
    x-group: Price Books
  - name: products
    description: Product CRUD, bulk import, and publish
    x-group: Products
  - name: promotions
    description: Central promotions and marketplace sync
    x-group: Promotions
  - name: public-agent
    description: Public agent discovery and catalog APIs
    x-group: Public Agent
  - name: settlements
    description: settlements
    x-group: Settlements
  - name: ucp
    description: Universal Commerce Protocol
    x-group: UCP
paths:
  /api/v1/price-books/preview:
    post:
      tags:
        - price-books
      summary: Preview Channel List Price
      description: >-
        Compute channel list price from a canonical list price using matching
        enabled rules (or a forced ruleId). Requires `price_books:read`.
      operationId: post_v1_price_books_preview
      requestBody:
        required: true
        content:
          application/json:
            schema:
              type: object
              additionalProperties: false
              required:
                - platform
                - listPrice
              properties:
                organizationId:
                  type: string
                  maxLength: 120
                  description: >-
                    Required for session auth across multiple organizations.
                    Optional for OAuth/API keys bound to one organization.
                platform:
                  type: string
                  enum:
                    - shopee
                    - lazada
                    - tiktok
                    - shopify
                    - whatsapp
                    - zalora
                    - amazon
                listPrice:
                  type: number
                  description: Canonical list price to mark up.
                storeId:
                  type:
                    - string
                    - 'null'
                  maxLength: 200
                country:
                  type:
                    - string
                    - 'null'
                  maxLength: 80
                currency:
                  type:
                    - string
                    - 'null'
                  minLength: 3
                  maxLength: 3
                ruleId:
                  type: string
                  format: uuid
                  description: >-
                    Optional force a specific rule instead of specificity
                    matching.
            example:
              platform: shopee
              listPrice: 100
              country: singapore
              currency: SGD
      responses:
        '200':
          description: Preview computed.
          content:
            application/json:
              schema:
                type: object
                required:
                  - listPrice
                  - channelListPrice
                  - applied
                  - source
                properties:
                  listPrice:
                    type: number
                  channelListPrice:
                    type: number
                  applied:
                    type: boolean
                  source:
                    type: string
                    enum:
                      - price_book
                      - canonical
                  markupPercent:
                    type: number
                  rule:
                    type:
                      - object
                      - 'null'
                  message:
                    type: string
        '400':
          description: Bad Request
        '401':
          description: Unauthorized
        '403':
          description: Forbidden or missing `price_books:read` scope
        '404':
          description: Price book rule not found (when ruleId is set)
        '500':
          description: Internal Server Error
      security:
        - bearerAuth: []
components:
  securitySchemes:
    bearerAuth:
      type: http
      scheme: bearer
      bearerFormat: API Key
      description: >-
        Bearer API key for server-to-server access. Session auth is also
        supported in first-party UI flows.

````