Loading...

Getting started API MCP

Introduction

Overview
Architecture
Core concepts

Getting started

Accounts & organizations
Create a store
The admin
API keys & scopes
Authentication
Endpoints & environments

Guides

Content types & content sites
Themes, customizer & Liquid
Marketing & pixels
Webhooks
Multi-language (i18n)
Domains & SSL
Plans & entitlements
Media & uploads

MCP

Overview
Connect (Claude Code, Cursor…)
Tools reference
Skills (how they're served)

Playbooks

shop-core-rules
shop-builder
shop-redesign
shop-create-product
shop-create-content-type
shop-build-section
shop-content-site
shop-i18n
pexels-stock-images

API reference

Conventions
Explorer
Queries
Mutations
Types
Non-GraphQL endpoints

Query.campaignByFriendlyId

Resolve a campaign by its per-org friendly number.

ReturnsCampaign

Signature

campaignByFriendlyId(store_id, friendlyId):Campaign

Resolve a campaign by its per-org friendly number.

store_idID!
friendlyIdInt!

PreviousExplorer Next Mutations