VTEX · Schema

Location1

CommerceE-CommerceRetailMarketplacePayments

Properties

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

JSON Schema

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