gid://shopify/p/exampleChair · Natural oakOne API, three calls
Search millions of merchants, show any product in full,
and get current prices for products you found anywhere else.
and get current prices for products you found anywhere else.
Find products by keyword, image or both. Filter by price, rating, color, gender, shipping and more.
$ shop search 'oak chair' --price-max 25000 --currency USD --ships-to US$ shop search 'oak chair' \ --price-max 25000 --currency USD --ships-to US
{ "products": [ { "title": "Matilda Chair", "description": { "plain": "Solid oak dining chair with a curved…" }, "rating": { "value": 4.7, "count": 58 }, "price_range": { "min": { "amount": 20000, "currency": "USD" }, "max": { … } }, "variants": [ { "seller": { "name": "VNTI" }, "price": { "amount": 20000, … }, "availability": { "available": true } } ] }, … ]}{ "products": [ { "title": "Matilda Chair", "description": { "plain": "Solid…" }, "rating": { "value": 4.7, … }, "price_range": { "min": { "amount": 20000, … }, … }, "variants": [ … ] }, … ]}
Get one product’s description, options, images and ratings, plus the price at each store that sells it.
$ shop catalog get '<product-id>' --select 'Color=Natural oak'$ shop catalog get '<product-id>' \ --select 'Color=Natural oak'
{ "product": { "title": "Matilda Chair", "description": { "plain": "Solid oak dining chair with a curved…" }, "rating": { "value": 4.7, "count": 58 }, "options": [ { "name": "Color", "values": [ { "label": "Natural oak", … }, … ] } ], "media": [ { "type": "image", "url": "https://cdn.shopify.com/…" } ], "variants": [ { "seller": { "name": "VNTI" }, "price": { "amount": 20000, … }, "availability": { "available": true } }, { "seller": { "name": "Kiln & Co." }, "price": { "amount": 21500, … }, "availability": { "available": true } } ] }}{ "product": { "title": "Matilda Chair", "description": { "plain": "Solid…" }, "rating": { "value": 4.7, "count": 58 }, "options": [ { "name": "Color", … } ], "media": [ { "type": "image", … } ], "variants": [ { "seller": { "name": "VNTI" } }, { "seller": { "name": "Kiln & Co." } } ] }}
Turn up to 50 product links or IDs from around the web, like reviews or YouTube, into current price, inventory, images and a checkout link.
$ shop catalog lookup '<link>' '<link>' --ships-to US$ shop catalog lookup '<link>' \ '<link>' --ships-to US
{ "products": [ { "title": "Matilda Chair", "price_range": { "min": { "amount": 20000, "currency": "USD" }, "max": { … } }, "variants": [ { "seller": { "name": "VNTI" }, "price": { "amount": 20000, … }, "availability": { "available": true } }, { "seller": { "name": "Kiln & Co." }, "price": { "amount": 21500, … }, "availability": { "available": true } } ] }, … ]}{ "products": [ { "title": "Matilda Chair", "price_range": { "min": { … }, … }, "variants": [ { "seller": { "name": "VNTI" }, … }, … ] }, … ]}
