Catalog API - Seller Portal

vtex · Company

Company No Auth Free & Open API

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 be responsible for any instabilities caused by its use or discontinuity. If you have any questi

Authentication

No authentication requiredFree to use with no key needed.

Sample Requests

GET Get List of Brands

>📘 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 be responsible for any instabilities

https://api.apis.guru/v2/specs/vtex.local/Catalog-API-Seller-Portal/1.0.0/api/catalog-seller-portal/brands?q=tshirt&to=50&from=1&name=Zwilling&orderBy=status,asc;name,asc

Hover any highlighted part to learn what it does

Headers — extra info sent with the request

Accept	application/json
Content-Type	application/json

curl -X GET "https://api.apis.guru/v2/specs/vtex.local/Catalog-API-Seller-Portal/1.0.0/api/catalog-seller-portal/brands?q=tshirt&to=50&from=1&name=Zwilling&orderBy=status%2Casc%3Bname%2Casc" \
  -H "Accept: application/json" \
  -H "Content-Type: application/json"

import requests
params = {
    "q": "tshirt",
    "to": "50",
    "from": "1",
    "name": "Zwilling",
    "orderBy": "status,asc;name,asc"
}
headers = {
    "Accept": "application/json",
    "Content-Type": "application/json"
}
response = requests.get(
    "https://api.apis.guru/v2/specs/vtex.local/Catalog-API-Seller-Portal/1.0.0/api/catalog-seller-portal/brands",
    params=params,
    headers=headers,
)
print(response.json())

const url = new URL('https://api.apis.guru/v2/specs/vtex.local/Catalog-API-Seller-Portal/1.0.0/api/catalog-seller-portal/brands');
url.searchParams.set('q', 'tshirt');
url.searchParams.set('to', '50');
url.searchParams.set('from', '1');
url.searchParams.set('name', 'Zwilling');
url.searchParams.set('orderBy', 'status,asc;name,asc');

const response = await fetch(url, {
  headers: {
    'Accept': 'application/json',
    'Content-Type': 'application/json'
  },
}); 
const data = await response.json();
console.log(data);

package main

import (
	"fmt"
	"io"
	"net/http"
	"net/url"
)

func main() {
	baseURL, _ := url.Parse("https://api.apis.guru/v2/specs/vtex.local/Catalog-API-Seller-Portal/1.0.0/api/catalog-seller-portal/brands")
	q := baseURL.Query()
	q.Set("q", "tshirt")
	q.Set("to", "50")
	q.Set("from", "1")
	q.Set("name", "Zwilling")
	q.Set("orderBy", "status,asc;name,asc")
	baseURL.RawQuery = q.Encode()
	targetURL := baseURL.String()
	req, _ := http.NewRequest("GET", targetURL, nil)
	req.Header.Set("Accept", "application/json")
	req.Header.Set("Content-Type", "application/json")

	client := &http.Client{}
	resp, _ := client.Do(req)
	defer resp.Body.Close()
	body, _ := io.ReadAll(resp.Body)
	fmt.Println(string(body))
}

require "net/http"
require "json"

uri = URI("https://api.apis.guru/v2/specs/vtex.local/Catalog-API-Seller-Portal/1.0.0/api/catalog-seller-portal/brands")
uri.query = URI.encode_www_form({
  "q" => "tshirt",
  "to" => "50",
  "from" => "1",
  "name" => "Zwilling",
  "orderBy" => "status,asc;name,asc"
})

http = Net::HTTP.new(uri.host, uri.port)
http.use_ssl = uri.scheme == "https"

req = Net::HTTP::Get.new(uri)
req["Accept"] = "application/json"
req["Content-Type"] = "application/json"

res = http.request(req)
puts JSON.parse(res.body)

<?php
$url = "https://api.apis.guru/v2/specs/vtex.local/Catalog-API-Seller-Portal/1.0.0/api/catalog-seller-portal/brands?" . http_build_query([
    "q" => "tshirt",
    "to" => "50",
    "from" => "1",
    "name" => "Zwilling",
    "orderBy" => "status,asc;name,asc"
]);
$opts = ["http" => [
    "method" => "GET",
    "header" => implode("\r\n", [
        "Accept: application/json",
        "Content-Type: application/json"
    ]),
]];
$ctx = stream_context_create($opts);
$res = file_get_contents($url, false, $ctx);
print_r(json_decode($res, true));

GET Get Category Tree

https://api.apis.guru/v2/specs/vtex.local/Catalog-API-Seller-Portal/1.0.0/api/catalog-seller-portal/category-tree?depth=1

Hover any highlighted part to learn what it does

Headers — extra info sent with the request

Accept	application/json
Content-Type	application/json

curl -X GET "https://api.apis.guru/v2/specs/vtex.local/Catalog-API-Seller-Portal/1.0.0/api/catalog-seller-portal/category-tree?depth=1" \
  -H "Accept: application/json" \
  -H "Content-Type: application/json"

import requests
params = {
    "depth": "1"
}
headers = {
    "Accept": "application/json",
    "Content-Type": "application/json"
}
response = requests.get(
    "https://api.apis.guru/v2/specs/vtex.local/Catalog-API-Seller-Portal/1.0.0/api/catalog-seller-portal/category-tree",
    params=params,
    headers=headers,
)
print(response.json())

const url = new URL('https://api.apis.guru/v2/specs/vtex.local/Catalog-API-Seller-Portal/1.0.0/api/catalog-seller-portal/category-tree');
url.searchParams.set('depth', '1');

const response = await fetch(url, {
  headers: {
    'Accept': 'application/json',
    'Content-Type': 'application/json'
  },
}); 
const data = await response.json();
console.log(data);

package main

import (
	"fmt"
	"io"
	"net/http"
	"net/url"
)

func main() {
	baseURL, _ := url.Parse("https://api.apis.guru/v2/specs/vtex.local/Catalog-API-Seller-Portal/1.0.0/api/catalog-seller-portal/category-tree")
	q := baseURL.Query()
	q.Set("depth", "1")
	baseURL.RawQuery = q.Encode()
	targetURL := baseURL.String()
	req, _ := http.NewRequest("GET", targetURL, nil)
	req.Header.Set("Accept", "application/json")
	req.Header.Set("Content-Type", "application/json")

	client := &http.Client{}
	resp, _ := client.Do(req)
	defer resp.Body.Close()
	body, _ := io.ReadAll(resp.Body)
	fmt.Println(string(body))
}

require "net/http"
require "json"

uri = URI("https://api.apis.guru/v2/specs/vtex.local/Catalog-API-Seller-Portal/1.0.0/api/catalog-seller-portal/category-tree")
uri.query = URI.encode_www_form({
  "depth" => "1"
})

http = Net::HTTP.new(uri.host, uri.port)
http.use_ssl = uri.scheme == "https"

req = Net::HTTP::Get.new(uri)
req["Accept"] = "application/json"
req["Content-Type"] = "application/json"

res = http.request(req)
puts JSON.parse(res.body)

<?php
$url = "https://api.apis.guru/v2/specs/vtex.local/Catalog-API-Seller-Portal/1.0.0/api/catalog-seller-portal/category-tree?" . http_build_query([
    "depth" => "1"
]);
$opts = ["http" => [
    "method" => "GET",
    "header" => implode("\r\n", [
        "Accept: application/json",
        "Content-Type: application/json"
    ]),
]];
$ctx = stream_context_create($opts);
$res = file_get_contents($url, false, $ctx);
print_r(json_decode($res, true));

GET Search for SKU

https://api.apis.guru/v2/specs/vtex.local/Catalog-API-Seller-Portal/1.0.0/api/catalog-seller-portal/skus/_search?id=1&to=50&from=1&externalid=123456789

Hover any highlighted part to learn what it does

Headers — extra info sent with the request

Accept	application/json
Content-Type	application/json

curl -X GET "https://api.apis.guru/v2/specs/vtex.local/Catalog-API-Seller-Portal/1.0.0/api/catalog-seller-portal/skus/_search?id=1&to=50&from=1&externalid=123456789" \
  -H "Accept: application/json" \
  -H "Content-Type: application/json"

import requests
params = {
    "id": "1",
    "to": "50",
    "from": "1",
    "externalid": "123456789"
}
headers = {
    "Accept": "application/json",
    "Content-Type": "application/json"
}
response = requests.get(
    "https://api.apis.guru/v2/specs/vtex.local/Catalog-API-Seller-Portal/1.0.0/api/catalog-seller-portal/skus/_search",
    params=params,
    headers=headers,
)
print(response.json())

const url = new URL('https://api.apis.guru/v2/specs/vtex.local/Catalog-API-Seller-Portal/1.0.0/api/catalog-seller-portal/skus/_search');
url.searchParams.set('id', '1');
url.searchParams.set('to', '50');
url.searchParams.set('from', '1');
url.searchParams.set('externalid', '123456789');

const response = await fetch(url, {
  headers: {
    'Accept': 'application/json',
    'Content-Type': 'application/json'
  },
}); 
const data = await response.json();
console.log(data);

package main

import (
	"fmt"
	"io"
	"net/http"
	"net/url"
)

func main() {
	baseURL, _ := url.Parse("https://api.apis.guru/v2/specs/vtex.local/Catalog-API-Seller-Portal/1.0.0/api/catalog-seller-portal/skus/_search")
	q := baseURL.Query()
	q.Set("id", "1")
	q.Set("to", "50")
	q.Set("from", "1")
	q.Set("externalid", "123456789")
	baseURL.RawQuery = q.Encode()
	targetURL := baseURL.String()
	req, _ := http.NewRequest("GET", targetURL, nil)
	req.Header.Set("Accept", "application/json")
	req.Header.Set("Content-Type", "application/json")

	client := &http.Client{}
	resp, _ := client.Do(req)
	defer resp.Body.Close()
	body, _ := io.ReadAll(resp.Body)
	fmt.Println(string(body))
}

require "net/http"
require "json"

uri = URI("https://api.apis.guru/v2/specs/vtex.local/Catalog-API-Seller-Portal/1.0.0/api/catalog-seller-portal/skus/_search")
uri.query = URI.encode_www_form({
  "id" => "1",
  "to" => "50",
  "from" => "1",
  "externalid" => "123456789"
})

http = Net::HTTP.new(uri.host, uri.port)
http.use_ssl = uri.scheme == "https"

req = Net::HTTP::Get.new(uri)
req["Accept"] = "application/json"
req["Content-Type"] = "application/json"

res = http.request(req)
puts JSON.parse(res.body)

<?php
$url = "https://api.apis.guru/v2/specs/vtex.local/Catalog-API-Seller-Portal/1.0.0/api/catalog-seller-portal/skus/_search?" . http_build_query([
    "id" => "1",
    "to" => "50",
    "from" => "1",
    "externalid" => "123456789"
]);
$opts = ["http" => [
    "method" => "GET",
    "header" => implode("\r\n", [
        "Accept: application/json",
        "Content-Type: application/json"
    ]),
]];
$ctx = stream_context_create($opts);
$res = file_get_contents($url, false, $ctx);
print_r(json_decode($res, true));

Postman Setup Guide

Get Postman ↗

See official documentation for authentication and setup.

What can you build with Catalog API - Seller Portal?

Catalog API - Seller Portal is a Company API. Developers commonly use company APIs for:

enriching CRM records with company firmographics
building lead-generation and prospecting tools
verifying business identity and registration details
monitoring competitors and market intelligence
powering B2B data enrichment pipelines

No authentication required. This API is open — no signup or key needed. Ideal for quick prototypes and public-facing features. Catalog API - Seller Portal is free to use, making it a low-risk choice to experiment with.

New to APIs? Read our beginner's guide · Learn about API keys · What is REST?

Open documentation ↗