Shopify

List Shopify pickup availability

List per-variant pickup availability and location for one Shopify product.

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

API key (`sfk_...`)

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

limitintegeroptionalquery

Variants per page, 1 to 250. Default: 10.

≥ 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
18

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 product handle that was requested.

Pickup availability by variant and location.

datavariants[]variantId
stringnullable

Variant id; null when the store's answer omits it.

datavariants[]variantTitle
stringnullable

Variant title.

Locations with pickup availability for this variant.

datavariants[]locations[]name
stringnullable

Location name.

datavariants[]locations[]available
booleannullable

Available for pickup.

datavariants[]locations[]pickUpTime
stringnullable

Pickup time as the store words 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/products/mens-wool-runners/availability?store=www.allbirds.com" \
  -H "x-api-key: YOUR_API_KEY"

Responses

Per-variant pickup availability and location.