VTEX · Schema

SimulateResponse

CommerceE-CommerceRetailMarketplacePayments

Properties

Name	Type	Description
items	array
logisticsInfo	array
paymentData	object
country	string
postalCode	string
messages	array
selectableGiftsResponse	array
totals	array
simulationItems	array

View JSON Schema on GitHub

JSON Schema

{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "$id": "#/components/schemas/SimulateResponse",
  "title": "SimulateResponse",
  "type": "object",
  "properties": {
    "items": {
      "type": "array",
      "items": {
        "$ref": "#/components/schemas/OrderItem"
      },
      "nullable": true
    },
    "logisticsInfo": {
      "type": "array",
      "items": {
        "$ref": "#/components/schemas/LogisticsInfo"
      },
      "nullable": true
    },
    "paymentData": {
      "$ref": "#/components/schemas/PaymentData"
    },
    "country": {
      "type": "string",
      "nullable": true
    },
    "postalCode": {
      "type": "string",
      "nullable": true
    },
    "messages": {
      "type": "array",
      "items": {
        "$ref": "#/components/schemas/SimulateMessageResponse"
      },
      "nullable": true
    },
    "selectableGiftsResponse": {
      "type": "array",
      "items": {
        "$ref": "#/components/schemas/PurchaseContextSelectableGiftsResponse"
      },
      "nullable": true
    },
    "totals": {
      "type": "array",
      "items": {
        "$ref": "#/components/schemas/TotalizationResponse"
      },
      "nullable": true
    },
    "simulationItems": {
      "type": "array",
      "items": {
        "$ref": "#/components/schemas/SimulationItemResult"
      },
      "nullable": true
    }
  },
  "additionalProperties": false
}