curl --request GET \
--url https://api.platformdtc.com/api/v1/agent/v1/products \
--header 'X-Agent-Key: <api-key>'import requests
url = "https://api.platformdtc.com/api/v1/agent/v1/products"
headers = {"X-Agent-Key": "<api-key>"}
response = requests.get(url, headers=headers)
print(response.text)const options = {method: 'GET', headers: {'X-Agent-Key': '<api-key>'}};
fetch('https://api.platformdtc.com/api/v1/agent/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://api.platformdtc.com/api/v1/agent/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-Agent-Key: <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://api.platformdtc.com/api/v1/agent/v1/products"
req, _ := http.NewRequest("GET", url, nil)
req.Header.Add("X-Agent-Key", "<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://api.platformdtc.com/api/v1/agent/v1/products")
.header("X-Agent-Key", "<api-key>")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.platformdtc.com/api/v1/agent/v1/products")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Get.new(url)
request["X-Agent-Key"] = '<api-key>'
response = http.request(request)
puts response.read_body{
"success": true,
"message": "<string>",
"data": {
"data": [
{
"id": "<string>",
"store_id": "<string>",
"title": "<string>",
"handle": "<string>",
"product_type": "<string>",
"vendor": "<string>",
"tags": [
"<string>"
],
"options": [
"<string>"
],
"status": 0,
"status_label": "draft",
"price": "19.99",
"currency": "USD",
"image_url": "<string>",
"images": [
{
"id": "<string>",
"url": "<string>",
"width": "<string>",
"height": "<string>"
}
],
"link": "<string>",
"template_suffix": "<string>",
"is_published": true,
"variants_count": 123,
"created_at": "2023-11-07T05:31:56Z",
"updated_at": "2023-11-07T05:31:56Z",
"variants": [
{
"id": "<string>",
"product_id": "<string>",
"title": "<string>",
"sku": "<string>",
"price": "19.99",
"compare_at_price": "19.99",
"option1": "<string>",
"option2": "<string>",
"option3": "<string>",
"position": 123,
"weight": 123,
"weight_unit": "<string>",
"image_url": "<string>",
"inventory_quantity": 123,
"inventory_tracked": true,
"inventory_policy": "continue",
"created_at": "2023-11-07T05:31:56Z"
}
],
"description": "<string>",
"category": "<string>"
}
],
"meta": {
"limit": 123,
"total": 123,
"page": 123,
"total_pages": 123,
"next_page_info": "<string>",
"previous_page_info": "<string>",
"has_next_page": true,
"has_previous_page": true
}
},
"meta": {}
}{
"success": false,
"message": "<string>",
"error_code": "NOT_FOUND",
"errors": {}
}{
"success": false,
"message": "<string>",
"error_code": "NOT_FOUND",
"errors": {}
}{
"success": false,
"message": "<string>",
"error_code": "NOT_FOUND",
"errors": {}
}List products.
One call returns up to 250 products and, with include=variants, every variant’s price, compare-at price, SKU and stock, so a bulk read costs one request against your rate limit. Money is a decimal string in the store currency ("19.99"). Paginate with page_info (cursor, recommended): follow meta.next_page_info or the Link header. When page_info is set, only limit, fields and include may accompany it; the filters travel inside the cursor. page selects legacy offset pagination. Unknown query parameters return 400.
curl --request GET \
--url https://api.platformdtc.com/api/v1/agent/v1/products \
--header 'X-Agent-Key: <api-key>'import requests
url = "https://api.platformdtc.com/api/v1/agent/v1/products"
headers = {"X-Agent-Key": "<api-key>"}
response = requests.get(url, headers=headers)
print(response.text)const options = {method: 'GET', headers: {'X-Agent-Key': '<api-key>'}};
fetch('https://api.platformdtc.com/api/v1/agent/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://api.platformdtc.com/api/v1/agent/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-Agent-Key: <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://api.platformdtc.com/api/v1/agent/v1/products"
req, _ := http.NewRequest("GET", url, nil)
req.Header.Add("X-Agent-Key", "<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://api.platformdtc.com/api/v1/agent/v1/products")
.header("X-Agent-Key", "<api-key>")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.platformdtc.com/api/v1/agent/v1/products")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Get.new(url)
request["X-Agent-Key"] = '<api-key>'
response = http.request(request)
puts response.read_body{
"success": true,
"message": "<string>",
"data": {
"data": [
{
"id": "<string>",
"store_id": "<string>",
"title": "<string>",
"handle": "<string>",
"product_type": "<string>",
"vendor": "<string>",
"tags": [
"<string>"
],
"options": [
"<string>"
],
"status": 0,
"status_label": "draft",
"price": "19.99",
"currency": "USD",
"image_url": "<string>",
"images": [
{
"id": "<string>",
"url": "<string>",
"width": "<string>",
"height": "<string>"
}
],
"link": "<string>",
"template_suffix": "<string>",
"is_published": true,
"variants_count": 123,
"created_at": "2023-11-07T05:31:56Z",
"updated_at": "2023-11-07T05:31:56Z",
"variants": [
{
"id": "<string>",
"product_id": "<string>",
"title": "<string>",
"sku": "<string>",
"price": "19.99",
"compare_at_price": "19.99",
"option1": "<string>",
"option2": "<string>",
"option3": "<string>",
"position": 123,
"weight": 123,
"weight_unit": "<string>",
"image_url": "<string>",
"inventory_quantity": 123,
"inventory_tracked": true,
"inventory_policy": "continue",
"created_at": "2023-11-07T05:31:56Z"
}
],
"description": "<string>",
"category": "<string>"
}
],
"meta": {
"limit": 123,
"total": 123,
"page": 123,
"total_pages": 123,
"next_page_info": "<string>",
"previous_page_info": "<string>",
"has_next_page": true,
"has_previous_page": true
}
},
"meta": {}
}{
"success": false,
"message": "<string>",
"error_code": "NOT_FOUND",
"errors": {}
}{
"success": false,
"message": "<string>",
"error_code": "NOT_FOUND",
"errors": {}
}{
"success": false,
"message": "<string>",
"error_code": "NOT_FOUND",
"errors": {}
}Authorizations
Service-account key, format sq_agt_*. Carries least-privilege scopes.
Headers
Target store; required when the key is bound to multiple stores.
Query Parameters
1 <= x <= 250Opaque cursor from meta.next_page_info / meta.previous_page_info or the Link header.
Legacy offset pagination. Adds meta.page and meta.total_pages. Prefer page_info.
x >= 1Comma-separated: active, draft, archived.
"active,draft"
Comma-separated. A product matches if it has ANY of the tags (case-insensitive).
"sale,summer"
Only products in this collection (see GET /collections).
Case-insensitive substring match on title, handle or any variant SKU. Aliases: q, search.
Comma-separated product ids, at most 250.
<updated_at|created_at|title|id> <asc|desc>.
"id asc"
Comma-separated top-level fields to return. Including variants embeds variants.
"id,title,status,variants"
variants embeds each product's variants.
variants