VTEX · Schema

OrderProduct

Product information.

CommerceE-CommerceRetailMarketplacePayments

Properties

Name Type Description
productId string Unique identifier of the product.
price number Price of the product.
quantity number Quantity of the product.
View JSON Schema on GitHub

JSON Schema

vtex-orderproduct-schema.json Raw ↑ 
{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "$id": "#/components/schemas/OrderProduct",
  "title": "OrderProduct",
  "type": "object",
  "description": "Product information.",
  "required": [
    "productId",
    "price",
    "quantity"
  ],
  "properties": {
    "productId": {
      "type": "string",
      "description": "Unique identifier of the product.",
      "example": "ABC123"
    },
    "price": {
      "type": "number",
      "description": "Price of the product.",
      "example": 9.99
    },
    "quantity": {
      "type": "number",
      "description": "Quantity of the product.",
      "example": 3
    }
  }
}