Catalog API - Seller Portal
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 functionality is in the beta stage and can be discontinued at any moment at VTEX's discretion. VTEX will not be responsible for any instabilities caused by its use or discontinuity. If you have any questions, please contact our Support Center.
Endpoints
Product
| Summary | Method | Path |
|---|---|---|
| Get product by ID | GET | /api/catalog-seller-portal/products/{productId} |
| Update product | PUT | /api/catalog-seller-portal/products/{productId} |
| Get product description by product ID | GET | /api/catalog-seller-portal/products/{productId}/description |
| Update product description by product ID | PUT | /api/catalog-seller-portal/products/{productId}/description |
| Get product by external ID, SKU ID, SKU external ID or slug | GET | /api/catalog-seller-portal/products/{param} |
| Create product | POST | /api/catalog-seller-portal/products |
SKU
| Summary | Method | Path |
|---|---|---|
| Search for SKU | GET | /api/catalog-seller-portal/skus/_search |
| Get list of SKUs | GET | /api/catalog-seller-portal/skus/ids |
Brand
| Summary | Method | Path |
|---|---|---|
| Get list of brands | GET | /api/catalog-seller-portal/brands |
| Create brand | POST | /api/catalog-seller-portal/brands |
| Get brand by ID | GET | /api/catalog-seller-portal/brands/{brandId} |
| Update brand | PUT | /api/catalog-seller-portal/brands/{brandId} |
Category
| Summary | Method | Path |
|---|---|---|
| Get category tree | GET | /api/catalog-seller-portal/category-tree |
| Update category tree | PUT | /api/catalog-seller-portal/category-tree |
| Get category by ID | GET | /api/catalog-seller-portal/category-tree/categories/{categoryId} |
| Create category | POST | /api/catalog-seller-portal/category-tree/categories |