vtex.local

The _Marketplace Protocol_ is a set of API requests and definitions to help you integrate external sellers into a VTEX marketplace as well as external marketplaces into VTEX sellers. External Seller Here you will find the endpoints involved in the integration between a VTEX marketplace an

🔑 apikey 15 endpoints
📄 Docs 📋 OpenAPI spec 🔬 Try in Swagger UI

SDKs by language (10 total)

lever-sdk ✓ Official
npm install lever-sdk
ads-js ✓ Official
npm install ads-js
npm install vtex-node-sdk
physical-payments-sdk ✓ Official
# Maven: see https://github.com/vtex-apps/physical-payments-sdk
dotnet add package VTEX-SDK-dotnet
composer require vtex-sdk
composer require vtex-sdk-php
composer require vtex-api
# See https://github.com/ksetoue/vtex-kotlin-sdk
vtex.js ✓ Official
# See https://github.com/vtex/vtex.js
curl examples
Order placement
curl \
  -H "X-VTEX-API-AppKey: $API_KEY" \
  https://vtex.local/{fulfillmentEndpoint}/pvt/orders
Fulfillment simulation - External Marketplace
curl \
  -H "X-VTEX-API-AppKey: $API_KEY" \
  https://vtex.local/api/checkout/pub/orderForms/simulation
Endpoints (15 total)
POST
/{fulfillmentEndpoint}/pvt/orders
Order placement
POST
/api/checkout/pub/orderForms/simulation
Fulfillment simulation - External Marketplace
POST
/{fulfillmentEndpoint}/pvt/orderForms/simulation
Fulfillment simulation - External Seller
POST
/{fulfillmentEndpoint}/pvt/orders/{orderId}/cancel
Marketplace order cancellation
POST
/{fulfillmentEndpoint}/pvt/orders/{sellerOrderId}/fulfill
Authorize fulfillment
POST
/{accountName}.{environment}.com.br/api/fulfillment/pvt/orders
Place fulfillment order
POST
/{accountName}.vtexcommercestable.com.br/api/order-integration/orders
New Order Integration
POST
/{marketplaceServicesEndpoint}/pvt/orders/{marketplaceOrderId}/cancel
Cancel order in marketplace
POST
/{marketplaceServicesEndpoint}/pvt/orders/{marketplaceOrderId}/invoice
Send invoice
POST
/portal.vtexcommercestable.com.br/api/mkp-category-mapper/connector/register
VTEX Mapper Registration
POST
/{accountName}.{environment}.com.br/api/fulfillment/pvt/orders/{orderId}/fulfill
Authorize dispatch for fulfillment order
POST
/portal.vtexcommercestable.com.br/api/mkp-category-mapper/categories/marketplace/{id}
Send Category Mapping to VTEX Mapper
At a glance
Total SDKs10
Languages6
Endpoints15
Authapikey
https://vtex.local