Skip to main content
POST
Run a Shopify GraphQL operation

Authorizations

x-api-key
string
header
required

A server-side Bily API key created under Settings > MCP > Access key fallback. Select the intended store before creating it.

Headers

x-bily-organization-id
string

An organization ID returned by GET /context or GET /organizations. Required for GET /stores and optional for store-scoped paths.

Example:

"org_01J8W7T9G3E6ZQ4M2K5N8P1R0S"

Path Parameters

storeUrl
string
required

The exact store URL returned by GET /context or GET /stores.

Example:

"store.example.com"

Body

application/json
query
string
required

A GraphQL query. Mutations require allowMutation=true.

Maximum string length: 50000
variables
object
operationName
string
apiVersion
string

Optional commerce API version in YYYY-MM format or unstable.

Pattern: ^(?:\d{4}-\d{2}|unstable)$
includeCostDebug
boolean
default:false
allowMutation
boolean
default:false

Response

Request completed successfully.

ok
boolean
required
storeUrl
string
required
apiVersion
string
required
requestId
string | null
required
response
any
required

The commerce GraphQL response payload.