Shopify

Get Shopify store

Get a Shopify store's identity, brand, market, payment settings, policy summary and agent-commerce capabilities.

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

API key (`sfk_...`)

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

countrystringoptionalquery

ISO 3166-1 alpha-2 country used for prices, currency and language, e.g. `GB`. Default: the store's own market.

Response fields
61

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

The store's identity and settings; null unless `found`.

datastoreid
integernullable

Numeric shop id.

datastoregid
stringnullable

The store's global shop id.

datastorename
stringnullable

Store name.

datastoredescription
stringnullable

Store description.

datastoredomain
stringnullable

The store's primary domain.

datastoreurl
stringnullable

The store's primary URL.

datastoremyshopifyDomain
stringnullable

The stable `<name>.myshopify.com` host.

datastorecurrency
stringnullable

Default currency.

datastoremoneyFormat
stringnullable

Money format string.

datastorecountry
stringnullable

Country code.

The business location the merchant published.

datastoreaddresscity
stringnullable

City.

datastoreaddressprovince
stringnullable

Province or state.

datastoreaddresscountry
stringnullable

Country code.

Published catalogue counts.

datastorecountsproducts
integernullable

Published products.

datastorecountscollections
integernullable

Published collections.

Countries the store ships to; `*` means the rest of the world.

datastoreshipsToCountries[]
stringoptional

Payment settings the storefront publishes.

Accepted card brands.

datastorepaymentcardBrands[]
stringoptional

Supported digital wallets.

datastorepaymentdigitalWallets[]
stringoptional

Currencies the store can present.

datastorepaymentpresentmentCurrencies[]
stringoptional
datastorepaymentshopPayInstallments
booleannullable

Whether Shop Pay instalments are offered.

Brand assets.

datastorebrandlogoUrl
stringnullable

Brand logo URL.

datastorebrandslogan
stringnullable

Slogan.

datastorebrandshortDescription
stringnullable

Short description.

The market this request reads.

datastoremarketcountry
stringnullable

Market country code.

datastoremarketcountryName
stringnullable

Market country name.

datastoremarketlanguage
stringnullable

Language code.

datastoremarketlanguageName
stringnullable

Language name.

Countries the store sells to.

datastoremarkets[]code
string

Country code.

datastoremarkets[]name
string

Country name.

Languages the store offers.

datastorelanguages[]code
string

Language code.

datastorelanguages[]endonym
string

The language's own name.

Policies the store has.

datastorepolicies[]type
string

Policy kind.

one of: privacy, refund, shipping, terms_of_service, terms_of_sale, subscription, contact, legal_notice

datastorepolicies[]title
stringnullable

Title.

datastorepolicies[]url
stringnullable

Policy URL.

The store's agent-commerce manifest summary; null when it publishes none.

datastoreagentCommerceversion
string

Manifest protocol version.

Other protocol versions the store publishes.

datastoreagentCommercesupportedVersions[]
stringoptional

Capability names the store advertises.

datastoreagentCommercecapabilities[]
stringoptional

Transport names the store advertises.

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

Responses

Shopify store identity and settings.