Skip to content

ProductPricing

Type: schema

TypeScript Definition

typescript
ProductPricing: {{
            currency: string;
            /**
             * @default GST
             * @example GST
             * @constant
             */
            tax_type: "GST";
            /** Format: double */
            tax_rate: number;
            /**
             * Format: double
             * @example false
             */
            price_including_tax: boolean;
            /** Format: double */
            listing_price: number;
            /** Format: double */
            selling_price: number;
            /** @default 1 */
            min_order_quantity: number;
            max_order_quantity: number | null;
            /** @default 1 */
            incremental_quantity: number;
            /** Format: double */
            selling_price_excluding_tax: number;
        };
        /** ProductPromotion */
}

OpenAPI Schema

json
{
  "title": "ProductPricing",
  "type": "object",
  "externalDocs": {
    "url": "https://llm-docs.commercengine.io/storefront/schemas/ProductPricing",
    "description": "API reference for the ProductPricing schema"
  },
  "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",
      "const": "GST",
      "examples": [
        "GST"
      ]
    },
    "tax_rate": {
      "type": "number",
      "format": "double"
    },
    "price_including_tax": {
      "type": "boolean",
      "format": "double",
      "examples": [
        false
      ]
    },
    "listing_price": {
      "type": "number",
      "format": "double"
    },
    "selling_price": {
      "type": "number",
      "format": "double"
    },
    "min_order_quantity": {
      "type": "integer",
      "default": 1
    },
    "max_order_quantity": {
      "type": [
        "integer",
        "null"
      ]
    },
    "incremental_quantity": {
      "type": "integer",
      "default": 1
    },
    "selling_price_excluding_tax": {
      "type": "number",
      "format": "double"
    }
  },
  "examples": []
}

Auto-generated from OpenAPI spec and TypeScript definitions

Last updated: