V2NodesShopify
Shopify
V2

Shopify

Provides integration with Shopify by using the Admin GraphQL API for products, inventory, orders, customers, and other store data.

Revision History

1.0.0.7 - Initial release.
1.0.0.10 - Updated template key handling.
0.0.0.12 - Corrected Node name.

Connection

The Connection stores the Shopify store details, access token, and cached GraphQL schema used for templates and validation.

Property Type Description
Shop URL String The Shopify store URL or domain, e.g. mystore.myshopify.com.
Access Token Masked The Admin API access token for the store.
API Version String The Admin API version to target. Leave this empty to use latest.
Use Custom Endpoint Boolean When true, the Node calls the GraphQL endpoint supplied in Custom Endpoint.
Custom Endpoint String The full GraphQL endpoint URL used when Use Custom Endpoint is enabled.
Schema Object The cached GraphQL schema populated by Acquire Metadata.

Setup Notes

  1. Create a private or custom app in Shopify, and then generate an Admin API access token with the scopes required for your operations.
  2. Set API Version when you want to target a specific Admin API version.
  3. Run Acquire Metadata on the Connection so Flowgear can cache the GraphQL schema used for templates and variable validation.
  4. Enable Use Custom Endpoint only when you need to override the standard Shopify Admin GraphQL endpoint.

Methods

The Shopify Node exposes one method for queries and one method for mutations.

Query

Executes a Shopify Admin GraphQL query.

Parameter Type Description
Connection Connection The Shopify Connection that contains the store settings and cached schema.
Query String The GraphQL query document. Templates populate this automatically for supported operations.
Body Array An optional stream containing a single variables payload. Leave this empty when the query does not require variables.
Return Type Description
Response Array The GraphQL response, including aggregated paged data and any returned errors.

Mutation

Executes a Shopify Admin GraphQL mutation.

Parameter Type Description
Connection Connection The Shopify Connection that contains the store settings and cached schema.
Query String The GraphQL mutation document. Templates populate this automatically for supported operations.
Body Array An optional stream containing a single variables payload. Leave this empty when the mutation does not require variables.
Return Type Description
Response Array The GraphQL response, including returned data and any errors.

Usage Notes

  • Run Acquire Metadata again whenever Shopify schema changes affect the operations you use.
  • Query pagination is handled automatically when the response includes cursor metadata.
  • Supply at most one variables payload in Body. Multiple variable payloads are not supported.
  • Shopify Admin API rate limits still apply, so reduce request frequency or payload size when you encounter throttling.