VTEX · Schema

AccountResponse

Successful response for `/api/vlm/account`.

CommerceE-CommerceRetailMarketplacePayments

Properties

Name	Type	Description
isActive	boolean	Defines if the account is active (`true`) or not (`false`).
id	string	ID of the account.
name	string	Trading name.
accountName	string	Account name.
lv	string	Level.
isOperating	boolean	Defines if the account is in production (`true`) or not (`false`).
defaultUrl	string	Default URL.
district	string	Neighborhood of the person assigned as main contact of the store.
country	string	Country of the person assigned as main contact of the store.
complement	string	Additional address of the person assigned as main contact of the store.
companyName	string	Company name.
cnpj	string	CNPJ (Corporate Tax ID) of account.
haveParentAccount	boolean	Defines if the account has a parent account (`true`) or not (`false`).
parentAccountId	string	ID of the parent account.
parentAccountName	string	Name of the parent account.
city	string	City of the person assigned as main contact of the store.
address	string	Address of the person assigned as main contact of the store.
logo	string	Filename of the account's logotype.
hasLogo	boolean	Defines if the store's logotype has been uploaded (`true`) or not (`false`).
number	string	Number of the address of the person assigned as main contact of the store.
postalCode	string	Zip code of the person assigned as main contact of the store.
state	string	State or province of the person assigned as main contact of the store.
telephone	string	Telephone number of the person assigned as main contact of the store.
tradingName	string	Trading name.
licenses	array	Licenses of the account.
sponsor	object	Object with information about the sponsor user.
contact	object	Information about the person assigned as main contact of the store.
operationDate	string	Date when the account went into production.
inactivationDate	string	Date when the account was deactivated.
creationDate	string	Date when the account was created.
hosts	array	Hosts of all stores.
sites	array	Array of objects representing each store.
appKey	object	Deprecated. Check the `appKeys` object for all appKeys.
appKeys	array	Array of application keys.

View JSON Schema on GitHub

JSON Schema

{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "$id": "#/components/schemas/AccountResponse",
  "title": "AccountResponse",
  "description": "Successful response for `/api/vlm/account`.",
  "type": "object",
  "properties": {
    "isActive": {
      "description": "Defines if the account is active (`true`) or not (`false`).",
      "type": "boolean"
    },
    "id": {
      "description": "ID of the account.",
      "type": "string"
    },
    "name": {
      "description": "Trading name.",
      "type": "string"
    },
    "accountName": {
      "description": "Account name.",
      "type": "string"
    },
    "lv": {
      "type": "string",
      "description": "Level.",
      "nullable": true,
      "deprecated": true
    },
    "isOperating": {
      "description": "Defines if the account is in production (`true`) or not (`false`).",
      "type": "boolean"
    },
    "defaultUrl": {
      "deprecated": true,
      "description": "Default URL.",
      "type": "string",
      "nullable": true
    },
    "district": {
      "description": "Neighborhood of the person assigned as main contact of the store.",
      "type": "string",
      "nullable": true
    },
    "country": {
      "description": "Country of the person assigned as main contact of the store.",
      "type": "string",
      "nullable": true
    },
    "complement": {
      "description": "Additional address of the person assigned as main contact of the store.",
      "type": "string",
      "nullable": true
    },
    "companyName": {
      "description": "Company name.",
      "type": "string"
    },
    "cnpj": {
      "description": "CNPJ (Corporate Tax ID) of account.",
      "type": "string",
      "nullable": true
    },
    "haveParentAccount": {
      "description": "Defines if the account has a parent account (`true`) or not (`false`).",
      "type": "boolean"
    },
    "parentAccountId": {
      "description": "ID of the parent account.",
      "type": "string",
      "nullable": true
    },
    "parentAccountName": {
      "description": "Name of the parent account.",
      "type": "string",
      "nullable": true
    },
    "city": {
      "description": "City of the person assigned as main contact of the store.",
      "type": "string",
      "nullable": true
    },
    "address": {
      "description": "Address of the person assigned as main contact of the store.",
      "type": "string",
      "nullable": true
    },
    "logo": {
      "description": "Filename of the account's logotype.",
      "type": "string",
      "nullable": true
    },
    "hasLogo": {
      "description": "Defines if the store's logotype has been uploaded (`true`) or not (`false`).",
      "type": "boolean"
    },
    "number": {
      "description": "Number of the address of the person assigned as main contact of the store.",
      "type": "string",
      "nullable": true
    },
    "postalCode": {
      "description": "Zip code of the person assigned as main contact of the store.",
      "type": "string",
      "nullable": true
    },
    "state": {
      "description": "State or province of the person assigned as main contact of the store.",
      "type": "string",
      "nullable": true
    },
    "telephone": {
      "description": "Telephone number of the person assigned as main contact of the store.",
      "type": "string"
    },
    "tradingName": {
      "description": "Trading name.",
      "type": "string"
    },
    "licenses": {
      "description": "Licenses of the account.",
      "type": "array",
      "items": {
        "$ref": "#/components/schemas/LicenseItems"
      }
    },
    "sponsor": {
      "description": "Object with information about the sponsor user.",
      "type": "object",
      "properties": {
        "name": {
          "description": "Name of the sponsor user.",
          "type": "string"
        },
        "email": {
          "description": "Email of the sponsor user.",
          "type": "string"
        },
        "phone": {
          "description": "Phone of the sponsor user.",
          "type": "string"
        }
      }
    },
    "contact": {
      "type": "object",
      "description": "Information about the person assigned as main contact of the store.",
      "properties": {
        "name": {
          "description": "Name of the person assigned as main contact of the store.",
          "type": "string"
        },
        "email": {
          "description": "Email of the person assigned as main contact of the store.",
          "type": "string"
        },
        "phone": {
          "description": "Telephone number of the person assigned as main contact of the store.",
          "type": "string"
        }
      }
    },
    "operationDate": {
      "description": "Date when the account went into production.",
      "type": "string",
      "nullable": true,
      "format": "date-time"
    },
    "inactivationDate": {
      "description": "Date when the account was deactivated.",
      "type": "string",
      "nullable": true,
      "format": "date-time"
    },
    "creationDate": {
      "description": "Date when the account was created.",
      "type": "string",
      "format": "date-time"
    },
    "hosts": {
      "description": "Hosts of all stores.",
      "type": "array",
      "items": {
        "type": "string",
        "description": "Host address."
      }
    },
    "sites": {
      "description": "Array of objects representing each store.",
      "type": "array",
      "items": {
        "$ref": "#/components/schemas/SiteItems"
      }
    },
    "appKey": {
      "description": "Deprecated. Check the `appKeys` object for all appKeys.",
      "type": "object",
      "properties": {
        "token": {
          "type": "string",
          "description": "Token.",
          "nullable": true,
          "deprecated": true
        },
        "name": {
          "type": "string",
          "description": "Token name.",
          "nullable": true,
          "deprecated": true
        }
      },
      "deprecated": true
    },
    "appKeys": {
      "description": "Array of application keys.",
      "type": "array",
      "items": {
        "$ref": "#/components/schemas/AppKeyItems"
      }
    }
  }
}