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

The External Marketplace API from VTEX — 12 operation(s) for external marketplace.

Documentation Provider Profile APIs.io OpenAPI GitHub

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

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

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

16 operations 12 paths 22 schemas 1 DELETE4 GET1 PATCH8 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 External Marketplace 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 16

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

External Marketplace 16
GET
/api/channel-manager/channel/all
VTex List all channels
list-all-channels 4 params → 200
GET
/api/channel-manager/channel/:channelId
VTex Retrieve channel
retrieve-channel 5 params → 200
POST
/api/mkp-category-mapper/connector/register
VTEX Mapper Registration
vtex-mapper-registration 3 params body → 200
POST
/api/mkp-category-mapper/categories/marketplace/{id}
Send Category Mapping to VTEX Mapper
send-category-mapping-vtex-mapper 3 params body → 200
POST
/api/channel-manager/connector
VTex Register connector
register-connector 4 params body → 200
GET
/api/channel-manager/connector/all
VTex List all connectors
list-all-connectors 13 params → 200
GET
/api/channel-manager/connector/:connectorId
VTex Retrieve connector
retrieve-connector 5 params → 200
POST
/api/channel-manager/connector/:connectorId
VTex Upsert merchant connection
upsert-merchant-connection 5 params body → 200
DELETE
/api/channel-manager/connector/:connectorId
VTex Remove connector
remove-connector 5 params → 200
PUT
/api/channel-manager/connector/:connectorId
VTex Full update connector
full-update-connector 5 params body → 200
PATCH
/api/channel-manager/connector/:connectorId
VTex Partial update connector
partial-update-connector 5 params body → 200
POST
/api/fulfillment/pvt/orders
VTex Place fulfillment order
PlaceFulfillmentOrder 6 params body → 200
POST
/api/fulfillment/pvt/orders/{orderId}/fulfill
VTex Authorize dispatch for fulfillment order
AuthorizeDispatchForFulfillmentOrder 7 params body → 200
POST
/api/order-integration/orders
VTex New Order Integration
EnqueueNewOrder 5 params body → 200default
PUT
/api/order-integration/orders/status
VTex Update Order Status
UpdateOrderStatus 4 params body → 200
POST
/api/checkout/pub/orderForms/simulation
VTex Fulfillment simulation - External Marketplace
fulfillment-simulation-external-marketplace 6 params body → 200

Schemas 22

The contract defines 22 schemas that model the data the API accepts and returns. The most detailed are SelectedAddress (12 properties), EnqueueNewOrderRequest (12 properties), ClientProfileData (10 properties), Deliverybyseller (9 properties). Each schema is shown below with its type and property counts.

upsertMerchantConnection
object
2 properties 2 required
Fields
object
String dictionary with the names of the fields and their respective values that must be inserted into the order.
1 property 1 required
Deliverybyseller
object
9 properties 9 required
CustomData
object
Structure with the order's customizable fields. To insert custom fields in the order, you must first go through the process of [Creating an app](https://develo…
1 property 1 required
Item
object
3 properties 3 required
partialUpdateConnector
object
3 properties 3 required
InvoiceData
object
Object with the order's billing data.
1 property 1 required
UpdateOrderStatusRequest
object
4 properties 4 required
Approveorder
object
9 properties 9 required
CustomApp
object
3 properties 3 required
VtexMapperRegistration
object
5 properties 4 required
sendCategoryMappingToVtexMapper
object
1 property 3 required
fullUpdateConnector
object
8 properties 8 required
Deliverybyfranchiseseller
object
9 properties 9 required
GeoCoordinates
object
Structure with the address geocoordinates. Optional for delivery orders, required for pickup-in-point orders.
2 properties 2 required
DeliveryIds
object
List of delivery IDs, used for orders where the marketplace is responsible for the fulfillment of the order, including keeping inventory at a warehouse as well…
1 property 1 required
EnqueueNewOrderRequest
object
12 properties 8 required
SelectedAddress
object
List with the delivery addresses selected for the order. We currently only support a single delivery address.
12 properties 5 required
LogisticsInfo
object
List that references the SLAs responsible for delivering each item in the order. This list must contain the same number of items as the items list, previously…
6 properties 6 required
UserPaymentInfo
object
Structure with the order’s payment data. Required only if invoiceData is defined.
1 property 1 required
ClientProfileData
object
Structure with the customer's information. An order will be identified as corporate if any of the corporate fields are filled out (corporateDocument, corporate…
10 properties 10 required
ShippingData
object
4 properties 4 required

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

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