Learn Shopify API

`learn_shopify_api`

Loads getting-started context for a Shopify API — the schema shape, core objects, and conventions — so your AI client builds valid Shopify operations instead of guessing at field names. It also mints a conversationId that threads through the two other documentation tools (search_docs_chunks and validate_graphql_codeblocks).

Call this first. Run learn_shopify_api before search_docs_chunks, validate_graphql_codeblocks, or shopify_admin_graphql. Pass the returned conversationId into search_docs_chunks and validate_graphql_codeblocks so they share the same API and version context. shopify_admin_graphql does not take a conversationId — set its API version explicitly with its own apiVersion parameter (see its page). For CDP brands the relevant API is admin.

Read-only — this loads documentation context and never touches your store.

Parameters

Name	Type	Required	Description	Default
`api`	`string`	Yes	Which Shopify API to load. Enum: `admin`, `storefront-graphql`, `functions`, `hydrogen`, `liquid`, and more. Use `admin` for CDP brand work.	—
`version`	`string`	No	Shopify API version to pin, `YYYY-MM` (e.g. `2026-04`). Omit to use the current stable version.	—
`conversationId`	`string`	No	Existing conversation id to continue. Omit on the first call — one is minted for you.	—
`model`	`string`	No	The model name consuming the context, or `none` if unknown.	—
`user_prompt`	`string`	No	Your latest prompt, verbatim when available, so the returned getting-started context is tailored to the task.	—

Returns

Getting-started context for the requested Shopify API — the objects, conventions, and entry points your client needs to write valid operations.
conversationId — thread this through search_docs_chunks and validate_graphql_codeblocks so those calls share the same API and version. shopify_admin_graphql does not accept a conversationId.

Example prompts

Load the Shopify Admin API docs so we can build a query

Get me started with the Shopify Admin API for version 2026-04

Notes

Always call this before the other Shopify tools. The two documentation tools (search_docs_chunks, validate_graphql_codeblocks) work best with the conversationId it returns; shopify_admin_graphql does not use a conversationId.
admin is the API CDP brands work with; the other enum values (storefront-graphql, functions, hydrogen, liquid, …) are for storefront and theme development.
Pinning version keeps the documentation tools consistent — pass the same version to validate_graphql_codeblocks. shopify_admin_graphql does not inherit that version: to execute against the same schema, pass it explicitly as that tool's apiVersion (which defaults to 2026-04).