VTEX · Schema

Account

Account information.

CommerceE-CommerceRetailMarketplacePayments

Properties

Name	Type	Description
name	string	Inserted name.
accountName	string	Name of the VTEX Account dispatching the package.
isOperating	boolean	Whether the store is operating or not.
defaultUrl	string	Retrieved from VTEX's License Manager.
district	string	District where the VTEX store dispatching the package is located.
country	string	Country where the VTEX store, dispatching the package, is located.
complement	string	Complement for the VTEX store's address.
companyName	string	Name of the VTEX store responsible for the package.
cnpj	string	CNPJ code of the VTEX store responsible for the package.
city	string	City where the VTEX store responsible for the package is located.
address	string	Address where the VTEX store responsible for the package is located.
number	string	Number of the address related to the `address` field.
postalCode	string	ZIP code of the VTEX store responsible for the package.
state	string	State of the address belonging to the VTEX store responsible for the package.
telephone	string	Telephone number of the VTEX store responsible for the package.
tradingName	string	Trading name of the VTEX store responsible for the package.

View JSON Schema on GitHub

JSON Schema

{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "$id": "#/components/schemas/Account",
  "title": "Account",
  "required": [
    "name",
    "accountName",
    "isOperating",
    "defaultUrl",
    "district",
    "country",
    "complement",
    "companyName",
    "cnpj",
    "city",
    "address",
    "number",
    "postalCode",
    "state",
    "telephone",
    "tradingName"
  ],
  "type": "object",
  "properties": {
    "name": {
      "type": "string",
      "description": "Inserted name.",
      "example": "Ltda"
    },
    "accountName": {
      "type": "string",
      "description": "Name of the VTEX Account dispatching the package.",
      "example": "mystore"
    },
    "isOperating": {
      "type": "boolean",
      "description": "Whether the store is operating or not.",
      "example": true
    },
    "defaultUrl": {
      "type": "string",
      "nullable": true,
      "description": "Retrieved from VTEX's License Manager.",
      "example": "https://url.example.com"
    },
    "district": {
      "type": "string",
      "nullable": true,
      "description": "District where the VTEX store dispatching the package is located.",
      "example": "District name"
    },
    "country": {
      "type": "string",
      "description": "Country where the VTEX store, dispatching the package, is located.",
      "example": "Brasil"
    },
    "complement": {
      "type": "string",
      "nullable": true,
      "description": "Complement for the VTEX store's address.",
      "example": "Second floor"
    },
    "companyName": {
      "type": "string",
      "description": "Name of the VTEX store responsible for the package.",
      "example": "VTEX Store 1"
    },
    "cnpj": {
      "type": "string",
      "description": "CNPJ code of the VTEX store responsible for the package.",
      "example": "00000000000000"
    },
    "city": {
      "type": "string",
      "nullable": true,
      "description": "City where the VTEX store responsible for the package is located.",
      "example": "Rio de Janeiro"
    },
    "address": {
      "type": "string",
      "nullable": true,
      "description": "Address where the VTEX store responsible for the package is located.",
      "example": "VTEX Street"
    },
    "number": {
      "type": "string",
      "nullable": true,
      "description": "Number of the address related to the `address` field.",
      "example": "26"
    },
    "postalCode": {
      "type": "string",
      "nullable": true,
      "description": "ZIP code of the VTEX store responsible for the package.",
      "example": "12345-678"
    },
    "state": {
      "type": "string",
      "nullable": true,
      "description": "State of the address belonging to the VTEX store responsible for the package.",
      "example": "RJ"
    },
    "telephone": {
      "type": "string",
      "nullable": true,
      "description": "Telephone number of the VTEX store responsible for the package.",
      "example": "99999999"
    },
    "tradingName": {
      "type": "string",
      "description": "Trading name of the VTEX store responsible for the package.",
      "example": "Trading name"
    }
  },
  "description": "Account information.",
  "example": {
    "name": "Ltda",
    "accountName": "{{account}}",
    "isOperating": true,
    "defaultUrl": null,
    "district": null,
    "country": "Brasil",
    "complement": null,
    "companyName": "LTDA",
    "cnpj": "00000000000000",
    "city": null,
    "address": null,
    "number": null,
    "postalCode": null,
    "state": null,
    "telephone": null,
    "tradingName": "tradingName"
  }
}