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

GitHub integration →

ads-js ✓ Official

npm install ads-js

GitHub integration →

vtex-node-sdk

npm install vtex-node-sdk

GitHub integration →

physical-payments-sdk ✓ Official

# Maven: see https://github.com/vtex-apps/physical-payments-sdk

GitHub integration →

VTEX-SDK-dotnet

dotnet add package VTEX-SDK-dotnet

GitHub integration →

vtex-sdk

composer require vtex-sdk

GitHub integration →

vtex-sdk-php

composer require vtex-sdk-php

GitHub integration →

vtex-api

composer require vtex-api

GitHub integration →

vtex-kotlin-sdk

# See https://github.com/ksetoue/vtex-kotlin-sdk

GitHub integration →

vtex.js ✓ Official

# See https://github.com/vtex/vtex.js

GitHub integration →

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