Shopify

Get Shopify store menu

Try in Playground

Get one of a Shopify store's navigation menus, including nested items.

Try in Playground

GET/v1/shopify/store/menus/{handle}

1credit

Headers

Get your API key

x-api-keystringheader

API key (`sfk_...`)

Parameters

2

handlestringrequiredpath

The menu handle, as it appears in its URL, e.g. `main-menu`.

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.

Response fields

45

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

The menu when found; null otherwise.

datamenuid

string

Menu id.

datamenutitle

stringnullable

Menu title.

datamenuitemsCount

integernullable

Top-level item count.

datamenutruncated

boolean

True when nesting deeper than the API's three levels was cut.

Top-level items.

datamenuitems[]id

stringnullable

Menu item id.

datamenuitems[]title

string

Label.

datamenuitems[]type

string

`FRONTPAGE`, `COLLECTION`, `HTTP` and so on.

datamenuitems[]url

stringnullable

Destination URL.

datamenuitems[]resourceId

stringnullable

The page or collection it points at.

Tags.

datamenuitems[]tags[]

stringoptional

Nested items, up to the API's three levels.

datamenuitems[]items[]id

stringnullable

Menu item id.

datamenuitems[]items[]title

string

Label.

datamenuitems[]items[]type

string

`FRONTPAGE`, `COLLECTION`, `HTTP` and so on.

datamenuitems[]items[]url

stringnullable

Destination URL.

datamenuitems[]items[]resourceId

stringnullable

The page or collection it points at.

Tags.

datamenuitems[]items[]tags[]

stringoptional

Third-level items.

datamenuitems[]items[]items[]id

stringnullable

Menu item id.

datamenuitems[]items[]items[]title

string

Label.

datamenuitems[]items[]items[]type

string

`FRONTPAGE`, `COLLECTION`, `HTTP` and so on.

datamenuitems[]items[]items[]url

stringnullable

Destination URL.

datamenuitems[]items[]items[]resourceId

stringnullable

The page or collection it points at.

Tags.

datamenuitems[]items[]items[]tags[]

stringoptional

Items below this one; menus have at most three levels.

datamenuitems[]items[]items[]items[]id

stringnullable

Menu item id.

datamenuitems[]items[]items[]items[]title

string

Label.

datamenuitems[]items[]items[]items[]type

string

`FRONTPAGE`, `COLLECTION`, `HTTP` and so on.

datamenuitems[]items[]items[]items[]url

stringnullable

Destination URL.

datamenuitems[]items[]items[]items[]resourceId

stringnullable

The page or collection it points at.

Tags.

datamenuitems[]items[]items[]items[]tags[]

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

Responses

A Shopify navigation menu.

Locations

List a Shopify store's physical locations with address, coordinates and phone.

Redirects

List a Shopify store's URL redirect table.