Marketplace API
vtex · Company
The **Marketplace API** enables marketplaces and sellers hosted on VTEX to perform their collaborative operations. >⚠️ The marketplace must [create an appKey and appToken](https://developers.vtex.com/docs/guides/getting-started-authentication) for each non-VTEX seller that will use this API. ## Index ### Notification Endpoints used by sellers to notify marketplaces that the price or inventory language has changed for one of their SKUs. `POST` [Notify marketplace of price updat
Authentication
Sample Requests
This endpoint retrieves a list of all SKUs sent by the seller for the Marketplace's approval. Marketplace operators should use this endpoint whenever they want to check the full list of received SKUs and their information. Note that all the information sent by the seller will be in the [content]
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/Marketplace-APIs/1.0/suggestions?q=&_to=50&type=new&_from=1&seller=&status=accepted&matcherid=vtex-matcher&hasmapping=true&accountName=apiexamples" \ -H "Accept: application/json" \ -H "Content-Type: application/json"
import requests
params = {
"q": "",
"_to": "50",
"type": "new",
"_from": "1",
"seller": "",
"status": "accepted",
"matcherid": "vtex-matcher",
"hasmapping": "true",
"accountName": "apiexamples"
}
headers = {
"Accept": "application/json",
"Content-Type": "application/json"
}
response = requests.get(
"https://api.apis.guru/v2/specs/vtex.local/Marketplace-APIs/1.0/suggestions",
params=params,
headers=headers,
)
print(response.json())const url = new URL('https://api.apis.guru/v2/specs/vtex.local/Marketplace-APIs/1.0/suggestions');
url.searchParams.set('q', '');
url.searchParams.set('_to', '50');
url.searchParams.set('type', 'new');
url.searchParams.set('_from', '1');
url.searchParams.set('seller', '');
url.searchParams.set('status', 'accepted');
url.searchParams.set('matcherid', 'vtex-matcher');
url.searchParams.set('hasmapping', 'true');
url.searchParams.set('accountName', 'apiexamples');
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/Marketplace-APIs/1.0/suggestions")
q := baseURL.Query()
q.Set("q", "")
q.Set("_to", "50")
q.Set("type", "new")
q.Set("_from", "1")
q.Set("seller", "")
q.Set("status", "accepted")
q.Set("matcherid", "vtex-matcher")
q.Set("hasmapping", "true")
q.Set("accountName", "apiexamples")
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/Marketplace-APIs/1.0/suggestions")
uri.query = URI.encode_www_form({
"q" => "",
"_to" => "50",
"type" => "new",
"_from" => "1",
"seller" => "",
"status" => "accepted",
"matcherid" => "vtex-matcher",
"hasmapping" => "true",
"accountName" => "apiexamples"
})
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/Marketplace-APIs/1.0/suggestions?" . http_build_query([
"q" => "",
"_to" => "50",
"type" => "new",
"_from" => "1",
"seller" => "",
"status" => "accepted",
"matcherid" => "vtex-matcher",
"hasmapping" => "true",
"accountName" => "apiexamples"
]);
$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));This endpoint retrieves the current approval settings of a marketplace's Received SKUs module. Its response includes: - `Score`: Matcher scores for approving and rejecting SKUs received from sellers. - `Matchers`: All Matchers configured on the marketplace, and their respective details. - `Spe
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/Marketplace-APIs/1.0/suggestions/configuration?accountName=apiexamples" \ -H "Accept: application/json" \ -H "Content-Type: application/json"
import requests
params = {
"accountName": "apiexamples"
}
headers = {
"Accept": "application/json",
"Content-Type": "application/json"
}
response = requests.get(
"https://api.apis.guru/v2/specs/vtex.local/Marketplace-APIs/1.0/suggestions/configuration",
params=params,
headers=headers,
)
print(response.json())const url = new URL('https://api.apis.guru/v2/specs/vtex.local/Marketplace-APIs/1.0/suggestions/configuration');
url.searchParams.set('accountName', 'apiexamples');
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/Marketplace-APIs/1.0/suggestions/configuration")
q := baseURL.Query()
q.Set("accountName", "apiexamples")
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/Marketplace-APIs/1.0/suggestions/configuration")
uri.query = URI.encode_www_form({
"accountName" => "apiexamples"
})
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/Marketplace-APIs/1.0/suggestions/configuration?" . http_build_query([
"accountName" => "apiexamples"
]);
$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));This endpoint can be used to check whether the autoapprove setting is active or not, for a specific seller. If the response is `true`, the autoapprove setting is active. If the response is `false`, it is inactive.
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/Marketplace-APIs/1.0/suggestions/configuration/autoapproval/toggle?sellerId=seller123&accountName=apiexamples" \ -H "Accept: application/json" \ -H "Content-Type: application/json"
import requests
params = {
"sellerId": "seller123",
"accountName": "apiexamples"
}
headers = {
"Accept": "application/json",
"Content-Type": "application/json"
}
response = requests.get(
"https://api.apis.guru/v2/specs/vtex.local/Marketplace-APIs/1.0/suggestions/configuration/autoapproval/toggle",
params=params,
headers=headers,
)
print(response.json())const url = new URL('https://api.apis.guru/v2/specs/vtex.local/Marketplace-APIs/1.0/suggestions/configuration/autoapproval/toggle');
url.searchParams.set('sellerId', 'seller123');
url.searchParams.set('accountName', 'apiexamples');
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/Marketplace-APIs/1.0/suggestions/configuration/autoapproval/toggle")
q := baseURL.Query()
q.Set("sellerId", "seller123")
q.Set("accountName", "apiexamples")
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/Marketplace-APIs/1.0/suggestions/configuration/autoapproval/toggle")
uri.query = URI.encode_www_form({
"sellerId" => "seller123",
"accountName" => "apiexamples"
})
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/Marketplace-APIs/1.0/suggestions/configuration/autoapproval/toggle?" . http_build_query([
"sellerId" => "seller123",
"accountName" => "apiexamples"
]);
$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 Marketplace API?
Marketplace 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. Marketplace 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?