Shopify

Get Shopify product recommendations

Get the products a Shopify store recommends beside one product, related or complementary.

GET/v1/shopify/products/{handle}/recommendations
1credit
x-api-keystringheader

API key (`sfk_...`)

Parameters
5
handlestringrequiredpath

The product handle, as it appears in its URL.

min 1 chars · max 255 chars · pattern: ^[^\s/?#]+$

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.

intentstringoptionalquery

`related` (default) or `complementary`.

one of: related, complementary

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
45

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.

datahandle
string

The requested product handle.

dataintent
string

The recommendation intent of this result.

one of: related, complementary

Recommended products.

dataproducts[]id
string

Numeric product id as a string.

dataproducts[]gid
stringnullable

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

dataproducts[]handle
string

Product handle.

dataproducts[]url
stringnullable

Product page URL.

dataproducts[]title
string

Product title.

dataproducts[]vendor
stringnullable

Vendor.

dataproducts[]productType
stringnullable

Product type.

Tags.

dataproducts[]tags[]
stringoptional
dataproducts[]availableForSale
booleannullable

Whether any variant is available.

dataproducts[]updatedAt
stringnullable

Last update, ISO 8601 UTC.

Lowest and highest variant price.

An amount and its currency.

dataproducts[]priceRangeminamount
numbernullable

The amount as a decimal number.

dataproducts[]priceRangemincurrency
stringnullable

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

An amount and its currency.

dataproducts[]priceRangemaxamount
numbernullable

The amount as a decimal number.

dataproducts[]priceRangemaxcurrency
stringnullable

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

Lowest and highest compare-at price.

An amount and its currency.

dataproducts[]compareAtPriceRangeminamount
numbernullable

The amount as a decimal number.

dataproducts[]compareAtPriceRangemincurrency
stringnullable

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

An amount and its currency.

dataproducts[]compareAtPriceRangemaxamount
numbernullable

The amount as a decimal number.

dataproducts[]compareAtPriceRangemaxcurrency
stringnullable

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

The main image; null when the product has none.

dataproducts[]featuredImageid
stringnullable

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

dataproducts[]featuredImageurl
stringnullable

Image URL.

dataproducts[]featuredImagealtText
stringnullable

Alt text the merchant set.

dataproducts[]featuredImagewidth
integernullable

Pixel width.

dataproducts[]featuredImageheight
integernullable

Pixel height.

Variants the image belongs to; empty when not given.

dataproducts[]featuredImagevariantIds[]
stringoptional

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/mens-wool-runners/recommendations?store=www.allbirds.com" \
  -H "x-api-key: YOUR_API_KEY"

Responses

Products the store recommends beside one product.