APIHub
Back to Explore

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](https://help.vtex.com/en/tutorial/how-the-seller-portal-catalog-works--7pMB6YOt6YQDQQbzFB4Pxp). This functionality is in the Beta stage and can be discontinued at any moment at VTEX's discretion. VTEX will not

Uncategorized
apiKeyHeader
HTTPS
CORS: Unknown
Visit official documentation

Latency

3260ms p95

Uptime

0.0% 30d

Playground

Verified

live

Endpoints

REST · JSON
PUT

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

Update Product Description by Product ID

  • Content-Type (header, required) — Type of the content being sent.
  • Accept (header, required) — HTTP Client Negotiation _Accept_ Header. Indicates the types of responses the client can understand.
  • productId (path, required) — Product unique identifier number.
GET

/api/catalog-seller-portal/brands

Get List of Brands

  • Content-Type (header, required) — Type of the content being sent.
  • Accept (header, required) — HTTP Client Negotiation _Accept_ Header. Indicates the types of responses the client can understand.
  • q (query) — Search word.
  • from (query) — The first page of the interval of the brand list.
  • to (query) — The last page of the interval of the brand list.
  • orderBy (query) — The order that the list is displayed. You can select `name`, or `updated_at` to select the order criteria. Then you can add `,` , `asc` or `desc` to define the brands order.
  • name (query) — Brand name.
POST

/api/catalog-seller-portal/brands

Create Brand

  • Content-Type (header, required) — Type of the content being sent.
  • Accept (header, required) — HTTP Client Negotiation _Accept_ Header. Indicates the types of responses the client can understand.
GET

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

Get Brand by ID

  • Content-Type (header, required) — Type of the content being sent.
  • Accept (header, required) — HTTP Client Negotiation _Accept_ Header. Indicates the types of responses the client can understand.
  • brandId (path, required) — Brand unique identifier number.
PUT

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

Update Brand

  • Content-Type (header, required) — Type of the content being sent.
  • Accept (header, required) — HTTP Client Negotiation _Accept_ Header. Indicates the types of responses the client can understand.
  • brandId (path, required) — Brand unique identifier number.
GET

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

Get Category Tree

  • Content-Type (header, required) — Type of the content being sent.
  • Accept (header, required) — HTTP Client Negotiation _Accept_ Header. Indicates the types of responses the client can understand.
  • depth (query) — Category tree level.
PUT

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

Update Category Tree

  • Content-Type (header, required) — Type of the content being sent.
  • Accept (header, required) — HTTP Client Negotiation _Accept_ Header. Indicates the types of responses the client can understand.
POST

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

Create Category

  • Content-Type (header, required) — Type of the content being sent.
  • Accept (header, required) — HTTP Client Negotiation _Accept_ Header. Indicates the types of responses the client can understand.
GET

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

Get Category by ID

  • Content-Type (header, required) — Type of the content being sent.
  • Accept (header, required) — HTTP Client Negotiation _Accept_ Header. Indicates the types of responses the client can understand.
  • categoryId (path, required) — Category unique identifier number.
POST

/api/catalog-seller-portal/products

Create Product

  • Content-Type (header, required) — Type of the content being sent.
  • Accept (header, required) — HTTP Client Negotiation _Accept_ Header. Indicates the types of responses the client can understand.
GET

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

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

  • Content-Type (header, required) — Type of the content being sent.
  • Accept (header, required) — HTTP Client Negotiation _Accept_ Header. Indicates the types of responses the client can understand.
  • param (path, required) — This part of the path must follow this format: `{param}={value}`. Replace `{param}` with the name of the parameter used to fetch a product, which can be one of the following: `external-id` (product reference unique identifier number in the store), `sku-id` (SKU unique identifier number), `sku-external-id` (SKU reference unique identifier number in the store) or `slug` (reference of the product in the URL of the store). Replace `{value}` with the value of the selected param. Make sure there is a `=` between them.
GET

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

Get Product by ID

  • Content-Type (header, required) — Type of the content being sent.
  • Accept (header, required) — HTTP Client Negotiation _Accept_ Header. Indicates the types of responses the client can understand.
  • productId (path, required) — Product unique identifier number.
PUT

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

Update Product

  • Content-Type (header, required) — Type of the content being sent.
  • Accept (header, required) — HTTP Client Negotiation _Accept_ Header. Indicates the types of responses the client can understand.
  • productId (path, required) — Product unique identifier number.
GET

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

Get Product Description by Product ID

  • Content-Type (header, required) — Type of the content being sent.
  • Accept (header, required) — HTTP Client Negotiation _Accept_ Header. Indicates the types of responses the client can understand.
  • productId (path, required) — Product unique identifier number.
GET

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

Search for SKU

  • Content-Type (header, required) — Type of the content being sent.
  • Accept (header, required) — HTTP Client Negotiation _Accept_ Header. Indicates the types of responses the client can understand.
  • from (query) — The first page of the interval of the product list.
  • to (query) — The last page of the interval of the product list.
  • id (query) — SKU unique idenfier number.
  • externalid (query) — SKU reference unique identifier number in the store.
GET

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

Get List of SKUs

  • Content-Type (header, required) — Type of the content being sent.
  • Accept (header, required) — HTTP Client Negotiation _Accept_ Header. Indicates the types of responses the client can understand.
  • from (query) — The first page of the interval of the product list.
  • to (query) — The last page of the interval of the product list.

16 endpoints auto-detected

Authentication

This API uses an API key, passed in the "X-VTEX-API-AppKey" header. No OAuth required.

curl -X PUT \
  "https://vtex.local/api/catalog-seller-portal/products/{productId}/description" \
  -H "X-VTEX-API-AppKey: YOUR_API_KEY"

vtex.local · HTTPS only