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 Change Order (Beta) API

The Change Order (Beta) API from VTEX — 5 operation(s) for change order (beta).

Documentation Provider Profile APIs.io OpenAPI GitHub

VTEX Change Order (Beta) API is one of 142 APIs that VTEX publishes on the APIs.io network, described by a machine-readable OpenAPI specification.

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

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

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

6 operations 5 paths 38 schemas 2 GET1 PATCH3 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 Change Order (Beta) 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 6

Across 5 paths, the API surfaces 6 operations — 2 GET, 1 PATCH, 3 POST. Each is listed below with its method, path, parameters, and response codes.

Change Order (Beta) 6
PATCH
/api/order-system/orders/{changeOrderId}/changes
VTex Create order change
Createchange 4 params body → 202
GET
/api/order-system/orders/{changeOrderId}/changes
VTex Get order change history
GetChangeHistory 4 params → 200
GET
/api/order-system/orders/{changeOrderId}/changes/{changeRequestId}
VTex Get order change details
GetChangeDetail 5 params → 200
POST
/api/order-system/orders/{changeOrderId}/changes/preview
VTex Preview order change
PreviewChange 4 params body → 200
POST
/api/order-system/orders/{changeOrderId}/changes/{changeRequestId}/retry
VTex Retry order change
RetryChange 5 params body → 204
POST
/api/order-system/orders/{changeOrderId}/changes/{changeRequestId}/cancel
VTex Cancel order change
CancelChangeStoppedonError 5 params body → 200

Schemas 38

The contract defines 38 schemas that model the data the API accepts and returns. The most detailed are Item3 (41 properties), LogisticsInfo2 (23 properties), LogisticsInfo1 (23 properties), SlaV2 (17 properties). Each schema is shown below with its type and property counts.

Replace2
object
2 properties 2 required
Item1V2
object
4 properties 4 required
OriginV2
object
Object containing information about the order origin.
3 properties 3 required
ShippingData3
object
1 property 1 required
Settings
object
1 property 1 required
To2
object
4 properties 4 required
TotalV2
object
3 properties 3 required
LogisticsInfo1
object
23 properties 23 required
Createchange
object
2 properties 1 required
GetChangeDetail
object
15 properties 15 required
Item4
object
9 properties 9 required
LogisticsInfo2
object
23 properties 23 required
Request
object
13 properties 13 required
Item3
object
41 properties 41 required
PreviewChange1
object
11 properties 11 required
Replace
object
2 properties 2 required
FromV2
object
Object with information about the items been replaced. If instead of an order replace you wish to remove items, you will use the same schema naming the object…
1 property 1 required
CancelChangeStoppedonError
object
1 property 1 required
DeliveryChannel
object
1 property 1 required
To1
object
4 properties 4 required
PickupStoreInfoV2
object
5 properties 5 required
AdditionalInfoV2
object
9 properties 9 required
response202
object
13 properties 13 required
ShippingDataV2
object
1 property 1 required
PreviewChange
object
2 properties 2 required
Item2V2
object
9 properties 9 required
ToV2
object
Object with information about the new replacing items. If instead of an order replace you wish to add items, you will use the same schema naming the object add…
2 properties 1 required
ItemV2
object
2 properties 2 required
From2
object
3 properties 3 required
LogisticsInfoV2
object
5 properties 5 required
ShippingData2
object
1 property 1 required
Replace1
object
2 properties 2 required
SlaV2
object
17 properties 17 required
DeliveryIdV2
object
7 properties 7 required
ShippingData1
object
1 property 1 required
GetChangeHistory
object
2 properties 2 required
PaymentDataV2
object
1 property 1 required
From1
object
3 properties 3 required

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

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