Vtex Getaccount Example is an example object payload from VTEX, with 6 top-level fields. It illustrates the shape of data this provider's APIs accept or return.
Top-level fields
operationIdmethodpathsummaryrequestExamplesresponseExamples
Example Payload
{
"operationId": "GetAccount",
"method": "GET",
"path": "/api/vlm/account",
"summary": "VTex Get information about account",
"requestExamples": [],
"responseExamples": [
{
"status": "200",
"contentType": "application/json",
"example": {
"isActive": true,
"id": "71fe5fdabc4940ad81c226d43b754ba8",
"name": "UNISUPER, SOCIEDAD ANONIMA",
"accountName": "apiexamples",
"lv": null,
"isOperating": false,
"defaultUrl": null,
"district": null,
"country": null,
"complement": null,
"companyName": "UNISUPER, SOCIEDAD ANONIMA",
"cnpj": null,
"haveParentAccount": false,
"parentAccountId": null,
"parentAccountName": null,
"city": null,
"address": null,
"logo": null,
"hasLogo": false,
"number": null,
"postalCode": null,
"state": null,
"telephone": "+219999999",
"tradingName": "UNISUPER, SOCIEDAD ANONIMA",
"licenses": [
{
"expiration": null,
"id": 24,
"isPurchased": false,
"products": [
{
"id": 1,
"domains": [],
"endpoints": {
"webApiUrl": null,
"consoleUrl": null
},
"name": "License Manager"
},
{
"id": 9,
"domains": [],
"endpoints": {
"webApiUrl": null,
"consoleUrl": null
},
"name": "Logistics"
},
{
"id": 14,
"domains": [],
"endpoints": {
"webApiUrl": null,
"consoleUrl": null
},
"name": "Log"
},
{
"id": 23,
"domains": [],
"endpoints": {
"webApiUrl": null,
"consoleUrl": null
},
"name": "Message Center"
},
{
"id": 43,
"domains": [],
"endpoints": {
"webApiUrl": null,
"consoleUrl": null
},
"name": "Billing"
},
{
"id": 55,
"domains": [],
"endpoints": {
"webApiUrl": null,
"consoleUrl": null
},
"name": "Audit"
},
{
"id": 64,
"domains": [],
"endpoints": {
"webApiUrl": null,
"consoleUrl": null
},
"name": "Vtex ID"
},
{
"id": 66,
"domains": [],
"endpoints": {
"webApiUrl": null,
"consoleUrl": null
},
"name": "VTEX IO"
},
{
"id": 73,
"domains": [],
"endpoints": {
"webApiUrl": null,
"consoleUrl": null
},
"name": "Seller Register"
},
{
"id": 75,
"domains": [],
"endpoints": {
"webApiUrl": null,
"consoleUrl": null
},
"name": "Time Series"
},
{
"id": 91,
"domains": [],
"endpoints": {
"webApiUrl": null,
"consoleUrl": null
},
"name": "Releases"
}
],
"name": "Carrier"
},
{
"expiration": null,
"id": 10,
"isPurchased": false,
"products": [
{
"id": 1,
"domains": [],
"endpoints": {
"webApiUrl": null,
"consoleUrl": null
},
"name": "License Manager"
},
{
"id": 3,
"domains": [],
"endpoints": {
"webApiUrl": null,
"consoleUrl": null
},
"name": "Master Data"
},
{
"id": 14,
"domains": [],
"endpoints": {
"webApiUrl": null,
"consoleUrl": null
},
"name": "Log"
},
{
"id": 17,
"domains": [],
"endpoints": {
"webApiUrl": null,
"consoleUrl": null
},
"name": "VTEX DWT"
},
{
"id": 18,
"domains": [],
"endpoints": {
"webApiUrl": null,
"consoleUrl": null
},
"name": "Unikey"
},
{
"id": 23,
"domains": [],
"endpoints": {
"webApiUrl": null,
"consoleUrl": null
},
"name": "Message Center"
},
{
"id": 25,
"domains": [],
"endpoints": {
"webApiUrl": null,
"consoleUrl": null
},
"name": "Dynamic Storage"
},
{
"id": 30,
"domains": [],
"endpoints": {
"webApiUrl": null,
"consoleUrl": null
},
"name": "Key Store"
},
{
"id": 48,
"domains": [],
"endpoints": {
"webApiUrl": null,
"consoleUrl": null
},
"name": "VTEX Bridge"
},
{
"id": 51,
"domains": [],
"endpoints": {
"webApiUrl": null,
"consoleUrl": null
},
"name": "Vtex My Account"
},
{
"id": 55,
"domains": [],
"endpoints": {
"webApiUrl": null,
"consoleUrl": null
},
"name": "Audit"
},
{
"id": 64,
"domains": [],
"endpoints": {
"webApiUrl": null,
"consoleUrl": null
},
"name": "Vtex ID"
},
{
"id": 67,
"domains": [],
"endpoints": {
"webApiUrl": null,
"consoleUrl": null
},
"name": "VTable"
},
{
"id": 68,
"domains": [],
"endpoints": {
"webApiUrl": null,
"consoleUrl": null
},
"name": "Zendesk"
},
{
"id": 73,
"domains": [],
"endpoints": {
"webApiUrl": null,
"consoleUrl": null
},
"name": "Seller Register"
},
{
"id": 75,
"domains": [],
"endpoints": {
"webApiUrl": null,
"consoleUrl": null
},
"name": "Time Series"
},
{
"id": 91,
"domains": [],
"endpoints": {
"webApiUrl": null,
"consoleUrl": null
},
"name": "Releases"
}
],
"name": "CRM"
},
{
"expiration": null,
"id": 8,
"isPurchased": false,
"products": [
{
"id": 1,
"domains": [],
"endpoints": {
"webApiUrl": null,
"consoleUrl": null
},
"name": "License Manager"
},
{
"id": 2,
"domains": [],
"endpoints": {
"webApiUrl": null,
"consoleUrl": null
},
"name": "Catalog"
},
{
"id": 3,
"domains": [],
"endpoints": {
"webApiUrl": null,
"consoleUrl": null
},
"name": "Master Data"
},
{
"id": 4,
"domains": [],
"endpoints": {
"webApiUrl": null,
"consoleUrl": null
},
"name": "Request Capture"
},
{
"id": 5,
"domains": [],
"endpoints": {
"webApiUrl": null,
"consoleUrl": null
},
"name": "Checkout"
},
{
"id": 6,
"domains": [],
"endpoints": {
"webApiUrl": null,
"consoleUrl": null
},
"name": "PCI Gateway"
},
{
"id": 9,
"domains": [],
"endpoints": {
"webApiUrl": null,
"consoleUrl": null
},
"name": "Logistics"
},
{
"id": 13,
"domains": [],
"endpoints": {
"webApiUrl": null,
"consoleUrl": null
},
"name": "Channels"
},
{
"id": 14,
"domains": [],
"endpoints": {
"webApiUrl": null,
"consoleUrl": null
},
"name": "Log"
},
{
"id": 16,
"domains": [],
"endpoints": {
"webApiUrl": null,
"consoleUrl": null
},
"name": "Rates and Benefits"
},
{
"id": 17,
"domains": [],
"endpoints": {
"webApiUrl": null,
"consoleUrl": null
},
"name": "VTEX DWT"
},
{
"id": 18,
"domains": [],
"endpoints": {
"webApiUrl": null,
"consoleUrl": null
},
"name": "Unikey"
},
{
"id": 19,
"domains": [],
"endpoints": {
"webApiUrl": null,
"consoleUrl": null
},
"name": "OMS"
},
{
"id": 20,
"domains": [],
"endpoints": {
"webApiUrl": null,
"consoleUrl": null
},
"name": "Conversation Tracker"
},
{
"id": 23,
"domains": [],
"endpoints": {
"webApiUrl": null,
"consoleUrl": null
},
"name": "Message Center"
},
{
"id": 25,
"domains": [],
"endpoints": {
"webApiUrl": null,
"consoleUrl": null
},
"name": "Dynamic Storage"
},
{
"id": 27,
"domains": [],
"endpoints": {
"webApiUrl": null,
"consoleUrl": null
},
"name": "Portal"
},
{
"id": 38,
"domains": [],
"endpoints": {
"webApiUrl": null,
"consoleUrl": null
},
"name": "CMS"
},
{
"id": 43,
"domains": [],
"endpoints": {
"webApiUrl": null,
"consoleUrl": null
},
"name": "Billing"
},
{
"id": 48,
"domains": [],
"endpoints": {
"webApiUrl": null,
"consoleUrl": null
},
"name": "VTEX Bridge"
},
{
"id": 50,
"domains": [],
"endpoints": {
"webApiUrl": null,
"consoleUrl": null
},
"name": "Suggestion"
},
{
"id": 51,
"domains": [],
"endpoints": {
"webApiUrl": null,
"consoleUrl": null
},
"name": "Vtex My Account"
},
{
"id": 53,
"domains": [],
"endpoints": {
"webApiUrl": null,
"consoleUrl": null
},
"name": "Network"
},
{
"id": 55,
"domains": [],
"endpoints": {
"webApiUrl": null,
"consoleUrl": null
},
"name": "Audit"
},
{
"id": 57,
"domains": [],
"endpoints": {
"webApiUrl": null,
"consoleUrl": null
},
"name": "Insights"
},
{
"id": 58,
"domains": [],
"endpoints": {
"webApiUrl": null,
"consoleUrl": null
},
"name": "Credit Control"
},
{
"id": 61,
"domains": [],
"endpoints": {
"webApiUrl": null,
"consoleUrl": null
},
"name": "WebService"
},
{
"id": 64,
"domains": [],
"endpoints": {
"webApiUrl": null,
"consoleUrl": null
},
"name": "Vtex ID"
},
{
"id": 65,
"domains": [],
"endpoints": {
"webApiUrl": null,
"consoleUrl": null
},
"name": "Pricing"
},
{
"id": 66,
"domains": [],
"endpoints": {
"webApiUrl": null,
"consoleUrl": null
},
"name": "VTEX IO"
},
{
"id": 67,
"domains": [],
"endpoints": {
"webApiUrl": null,
"consoleUrl": null
},
"name": "VTable"
},
{
"id": 69,
"domains": [],
"endpoints": {
"webApiUrl": null,
"consoleUrl": null
},
"name": "Conditions Evaluator"
},
{
"id": 70,
"domains": [],
"endpoints": {
"webApiUrl": null,
"consoleUrl": null
},
"name": "GiftCard"
},
{
"id": 73,
"domains": [],
"endpoints": {
"webApiUrl": null,
"consoleUrl": null
},
"name": "Seller Register"
},
{
"id": 74,
"domains": [],
"endpoints": {
"webApiUrl": null,
"consoleUrl": null
},
"name": "Order Authorization"
},
{
"id": 75,
"domains": [],
"endpoints": {
"webApiUrl": null,
"consoleUrl": null
},
"name": "Time Series"
},
{
"id": 76,
"domains": [],
"endpoints": {
"webApiUrl": null,
"consoleUrl": null
},
"name": "Search"
},
{
"id": 81,
"domains": [],
"endpoints": {
"webApiUrl": null,
"consoleUrl": null
},
"name": "Application Logs Stream"
},
{
"id": 83,
"domains": [],
"endpoints": {
"webApiUrl": null,
"consoleUrl": null
},
"name": "Subscriptions"
},
{
"id": 84,
"domains": [],
"endpoints": {
"webApiUrl": null,
"consoleUrl": null
},
"name": "CDN Service"
},
{
"id": 85,
"domains": [],
"endpoints": {
"webApiUrl": null,
"consoleUrl": null
},
"name": "Dandelion"
},
{
"id": 88,
"domains": [],
"endpoints": {
"webApiUrl": null,
"consoleUrl": null
},
"name": "Tenant Switcher"
},
{
"id": 89,
"domains": [],
"endpoints": {
"webApiUrl": null,
"consoleUrl": null
},
"name": "Promotions Policy Engine"
},
{
"id": 91,
"domains": [],
"endpoints": {
"webApiUrl": null,
"consoleUrl": null
},
"name": "Releases"
}
],
"name": "E-Commerce Professional"
},
{
"expiration": null,
"id": 6,
"isPurchased": false,
"products": [
{
"id": 1,
"domains": [],
"endpoints": {
"webApiUrl": null,
"consoleUrl": null
},
"name": "License Manager"
},
{
"id": 2,
"domains": [],
"endpoints": {
"webApiUrl": null,
"consoleUrl": null
},
"name": "Catalog"
},
{
"id": 3,
"domains": [],
"endpoints": {
"webApiUrl": null,
"consoleUrl": null
},
"name": "Master Data"
},
{
"id": 4,
"domains": [],
"endpoints": {
"webApiUrl": null,
"consoleUrl": null
},
"name": "Request Capture"
},
{
"id": 5,
"domains": [],
"endpoints": {
"webApiUrl": null,
"consoleUrl": null
},
"name": "Checkout"
},
{
"id": 6,
"domains": [],
"endpoints": {
"webApiUrl": null,
"consoleUrl": null
},
"name": "PCI Gateway"
},
{
"id": 7,
"domains": [],
"endpoints": {
"webApiUrl": null,
"consoleUrl": null
},
"name": "Buscap\u00e9 Connect"
},
{
"id": 9,
"domains": [],
"endpoints": {
"webApiUrl": null,
"consoleUrl": null
},
"name": "Logistics"
},
{
"id": 13,
"domains": [],
"endpoints": {
"webApiUrl": null,
"consoleUrl": null
},
"name": "Channels"
},
{
"id": 14,
"domains": [],
"endpoints": {
"webApiUrl": null,
"consoleUrl": null
},
"name": "Log"
},
{
"id": 16,
"domains": [],
"endpoints": {
"webApiUrl": null,
"consoleUrl": null
},
"name": "Rates and Benefits"
},
{
"id": 17,
"domains": [],
"endpoints": {
"webApiUrl": null,
"consoleUrl": null
},
"name": "VTEX DWT"
},
{
"id": 18,
"domains": [],
"endpoints": {
"webApiUrl": null,
"consoleUrl": null
},
"name": "Unikey"
},
{
"id": 19,
"domains": [],
"endpoints": {
"webApiUrl": null,
"consoleUrl": null
},
"name": "OMS"
},
{
"id": 20,
"domains": [],
"endpoints": {
"webApiUrl": null,
"consoleUrl": null
},
"name": "Conversation Tracker"
},
{
"id": 23,
"domains": [],
"endpoints": {
"webApiUrl": null,
"consoleUrl": null
},
"name": "Message Center"
},
{
"id": 25,
"domains": [],
"endpoints": {
"webApiUrl": null,
"consoleUrl": null
},
"name": "Dynamic Storage"
},
{
"id": 27,
"domains": [],
"endpoints": {
"webApiUrl": null,
"consoleUrl": null
},
"name": "Portal"
},
{
"id": 38,
"domains": [],
"endpoints": {
"webApiUrl": null,
"consoleUrl": null
},
"name": "CMS"
},
{
"id": 43,
"domains": [],
"endpoints": {
"webApiUrl": null,
"consoleUrl": null
},
"name": "Billing"
},
{
"id": 48,
"domains": [],
"endpoints": {
"webApiUrl": null,
"consoleUrl": null
},
"name": "VTEX Bridge"
},
{
"id": 50,
"domains": [],
"endpoints": {
"webApiUrl": null,
"consoleUrl": null
},
"name": "Suggestion"
},
{
"id": 51,
"domains": [],
"endpoints": {
"webApiUrl": null,
"consoleUrl": null
},
"name": "Vtex My Account"
},
{
"id": 53,
"domains": [],
"endpoints": {
"webApiUrl": null,
"consoleUrl": null
},
"name": "Network"
},
{
"id": 55,
"domains": [],
"endpoints": {
"webApiUrl": null,
"consoleUrl": null
},
"name": "Audit"
},
{
"id": 57,
"domains": [],
"endpoints": {
"webApiUrl": null,
"consoleUrl": null
},
"name": "Insights"
},
{
"id": 58,
"domains": [],
"endpoints": {
"webApiUrl": null,
"consoleUrl": null
},
"name": "Credit Control"
},
{
"id": 61,
"domains": [],
"endpoints": {
"webApiUrl": null,
"consoleUrl": null
},
"name": "WebService"
},
{
"id": 64,
"domains": [],
"endpoints": {
"webApiUrl": null,
"consoleUrl": null
},
"name": "Vtex ID"
},
{
"id": 65,
"domains": [],
"endpoints": {
"webApiUrl": null,
"consoleUrl": null
},
"name": "Pricing"
},
{
"id": 66,
"domains": [],
"endpoints": {
"webApiUrl": null,
"consoleUrl": null
},
"name": "VTEX IO"
},
{
"id": 67,
"domains": [],
"endpoints": {
"webApiUrl": null,
"consoleUrl": null
},
"name": "VTable"
},
{
"id": 68,
"domains": [],
"endpoints": {
"webApiUrl": null,
"consoleUrl": null
},
"name": "Zendesk"
},
{
"id": 69,
"domains": [],
"endpoints": {
"webApiUrl": null,
"consoleUrl": null
},
"name": "Conditions Evaluator"
},
{
"id": 70,
"domains": [],
"endpoints": {
"webApiUrl": null,
"consoleUrl": null
},
"name": "GiftCard"
},
{
"id": 73,
"domains": [],
"endpoints": {
"webApiUrl": null,
"consoleUrl": null
},
"name": "Seller Register"
},
{
"id": 74,
"domains": [],
"endpoints": {
"webApiUrl": null,
"consoleUrl": null
},
"name": "Order Authorization"
},
{
"id": 75,
"domains": [],
"endpoints": {
"webApiUrl": null,
"consoleUrl": null
},
"name": "Time Series"
},
{
"id": 76,
"domains": [],
"endpoints": {
"webApiUrl": null,
"consoleUrl": null
},
"name": "Search"
},
{
"id": 81,
"domains": [],
"endpoints": {
"webApiUrl": null,
"consoleUrl": null
},
"name": "Application Logs Stream"
},
{
"id": 83,
"domains": [],
"endpoints": {
"webApiUrl": null,
"consoleUrl": null
},
"name": "Subscriptions"
},
{
"id": 84,
"domains": [],
"endpoints": {
"webApiUrl": null,
"consoleUrl": null
},
"name": "CDN Service"
},
{
"id": 85,
"domains": [],
"endpoints": {
"webApiUrl": null,
"consoleUrl": null
},
"name": "Dandelion"
},
{
"id": 88,
"domains": [],
"endpoints": {
"webApiUrl": null,
"consoleUrl": null
},
"name": "Tenant Switcher"
},
{
"id": 89,
"domains": [],
"endpoints": {
"webApiUrl": null,
"consoleUrl": null
},
"name": "Promotions Policy Engine"
},
{
"id": 91,
"domains": [],
"endpoints": {
"webApiUrl": null,
"consoleUrl": null
},
"name": "Releases"
}
],
"name": "E-Commerce Starter"
},
{
"expiration": null,
"id": 7,
"isPurchased": true,
"products": [
{
"id": 1,
"domains": [],
"endpoints": {
"webApiUrl": null,
"consoleUrl": null
},
"name": "License Manager"
},
{
"id": 2,
"domains": [],
"endpoints": {
"webApiUrl": null,
"consoleUrl": null
},
"name": "Catalog"
},
{
"id": 3,
"domains": [],
"endpoints": {
"webApiUrl": null,
"consoleUrl": null
},
"name": "Master Data"
},
{
"id": 4,
"domains": [],
"endpoints": {
"webApiUrl": null,
"consoleUrl": null
},
"name": "Request Capture"
},
{
"id": 5,
"domains": [],
"endpoints": {
"webApiUrl": null,
"consoleUrl":
# --- truncated at 32 KB (99 KB total) ---
# Full source: https://raw.githubusercontent.com/api-evangelist/vtex/refs/heads/main/examples/vtex-getaccount-example.json