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 Configuration API

The Configuration API from VTEX — 8 operation(s) for configuration.

Documentation Provider Profile APIs.io OpenAPI GitHub

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

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

This API exposes 15 operations across 8 paths, and defines 16 schemas. It is described by OpenAPI 3.0.0, at version 1.0.

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

15 operations 8 paths 16 schemas 1 DELETE7 GET5 POST2 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 Configuration 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 15

Across 8 paths, the API surfaces 15 operations — 1 DELETE, 7 GET, 5 POST, 2 PUT. Each is listed below with its method, path, parameters, and response codes.

Configuration 15
GET
/api/checkout/pvt/configuration/orderForm
VTex Get orderForm configuration
GetorderFormconfiguration 2 params → 200
POST
/api/checkout/pvt/configuration/orderForm
VTex Update orderForm configuration
UpdateorderFormconfiguration 2 params body → 204
GET
/api/checkout/pvt/configuration/window-to-change-seller
VTex Get window to change seller
GetWindowToChangeSeller 2 params → 200
POST
/api/checkout/pvt/configuration/window-to-change-seller
VTex Update window to change seller
UpdateWindowToChangeSeller 2 params body → 201
POST
/api/checkout/pub/orderForm/{orderFormId}/messages/clear
VTex Clear orderForm messages
ClearorderFormMessages 3 params body → 200
GET
/api/pvt/affiliations
VTex List all affiliations
Affiliations 2 params → 200
POST
/api/pvt/affiliations
VTex Insert new affiliation
InsertAffiliation 2 params body → 200
PUT
/api/pvt/affiliations/{affiliationId}
VTex Update affiliation by ID
UpdateAffiliation 3 params body → 200
GET
/api/pvt/affiliations/{affiliationId}
VTex Get affiliation by ID
AffiliationById 3 params → 200
GET
/api/pvt/rules
VTex List all payment rules
Rules 2 params → 200
POST
/api/pvt/rules
VTex Insert a new payment rule
InsertRule 2 params body → 200
GET
/api/pvt/rules/{ruleId}
VTex Get payment rule by ID
RuleById 3 params → 200
PUT
/api/pvt/rules/{ruleId}
VTex Update payment rule by ID
PutRuleById 3 params body → 200
DELETE
/api/pvt/rules/{ruleId}
VTex Delete payment rule by ID
Rule 3 params → 200
GET
/api/pvt/merchants/payment-systems
VTex List all available payment methods
AvailablePaymentMethods 2 params → 200

Schemas 16

The contract defines 16 schemas that model the data the API accepts and returns. The most detailed are PaymentSystemsResponse (30 properties), RulesRequest (25 properties), InsertRuleRequest (24 properties), UpdateorderFormconfigurationRequest (16 properties). Each schema is shown below with its type and property counts.

Antifraud
object
Anti-fraud information.
2 properties 2 required
PaymentConfiguration
object
Payment Configuration object.
3 properties 1 required
RulesRequest
object
Payment rules information.
25 properties 19 required
AffiliationResponse
object
Affiliation by ID response body information.
6 properties 6 required
Issuer
object
Card issuer information.
1 property 1 required
WaitingTime
object
Object containing the days after order cancelation by a seller.
1 property 1 required
Connector
object
Connector (payment provider) information.
2 properties 2 required
Validator
object
Validator information.
10 properties 10 required
UpdateAffiliationRequest
object
Update affiliation by ID request body information.
6 properties 6 required
GetRulesResponse
array
Array containing payment rules information.
19 required
UpdateorderFormconfigurationRequest
object
16 properties 8 required
InsertRuleRequest
object
New payment rule request body information.
24 properties 18 required
PaymentSystemsResponse
object
Available payment methods response body information.
30 properties 30 required
PaymentSystem
object
Payment system information.
3 properties 3 required
InsertAffiliationRequest
object
Insert new affiliation request body information.
5 properties 5 required
SalesChannel
array
Array containing information about the Sales channel.

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

vtex-configuration-api-openapi.yml Raw ↑

Other APIs VTEX publishes across the network.

VTEX Account API
AE Profile APIs.io
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
#Configuration
← Back to V APIs
API Details
ID
vtex:vtex-configuration-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-configuration-api&limit=10"
Everything under a tag 
curl "https://api.apievangelist.com/v1/tags/vtex-configuration-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 Configuration 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.