How AI is applied across API Evangelist and APIs.io. Read my AI disclosure →
API Evangelist API Evangelist
Discovery
Learnings
Guidance
Toolbox
Alignment
API Evangelist LLC
Discovery
Learnings
Guidance
Toolbox
Alignment
API Evangelist LLC

Need help?

Contact us
VTEX

VTEX Account API

The Account API from VTEX — 13 operation(s) for account.

Documentation Provider Profile APIs.io OpenAPI GitHub

VTEX Account API is one of 142 APIs that VTEX publishes on the APIs.io network, described by a machine-readable OpenAPI specification.

Tagged areas include Account. The published artifact set on APIs.io includes an OpenAPI specification and API documentation.

This API exposes 17 operations across 13 paths, and defines 4 schemas. It is described by OpenAPI 3.0.0, at version 1.0.

Requests are made against a single base URL, https://{providerApiEndpoint}.

17 operations 13 paths 4 schemas 3 DELETE4 GET4 POST6 PUT

Metadata

The identity and technical contract details declared by the specification.

Specification
OpenAPI 3.0.0
API Version
1.0
Base URL
https://{providerApiEndpoint}
Authentication
API Key
Resource Areas
1

Authentication & Security 1

VTEX Account API declares 1 security scheme for authenticating requests. An API key is passed in the header as VtexIdclientAutCookie (VtexIdclientAutCookie).

  • VtexIdclientAutCookie — [User token](https://developers.vtex.com/docs/guides/api-authentication-using-user-tokens), valid for 24 hours.

Paths & Operations 17

Across 13 paths, the API surfaces 17 operations — 3 DELETE, 4 GET, 4 POST, 6 PUT. Each is listed below with its method, path, parameters, and response codes.

Account 17
GET
/api/creditcontrol/accounts
VTex Search all accounts
Searchallaccounts 6 params → 200
POST
/api/creditcontrol/accounts
VTex Open an account
OpenanAccount 2 params body → 200
GET
/api/creditcontrol/accounts/{creditAccountId}
VTex Retrieve an account by ID
RetrieveaAccountbyId 3 params → 200
DELETE
/api/creditcontrol/accounts/{creditAccountId}
VTex Close an account
CloseanAccount 3 params body → 200
PUT
/api/creditcontrol/accounts/{creditAccountId}
VTex Update account information
Updateemailanddescriptionofaaccount 3 params body → 200
GET
/api/creditcontrol/accounts/{creditAccountId}/statements
VTex Get account statements
Accountstatements 3 params → 200
PUT
/api/creditcontrol/accounts/{creditAccountId}/creditlimit
VTex Change credit limit of an account
ChangecreditlimitofanAccount 3 params body → 200
PUT
/api/creditcontrol/accounts/{creditAccountId}/statements/{statementId}
VTex Decrease balance of an account
Decreasebalanceofanaccount 4 params body → 200
PUT
/api/creditcontrol/accounts/{creditAccountId}/transactions/{transactionId}/settlement
VTex Create or update settlement
CreateorUpdateSettlement 4 params body → 200
POST
/api/creditcontrol/accounts/{creditAccountId}/transactions
VTex Create a pre-authorization
CreateaPreAuthorization 3 params body → 200
PUT
/api/creditcontrol/accounts/{creditAccountId}/transactions/{transactionId}
VTex Update a pre-authorization
CreateaPreAuthorization(usingid) 4 params body → 200
DELETE
/api/creditcontrol/accounts/{creditAccountId}/transactions/{transactionId}
VTex Cancel a pre-authorization
CancelaPreAuthorization 4 params → 200
POST
/api/creditcontrol/accounts/{creditAccountId}/holders
VTex Add an account holder
AddanaccountHolder 3 params body → 200
DELETE
/api/creditcontrol/accounts/{creditAccountId}/holders/{holderId}
VTex Delete an account holder
Deleteanaccountholder 4 params → 200
PUT
/api/creditcontrol/accounts/{creditAccountId}/tolerance
VTex Change tolerance of an account
Changetoleranceofanaccount 3 params body → 200
POST
/api/creditcontrol/accounts/{creditAccountId}/transactions/{transactionId}/refunds
VTex Partially or totally refund a settlement
PartialorTotalRefundaSettlement 4 params body → 200
GET
/api/vlm/account
VTex Get information about account
GetAccount → 200

Schemas 4

The contract defines 4 schemas that model the data the API accepts and returns. The most detailed are AccountResponse (34 properties), SiteItems (9 properties), AppKeyItems (7 properties), LicenseItems (5 properties). Each schema is shown below with its type and property counts.

AppKeyItems
object
Object representing application keys.
7 properties
AccountResponse
object
Successful response for /api/vlm/account.
34 properties
LicenseItems
object
Object representing licenses.
5 properties
SiteItems
object
Object containing complete information from a store.
9 properties

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

vtex-account-api-openapi.yml Raw ↑

Other APIs VTEX publishes across the network.

VTEX Addresses API
AE Profile APIs.io
VTEX Anti-Fraud Flow API
AE Profile APIs.io
VTEX App Keys API
AE Profile APIs.io
VTEX Attachment API
AE Profile APIs.io
VTEX Authentication API
AE Profile APIs.io
VTEX Autocomplete API
AE Profile APIs.io
VTEX Brand API
AE Profile APIs.io
VTEX Bulk Import API
AE Profile APIs.io
VTEX Carriers API
AE Profile APIs.io
VTEX Cart Attachments API
AE Profile APIs.io
VTEX Category API
AE Profile APIs.io
VTEX Category Specification API
AE Profile APIs.io
#Account
← Back to V APIs
API Details
ID
vtex:vtex-account-api
Base URL
https://{providerApiEndpoint}
Docs
https://developers.vtex.com/docs/guides/how-the-integration-protocol-between-vtex-and-antifraud-companies-works
Provider
VTEX
APIs.io →  GitHub →
Explore more
All APIs Providers APIs.io Network
Work with this as data

Every API here is available over the API and to AI agents over MCP. APIs is not yet its own endpoint on the v1 API. Reach this content through network search and the tag graph, or the MCP server below.

Installs https://mcp.apievangelist.com/mcp in Claude, Cursor, VS Code and the rest — one button, every client.

MCP tools for apis
4 tools reach this content
  • search_api_evangelistSearch every content type across the network at once.
  • find_relatedThe shared-tag relevance graph — what else covers this.
  • get_tagEverything one tag labels, across all content types.
  • guide_topicPRO — a curated bundle for a topic: area, guidance, rules, papers, stories, services.
All tools & prompts
Call it yourself
curl for this page
Search the network for this 
curl "https://api.apievangelist.com/v1/search?q=vtex-account-api&limit=10"
Everything under a tag 
curl "https://api.apievangelist.com/v1/tags/vtex-account-api"

Discovery needs no key. Full bodies and the synthesis endpoints are Pro.

Get an API key

Free tier, no email required. Sign in with whichever identity you already have.

GitHub Google LinkedIn

A second provider on the same verified email joins the account you already have. Your account

Where this information came from

This is an independent, third-party profile of VTEX Account API, published by API Evangelist. We do not operate, host, resell, or support these APIs, and we are not affiliated with or endorsed by the company unless stated above. Everything here is built from publicly available information — the company's own site, developer portal, documentation, public repositories, and the specifications it publishes for public use. Nothing is obtained by breaching a system, defeating an access control, or using credentials.

The Kin Score and Agent Readiness rating are independently calculated assessments of a company's public API artifacts, scored against a published rubric. They are not certifications, endorsements, security assessments, or audits.

Corrections, re-scores, and removal are free — no partnership or purchase required, and you do not need to justify the request. A removed company is recorded as unrated, never scored zero for having asked. Acknowledgement within one business day; removal within two.

info@apievangelist.com · Read the full data-sourcing policy →
On a security or compliance team? Put security in the subject line and you will get a person, not a form — we will tell you exactly which public URLs this profile was built from.