vtex.local

With the Catalog API for Seller Portal, you will be able to create, edit and consult products and their variations, brands, and categories. > This API is part of the Seller Portal Catalog. This func

🔑 apikey 16 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 List of Brands

curl \
  -H "X-VTEX-API-AppKey: $API_KEY" \
  https://vtex.local/api/catalog-seller-portal/brands

Get List of SKUs

curl \
  -H "X-VTEX-API-AppKey: $API_KEY" \
  https://vtex.local/api/catalog-seller-portal/skus/ids

Search for SKU

curl \
  -H "X-VTEX-API-AppKey: $API_KEY" \
  https://vtex.local/api/catalog-seller-portal/skus/_search

Endpoints (16 total)

GET

/api/catalog-seller-portal/brands

Get List of Brands

GET

/api/catalog-seller-portal/skus/ids

Get List of SKUs

GET

/api/catalog-seller-portal/skus/_search

Search for SKU

GET

/api/catalog-seller-portal/category-tree

Get Category Tree

GET

/api/catalog-seller-portal/brands/{brandId}

Get Brand by ID

GET

/api/catalog-seller-portal/products/{param}

Get Product by external ID, SKU ID, SKU external ID or slug

GET

/api/catalog-seller-portal/products/{productId}

Get Product by ID

GET

/api/catalog-seller-portal/products/{productId}/description

Get Product Description by Product ID

GET

/api/catalog-seller-portal/category-tree/categories/{categoryId}

Get Category by ID

POST

/api/catalog-seller-portal/brands

Create Brand

POST

/api/catalog-seller-portal/products

Create Product

POST

/api/catalog-seller-portal/category-tree/categories

Create Category