read

Run an arbitrary READ-ONLY Shopify Admin GraphQL query and get the raw data back — the Shopify analog of GAQL. Full Admi

Run an arbitrary READ-ONLY Shopify Admin GraphQL query and get the raw data back — the Shopify analog of GAQL. Full Admin API read surface: orders, customers, products, variants, inventory, fulfillments, metafields, discounts, draft orders, and more. Mutations are rejected (use the typed write tools). Fields the pinned Admin API version marks deprecated are refused, naming each field and its successor; rewrite and run again. Common ones: Market.enabled (use status), Market.primary, Market.regions (use conditions.regionConditions), Market.priceList (use catalogs), Customer.email (use defaultEmailAddress { emailAddress }), Customer.phone (use defaultPhoneNumber { phoneNumber }), productByHandle / collectionByHandle (use productByIdentifier / collectionByIdentifier(identifier: { handle })), Shop.billingAddress (use shopAddress). Example: "{ orders(first: 5, query: "financial_status:paid") { edges { node { id name totalPriceSet { shopMoney { amount } } } } } }". Queries the Shopify Admin GraphQL API, see https://shopify.dev/docs/api/admin-graphql

post/api/v1/tools/shopify_graphql_query

Request

  • Base URL: https://app.magistry.io
  • URL: https://app.magistry.io/api/v1/tools/shopify_graphql_query
  • Auth: one of:
    • HTTP bearer
    • OAuth 2 (authorization code, authorization URL https://app.magistry.io/api/oauth/authorize, token URL https://app.magistry.io/api/oauth/token, scopes: admin:read)

Request body

querystring required

A read-only Shopify Admin GraphQL query.

variablesobject

Optional GraphQL variables.

Response

Tool result

okboolean required
resultunknown required

Changes

No recorded changes to this operation across all 2 revisions of this API.