Skip to main content
POST
/
store-data
/
{storeUrl}
/
shopify
/
graphql
Run a Shopify GraphQL operation
curl --request POST \
  --url https://app.bily.ai/api/customer/v1/store-data/{storeUrl}/shopify/graphql \
  --header 'Content-Type: application/json' \
  --header 'x-api-key: <api-key>' \
  --data '
{
  "query": "<string>"
}
'
const options = {
  method: 'POST',
  headers: {'x-api-key': '<api-key>', 'Content-Type': 'application/json'},
  body: JSON.stringify({query: '<string>'})
};

fetch('https://app.bily.ai/api/customer/v1/store-data/{storeUrl}/shopify/graphql', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));
import requests

url = "https://app.bily.ai/api/customer/v1/store-data/{storeUrl}/shopify/graphql"

payload = { "query": "<string>" }
headers = {
    "x-api-key": "<api-key>",
    "Content-Type": "application/json"
}

response = requests.post(url, json=payload, headers=headers)

print(response.text)
{
  "ok": true,
  "storeUrl": "<string>",
  "apiVersion": "<string>",
  "requestId": "<string>",
  "response": "<unknown>"
}
{
  "error": "Store not found",
  "requestId": "<string>",
  "details": "<unknown>",
  "retryAfter": "<string>"
}
{
  "error": "Store not found",
  "requestId": "<string>",
  "details": "<unknown>",
  "retryAfter": "<string>"
}
{
  "error": "Store not found",
  "requestId": "<string>",
  "details": "<unknown>",
  "retryAfter": "<string>"
}
{
  "error": "Store not found",
  "requestId": "<string>",
  "details": "<unknown>",
  "retryAfter": "<string>"
}
{
  "error": "Store not found",
  "requestId": "<string>",
  "details": "<unknown>",
  "retryAfter": "<string>"
}
{
  "error": "Store not found",
  "requestId": "<string>",
  "details": "<unknown>",
  "retryAfter": "<string>"
}

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.