VTEX · Schema

Getcomputedprice

Computed price request body information.

CommerceE-CommerceRetailMarketplacePayments

Properties

Name Type Description
tradePolicyId string Trade Policy ID ou `priceTableId`.
listPrice integer Trade Policy List Price, also known as "from" price.
costPrice number Cost price.
sellingPrice number Computed Price before applying coupons, promotions and taxes. This price may change before reaching the shelf.
priceValidUntil string Date until when the computed price will be valid, due to price scheduling. If no price scheduling applies, this will be set a year from the current time.
View JSON Schema on GitHub

JSON Schema

vtex-getcomputedprice-schema.json Raw ↑ 
{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "$id": "#/components/schemas/Getcomputedprice",
  "title": "Getcomputedprice",
  "required": [
    "tradePolicyId",
    "listPrice",
    "sellingPrice",
    "priceValidUntil"
  ],
  "type": "object",
  "description": "Computed price request body information.",
  "properties": {
    "tradePolicyId": {
      "type": "string",
      "description": "Trade Policy ID ou `priceTableId`."
    },
    "listPrice": {
      "type": "integer",
      "format": "int32",
      "description": "Trade Policy List Price, also known as \"from\" price."
    },
    "costPrice": {
      "type": "number",
      "description": "Cost price."
    },
    "sellingPrice": {
      "type": "number",
      "description": "Computed Price before applying coupons, promotions and taxes. This price may change before reaching the shelf."
    },
    "priceValidUntil": {
      "type": "string",
      "description": "Date until when the computed price will be valid, due to price scheduling. If no price scheduling applies, this will be set a year from the current time."
    }
  }
}