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

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