Shopify

Get several Shopify products

Get up to 25 Shopify products by handle in one call.

GET/v1/shopify/products/batch
x-api-keystringheader

API key (`sfk_...`)

Parameters
4
storestringrequiredquery

The store's domain, for example `allbirds.com`, `www.allbirds.com` or `weareallbirds.myshopify.com`. A full URL is accepted and reduced to its host. Only public storefront hosts are accepted.

handlesarrayrequiredquery

Product handles, comma-separated, 1 to 25. Duplicates are dropped and order is kept.

countrystringoptionalquery

ISO 3166-1 alpha-2 country used for prices, currency and language, e.g. `GB`. Default: the store's own market.

languagestringoptionalquery

Two-letter language code, e.g. `EN`. Default: the store's own language.

Response fields
50

Endpoint-specific response payload.

datalookupStatus
string

`found` on success; `not_found` when it does not exist or is not a Shopify store; `private` when the storefront is password-protected; `restricted` when the store is paused or frozen.

one of: found, not_found, private, restricted

datastore
string

The store host that was requested.

One entry per requested handle, in request order.

dataresults[]handle
string

The requested handle.

dataresults[]lookupStatus
string

Whether that handle resolved.

one of: found, not_found

The product when found; null otherwise.

dataresults[]productid
string

Numeric product id as a string.

dataresults[]productgid
stringnullable

The store's global product id; null when the store does not publish it for this row.

dataresults[]producthandle
string

Product handle.

dataresults[]producturl
stringnullable

Product page URL.

dataresults[]producttitle
string

Product title.

dataresults[]productvendor
stringnullable

Vendor.

dataresults[]productproductType
stringnullable

Product type.

Tags.

dataresults[]producttags[]
stringoptional
dataresults[]productavailableForSale
booleannullable

Whether any variant is available.

dataresults[]productupdatedAt
stringnullable

Last update, ISO 8601 UTC.

Lowest and highest variant price.

An amount and its currency.

dataresults[]productpriceRangeminamount
numbernullable

The amount as a decimal number.

dataresults[]productpriceRangemincurrency
stringnullable

ISO 4217 currency code, e.g. `USD`.

An amount and its currency.

dataresults[]productpriceRangemaxamount
numbernullable

The amount as a decimal number.

dataresults[]productpriceRangemaxcurrency
stringnullable

ISO 4217 currency code, e.g. `USD`.

Lowest and highest compare-at price.

An amount and its currency.

dataresults[]productcompareAtPriceRangeminamount
numbernullable

The amount as a decimal number.

dataresults[]productcompareAtPriceRangemincurrency
stringnullable

ISO 4217 currency code, e.g. `USD`.

An amount and its currency.

dataresults[]productcompareAtPriceRangemaxamount
numbernullable

The amount as a decimal number.

dataresults[]productcompareAtPriceRangemaxcurrency
stringnullable

ISO 4217 currency code, e.g. `USD`.

The main image; null when the product has none.

dataresults[]productfeaturedImageid
stringnullable

Image id; null when the store does not publish it for this row.

dataresults[]productfeaturedImageurl
stringnullable

Image URL.

dataresults[]productfeaturedImagealtText
stringnullable

Alt text the merchant set.

dataresults[]productfeaturedImagewidth
integernullable

Pixel width.

dataresults[]productfeaturedImageheight
integernullable

Pixel height.

Variants the image belongs to; empty when not given.

dataresults[]productfeaturedImagevariantIds[]
stringoptional

Counts for this batch.

datasummaryrequested
integer

Handles requested.

datasummaryfound
integer

Handles that resolved.

datasummarynotFound
integer

Handles that did not.

Notes about the answer, e.g. a requested market the store does not price in and the market it used instead.

datawarnings[]
stringoptional

Metadata describing the request and billing outcome.

metarequestId
string

Unique request identifier for tracing this API call.

min 1 chars

metacreditsCharged
integer

Credits charged for this request.

≥ 0

metaversion
string

Public API version that served the response.

one of: v1

Code example

curl "https://api.socialfetch.dev/v1/shopify/products/batch?store=www.allbirds.com&handles=mens-wool-runners,mens-tree-runners" \
  -H "x-api-key: YOUR_API_KEY"

Responses

Shopify products by handle with a found and not-found summary.