vtex.local

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

🔑 apikey 162 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 attachments

curl \
  -H "X-VTEX-API-AppKey: $API_KEY" \
  https://vtex.local/api/catalog/pvt/attachments

Get Brand and context

curl \
  -H "X-VTEX-API-AppKey: $API_KEY" \
  https://vtex.local/api/catalog/pvt/brand/{brandId}

Get SKU by RefId

curl \
  -H "X-VTEX-API-AppKey: $API_KEY" \
  https://vtex.local/api/catalog/pvt/stockkeepingunit

Endpoints (162 total)

GET

/api/catalog/pvt/attachments

Get all attachments

GET

/api/catalog/pvt/brand/{brandId}

Get Brand and context

GET

/api/catalog/pvt/stockkeepingunit

Get SKU by RefId

GET

/api/catalog_system/pvt/brand/list

Get Brand List

GET

/api/catalog_system/pvt/seller/list

Get Seller List

GET

/api/addon/pvt/giftlist/get/{listId}

Get Gift List

GET

/api/catalog/pvt/collection/inactive

Get All Inactive Collections

GET

/api/catalog/pvt/product/{productId}

Get Product by ID

GET

/api/catalog/pvt/stockkeepingunitkit

Get SKU Kit by SKU ID or Parent SKU ID

GET

/api/catalog/pvt/category/{categoryId}

Get Category by ID

GET

/api/catalog_system/pvt/brand/pagedlist

Get Brand List Per Page

GET

/api/catalog_system/pvt/brand/{brandId}

Get Brand