Catalog API
vtex · Company
> Check the new [Catalog onboarding guide](https://developers.vtex.com/docs/guides/catalog-overview). We created this guide to improve the onboarding experience for developers at VTEX. It assembles all documentation on our Developer Portal about Catalog and is organized by focusing on the developer's journey. Methods for collecting product/SKU catalog data, categories, brands and other information. All content that comes between `{{}}` keys must be replaced with the correct data before perf
Authentication
Sample Requests
Retrieves information about a specific SKU by its `RefId`. ### Response body example ```json { "Id": 1, "ProductId": 1, "IsActive": true, "Name": "Royal Canin Feline Urinary 500g", "RefId": "0001", "PackagedHeight": 6.0000, "PackagedLength": 24.0000, "
Hover any highlighted part to learn what it does
| Accept | application/json |
| Content-Type | application/json |
curl -X GET "https://api.apis.guru/v2/specs/vtex.local/Catalog-API/1.0/api/catalog/pvt/stockkeepingunit?refId=1" \ -H "Accept: application/json" \ -H "Content-Type: application/json"
import requests
params = {
"refId": "1"
}
headers = {
"Accept": "application/json",
"Content-Type": "application/json"
}
response = requests.get(
"https://api.apis.guru/v2/specs/vtex.local/Catalog-API/1.0/api/catalog/pvt/stockkeepingunit",
params=params,
headers=headers,
)
print(response.json())const url = new URL('https://api.apis.guru/v2/specs/vtex.local/Catalog-API/1.0/api/catalog/pvt/stockkeepingunit');
url.searchParams.set('refId', '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/1.0/api/catalog/pvt/stockkeepingunit")
q := baseURL.Query()
q.Set("refId", "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/1.0/api/catalog/pvt/stockkeepingunit")
uri.query = URI.encode_www_form({
"refId" => "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/1.0/api/catalog/pvt/stockkeepingunit?" . http_build_query([
"refId" => "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));Retrieves general information about the components of an SKU Kit by SKU ID or Parent SKU ID. ## Response body example ```json { "Id": 7, "StockKeepingUnitParent": 7, "StockKeepingUnitId": 1, "Quantity": 1, "UnitPrice": 50.0000 } ```
Hover any highlighted part to learn what it does
| Accept | application/json |
| Content-Type | application/json |
curl -X GET "https://api.apis.guru/v2/specs/vtex.local/Catalog-API/1.0/api/catalog/pvt/stockkeepingunitkit?skuId=1&parentSkuId=1" \ -H "Accept: application/json" \ -H "Content-Type: application/json"
import requests
params = {
"skuId": "1",
"parentSkuId": "1"
}
headers = {
"Accept": "application/json",
"Content-Type": "application/json"
}
response = requests.get(
"https://api.apis.guru/v2/specs/vtex.local/Catalog-API/1.0/api/catalog/pvt/stockkeepingunitkit",
params=params,
headers=headers,
)
print(response.json())const url = new URL('https://api.apis.guru/v2/specs/vtex.local/Catalog-API/1.0/api/catalog/pvt/stockkeepingunitkit');
url.searchParams.set('skuId', '1');
url.searchParams.set('parentSkuId', '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/1.0/api/catalog/pvt/stockkeepingunitkit")
q := baseURL.Query()
q.Set("skuId", "1")
q.Set("parentSkuId", "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/1.0/api/catalog/pvt/stockkeepingunitkit")
uri.query = URI.encode_www_form({
"skuId" => "1",
"parentSkuId" => "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/1.0/api/catalog/pvt/stockkeepingunitkit?" . http_build_query([
"skuId" => "1",
"parentSkuId" => "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));Gets general information about unmapped Specifications of a Seller's SKU in a Marketplace by SKU ID. ## Response body example ```json [ { "Id": 1010, "SkuId": 310119072, "SpecificationName": "size", "SpecificationValue": "Small" } ] ```
Hover any highlighted part to learn what it does
| Accept | application/json |
| Content-Type | application/json |
curl -X GET "https://api.apis.guru/v2/specs/vtex.local/Catalog-API/1.0/api/catalog/pvt/specification/nonstructured?skuId=1" \ -H "Accept: application/json" \ -H "Content-Type: application/json"
import requests
params = {
"skuId": "1"
}
headers = {
"Accept": "application/json",
"Content-Type": "application/json"
}
response = requests.get(
"https://api.apis.guru/v2/specs/vtex.local/Catalog-API/1.0/api/catalog/pvt/specification/nonstructured",
params=params,
headers=headers,
)
print(response.json())const url = new URL('https://api.apis.guru/v2/specs/vtex.local/Catalog-API/1.0/api/catalog/pvt/specification/nonstructured');
url.searchParams.set('skuId', '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/1.0/api/catalog/pvt/specification/nonstructured")
q := baseURL.Query()
q.Set("skuId", "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/1.0/api/catalog/pvt/specification/nonstructured")
uri.query = URI.encode_www_form({
"skuId" => "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/1.0/api/catalog/pvt/specification/nonstructured?" . http_build_query([
"skuId" => "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));Postman Setup Guide
- See official documentation for authentication and setup.
What can you build with Catalog API?
Catalog API 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 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?