Shopify

Get Shopify article

Get one Shopify article by handle, with its comments.

GET/v1/shopify/blogs/{blogHandle}/articles/{handle}
1credit
x-api-keystringheader

API key (`sfk_...`)

Parameters
5
blogHandlestringrequiredpath

The blog handle, as it appears in its URL, e.g. `news`.

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

handlestringrequiredpath

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

commentLimitintegeroptionalquery

Comments 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
43

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.

datablogHandle
string

The blog handle that was requested.

datahandle
string

The article handle that was requested.

The article when found; null otherwise.

dataarticleid
string

Numeric article id as a string.

dataarticlegid
stringnullable

The store's global article id.

dataarticlehandle
string

Article handle.

dataarticletitle
string

Article title.

dataarticleurl
stringnullable

Article URL.

dataarticleexcerpt
stringnullable

Excerpt as plain text.

dataarticlecontent
stringnullable

Article text as plain text.

dataarticlecontentHtml
stringnullable

Article text as HTML.

dataarticlepublishedAt
stringnullable

Published, ISO 8601 UTC.

Tags.

dataarticletags[]
stringoptional

The merchant's meta tags.

dataarticleseotitle
stringnullable

SEO title.

dataarticleseodescription
stringnullable

SEO description.

Who wrote it.

dataarticleauthorname
stringnullable

Author display name.

dataarticleauthorbio
stringnullable

Author bio.

Article image; null when none.

dataarticleimageid
stringnullable

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

dataarticleimageurl
stringnullable

Image URL.

dataarticleimagealtText
stringnullable

Alt text the merchant set.

dataarticleimagewidth
integernullable

Pixel width.

dataarticleimageheight
integernullable

Pixel height.

Variants the image belongs to; empty when not given.

dataarticleimagevariantIds[]
stringoptional

Moderated comments on the article, up to the page size.

dataarticlecomments[]id
string

Comment id.

dataarticlecomments[]body
stringnullable

Comment text.

dataarticlecomments[]author
stringnullable

The commenter's display name.

dataarticlecommentsHasMore
boolean

Whether the store has more comments than this page.

Pagination state for the article's comments.

datacommentsPagehasMore
boolean

Whether another page is available.

datacommentsPagenextCursor
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/blogs/news/articles/allbirds-uber-eats-press-release?store=www.allbirds.com" \
  -H "x-api-key: YOUR_API_KEY"

Responses

One Shopify article with its comments.