Shopify

List Shopify collection products

List the products in a Shopify collection with filters, sorting and cursor paging.

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

API key (`sfk_...`)

Parameters
14
handlestringrequiredpath

The collection 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.

sortstringoptionalquery

`collection_default`, `best_selling`, `created`, `price` or `title`. A collection cannot be ordered by vendor or product type on Shopify; filter on them instead.

one of: collection_default, best_selling, created, price, title

reversebooleanoptionalquery

Reverse the sort order.

availablebooleanoptionalquery

Only products with an available variant.

priceMinnumberoptionalquery

Lowest price to include.

≥ 0 · ≤ 1000000000

priceMaxnumberoptionalquery

Highest price to include.

≥ 0 · ≤ 1000000000

productTypestringoptionalquery

Product type.

max 255 chars

vendorstringoptionalquery

The product vendor to filter by.

max 255 chars

tagstringoptionalquery

The product tag to filter by.

max 255 chars

limitintegeroptionalquery

Rows per page, 1 to 250. Default: 50.

≥ 1 · ≤ 250

cursorstringoptionalquery

Cursor from `page.nextCursor` of the previous response. It only works with the same filters.

min 1 chars · max 4096 chars

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
62

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.

The collection when found; null otherwise.

datacollectionid
string

Collection id.

datacollectionhandle
string

Collection handle.

datacollectiontitle
stringnullable

Collection title.

Products on this page.

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

The collection's filter facets.

datafilters[]id
string

Filter id.

datafilters[]label
string

Label.

datafilters[]type
string

`LIST`, `PRICE_RANGE` or `BOOLEAN`.

datafilters[]presentation
stringnullable

How the store presents it, e.g. `TEXT`.

Facet values.

datafilters[]values[]id
string

Filter value id.

datafilters[]values[]label
string

Label.

datafilters[]values[]count
integernullable

Matching products.

datafilters[]values[]input
stringnullable

The store's own filter input as JSON, e.g. `{"available":true}`.

Colour swatch where given.

datafilters[]values[]swatchcolor
stringnullable

Hex colour.

Pagination state for the current page.

datapagehasMore
boolean

Whether another page is available.

datapagenextCursor
stringnullable

Cursor for the next page; null on the last page.

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/collections/general-clothes-example-products/products?store=000000band.myshopify.com" \
  -H "x-api-key: YOUR_API_KEY"

Responses

Shopify collection products with filter facets.