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

The Orders API from VTEX — 10 operation(s) for orders.

Documentation Provider Profile APIs.io OpenAPI GitHub

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

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

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

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

10 operations 10 paths 45 schemas 3 GET7 POST

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 Orders 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 10

Across 10 paths, the API surfaces 10 operations — 3 GET, 7 POST. Each is listed below with its method, path, parameters, and response codes.

Orders 10
GET
/api/oms/pvt/orders/{orderId}
VTex Get order
GetOrder 3 params → 200
GET
/api/oms/pvt/orders
VTex List orders
ListOrders 23 params → 200
POST
/api/oms/pvt/orders/{orderId}/start-handling
VTex Start handling order
StartHandling 3 params → 204401403404409429
POST
/api/oms/pvt/orders/{orderId}/cancel
VTex Cancel order
CancelOrder 3 params body → 200403404429
POST
/api/oms/pvt/orders/{orderId}/changes
VTex Register change on order
RegisterChange 3 params body → 200
POST
/api/oms/pvt/orders/{orderId}/interactions
VTex Add log in orders
AddLog 3 params body → 200
GET
/api/orders/pvt/document/{orderId}
VTex Get order
GetOrder2 4 params → 200
POST
/api/orders/extendsearch/orders
VTex List orders
ListOrders2 3 params body → 200
POST
/api/orders/pvt/document/{orderId}/actions/start-handling
VTex Start handling order
StartHandling2 3 params → 204403404429
POST
/api/orders/pvt/document/{orderId}/cancel
VTex Cancel order
CancelOrder2 3 params body → 200403404429

Schemas 45

The contract defines 45 schemas that model the data the API accepts and returns. The most detailed are List_2 (26 properties), List (26 properties), Payment (22 properties), LogisticsInfo (17 properties). Each schema is shown below with its type and property counts.

TotalItems
object
9 properties 9 required
ChangesAttachment
object
2 properties 2 required
Origin
object
2 properties 2 required
CurrencyCode1
object
1 property 1 required
RegisterChange
object
3 properties
Origin1
object
2 properties 2 required
Transaction
object
4 properties 4 required
BRL1
object
9 properties 9 required
Stats1
object
2 properties 2 required
ItemsRemoved
object
5 properties 5 required
Fulfillment1
object
9 properties 9 required
Facets
object
2 properties 2 required
BRL
object
9 properties 9 required
List
object
26 properties 26 required
List_2
object
26 properties 26 required
Facets1
object
2 properties 2 required
RatesAndBenefitsData
object
2 properties 2 required
Marketplace
object
3 properties 3 required
Receipt
object
3 properties 3 required
Paging
object
4 properties 4 required
Address
object
14 properties 13 required
PickupStoreInfo
object
5 properties 5 required
Stats
object
1 property 1 required
PaymentData
object
1 property 1 required
Seller
object
3 properties 3 required
AddLogRequest
object
2 properties 2 required
Marketplace2
object
9 properties 9 required
DeliveryId
object
5 properties 5 required
StorePreferencesData
object
6 properties 6 required
ListOrders
object
4 properties 4 required
Fulfillment
object
9 properties 9 required
ClientProfileData
object
15 properties 15 required
Paging_2
object
4 properties 4 required
CurrencyFormatInfo
object
5 properties 5 required
RegisterChangeRequest
object
6 properties 4 required
ChangesDatum
object
6 properties 6 required
SelectedAddress
LogisticsInfo
object
17 properties 17 required
Sla
object
8 properties 8 required
Marketplace1
object
9 properties 9 required
TotalValue
object
9 properties 9 required
CurrencyCode
object
1 property 1 required
ListOrders_2
object
4 properties 4 required
Payment
object
22 properties 22 required
ShippingData
object
6 properties 5 required

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

vtex-orders-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
#Order
← Back to V APIs
API Details
ID
vtex:vtex-orders-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-orders-api&limit=10"
Everything under a tag 
curl "https://api.apievangelist.com/v1/tags/vtex-orders-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 Orders 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.