VTEX · Schema

Location

CommerceE-CommerceRetailMarketplacePayments

Properties

Name Type Description
zipCode string
country string
inStore object
View JSON Schema on GitHub

JSON Schema

vtex-location-schema.json Raw ↑ 
{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "$id": "#/components/schemas/Location",
  "title": "Location",
  "required": [
    "zipCode",
    "country",
    "inStore"
  ],
  "type": "object",
  "properties": {
    "zipCode": {
      "type": "string"
    },
    "country": {
      "type": "string"
    },
    "inStore": {
      "title": "InStore",
      "required": [
        "IsCheckedIn",
        "StoreId"
      ],
      "type": "object",
      "properties": {
        "IsCheckedIn": {
          "type": "boolean"
        },
        "StoreId": {
          "type": "string",
          "nullable": true
        }
      },
      "example": {
        "IsCheckedIn": false,
        "StoreId": null
      }
    }
  },
  "example": {
    "zipCode": "22220070",
    "country": "BRA",
    "inStore": {
      "IsCheckedIn": false,
      "StoreId": null
    }
  }
}