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

The User Orders API from VTEX — 2 operation(s) for user orders.

Documentation Provider Profile APIs.io OpenAPI GitHub

VTEX User 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 User Orders. The published artifact set on APIs.io includes an OpenAPI specification and API documentation.

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

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

2 operations 2 paths 35 schemas 2 GET

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 User 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 2

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

User Orders 2
GET
/api/oms/user/orders
VTex Retrieve user's orders
Userorderslist 5 params → 200
GET
/api/oms/user/orders/{orderId}
VTex Retrieve user order details
Userorderdetails 4 params → 200

Schemas 35

The contract defines 35 schemas that model the data the API accepts and returns. The most detailed are Userorderdetails (52 properties), Item (43 properties), Payment (32 properties), List1 (26 properties). Each schema is shown below with its type and property counts.

ChangesAttachment
object
Information about changes in the order.
2 properties 2 required
Transaction
object
Financial transaction details.
4 properties 4 required
AdditionalInfo
object
Additional information about the item.
9 properties 9 required
List1
object
26 properties 26 required
ItemsRemoved
object
5 properties 5 required
Userorderdetails
object
52 properties 52 required
Item
object
43 properties 43 required
TotalValue1
object
9 properties 9 required
RatesAndBenefitsData
object
Information on promotions and taxes that apply to the order.
2 properties 2 required
Marketplace
object
Details about the marketplace related to the order.
3 properties 3 required
Stats2
object
1 property 1 required
TotalItems1
object
9 properties 9 required
Paging
object
4 properties 4 required
PackageAttachment
object
Package object populated after order invoiced.
1 property 1 required
Address
object
Shipping address details.
15 properties 15 required
Userorderslist
object
Order list object.
4 properties 4 required
ItemAttachment
object
Information about attachments, if it applies.
2 properties 2 required
PickupStoreInfo
object
Detailed information about a [pickup point](https://help.vtex.com/en/tutorial/pickup-points--2fljn6wLjn8M4lJHA6HP3R).
5 properties 5 required
Receipt
object
Information about the receipt for changed orders.
3 properties 3 required
PaymentData
object
Object with information about the payment.
2 properties 1 required
Seller
object
Information about the seller associated with the order.
4 properties 4 required
Total
object
3 properties 3 required
DeliveryId
object
Information about delivery IDs.
7 properties 7 required
StorePreferencesData
object
Object with data from the store's configuration - stored in VTEX's License Manager.
6 properties 6 required
Payment
object
Payment details.
32 properties 32 required
Item2
object
9 properties 9 required
CurrencyFormatInfo
object
Object with currency format details.
5 properties 5 required
Stats3
object
2 properties 2 required
ChangesDatum
object
6 properties 6 required
SelectedAddress
object
15 properties 15 required
LogisticsInfo
object
22 properties 22 required
Sla
object
12 properties 12 required
Dimension
object
5 properties 5 required
ClientProfileData
object
Object with information on the client's profile.
15 properties 15 required
ShippingData
object
Object containing shipping data.
5 properties 5 required

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

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