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 23 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

Get Matched Offers List

curl \
  -H "X-VTEX-API-AppKey: $API_KEY" \
  https://vtex.local/offer-manager/pvt/offers

List Sellers

curl \
  -H "X-VTEX-API-AppKey: $API_KEY" \
  https://vtex.local/seller-register/pvt/sellers

List Seller Leads

curl \
  -H "X-VTEX-API-AppKey: $API_KEY" \
  https://vtex.local/seller-register/pvt/seller-leads

Endpoints (23 total)

GET

/offer-manager/pvt/offers

Get Matched Offers List

GET

/seller-register/pvt/sellers

List Sellers

GET

/seller-register/pvt/seller-leads

List Seller Leads

GET

/offer-manager/pvt/product/{productId}

Get Matched Offer's Data by Product ID

GET

/seller-register/pvt/sellers/{sellerId}

Get Seller data by ID

GET

/seller-register/pvt/seller-leads/{sellerLeadId}

Get Seller Lead's Data by Id

GET

/offer-manager/pvt/product/{productId}/sku/{skuId}

Get Matched Offer's Data by SKU ID

GET

/seller-register/pvt/sellers/{sellerId}/commissions

List Seller Commissions by seller ID

GET

/seller-register/pvt/sellers/{sellerId}/sales-channel/mapping

Get Sales Channel Mapping Data

GET

/seller-register/pvt/sellers/{sellerId}/commissions/{categoryId}

Get Seller Commissions by Category ID

POST

/seller-register/pvt/sellers

Configure Seller Account

POST

/seller-register/pvt/seller-leads

Invite Seller Lead