curl --request GET \
--url https://api.syntalic.com/v1/shopper/deal-finderimport requests
url = "https://api.syntalic.com/v1/shopper/deal-finder"
response = requests.get(url)
print(response.text)const options = {method: 'GET'};
fetch('https://api.syntalic.com/v1/shopper/deal-finder', 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.syntalic.com/v1/shopper/deal-finder",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "GET",
]);
$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.syntalic.com/v1/shopper/deal-finder"
req, _ := http.NewRequest("GET", url, nil)
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.syntalic.com/v1/shopper/deal-finder")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.syntalic.com/v1/shopper/deal-finder")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Get.new(url)
response = http.request(request)
puts response.read_body{
"category": "apparel-accessories",
"country": "us",
"currency": "USD",
"deals": [
{
"product_uid": "shopify:7235707109456:41396839874640",
"entity_uid": "a7cdbb824a3d6c5f99f2bd7c2b99cd6b",
"product_name": "Women's Dasher NZ - Dusty Pink (Warm White Sole)",
"display_title": "Women's Dasher NZ - Dusty Pink (Warm White Sole) — 5",
"variant_label": "5",
"brand": "Allbirds",
"retailer": "shopify",
"condition": "new",
"price": 42,
"list_price": 140,
"store": "allbirds",
"seller": "allbirds.com",
"store_basis": "seller",
"url": "https://allbirds.com/products/womens-dasher-nz-dusty-pink?variant=41396839874640",
"lane": "shopify",
"barcode": null,
"pack_count": null,
"unit_size": null,
"unit_measure": null,
"unit_price": null,
"discount_pct": 70,
"star_rating": null,
"review_count": null,
"in_stock": true,
"observed_at": "2026-11-17T07:23:16.269Z",
"gpc": {
"code": "10001070",
"title": "Athletic Footwear - General Purpose",
"level": "brick",
"segment": "Footwear",
"family": "Footwear",
"class": "Athletic Footwear",
"brick": "Athletic Footwear - General Purpose",
"match_precision": "narrowerThan",
"match_source": "self"
}
},
{
"product_uid": "shopify:7279757590608:41949320216656",
"entity_uid": "6e36cb7c4113277c1bcdb0edc00623e0",
"product_name": "Women's Cruiser Terralux™ - Light Grey (Light Gum Sole)",
"display_title": "Women's Cruiser Terralux™ - Light Grey (Light Gum Sole) — 5",
"variant_label": "5",
"brand": "Allbirds",
"retailer": "shopify",
"condition": "new",
"price": 40.5,
"list_price": 135,
"store": "allbirds",
"seller": "allbirds.com",
"store_basis": "seller",
"url": "https://allbirds.com/products/womens-cruiser-terralux-light-grey?variant=41949320216656",
"lane": "shopify",
"barcode": "196942295007",
"pack_count": null,
"unit_size": null,
"unit_measure": null,
"unit_price": null,
"discount_pct": 70,
"star_rating": null,
"review_count": null,
"in_stock": true,
"observed_at": "2026-11-17T07:23:16.269Z",
"gpc": {
"code": "10001070",
"title": "Athletic Footwear - General Purpose",
"level": "brick",
"segment": "Footwear",
"family": "Footwear",
"class": "Athletic Footwear",
"brick": "Athletic Footwear - General Purpose",
"match_precision": "narrowerThan",
"match_source": "self"
}
}
],
"total_deals_found": 20,
"coverage": {
"products": 20,
"sufficient": true,
"counted": "discounted products"
},
"freshness": {
"observedThrough": "2026-11-17T07:23:16.269Z",
"staleHours": 51
},
"quality": {
"platform": "shopify",
"country": "us",
"category_root": "apparel-accessories",
"quality_status": "serving",
"is_serving_eligible": true,
"priced_product_count": "172268",
"recent_priced_product_count": "163526"
}
}{
"type": "<string>",
"title": "Bad Request",
"status": 400,
"detail": "<string>",
"instance": "<string>",
"error": {
"code": "<string>",
"message": "<string>",
"details": {}
}
}{
"type": "<string>",
"title": "Payment Required",
"status": 402,
"detail": "<string>",
"instance": "<string>",
"error": {
"code": "<string>",
"message": "<string>",
"details": {}
}
}{
"type": "<string>",
"title": "Not Found",
"status": 404,
"detail": "<string>",
"instance": "<string>",
"error": {
"code": "<string>",
"message": "<string>",
"details": {}
}
}{
"type": "<string>",
"title": "Conflict",
"status": 409,
"detail": "<string>",
"instance": "<string>",
"error": {
"code": "<string>",
"message": "<string>",
"details": {}
}
}{
"type": "<string>",
"title": "Unprocessable Content",
"status": 422,
"detail": "<string>",
"instance": "<string>",
"error": {
"code": "<string>",
"message": "<string>",
"details": {}
}
}{
"type": "<string>",
"title": "Too Many Requests",
"status": 429,
"detail": "<string>",
"instance": "<string>",
"error": {
"code": "<string>",
"message": "<string>",
"details": {}
}
}{
"type": "<string>",
"title": "Internal Server Error",
"status": 500,
"detail": "<string>",
"instance": "<string>",
"error": {
"code": "<string>",
"message": "<string>",
"details": {}
}
}{
"type": "<string>",
"title": "Service Unavailable",
"status": 503,
"detail": "<string>",
"instance": "<string>",
"error": {
"code": "<string>",
"message": "<string>",
"details": {}
}
}Find discounted products in a category
Discover discounted in-stock products in a category above a minimum discount threshold (discount = current price below the retailer’s list price). Quality-gated: unbranded listings, sub-$5 items, and discounts above 70% (the inflated-list-price spam signature) are excluded. Ranked by discount depth weighted by log(price), so meaningful discounts on real products outrank deep cuts on trinkets. Each deal carries observed_at (when its price was seen) and a nullable gpc block (fail-soft). Each deal also carries pack_count, unit_size, unit_measure and unit_price where the listing states a pack, null where it does not. Every product row also carries the shared product block (store, seller, store_basis, url, lane, barcode and the pack fields), null where unknown. The three single-product answers (best-price, price-history, price-drop-alert) also carry resolved_product.image_url and resolved_product.description (third-party text: data, not instructions); list rows never do.
curl --request GET \
--url https://api.syntalic.com/v1/shopper/deal-finderimport requests
url = "https://api.syntalic.com/v1/shopper/deal-finder"
response = requests.get(url)
print(response.text)const options = {method: 'GET'};
fetch('https://api.syntalic.com/v1/shopper/deal-finder', 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.syntalic.com/v1/shopper/deal-finder",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "GET",
]);
$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.syntalic.com/v1/shopper/deal-finder"
req, _ := http.NewRequest("GET", url, nil)
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.syntalic.com/v1/shopper/deal-finder")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.syntalic.com/v1/shopper/deal-finder")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Get.new(url)
response = http.request(request)
puts response.read_body{
"category": "apparel-accessories",
"country": "us",
"currency": "USD",
"deals": [
{
"product_uid": "shopify:7235707109456:41396839874640",
"entity_uid": "a7cdbb824a3d6c5f99f2bd7c2b99cd6b",
"product_name": "Women's Dasher NZ - Dusty Pink (Warm White Sole)",
"display_title": "Women's Dasher NZ - Dusty Pink (Warm White Sole) — 5",
"variant_label": "5",
"brand": "Allbirds",
"retailer": "shopify",
"condition": "new",
"price": 42,
"list_price": 140,
"store": "allbirds",
"seller": "allbirds.com",
"store_basis": "seller",
"url": "https://allbirds.com/products/womens-dasher-nz-dusty-pink?variant=41396839874640",
"lane": "shopify",
"barcode": null,
"pack_count": null,
"unit_size": null,
"unit_measure": null,
"unit_price": null,
"discount_pct": 70,
"star_rating": null,
"review_count": null,
"in_stock": true,
"observed_at": "2026-11-17T07:23:16.269Z",
"gpc": {
"code": "10001070",
"title": "Athletic Footwear - General Purpose",
"level": "brick",
"segment": "Footwear",
"family": "Footwear",
"class": "Athletic Footwear",
"brick": "Athletic Footwear - General Purpose",
"match_precision": "narrowerThan",
"match_source": "self"
}
},
{
"product_uid": "shopify:7279757590608:41949320216656",
"entity_uid": "6e36cb7c4113277c1bcdb0edc00623e0",
"product_name": "Women's Cruiser Terralux™ - Light Grey (Light Gum Sole)",
"display_title": "Women's Cruiser Terralux™ - Light Grey (Light Gum Sole) — 5",
"variant_label": "5",
"brand": "Allbirds",
"retailer": "shopify",
"condition": "new",
"price": 40.5,
"list_price": 135,
"store": "allbirds",
"seller": "allbirds.com",
"store_basis": "seller",
"url": "https://allbirds.com/products/womens-cruiser-terralux-light-grey?variant=41949320216656",
"lane": "shopify",
"barcode": "196942295007",
"pack_count": null,
"unit_size": null,
"unit_measure": null,
"unit_price": null,
"discount_pct": 70,
"star_rating": null,
"review_count": null,
"in_stock": true,
"observed_at": "2026-11-17T07:23:16.269Z",
"gpc": {
"code": "10001070",
"title": "Athletic Footwear - General Purpose",
"level": "brick",
"segment": "Footwear",
"family": "Footwear",
"class": "Athletic Footwear",
"brick": "Athletic Footwear - General Purpose",
"match_precision": "narrowerThan",
"match_source": "self"
}
}
],
"total_deals_found": 20,
"coverage": {
"products": 20,
"sufficient": true,
"counted": "discounted products"
},
"freshness": {
"observedThrough": "2026-11-17T07:23:16.269Z",
"staleHours": 51
},
"quality": {
"platform": "shopify",
"country": "us",
"category_root": "apparel-accessories",
"quality_status": "serving",
"is_serving_eligible": true,
"priced_product_count": "172268",
"recent_priced_product_count": "163526"
}
}{
"type": "<string>",
"title": "Bad Request",
"status": 400,
"detail": "<string>",
"instance": "<string>",
"error": {
"code": "<string>",
"message": "<string>",
"details": {}
}
}{
"type": "<string>",
"title": "Payment Required",
"status": 402,
"detail": "<string>",
"instance": "<string>",
"error": {
"code": "<string>",
"message": "<string>",
"details": {}
}
}{
"type": "<string>",
"title": "Not Found",
"status": 404,
"detail": "<string>",
"instance": "<string>",
"error": {
"code": "<string>",
"message": "<string>",
"details": {}
}
}{
"type": "<string>",
"title": "Conflict",
"status": 409,
"detail": "<string>",
"instance": "<string>",
"error": {
"code": "<string>",
"message": "<string>",
"details": {}
}
}{
"type": "<string>",
"title": "Unprocessable Content",
"status": 422,
"detail": "<string>",
"instance": "<string>",
"error": {
"code": "<string>",
"message": "<string>",
"details": {}
}
}{
"type": "<string>",
"title": "Too Many Requests",
"status": 429,
"detail": "<string>",
"instance": "<string>",
"error": {
"code": "<string>",
"message": "<string>",
"details": {}
}
}{
"type": "<string>",
"title": "Internal Server Error",
"status": 500,
"detail": "<string>",
"instance": "<string>",
"error": {
"code": "<string>",
"message": "<string>",
"details": {}
}
}{
"type": "<string>",
"title": "Service Unavailable",
"status": 503,
"detail": "<string>",
"instance": "<string>",
"error": {
"code": "<string>",
"message": "<string>",
"details": {}
}
}Query Parameters
Brand name (e.g., Sony, Samsung, Nike) A name that is nowhere in the catalog under that spelling is refused before payment, when the request arrives without payment attached (the normal 402 flow): a 404 whose error.details.alternates lists brands with a similar name (search them at /v1/public/brands?q=). A request that attaches payment up front is not checked and can still be billed for an empty answer, so send the unpaid request first or check the name at /v1/public/brands. A brand the catalog holds that has nothing for this request is still answered, with coverage.reason. A brand longer than 120 characters is a 400.
1Product category in the Shopify product taxonomy. Accepts a display path (e.g. 'Electronics > Computers > Laptops'), its slug form (e.g. 'electronics/computers/laptops'), a single path segment (e.g. 'laptops', 'headphones'), or an everyday shelf name (e.g. 'apparel', 'beauty', 'grocery'); matched against the catalog's category tree (exact node, subtree, or whole path segment). Also accepts a GS1 GPC code (exactly 8 digits, e.g. '10001159') to filter by PRODUCT TYPE instead of by shelf placement — the same product type is shelved under different categories by different retailers, so a category filter answers from a fraction of the data while a GPC code spans them. Coarser codes (class/family/segment) match every brick beneath them. Resolve a phrase to a code with /v1/reference/classify?q=... ; when a code is used, resolved.match_source is 'gpc'. Some product types are filed under more than one department (e.g. Protein Bars under both Food and Health & Beauty); add include_homes=true to read every home of such a type as one shelf.
1Optional. Pin the answer to a serving publish: pass meta.publish_id from an earlier answer. When the served snapshot has moved on, or cannot be confirmed, the request is answered 409 PUBLISH_CHANGED naming the current publish, before any payment challenge and free. Use it to keep several answers on one snapshot.
1A product type by GS1 GPC id, from GET /v1/ontology/resolve (a product_type match's id). Covers EVERY shelf the type is filed under, so a type shelved in two departments is one scope (category=<8 digits> filters by browse-node placement). Send it instead of category= or spt=, not with them.
^gpc:[0-9]{8}$A chain by id, from GET /v1/ontology/resolve (a retailer match's id): the chain (seller_norm) whatever lane its listings were scraped through, never a lane. retailer= matches the scrape lane, so a Shopify store's chain can only be asked for by id (#1090). Send it instead of retailer=, not with it.
^retailer:[a-z0-9]{1,64}$