vtex.local

> Check the new Promotions onboarding guide. We created this guide to improve the onboarding experience for developers at VTEX. It assembles all documentation on our Developer Portal about Promotions and is organized by focusing

🔑 apikey 31 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 coupons
curl \
  -H "X-VTEX-API-AppKey: $API_KEY" \
  https://vtex.local/api/rnb/pvt/coupon
Get Price by SKU ID
curl \
  -H "X-VTEX-API-AppKey: $API_KEY" \
  https://vtex.local/price-sheet/{skuId}
Get coupon by coupon code
curl \
  -H "X-VTEX-API-AppKey: $API_KEY" \
  https://vtex.local/api/rnb/pvt/coupon/{couponCode}
Endpoints (31 total)
GET
/api/rnb/pvt/coupon
Get all coupons
GET
/price-sheet/{skuId}
Get Price by SKU ID
GET
/api/rnb/pvt/coupon/{couponCode}
Get coupon by coupon code
GET
/api/rnb/pvt/campaignConfiguration
Get all campaign audiences
GET
/price-sheet/all/{page}/{pageSize}
Get all paged prices
GET
/price-sheet/{skuId}/{tradePolicy}
Get Price by SKU ID and Trade Policy
GET
/api/rnb/pvt/coupon/usage/{couponCode}
Get coupon usage
GET
/api/rnb/pvt/archive/coupon/{couponCode}
Get archived coupon by coupon code
GET
/api/rnb/pvt/taxes/calculatorconfiguration
Get All Taxes
GET
/api/rnb/pvt/benefits/calculatorconfiguration
Get All Promotions
GET
/api/rnb/pvt/campaignConfiguration/{campaignId}
Get campaign audience configuration
GET
/api/rnb/pvt/archive/taxes/calculatorConfiguration
List Archived Taxes
At a glance
Total SDKs10
Languages6
Endpoints31
Authapikey
https://vtex.local