Shopify

Get Shopify product metafields

Get merchant-exposed metafields for one Shopify product.

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

API key (`sfk_...`)

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

keysarrayoptionalquery

Metafield keys as `namespace.key`, comma-separated, up to 25. Defaults are `reviews.rating`, `reviews.rating_count`, `shopify.color-pattern`, `global.title_tag`, `global.description_tag` and `custom.color`.

Response fields
14

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.

datametafieldsAvailable
boolean

False when the store did not make metafields available for this request, so they are empty for that reason.

Metafields the merchant exposes, in requested-key order.

datametafields[]namespace
string

Namespace.

datametafields[]key
string

Key.

datametafields[]type
string

Metafield type.

datametafields[]value
string

Raw value as the store stores it.

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

Responses

Merchant-exposed product metafields.