vtex.local

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

🔑 apikey 14 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 Pricing Configuration

curl \
  -H "X-VTEX-API-AppKey: $API_KEY" \
  https://vtex.local/pricing/config

List price tables

curl \
  -H "X-VTEX-API-AppKey: $API_KEY" \
  https://vtex.local/pricing/tables

Get Pricing v2 Status

curl \
  -H "X-VTEX-API-AppKey: $API_KEY" \
  https://vtex.local/pricing/migration

Endpoints (14 total)

GET

/pricing/config

Get Pricing Configuration

GET

/pricing/tables

List price tables

GET

/pricing/migration

Get Pricing v2 Status

GET

/pricing/prices/{itemId}

Get Price

GET

/pricing/pipeline/catalog

Get all price tables and their rules

GET

/pricing/prices/{itemId}/fixed

Get Fixed Prices

GET

/pricing/pipeline/catalog/{priceTableId}

Get rules for a price table

GET

/pricing/prices/{itemId}/fixed/{priceTableId}

Get Fixed Prices on a price table or trade policy

GET

/pricing/prices/{itemId}/computed/{priceTableId}

Get Computed Price by price table or trade policy

POST

/pricing/prices/{itemId}/fixed/{priceTableId}

Create or Update Fixed Prices on a price table or trade policy

PUT

/pricing/prices/{itemId}

Create or Update Base Price or Fixed Prices

PUT

/pricing/pipeline/catalog/{priceTableId}

Update rules for a price table