vtex.local

The Marketplace API enables marketplaces and sellers hosted on VTEX to perform their collaborative operations. >⚠️ The marketplace must create an appKey and appToken for each non-VTEX seller that will use this API.

🔑 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
Get all SKU suggestions
curl \
  -H "X-VTEX-API-AppKey: $API_KEY" \
  https://vtex.local/suggestions
Get Account's Approval Settings
curl \
  -H "X-VTEX-API-AppKey: $API_KEY" \
  https://vtex.local/suggestions/configuration
Get SKU Suggestion by ID
curl \
  -H "X-VTEX-API-AppKey: $API_KEY" \
  https://vtex.local/suggestions/{sellerId}/{sellerSkuId}
Endpoints (15 total)
GET
/suggestions
Get all SKU suggestions
GET
/suggestions/configuration
Get Account's Approval Settings
GET
/suggestions/{sellerId}/{sellerSkuId}
Get SKU Suggestion by ID
GET
/suggestions/configuration/seller/{sellerId}
Get Seller's Approval Settings
GET
/suggestions/configuration/autoapproval/toggle
Get autoApprove Status in Account Settings
GET
/suggestions/{sellerId}/{sellerskuid}/versions
Get all Versions
GET
/suggestions/{sellerId}/{sellerskuid}/versions/{version}
Get Version by ID
PUT
/suggestions/configuration
Save Account's Approval Settings
PUT
/suggestions/{sellerId}/{sellerSkuId}
Send SKU Suggestion
PUT
/suggestions/matches/action/{actionName}
Match Multiple Received SKUs
PUT
/suggestions/configuration/seller/{sellerId}
Save Seller's Approval Settings
PUT
/suggestions/configuration/autoapproval/toggle
Activate autoApprove in Marketplace's Account
At a glance
Total SDKs10
Languages6
Endpoints15
Authapikey
https://vtex.local