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 External Seller API

The External Seller API from VTEX — 8 operation(s) for external seller.

Documentation Provider Profile APIs.io OpenAPI GitHub

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

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

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

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

8 operations 8 paths 14 schemas 8 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 External Seller 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 8

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

External Seller 8
POST
/pvt/orderForms/simulation
VTex Fulfillment simulation - External Seller
fulfillment-simulation 3 params body → 200
POST
/pvt/orders
VTex Order placement
order-placement 11 params body → 200
POST
/pvt/orders/{sellerOrderId}/fulfill
VTex Authorize fulfillment
authorize-fulfillment 4 params body → 200
POST
/pvt/orders/{orderId}/cancel
VTex Marketplace order cancellation
mkp-order-cancellation 4 params body → 200
POST
/pvt/orders/{marketplaceOrderId}/invoice
VTex Send invoice
send-invoice 4 params body → 200
POST
/pvt/orders/{marketplaceOrderId}/invoice/{invoiceNumber}
VTex Send tracking information
send-tracking-information 5 params body → 200
POST
/pvt/orders/{marketplaceOrderId}/invoice/{invoiceNumber}/tracking
VTex Update tracking status
update-tracking-status 5 params body → 200
POST
/pvt/orders/{marketplaceOrderId}/cancel
VTex Cancel order in marketplace
cancel-order-in-marketplace 4 params body → 200

Schemas 14

The contract defines 14 schemas that model the data the API accepts and returns. The most detailed are responseOrderPlacement (9 properties), orderPlacement (9 properties), requestSendInvoice (8 properties), requestOrderId (6 properties). Each schema is shown below with its type and property counts.

bundleItemsItem
object
An item included in a bundle, representing a service or product.
4 properties
requestUpdateTrackingStatus
object
Request body object used to update the tracking status of an order.
2 properties 1 required
itemAttachment
object
An attachment associated with an item, containing additional information or customization requested by the customer.
2 properties
responseOrderPlacement
object
Expected response from the Order Placement endpoint.
9 properties
repsonseOrderId
object
Details related to an order, including the order approval date, marketplace order ID, order number, and order receipt code.
4 properties
requestOrderId
object
Details related to a request for an order ID, which is used to trigger the fulfillment process of the corresponding order.
6 properties 6 required
requestSendTracking
object
4 properties 4 required
responseFulfillmentSimulation
object
Expected response body of fulfillment simulation.
5 properties 4 required
requestCancelOrderMarketplace
object
Object used to request the cancellation of an order on the marketplace.
1 property 1 required
requestSendInvoice
object
Object used to send invoice information related to an order.
8 properties 3 required
responseFulfill
object
3 properties
orderPlacement
object
Informations related to the placement of an order.
9 properties
requestFulfillmentSimulation
object
This request body represents a fulfillmentsimulation, which may involve delivering items to a specified address. It is used to test the process of fulfilling o…
5 properties 1 required
fulfillmentItem
object
Details of an item to be fulfilled.
3 properties 3 required

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

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