List Products
curl --request GET \
--url https://production-api.puppetvendors.com/v1/products \
--header 'x-access-token: <api-key>'import requests
url = "https://production-api.puppetvendors.com/v1/products"
headers = {"x-access-token": "<api-key>"}
response = requests.get(url, headers=headers)
print(response.text)const options = {method: 'GET', headers: {'x-access-token': '<api-key>'}};
fetch('https://production-api.puppetvendors.com/v1/products', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));<?php
$curl = curl_init();
curl_setopt_array($curl, [
CURLOPT_URL => "https://production-api.puppetvendors.com/v1/products",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "GET",
CURLOPT_HTTPHEADER => [
"x-access-token: <api-key>"
],
]);
$response = curl_exec($curl);
$err = curl_error($curl);
curl_close($curl);
if ($err) {
echo "cURL Error #:" . $err;
} else {
echo $response;
}package main
import (
"fmt"
"net/http"
"io"
)
func main() {
url := "https://production-api.puppetvendors.com/v1/products"
req, _ := http.NewRequest("GET", url, nil)
req.Header.Add("x-access-token", "<api-key>")
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(string(body))
}HttpResponse<String> response = Unirest.get("https://production-api.puppetvendors.com/v1/products")
.header("x-access-token", "<api-key>")
.asString();require 'uri'
require 'net/http'
url = URI("https://production-api.puppetvendors.com/v1/products")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Get.new(url)
request["x-access-token"] = '<api-key>'
response = http.request(request)
puts response.read_bodyProducts
List Products
Retrieve products with pagination
GET
/
v1
/
products
List Products
curl --request GET \
--url https://production-api.puppetvendors.com/v1/products \
--header 'x-access-token: <api-key>'import requests
url = "https://production-api.puppetvendors.com/v1/products"
headers = {"x-access-token": "<api-key>"}
response = requests.get(url, headers=headers)
print(response.text)const options = {method: 'GET', headers: {'x-access-token': '<api-key>'}};
fetch('https://production-api.puppetvendors.com/v1/products', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));<?php
$curl = curl_init();
curl_setopt_array($curl, [
CURLOPT_URL => "https://production-api.puppetvendors.com/v1/products",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "GET",
CURLOPT_HTTPHEADER => [
"x-access-token: <api-key>"
],
]);
$response = curl_exec($curl);
$err = curl_error($curl);
curl_close($curl);
if ($err) {
echo "cURL Error #:" . $err;
} else {
echo $response;
}package main
import (
"fmt"
"net/http"
"io"
)
func main() {
url := "https://production-api.puppetvendors.com/v1/products"
req, _ := http.NewRequest("GET", url, nil)
req.Header.Add("x-access-token", "<api-key>")
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(string(body))
}HttpResponse<String> response = Unirest.get("https://production-api.puppetvendors.com/v1/products")
.header("x-access-token", "<api-key>")
.asString();require 'uri'
require 'net/http'
url = URI("https://production-api.puppetvendors.com/v1/products")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Get.new(url)
request["x-access-token"] = '<api-key>'
response = http.request(request)
puts response.read_bodyOverview
Returns a paginated list of products in your shop, including variants, inventory, images, and vendor assignment.Use Cases
- Sync your product catalog to an external marketplace or PIM
- Build a vendor-specific product feed by filtering with
vendorId - Monitor product status (active, draft, archived) across vendors
- Export product data for reporting or analytics
Query Parameters
string
Filter products by vendor ID.
number
Number of products to return per page. Default:
100.number
Number of products to skip. Default:
0. Use nextOffset from the response for pagination.Response
200
{
"total": 250,
"nextOffset": 100,
"products": [
{
"_id": "...",
"title": "Classic T-Shirt",
"handle": "classic-t-shirt",
"productType": "Apparel",
"vendor": "acme supplies",
"vendorId": "6157faecbebcf01bf49097d9",
"status": "active",
"totalInventory": 150,
"isDigital": false,
"variants": [...],
"images": [...],
"tags": ["summer", "cotton"],
"createdAt": "2024-01-10T10:00:00.000Z",
"updatedAt": "2024-06-01T12:00:00.000Z"
}
]
}
Use
nextOffset for cursor-based pagination. When nextOffset is null, you have reached the last page.Example
# List all products
curl -X GET "https://api.puppetvendors.com/v1/products?limit=50" \
-H "x-access-token: YOUR_JWT_TOKEN"
# List products for a specific vendor
curl -X GET "https://api.puppetvendors.com/v1/products?vendorId=6157faecbebcf01bf49097d9&limit=50" \
-H "x-access-token: YOUR_JWT_TOKEN"
Was this page helpful?