VTEX · Schema

OrderFormSimulationRequest

CommerceE-CommerceRetailMarketplacePayments

Properties

Name Type Description
items array Array containing information about the SKUs inside the cart to be simulated.
country string
View JSON Schema on GitHub

JSON Schema

vtex-orderformsimulationrequest-schema.json Raw ↑ 
{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "$id": "#/components/schemas/OrderFormSimulationRequest",
  "title": "OrderFormSimulationRequest",
  "required": [
    "items",
    "country"
  ],
  "type": "object",
  "properties": {
    "items": {
      "type": "array",
      "items": {
        "$ref": "#/components/schemas/Item"
      },
      "description": "Array containing information about the SKUs inside the cart to be simulated."
    },
    "country": {
      "type": "string"
    }
  },
  "example": {
    "items": [
      {
        "id": "{{skuId}}",
        "quantity": 1,
        "seller": "1"
      }
    ],
    "country": "{{countryCode-ISO-3-digits}}"
  }
}