VTEX · Schema

CommertialOffer

CommerceE-CommerceRetailMarketplacePayments

Properties

Name Type Description
DeliverySlaSamplesPerRegion object
Installments array
DiscountHighLight array
GiftSkuIds array
Teasers array List with promotions teasers.
PromotionTeasers array List with promotions teasers.
BuyTogether array
Price number
ListPrice number
PriceValidUntil string
AvailableQuantity integer
Tax number
DeliverySlaSamples array
GetInfoErrorMessage string
CacheVersionUsedToCallCheckout string
View JSON Schema on GitHub

JSON Schema

vtex-commertialoffer-schema.json Raw ↑
{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "$id": "#/components/schemas/CommertialOffer",
  "title": "CommertialOffer",
  "required": [
    "DeliverySlaSamplesPerRegion",
    "Installments",
    "DiscountHighLight",
    "GiftSkuIds",
    "Teasers",
    "BuyTogether",
    "Price",
    "ListPrice",
    "PriceValidUntil",
    "AvailableQuantity",
    "Tax",
    "DeliverySlaSamples",
    "GetInfoErrorMessage",
    "CacheVersionUsedToCallCheckout"
  ],
  "type": "object",
  "properties": {
    "DeliverySlaSamplesPerRegion": {
      "type": "object",
      "additionalProperties": {
        "$ref": "#/components/schemas/generatedObject"
      }
    },
    "Installments": {
      "type": "array",
      "items": {
        "$ref": "#/components/schemas/Installment"
      },
      "description": ""
    },
    "DiscountHighLight": {
      "type": "array",
      "items": {
        "type": "string"
      },
      "description": ""
    },
    "GiftSkuIds": {
      "type": "array",
      "items": {
        "type": "string"
      },
      "description": ""
    },
    "Teasers": {
      "type": "array",
      "description": "List with promotions teasers.",
      "example": [
        {
          "<Name>k__BackingField": "TesteInfoAdicional",
          "<GeneralValues>k__BackingField": {
            "Time": "Flamengo",
            "Nome": "Pedro",
            "Camisa": "9"
          },
          "<Conditions>k__BackingField": {
            "<MinimumQuantity>k__BackingField": 0,
            "<Parameters>k__BackingField": [
              {
                "<Name>k__BackingField": "PaymentMethodId",
                "<Value>k__BackingField": "4"
              }
            ]
          },
          "<Effects>k__BackingField": {
            "<Parameters>k__BackingField": [
              {
                "<Name>k__BackingField": "PercentualDiscount",
                "<Value>k__BackingField": "1"
              }
            ]
          }
        }
      ],
      "items": {
        "type": "object",
        "properties": {
          "<Name>k__BackingField": {
            "type": "string",
            "description": "Name."
          },
          "<GeneralValues>k__BackingField": {
            "type": "object",
            "description": "General values. Each property follows the format: `{field}:{value}.",
            "properties": {
              "{field}": {
                "type": "string",
                "example": "{value}"
              }
            }
          },
          "<Conditions>k__BackingField": {
            "type": "object",
            "description": "Conditions.",
            "properties": {
              "<MinimumQuantity>k__BackingField": {
                "type": "integer",
                "description": "Minimum quantity."
              },
              "<Parameters>k__BackingField": {
                "type": "array",
                "description": "Parameters.",
                "items": {
                  "type": "object",
                  "description": "Parameter.",
                  "properties": {
                    "<Name>k__BackingField": {
                      "type": "string",
                      "description": "Name."
                    },
                    "<Value>k__BackingField": {
                      "type": "string",
                      "description": "Value."
                    }
                  }
                }
              }
            }
          },
          "<Effects>k__BackingField": {
            "type": "object",
            "description": "Effects.",
            "properties": {
              "<Parameters>k__BackingField": {
                "type": "array",
                "description": "Parameters.",
                "items": {
                  "type": "object",
                  "description": "Parameter.",
                  "properties": {
                    "<Name>k__BackingField": {
                      "type": "string",
                      "description": "Name."
                    },
                    "<Value>k__BackingField": {
                      "type": "string",
                      "description": "Value."
                    }
                  }
                }
              }
            }
          }
        }
      }
    },
    "PromotionTeasers": {
      "type": "array",
      "description": "List with promotions teasers.",
      "example": [
        {
          "Name": "TesteInfoAdicional",
          "GeneralValues": {
            "Time": "Flamengo",
            "Nome": "Pedro",
            "Camisa": "9"
          },
          "Conditions": {
            "MinimumQuantity": 0,
            "Parameters": [
              {
                "Name": "PaymentMethodId",
                "Value": "4"
              }
            ]
          },
          "Effects": {
            "Parameters": [
              {
                "Name": "PercentualDiscount",
                "Value": "1"
              }
            ]
          }
        }
      ],
      "items": {
        "type": "object",
        "properties": {
          "Name": {
            "type": "string",
            "description": "Name."
          },
          "GeneralValues": {
            "type": "object",
            "description": "General values. Each property follows the format: `{field}:{value}.",
            "properties": {
              "{field}": {
                "type": "string",
                "example": "{value}"
              }
            }
          },
          "Conditions": {
            "type": "object",
            "description": "Conditions.",
            "properties": {
              "MinimumQuantity": {
                "type": "integer",
                "description": "Minimum quantity."
              },
              "Parameters": {
                "type": "array",
                "description": "Parameters.",
                "items": {
                  "type": "object",
                  "description": "Parameter.",
                  "properties": {
                    "Name": {
                      "type": "string",
                      "description": "Name."
                    },
                    "Value": {
                      "type": "string",
                      "description": "Value."
                    }
                  }
                }
              }
            }
          },
          "Effects": {
            "type": "object",
            "description": "Effects.",
            "properties": {
              "Parameters": {
                "type": "array",
                "description": "Parameters.",
                "items": {
                  "type": "object",
                  "description": "Parameter.",
                  "properties": {
                    "Name": {
                      "type": "string",
                      "description": "Name."
                    },
                    "Value": {
                      "type": "string",
                      "description": "Value."
                    }
                  }
                }
              }
            }
          }
        }
      }
    },
    "BuyTogether": {
      "type": "array",
      "items": {
        "type": "string"
      },
      "description": ""
    },
    "Price": {
      "type": "number"
    },
    "ListPrice": {
      "type": "number"
    },
    "PriceValidUntil": {
      "type": "string"
    },
    "AvailableQuantity": {
      "type": "integer",
      "format": "int32"
    },
    "Tax": {
      "type": "number"
    },
    "DeliverySlaSamples": {
      "type": "array",
      "items": {
        "$ref": "#/components/schemas/DeliverySlaSample"
      },
      "description": ""
    },
    "GetInfoErrorMessage": {
      "type": "string",
      "nullable": true
    },
    "CacheVersionUsedToCallCheckout": {
      "type": "string"
    }
  }
}

Work with this as data

Every JSON Schema here is available over the APIs.io API and to AI agents over MCP.

MCP server

One button, every client — Claude, Cursor, VS Code and the rest.

https://apis.io/mcp

Tools for schemas

4 MCP tools reach this
  • find_json_schemasBrowse and filter every JSON Schema in the catalog.
  • apis_io_searchSTART HERE — APIs, providers and tags for one query, each with its total.
  • resolveTurn a domain, URL or GitHub org into the provider it belongs to.
  • find_cohortsEvery scored population of providers in the catalog.
All 92 tools

Call it yourself

curl for this page
This JSON Schema
curl "https://apis.io/api/v1/json-schemas/vtex-commertialoffer"
All schemas
curl "https://apis.io/api/v1/json-schemas?limit=25"

Discovery needs no key. Ratings and market analysis are Pro.

Get an API key

Free tier, no email required.

A second provider on the same verified email joins the account you already have.