List Products
curl --request GET \
--url https://production-api.puppetvendors.com/products \
--header 'x-access-token: <api-key>'import requests
url = "https://production-api.puppetvendors.com/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/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/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/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/products")
.header("x-access-token", "<api-key>")
.asString();require 'uri'
require 'net/http'
url = URI("https://production-api.puppetvendors.com/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 vendor-scoped products with cursor-based pagination
GET
/
products
List Products
curl --request GET \
--url https://production-api.puppetvendors.com/products \
--header 'x-access-token: <api-key>'import requests
url = "https://production-api.puppetvendors.com/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/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/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/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/products")
.header("x-access-token", "<api-key>")
.asString();require 'uri'
require 'net/http'
url = URI("https://production-api.puppetvendors.com/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_bodyV2 Alpha — This endpoint is part of the V2 API preview. Breaking changes may occur.
Overview
Retrieve a paginated list of products belonging to the authenticated vendor. Results include product title, handle, status, variants, and images. Only products assigned to the vendor are returned.Vendor Token Required — This endpoint requires a vendor-scoped JWT token. Merchant tokens will receive a 403 error.
Use Cases
- Product catalogue — Display a vendor’s product listings in a custom portal
- Inventory management — Pull product data for stock-level monitoring
- Product sync — Export vendor products to external systems
Query Parameters
string
Filter by product status. One of:
active, draft, archived.string
Filter by creation date (minimum, ISO 8601). Example:
2024-01-01T00:00:00Z.string
Filter by creation date (maximum, ISO 8601).
string
Search in product title or handle (max 200 characters).
integer
Number of items to return, forward pagination (1-100).
string
Cursor for forward pagination.
integer
Number of items to return, backward pagination (1-100).
string
Cursor for backward pagination.
Response
200
{
"success": true,
"data": {
"products": [
{
"_id": "507f1f77bcf86cd799439030",
"title": "Widget Pro",
"handle": "widget-pro",
"status": "active",
"productId": 7654321098765,
"variants": [
{
"variantId": 43210987654321,
"title": "Small",
"price": "19.99",
"sku": "WP-SM",
"inventoryQuantity": 50
},
{
"variantId": 43210987654322,
"title": "Medium",
"price": "24.99",
"sku": "WP-MD",
"inventoryQuantity": 30
}
],
"images": [
{
"src": "https://cdn.shopify.com/s/files/1/example/widget-pro.jpg",
"alt": "Widget Pro main image"
}
],
"createdAt": "2024-06-10T08:00:00.000Z"
}
],
"totalCount": 42,
"pageInfo": {
"hasNextPage": true,
"hasPreviousPage": false,
"startCursor": "eyJpZCI6IjUwN2YxZjc3YmNmODZjZDc5OTQzOTAzMCJ9",
"endCursor": "eyJpZCI6IjUwN2YxZjc3YmNmODZjZDc5OTQzOTA0MCJ9"
}
}
}
Example
curl -X GET "https://production-api.puppetvendors.com/products?status=active&first=20" \
-H "x-access-token: YOUR_VENDOR_JWT_TOKEN"
More Examples
Filter active products sorted by inventorycurl -X GET "https://production-api.puppetvendors.com/products?first=50&status=active&sortBy=totalInventory&sortOrder=asc" \
-H "x-access-token: YOUR_VENDOR_JWT_TOKEN"
curl -X GET "https://production-api.puppetvendors.com/products?first=20&search=summer+collection&inventoryStatus=outOfStock" \
-H "x-access-token: YOUR_VENDOR_JWT_TOKEN"
Was this page helpful?