Shopify

List Shopify store collections

List a Shopify store's collections with descriptions, images and SEO.

GET/v1/shopify/collections
1credit
x-api-keystringheader

API key (`sfk_...`)

Parameters
3
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.

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

Response fields
31

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.

Collections on this page.

datacollections[]id
string

Numeric collection id as a string.

datacollections[]gid
stringnullable

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

datacollections[]handle
string

Collection handle.

datacollections[]title
string

Collection title.

datacollections[]url
stringnullable

Collection page URL.

datacollections[]description
stringnullable

Description as plain text.

datacollections[]descriptionHtml
stringnullable

Description as HTML.

The merchant's meta tags.

datacollections[]seotitle
stringnullable

SEO title.

datacollections[]seodescription
stringnullable

SEO description.

Collection image; null when none.

datacollections[]imageid
stringnullable

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

datacollections[]imageurl
stringnullable

Image URL.

datacollections[]imagealtText
stringnullable

Alt text the merchant set.

datacollections[]imagewidth
integernullable

Pixel width.

datacollections[]imageheight
integernullable

Pixel height.

Variants the image belongs to; empty when not given.

datacollections[]imagevariantIds[]
stringoptional
datacollections[]updatedAt
stringnullable

Last update, ISO 8601 UTC.

datacollections[]productsCount
integernullable

Number of products; null when the store does not share it.

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.

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

Responses

Shopify collection summaries.