V2

Shopify

Provides integration with Shopify using the Admin GraphQL API for storefront and back-office operations such as managing products, inventory, orders, and customers. Supports schema-driven templates after running metadata acquisition and handles cursor-based pagination automatically.

Revision History

1.0.0.7 - 2025/12/02 - Initial release.
1.0.0.10 - 2026/01/21 - Changed template key format for AI system.
0.0.0.12 - Node name correction.

Setup Notes

  • Create a private or custom app in Shopify and generate an Admin API access token with the required scopes for your operations (for example: products, inventory, orders).
  • Ensure the API version matches your store configuration; omit to use latest or set an explicit version (for example: 2025-01).
  • Run Acquire Metadata on the connection to cache the GraphQL schema used for templates and variable validation.
  • For custom proxying scenarios, enable Use Custom Endpoint and provide the full GraphQL URL; otherwise the Admin endpoint is built from the shop URL and API version.

Connection

Parameter Type Description
Shop URL String Shopify store URL or domain (for example: mystore.myshopify.com).
Access Token Masked Admin API access token for the store.
API Version String Admin API version to target (for example: 2025-01); defaults to latest when omitted.
Use Custom Endpoint Boolean When true, calls the GraphQL endpoint specified in Custom Endpoint instead of the default.
Custom Endpoint String Full GraphQL endpoint URL used when Use Custom Endpoint is enabled.
Schema Object Cached GraphQL schema populated by Acquire Metadata (read-only in the designer).

Functions

Query

Executes a Shopify Admin GraphQL query. Templates are available after schema acquisition; pagination is automatically followed when pageInfo.hasNextPage/endCursor are present.

Parameter Type Notes
Connection Connection Shopify connection containing store URL, access token, and cached schema.
Query String GraphQL query document. Template selection auto-populates the query for supported operations.
Body IAsyncEnumerable<object?> Optional stream containing a single variables payload; omit when no variables are required.
Return Type Notes
Response IAsyncEnumerable Aggregated GraphQL response including data and errors; automatically paginates using cursor metadata.

Mutation

Executes a Shopify Admin GraphQL mutation with optional variables.

Parameter Type Notes
Connection Connection Shopify connection containing store URL, access token, and cached schema.
Query String GraphQL mutation document. Template selection auto-populates the mutation for supported actions.
Body IAsyncEnumerable<object?> Optional stream containing a single variables payload; omit when no variables are required.
Return Type Notes
Response IAsyncEnumerable GraphQL response including data and errors; pagination is applied when the response supplies cursors.

Usage Notes

  • Run Acquire Metadata on the connection to cache the schema before using templates or relying on variable validation.
  • For paginated queries, the node follows cursors and merges pages; avoid reusing cursors from previous runs to prevent loops.
  • Handle throttling by inspecting errors for rate limit messages and reducing request frequency or payload size.

Known Issues

  • GraphQL introspection requires unauthenticated_read_product_listings or similar permissions; run Acquire Metadata on the connection before using templates.
  • Shopify Admin API rate limits apply; consider batching variable sets and monitoring errors for throttling responses.