VTEX

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…

Other#openapi

Fork copies the collection into your workspace, without the publisher's secrets, so you can add your own key and send requests. Star saves it to your starred APIs (Account › Marketplace) and helps others find it.

Overview

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.

Index

Product

GET Get Product by ID
PUT Update Product
GET Get Product Description by Product ID
PUT Update Product Description by Product ID
GET Get Product by external ID, SKU ID, SKU external ID or slug
POST Create Product

SKU

GET Search for SKU
GET Get List of SKUs

Brand

GET Get List of Brands
POST Create a Brand
GET Get Brand by ID
PUT Update Brand

Category

GET Get Category Tree
PUT Update Category Tree
GET Get Category by ID
POST Create a Category

Endpoints 16

Product

  • POSTCreate Product/api/catalog-seller-portal/products>📘 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…
  • GETGet Product by external ID, SKU ID, SKU external ID or slug/api/catalog-seller-portal/products/:param>📘 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…
  • GETGet Product by ID/api/catalog-seller-portal/products/:productId>📘 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…
  • PUTUpdate Product/api/catalog-seller-portal/products/:productId>📘 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…
  • GETGet Product Description by Product ID/api/catalog-seller-portal/products/:productId/description>📘 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…
  • PUTUpdate Product Description by Product ID/api/catalog-seller-portal/products/:productId/description>📘 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…

SKU

  • GETSearch for SKU/api/catalog-seller-portal/skus/_search?from=1&to=50&id=1&externalid=123456789>📘 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…
  • GETGet List of SKUs/api/catalog-seller-portal/skus/ids?from=1&to=50>📘 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…

Brand

  • GETGet List of Brands/api/catalog-seller-portal/brands?q=tshirt&from=1&to=50&orderBy=status,asc;name,asc&name=Zwilling>📘 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…
  • POSTCreate Brand/api/catalog-seller-portal/brands>📘 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…
  • GETGet Brand by ID/api/catalog-seller-portal/brands/:brandId>📘 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…
  • PUTUpdate Brand/api/catalog-seller-portal/brands/:brandId>📘 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…

Category

  • GETGet Category Tree/api/catalog-seller-portal/category-tree?depth=1>📘 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…
  • PUTUpdate Category Tree/api/catalog-seller-portal/category-tree>📘 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…
  • POSTCreate Category/api/catalog-seller-portal/category-tree/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…
  • GETGet Category by ID/api/catalog-seller-portal/category-tree/categories/:categoryId>📘 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…

API details

Base URL
https://vtex.local
https://{accountName}.{environment}.com.br
Authentication
An API key in the X-VTEX-API-AppKey header
An API key in the X-VTEX-API-AppToken header
Operations
16 operations on 11 pathsGET 9PUT 4POST 3
Main resources
Product 6Brand 4Category 4SKU 2
Response formats
application/json
Description format
OpenAPI 3.0.0, API version 1.0.0
Listed from
APIs.guru OpenAPI Directory (CC0-1.0)
Source updated

How to test the Catalog API - Seller Portal in Swastik Codes

  1. Open the APISelect “Fork & run in Swastik Codes” on this page. Sign in or create a free account if asked.
  2. Fork it into your workspaceChoose a workspace. You get your own copy of the Catalog API - Seller Portal collection, without the publisher's secrets.
  3. Add your credentialsThis API uses an API key in the X-VTEX-API-AppKey header. Add yours in the collection's variables or an environment; the requests already reference it.
  4. Send a requestPick an endpoint, for example “Create Product” (POST /api/catalog-seller-portal/products), and press Send. Check the response, add tests and run the whole collection with the runner.

Frequently asked questions

What is the 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… It is listed under Other and has 16 endpoints.

Who publishes the Catalog API - Seller Portal?

It is listed from VTEX's public API description (an OpenAPI document), not published by VTEX on Swastik Codes. Anyone who controls vtex.com can claim the profile by adding a DNS TXT record.

What is the base URL of the Catalog API - Seller Portal?

Its description lists 2 base URLs: https://vtex.local, https://{accountName}.{environment}.com.br. The first is the usual one; the others are typically sandbox or regional servers.

How do I authenticate with the Catalog API - Seller Portal?

It accepts 2 methods: an API key in the X-VTEX-API-AppKey header; an API key in the X-VTEX-API-AppToken header.

How many endpoints does the Catalog API - Seller Portal have?

16 operations on 11 paths (9 GET, 4 PUT, 3 POST). The largest groups are Product, Brand, Category, SKU.

Is forking the Catalog API - Seller Portal free?

Yes. Forking copies the collection into your workspace for free. It has been starred 0 times and forked 0 times.

Suggest an API

Tell us which public API is missing. We check it, then add it here with its endpoints when it has an OpenAPI (Swagger) description.