VTEX · Schema

Getprice

Price request body information.

CommerceE-CommerceRetailMarketplacePayments

Properties

Name Type Description
itemId string SKU ID.
listPrice integer Suggested retail price for the SKU.
costPrice integer SKU's cost price.
markup integer Desired profit margin with the SKU's sale.
basePrice integer SKU's reference price.
fixedPrices array The fixed price is a price that overlaps all other existing price configurations of a price table.
View JSON Schema on GitHub

JSON Schema

vtex-getprice-schema.json Raw ↑ 
{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "$id": "#/components/schemas/Getprice",
  "title": "Getprice",
  "required": [
    "itemId",
    "listPrice",
    "costPrice",
    "markup",
    "basePrice",
    "fixedPrices"
  ],
  "type": "object",
  "description": "Price request body information.",
  "properties": {
    "itemId": {
      "type": "string",
      "description": "SKU ID."
    },
    "listPrice": {
      "type": "integer",
      "format": "int32",
      "description": "Suggested retail price for the SKU."
    },
    "costPrice": {
      "type": "integer",
      "format": "int32",
      "description": "SKU's cost price."
    },
    "markup": {
      "type": "integer",
      "format": "int32",
      "description": "Desired profit margin with the SKU's sale."
    },
    "basePrice": {
      "type": "integer",
      "format": "int32",
      "description": "SKU's reference price."
    },
    "fixedPrices": {
      "type": "array",
      "items": {
        "$ref": "#/components/schemas/FixedPrice"
      },
      "description": "The fixed price is a price that overlaps all other existing price configurations of a price table."
    }
  }
}