VTEX · Schema

PickupStoreInfo

CommerceE-CommerceRetailMarketplacePayments

Properties

Name Type Description
isPickupStore boolean
storeId string
friendlyName string
address object
additionalInfo string
dockId string
View JSON Schema on GitHub

JSON Schema

vtex-pickupstoreinfo-schema.json Raw ↑
{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "$id": "#/components/schemas/PickupStoreInfo",
  "title": "PickupStoreInfo",
  "required": [
    "isPickupStore",
    "storeId",
    "friendlyName",
    "address",
    "additionalInfo",
    "dockId"
  ],
  "type": "object",
  "properties": {
    "isPickupStore": {
      "type": "boolean"
    },
    "storeId": {
      "type": "string",
      "nullable": true
    },
    "friendlyName": {
      "type": "string",
      "nullable": true
    },
    "address": {
      "title": "Address",
      "required": [
        "postalCode",
        "country",
        "city",
        "state",
        "neighborhood",
        "street",
        "number",
        "complement",
        "coordinates"
      ],
      "type": "object",
      "properties": {
        "postalCode": {
          "type": "string"
        },
        "country": {
          "title": "Country",
          "required": [
            "acronym",
            "name"
          ],
          "type": "object",
          "properties": {
            "acronym": {
              "type": "string"
            },
            "name": {
              "type": "string"
            }
          },
          "example": {
            "acronym": "BRA",
            "name": "Brazil"
          }
        },
        "city": {
          "type": "string"
        },
        "state": {
          "type": "string"
        },
        "neighborhood": {
          "type": "string"
        },
        "street": {
          "type": "string"
        },
        "number": {
          "type": "string"
        },
        "complement": {
          "type": "string"
        },
        "coordinates": {
          "type": "string",
          "nullable": true
        }
      },
      "example": {
        "postalCode": "22220070",
        "country": {
          "acronym": "BRA",
          "name": "Brazil"
        },
        "city": "Rio de Janeiro",
        "state": "RJ",
        "neighborhood": "Catete",
        "street": "Artur Bernardes Street",
        "number": "100",
        "complement": "",
        "coordinates": null
      }
    },
    "additionalInfo": {
      "type": "string",
      "nullable": true
    },
    "dockId": {
      "type": "string",
      "nullable": true
    }
  },
  "example": {
    "isPickupStore": false,
    "storeId": null,
    "friendlyName": null,
    "address": {
      "postalCode": "22220070",
      "country": {
        "acronym": "BRA",
        "name": "Brazil"
      },
      "city": "Rio de Janeiro",
      "state": "RJ",
      "neighborhood": "Catete",
      "street": "Artur Bernardes Street",
      "number": "100",
      "complement": "",
      "coordinates": null
    },
    "additionalInfo": null,
    "dockId": null
  }
}