Skip to main content
Shopify logo
  • Category: ecommerce
  • Auth: OAUTH2, S2S_OAUTH2
  • Composio-managed OAuth available? No
  • Tools: 407
  • Triggers: 45
  • Slug: SHOPIFY
  • Version: 20261101_00

Frequently Asked Questions

For a step-by-step guide on creating and configuring your own Shopify OAuth credentials with Composio, see How to create OAuth credentials for Shopify.
The default Shopify OAuth app may be under review or expired. Use your own OAuth app or API authentication method until the default is restored.
Check the scopes on the Shopify connection. If order reads or updates require access beyond the default order scope set, reconnect with the needed order scopes such as read_all_orders before retrying.

Tools

Slug: SHOPIFY_ACCEPT_FULFILLMENT_CANCELLATION_REQUESTAccept a pending cancellation request as the fulfillment service managing the order. Use only for fulfillment orders assigned to this app’s fulfillment service, after the merchant requests cancellation. Returns the updated fulfillment order. Uses the legacy Shopify REST Admin API and requires protected customer data access.

Input Parameters

string
Optional reason for accepting the cancellation request.
string
required
ID of the fulfillment order with a pending cancellation request.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: SHOPIFY_ACCEPT_FULFILLMENT_REQUESTAccept a submitted fulfillment request as the fulfillment service managing the order. Use only for fulfillment orders assigned to this app’s fulfillment service, after the merchant submits a fulfillment request. Returns the updated order, normally with request_status accepted and status in_progress. Uses the legacy Shopify REST Admin API and requires protected customer data access.

Input Parameters

string
Optional reason for accepting the fulfillment request.
string
required
ID of the fulfillment order with a submitted fulfillment request.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: SHOPIFY_ACTIVATE_ONE_TIME_CHARGEActivate an accepted one-time Shopify application charge to finalize billing, using the legacy activation operation. DEPRECATED: Shopify removed this endpoint as of API version 2021-01; merchant-approved charges now transition directly from pending to active without a separate activation call.

Input Parameters

integer
required
The unique identifier of the application charge to activate. The charge must be in ‘accepted’ status before activation.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: SHOPIFY_ADD_PRODUCT_TO_COLLECTIONDEPRECATED: Use SHOPIFY_ADDS_A_PRODUCT_TO_A_CUSTOM_COLLECTION instead. Adds a product to an existing custom collection, optionally specifying its position if the collection is manually sorted.

Input Parameters

integer
Optional position where the product appears in a manually sorted custom collection. If unspecified, the product is added to the end. Note: Positions are not guaranteed to be consecutive. Only honored when the collection’s sort_order is set to manual; ignored silently otherwise.
string
required
The unique numeric identifier for the product to add to the collection.
integer
required
The ID of the custom collection to add the product to. Note: Products can only be added to custom collections, not smart collections.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: SHOPIFY_ADD_PRODUCT_TO_CUSTOM_COLLECTIONAdd a product to a custom collection by creating a collect resource. Use when you need to link a product to a custom collection. Note: Can only add products to custom collections, not smart collections.

Input Parameters

integer
required
The unique numeric identifier for the product to add to the collection.
integer
required
The ID of the custom collection to add the product to. Can only link products to custom collections, not smart collections.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: SHOPIFY_ADJUST_INVENTORY_LEVELAdjust the inventory level of an inventory item at a single location. Use when you need to increase or decrease stock quantities at a specific location.

Input Parameters

string
required
The ID of the location where the inventory level will be adjusted. Use the Location resource to find valid location IDs.
integer
required
The ID of the inventory item being adjusted. This identifies the specific product variant whose inventory will be updated.
integer
required
The amount to adjust the available inventory quantity. Positive values increase stock (e.g., 5 adds 5 units), negative values decrease stock (e.g., -3 removes 3 units).

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: SHOPIFY_APPLY_FULFILLMENT_HOLDApplies a fulfillment hold to an open fulfillment order, halting all fulfillment work. Use when you need to pause fulfillment due to payment issues, fraud concerns, address problems, or inventory shortages. The fulfillment order status will change to on_hold, preventing any fulfillment work from proceeding until the hold is released.

Input Parameters

string ("awaiting_payment" | "high_risk_of_fraud" | "incorrect_address" | "inventory_out_of_stock" | "other")
required
Reason for applying the hold. Must be one of: awaiting_payment, high_risk_of_fraud, incorrect_address, inventory_out_of_stock, or other.
string
Additional context or explanation for the hold reason. Provides more details beyond the standard reason.
boolean
Whether to send a notification to the merchant about this hold via the Shopify mobile app. Defaults to false if not specified.
string
required
The unique identifier of the fulfillment order to place on hold.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: SHOPIFY_APPROVE_COMMENTApproves a pending comment and publishes it to a blog article, making it publicly visible to readers. This action changes the comment’s status from ‘pending’ or ‘unapproved’ to ‘published’ and sets the published_at timestamp. Use this when moderating blog comments that require approval before appearing on the storefront. Requires the ‘write_content’ scope.

Input Parameters

string
required
The unique numeric ID of the comment to approve and publish. Must be a comment with status ‘pending’ or ‘unapproved’. Get comment IDs from the list comments or create comment actions.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: SHOPIFY_BULK_CREATE_PRODUCTSCreates products using a Shopify asynchronous bulk mutation and polls for a terminal status. It returns available parsed product results or an error if results are unavailable, and may time out while the operation is still running.

Input Parameters

array
required
Array of product inputs to create. Recommended 20-50+ items for optimal bulk operation efficiency.
integer
Maximum polling attempts before timeout. Default 60 (5 minutes with 5s interval).
integer
Seconds to wait between status polls. Default 5.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: SHOPIFY_BULK_DELETE_CUSTOMER_ADDRESSESBulk delete multiple customer addresses in a single operation. This action permanently removes several addresses from a customer’s address book at once, which is more efficient than deleting addresses one by one. Use this when you need to clean up multiple invalid or outdated addresses for a customer. Requires the ‘write_customers’ scope and access to protected customer data.

Input Parameters

string
The bulk operation to perform. Currently only ‘destroy’ is supported, which permanently deletes the specified addresses from the customer’s account.
array
required
Array of address IDs to delete from the customer’s address book. You must provide at least one address ID. Each ID should be a valid address that belongs to the specified customer.
string
required
The unique identifier for the customer in Shopify.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: SHOPIFY_BULK_DELETE_METAFIELDSDeletes multiple metafields in bulk using their owner ID, namespace, and key. If a metafield doesn’t exist, the mutation still succeeds but returns null for that identifier in the response.

Input Parameters

array
required
List of metafield identifiers to delete. Each identifier specifies the owner ID (GID), namespace, and key. If a metafield doesn’t exist, the mutation still succeeds but returns null for that identifier.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: SHOPIFY_BULK_DELETE_METAOBJECTSAsynchronously delete metaobjects and their associated metafields in bulk. Use this action to delete multiple metaobjects by their IDs or delete all metaobjects of a specific type. The operation is asynchronous and returns a job ID for tracking completion status.

Input Parameters

object
required
Specifies which metaobjects to delete. Must provide either ‘ids’ (array of metaobject IDs) or ‘type’ (string representing metaobject type).

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: SHOPIFY_BULK_QUERY_OPERATIONStart a Shopify GraphQL bulk query to retrieve large datasets, such as products, orders, customers, or inventory, without manual pagination. The query must include at least one connection using the edges and node structure. Polls the current bulk operation until a terminal state or timeout, returning its metadata and any available result or partial-data URL.

Input Parameters

string
required
GraphQL bulk query string. CRITICAL: Every connection field (any field returning a Connection type like LineItemConnection, VariantConnection, OrderConnection, etc.) must use the edges { node { … } } pattern. This applies to top-level queries AND all nested relationship fields (e.g., lineItems, variants, fulfillments, transactions, refunds, etc.). Scalar fields and object types (not connections) can be accessed directly. This query will be wrapped in a bulkOperationRunQuery mutation. Use actual newlines in the query, not escaped sequences like ‘\n’. If escaped sequences are provided (e.g., from JSON serialization), they will be automatically converted to actual characters.
number
Maximum number of seconds to wait for the bulk operation to complete before timing out. Shopify bulk operations can take several minutes for large datasets.
string
Optional identifier to track this bulk operation for debugging or logging purposes.
number
Number of seconds to wait between polling attempts when checking bulk operation status. Shopify recommends polling every 1-2 seconds.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: SHOPIFY_CALCULATE_REFUNDCalculate accurate refund amounts, taxes, and transactions for a Shopify order before creating an actual refund. Use this action to: - Preview refund calculations for line items with accurate tax breakdowns - Determine shipping refund amounts and maximum refundable values - Get suggested transactions that can be used to create the actual refund The response includes transactions with kind=‘suggested_refund’ which must be changed to kind=‘refund’ before creating an actual refund using the create refund endpoint.

Input Parameters

string
The ISO 4217 three-letter currency code (e.g., ‘USD’, ‘EUR’, ‘CAD’). Required when shipping ‘amount’ is specified.
string
required
The unique identifier of the order for which to calculate the refund.
object
Shipping refund specification. Specify either full_refund or amount, not both.
array
Array of line items to refund. Each item requires line_item_id, quantity, and optionally restock_type with location_id for inventory management.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: SHOPIFY_CANCEL_APP_SUBSCRIPTIONCancel an app subscription in Shopify using the appSubscriptionCancel GraphQL mutation. Use when you need to cancel an existing app subscription, optionally with prorated credits.

Input Parameters

string
required
The ID of the app subscription to be cancelled. Must be in the format: gid://shopify/AppSubscription/{id} (e.g., gid://shopify/AppSubscription/12345678).
boolean
Whether to issue prorated credits for the unused portion of the app subscription. If true, there will be a corresponding deduction (based on revenue share) to your Partner account. Defaults to false.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: SHOPIFY_CANCEL_BULK_OPERATIONCancel a running Shopify bulk operation. Use when you need to stop a long-running bulk query or mutation operation that is no longer needed. Note that there may be a short delay between when cancelation starts and when the operation is actually canceled.

Input Parameters

string
required
The ID of the bulk operation to cancel. Must be in GID format: gid://shopify/BulkOperation/{operation_id}. You can obtain this ID from the response of bulkOperationRunQuery or bulkOperationRunMutation actions.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: SHOPIFY_CANCEL_FULFILLMENTCancels an existing fulfillment by its ID, reverting all line items to an unfulfilled state. Use this when a fulfillment was created in error or needs to be redone. The cancellation is permanent and cannot be undone - the line items will return to the unfulfilled state and a new fulfillment must be created if needed. Only fulfillments that haven’t been shipped or are in certain states can be cancelled.

Input Parameters

string
required
The unique identifier of the fulfillment to cancel. Obtain this ID from a fulfillment that was previously created or by retrieving fulfillments for an order. The fulfillment must be in a state that allows cancellation (not already cancelled or completed with shipped status).

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: SHOPIFY_CANCEL_FULFILLMENT_ORDERCancels a fulfillment order in Shopify and marks it as closed. This creates a replacement fulfillment order with the same line items, allowing reassignment to a different location. Use this for merchant-managed fulfillments. For third-party fulfillment services, use the cancellation request endpoints instead. This endpoint immediately cancels the order without requiring acceptance from a fulfillment service.

Input Parameters

string
required
The ID of the fulfillment order to cancel. Can be provided as an integer or string.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: SHOPIFY_CANCEL_ORDERCancels a Shopify order and optionally restocks items and sends email notifications. Use when canceling an order that has not yet been paid or fulfilled. Orders cannot be cancelled if payment status is already paid or if the order has existing fulfillments.

Input Parameters

boolean
Whether to send a cancellation email notification to the customer.
string
The refund amount when canceling the order. Required for multi-currency orders along with currency.
string
The reason for canceling the order. Common values include ‘customer’, ‘fraud’, ‘inventory’, ‘declined’, ‘other’.
object
An object containing detailed refund information. Should be generated using the Refund API’s ‘calculate’ endpoint, specifying each line item with line_item_id, quantity, and restock_type.
boolean
Whether to restock the items from the canceled order back into inventory. Note: This parameter is deprecated but still functional.
string
The currency code for the refund amount (e.g., ‘USD’, ‘CAD’). Required when amount is specified in multi-currency scenarios.
string
required
The unique identifier of the order to cancel. Must use the order’s API id, not order_number.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: SHOPIFY_CANCEL_RECURRING_APPLICATION_CHARGECancel a recurring application charge by its ID. A successful cancellation returns an empty response. Uses the legacy REST Admin API; Shopify recommends GraphQL appSubscriptionCancel for new apps.

Input Parameters

string
required
ID of the recurring application charge to cancel.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: SHOPIFY_CLOSE_FULFILLMENT_ORDERMark an in-progress fulfillment order incomplete, not cancelled. Only the fulfillment service app that accepted the request can close it. The order must be assigned to a fulfillment service location with an accepted request and in_progress status. Closes the request and returns control to the merchant without cancelling the order. Uses the legacy REST Admin API.

Input Parameters

string
Optional reason for marking the fulfillment order incomplete.
string
required
ID of the accepted, in-progress fulfillment order to mark incomplete.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: SHOPIFY_CLOSE_ORDERCloses an open Shopify order. Use when all line items have been fulfilled or canceled and all financial transactions are complete.

Input Parameters

integer
required
The unique identifier of the Shopify order to close. The order must be open with all line items fulfilled or canceled and all financial transactions completed.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: SHOPIFY_COMPLETE_DRAFT_ORDERComplete a draft order in Shopify and transition it to an actual order. Use when you need to finalize a draft order, reserve inventory, and create a corresponding order. When completing with payment_pending=true, the payment gateway is set to Manual.

Input Parameters

integer
required
The unique identifier of the draft order to complete.
boolean
When set to true, marks the order as payment pending instead of paid. If omitted, the order is marked as paid. Setting this to true will always make the payment gateway as Manual.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: SHOPIFY_CONNECT_INVENTORY_LEVELConnects an inventory item to a location, establishing where the item can be stocked and fulfilled. This creates an inventory level with an initial available quantity of 0. Use this when you need to enable a product variant to be stocked at a new location. After connecting, use the ‘set’ or ‘adjust’ inventory level actions to update quantities.

Input Parameters

string
required
The ID of the location where you want to stock this inventory item. Use the ‘List locations’ action to retrieve available location IDs from your store.
string
required
The ID of the inventory item to connect to the location. Each product variant has an associated inventory item ID, which can be retrieved from the product variant’s ‘inventory_item_id’ field.
boolean
Whether to relocate inventory from previously connected locations. Must be set to true when connecting to fulfillment service locations, since an inventory item can only be active at one fulfillment service location at a time. Defaults to false for regular locations.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: SHOPIFY_COUNT_ARTICLESRetrieves a count of all articles from a blog. Use when you need to know how many articles exist in a specific blog, optionally filtered by creation, publication, or update dates and publication status.

Input Parameters

string
required
The unique identifier for the blog whose articles should be counted.
string
Count only articles created at or before this ISO 8601 timestamp.
string
Count only articles created at or after this ISO 8601 timestamp.
string
Count only articles last updated at or before this ISO 8601 timestamp.
string
Count only articles last updated at or after this ISO 8601 timestamp.
string
Count only articles published at or before this ISO 8601 timestamp.
string
Count only articles published at or after this ISO 8601 timestamp.
string ("published" | "unpublished" | "any")
Filter by publication status. ‘published’ returns only published articles, ‘unpublished’ returns only unpublished articles, ‘any’ returns all articles regardless of status. Defaults to ‘any’ if not specified.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: SHOPIFY_COUNT_BLOGSRetrieves the total count of all blogs in a Shopify store. Use this action when you need to know how many blogs exist in the store without fetching the full list of blog details. This is useful for pagination calculations, analytics, or checking if any blogs exist before performing other operations. Requires ‘read_content’ or ‘write_content’ OAuth scope.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: SHOPIFY_COUNT_CUSTOM_COLLECTIONSRetrieves a count of custom collections with optional filters. Use when you need to know how many custom collections exist in the store, optionally filtered by product, publication status, or date ranges.

Input Parameters

string
Filters count by custom collection title.
integer
Filters count to custom collections containing a specific product ID.
string
Counts custom collections updated before this date (ISO 8601 format).
string
Counts custom collections updated after this date (ISO 8601 format).
string
Counts custom collections published before this date (ISO 8601 format).
string
Counts custom collections published after this date (ISO 8601 format).
string ("published" | "unpublished" | "any")
Filters count by publication status. Valid values: ‘published’, ‘unpublished’, or ‘any’. Default: ‘any’.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: SHOPIFY_COUNT_DRAFT_ORDERSRetrieves a count of draft orders from a Shopify store. Use when you need to know how many draft orders exist without fetching full draft order details. Supports filtering by status and date range to count specific subsets of draft orders.

Input Parameters

string ("open" | "invoice_sent" | "completed")
Filter draft orders by their current state. ‘open’: Draft orders that haven’t been completed (default). ‘invoice_sent’: Draft orders where an invoice has been sent to the customer. ‘completed’: Draft orders that have been converted to actual orders.
string
Show draft orders last modified at or before this date. Format: ISO 8601 (e.g., 2014-04-25T16:15:47-04:00).
string
Show draft orders last modified at or after this date. Format: ISO 8601 (e.g., 2014-04-25T16:15:47-04:00).

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: SHOPIFY_COUNT_EVENTSCount all events in a Shopify store with comprehensive filtering. Use when you need to determine how many events match specified criteria including date range, resource type, or action verb.

Input Parameters

string
Show events of a certain type/action (e.g., create, destroy, update, confirmed)
string
Show events of certain resources, specified by a comma-separated list of resource names (e.g., Order, Product, Article, Blog, Collection, Comment, Page, PriceRule)
string
Show events created at or before this date and time. Format: ISO 8601 timestamp (e.g., 2014-04-25T16:15:47-04:00)
string
Show events created at or after this date and time. Format: ISO 8601 timestamp (e.g., 2014-04-25T16:15:47-04:00)

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: SHOPIFY_COUNT_FULFILLMENTSRetrieves a count of fulfillments associated with a specific order. Use when you need to determine how many fulfillments exist for an order, optionally filtered by creation or update dates.

Input Parameters

string
required
The unique numeric identifier for the order whose fulfillments you want to count.
string
Filter to count fulfillments created before this date. Must be in ISO 8601 format (e.g., 2014-04-25T16:15:47-04:00).
string
Filter to count fulfillments created after this date. Must be in ISO 8601 format (e.g., 2014-04-25T16:15:47-04:00).
string
Filter to count fulfillments last updated before this date. Must be in ISO 8601 format.
string
Filter to count fulfillments last updated after this date. Must be in ISO 8601 format.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: SHOPIFY_COUNT_LOCATIONRetrieves a count of locations. Use when you need to determine how many physical or virtual locations are configured in the Shopify store.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: SHOPIFY_COUNT_METAFIELDSRetrieves the shop-level count of metafields. Use resource-specific metafield actions for product, customer, order, collection, page, or article metafields.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: SHOPIFY_COUNT_ORDERDEPRECATED: Use SHOPIFY_RETRIEVES_AN_ORDER_COUNT instead. Retrieves the count of orders in a Shopify store. Use when you need to know how many orders exist, optionally filtered by status, dates, financial status, fulfillment status, or attribution app. Note: Only the last 60 days’ worth of orders are accessible by default unless the app has been granted the read_all_orders scope.

Input Parameters

string
Filter orders by their current status. Default is ‘any’.
string
Count only orders created at or before this ISO 8601 datetime.
string
Count only orders created at or after this ISO 8601 datetime (e.g., ‘2023-03-07T00:00:00.000’ or ‘2023-03-07 00:00:00.000’).
string
Count only orders last updated at or before this ISO 8601 datetime.
string
Count only orders last updated at or after this ISO 8601 datetime.
string ("pending" | "authorized" | "partially_paid" | "paid" | "partially_refunded" | "refunded" | "voided" | "expired" | "any")
Filter orders by payment status. Note: Multiple comma-separated values do NOT work properly with the count endpoint.
string
Filter orders attributed to a specific app ID.
string ("shipped" | "partial" | "unshipped" | "any" | "unfulfilled")
Filter orders by fulfillment state. Note: Multiple comma-separated values do NOT work properly with the count endpoint. Use ‘unfulfilled’ or null for unfulfilled orders.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: SHOPIFY_COUNT_PAGESRetrieve the total count of pages in a Shopify store. Use when you need to determine how many pages exist, optionally filtered by creation date, update date, publication date, publication status, or title.

Input Parameters

string
Count pages matching a specific title.
string
Filter pages created before a specified date (ISO 8601 format).
string
Filter pages created after a specified date (ISO 8601 format).
string
Filter pages updated before a specified date (ISO 8601 format).
string
Filter pages updated after a specified date (ISO 8601 format).
string
Filter pages published before a specified date (ISO 8601 format).
string
Filter pages published after a specified date (ISO 8601 format).
string
Restrict results by publication state. Valid options: ‘published’, ‘unpublished’, or ‘any’ (default).

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: SHOPIFY_COUNT_PRICE_RULESRetrieves a count of all price rules. Use when you need to determine how many price rules (discount campaigns) are configured in the store.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: SHOPIFY_COUNT_PRODUCT_IMAGESRetrieves the total count of images for a specific Shopify product. Use when you need to know how many images are associated with a product.

Input Parameters

string
required
The unique identifier for the Shopify product whose images are to be counted.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: SHOPIFY_COUNT_PRODUCT_LISTINGSCount products published to your app’s sales channel, not all store products. Uses the legacy REST Admin API. No query filters are supported by this endpoint.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: SHOPIFY_COUNT_PRODUCTSRetrieve a count of products in the Shopify store. Use when you need to get the total number of products, optionally filtered by collection, vendor, product type, status, or date ranges.

Input Parameters

string
Filter by product status (e.g., ‘active’, ‘draft’, ‘archived’).
string
Filter by vendor name (the supplier or manufacturer of the products).
string
Filter by product type (e.g., ‘Apparel’, ‘Electronics’, ‘Footwear’).
string
Filter products by collection ID to count only products within a specific collection.
string
Return products created before this date. Format: ISO 8601.
string
Return products created after this date. Format: ISO 8601 (e.g., 2014-04-25T16:15:47-04:00).
string
Return products last updated before this date. Format: ISO 8601.
string
Return products last updated after this date. Format: ISO 8601.
string
Return products published before this date. Format: ISO 8601.
string
Return products published after this date. Format: ISO 8601.
string
Filter by published status (e.g., ‘published’, ‘unpublished’, ‘any’).

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: SHOPIFY_COUNT_PRODUCT_VARIANTSRetrieves the total count of variants for a Shopify product. Use when you need to know how many variants exist for a specific product.

Input Parameters

string
required
The unique identifier for the Shopify product whose variants are to be counted.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: SHOPIFY_COUNT_SCRIPT_TAGSRetrieves a count of all script tags in the shop. Script tags are remote JavaScript files that are loaded into the pages of a shop’s storefront or checkout. Use this action to determine the total number of script tags, optionally filtered by a specific source URL. Note: This endpoint is part of the legacy REST Admin API (deprecated). The Shopify GraphQL Admin API should be used for new integrations.

Input Parameters

string
Filter to count only script tags with this exact source URL. If omitted, returns the total count of all script tags in the shop.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: SHOPIFY_COUNT_WEBHOOKSRetrieves a count of webhook subscriptions registered to the requesting app, optionally filtered by address or topic. Subscriptions created in the Shopify admin are not accessible through the API.

Input Parameters

string
Filter webhook subscriptions by event topic. Valid values include ‘orders/create’, ‘products/update’, ‘customers/create’, etc.
string
Filter webhook subscriptions by the URI where the POST request is sent. Only counts webhooks that send to this specific address.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: SHOPIFY_CREATE_A_METAFIELDCreate a metafield to attach custom metadata to a supported Shopify resource, such as a product, customer, order, collection, or the shop.

Input Parameters

string
required
The unique identifier for the metafield within its namespace. Must be 3-64 characters, alphanumeric, hyphen, or underscore.
string
required
The type of data stored in the metafield. Supported types include: single_line_text_field, multi_line_text_field, number_integer, number_decimal, boolean, json, rating, url, date, date_time, color, weight, volume, dimension, money, and list types.
string
required
The data to store in the metafield. Always stored as string format regardless of type.
string ("products" | "customers" | "blogs" | "collections" | "orders" | "pages" | "variants" | "articles" | "draft_orders" | "locations" | "product_images" | "smart_collections" | "shop")
required
The type of resource to attach the metafield to. Supported resources: products, customers, blogs, collections, orders, pages, variants, articles, draft_orders, locations, product_images, smart_collections, shop.
string
required
Container for a group of metafields. Must be 3-255 characters, alphanumeric, hyphen, or underscore.
string
Optional description of the metafield to provide context about its purpose.
string
The unique identifier of the resource to attach the metafield to. Not required for ‘shop’ resource.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: SHOPIFY_CREATE_A_NEW_PRODUCT_IMAGECreate a new product image for a Shopify product. Use when you need to add an image to a product by providing either an image URL or base64-encoded image data. Products can have up to 250 images in PNG, GIF, or JPG formats.

Input Parameters

object
required
Object containing the image details. Must include either ‘src’ or ‘attachment’.
string
required
The unique identifier for the product to associate the image with.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: SHOPIFY_CREATE_APP_SUBSCRIPTIONCreate a recurring or usage-based app subscription for charging Shopify merchants. Use when setting up billing for app features and services. Returns a confirmation URL where the merchant must approve charges before the subscription becomes active.

Input Parameters

string
required
Descriptive name for the subscription plan displayed to merchant (e.g., ‘Basic Plan’, ‘Premium Tier’).
boolean
Whether this is a test subscription that won’t actually charge the merchant. Useful for development and testing. Defaults to false.
array
required
One or more pricing plans defining the subscription structure. Only one pricing plan can be defined for each available type (recurring or usage-based).
string
required
URL where merchant is redirected after approving or declining the subscription. Should be a page in your app that handles the result.
integer
Number of free trial days beginning when merchant approves the subscription. Merchant won’t be charged during trial period.
string ("STANDARD" | "APPLY_IMMEDIATELY" | "APPLY_ON_NEXT_BILLING_CYCLE")
Controls how the new subscription interacts with existing active subscriptions.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: SHOPIFY_CREATE_ARTICLECreate an article in a specific Shopify blog. A title is required.

Input Parameters

string
A comma-separated list of tags. Tags are additional short descriptors for the article.
object
Image object for an article
string
required
The headline of the article. This field is required.
string
Name credited as the article’s creator.
string
required
The ID of the blog where the article will be created.
string
The text of the body of the article, complete with HTML markup.
boolean
Whether the article is visible. Defaults to unpublished (false) if not specified.
array
Custom metadata fields with key, namespace, value, and type.
string
Date and time (ISO 8601 format) when the article becomes visible. If not provided and published is true, the article is published immediately.
string
Brief summary with HTML markup for display on other pages.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: SHOPIFY_CREATE_ARTICLE_COMMENTCreate a comment for an article in Shopify. Use when you need to add reader comments to blog articles. Requires ‘content’ access scope and protected customer data access.

Input Parameters

string
The IP address from which the comment was posted.
string
required
The basic Textile markup of the comment. This field is required.
string
required
The email address of the author of the comment. This field is required and contains protected customer data.
string
required
The name of the author of the comment. This field is required and contains protected customer data.
integer
required
A unique numeric identifier for the blog to which the article belongs.
integer
required
A unique numeric identifier for the article to which the comment belongs.
string
The browser user agent string from which the comment was posted.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: SHOPIFY_CREATE_BLOGCreate a new blog in Shopify. Use when you need to add a blog to the store for publishing articles and content. The title field is mandatory.

Input Parameters

string
required
The title of the blog. This field is required. Maximum length: 255 characters.
string
A human-friendly unique string for the blog automatically generated from its title. If not provided, it will be auto-generated from the title.
array
Attaches additional metadata to a shop’s resources. Each metafield object should include key, value, type, and namespace.
string ("no" | "moderate" | "yes")
Whether readers can post comments to the blog and if comments are moderated or not. Defaults to ‘no’ if not specified.
string
The suffix of the Liquid template being used. For example, if the value is ‘custom’, then the blog is using the blog.custom.liquid template.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: SHOPIFY_CREATE_CARRIER_SERVICECreate a carrier service that supplies real-time shipping rates at checkout. Requires write_shipping and an eligible store: Advanced Shopify or higher, Shopify with yearly billing or the carrier service feature, or a development store that is not on the Basic plan. The callback must be a public POST endpoint. REST Admin API is legacy; new public apps must use GraphQL Admin API.

Input Parameters

string
required
The shipping service name shown to merchants and customers.
boolean
Whether the service is available to serve rates at checkout. Omit to use Shopify’s default.
string
Deprecated response format of the callback endpoint. Only ‘json’ is supported.
string
required
Public URL of the POST endpoint where Shopify retrieves shipping rates.
boolean
Whether merchants can send dummy data through Shopify admin to preview shipping rates. Omit to use Shopify’s default.
string
Deprecated property distinguishing API and legacy carrier services (for example, ‘api’). Normally omit for an API-created service.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: SHOPIFY_CREATE_CHECKOUT_PAYMENTCreate a checkout payment using an existing Shopify card-vault session. Can authorize or charge money. Requires elevated sales-channel payment processing access, protected customer data approval, and a direct payment gateway. Uses the legacy REST Admin API; the API version comes from the connection base URL. HTTP 202 means accepted, not paid: inspect transaction.status, payment_processing_error_message, and next_action for failure or authentication.

Input Parameters

string
required
Token of the existing checkout: URL-safe letters, digits, underscores or hyphens.
string
required
Payment amount as a decimal string, matching the checkout total.
string
required
Session ID returned by Shopify’s card vault; not raw card details.
string
required
App-generated idempotency token, unique across payment requests. Reuse only when retrying the same payment.
object
required
Customer request context required for payment processing.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: SHOPIFY_CREATE_COUNTRYCreate a country with tax configuration for the Shopify store. Use when you need to add a new country to the store’s shipping or tax settings. Important Notes: - The REST Country API is deprecated as of API version 2024-07 - This action requires merchant approval for the ‘write_shipping’ scope - The ‘tax’ field is deprecated as of API version 2020-10 and custom tax values can no longer be created or updated - For new implementations, consider using the GraphQL Admin API’s “Countries in shipping zone” endpoint instead

Input Parameters

number
The national sales tax rate applied to orders from that country in decimal format (e.g., 0.2 for 20%). Note: As of API version 2020-10, the tax field is deprecated and custom tax values can no longer be created or updated.
string
required
The two-letter country code in ISO 3166-1 alpha-2 format (e.g., ‘BR’ for Brazil, ‘FR’ for France, ‘US’ for United States). This is required.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: SHOPIFY_CREATE_CUSTOM_COLLECTIONCreate a manually curated custom collection in Shopify with a required title and optional description, image, publication settings, sort order, product associations, and metafields. The returned custom collection contains its ID.

Input Parameters

object
Image object for custom collection.
string
required
Name of the custom collection (limit: 255 characters). This is the only required field.
string
Human-friendly unique identifier (limit: 255 characters). Auto-generated from title if not provided. Use the returned collection_id for subsequent operations instead of relying on the handle.
array
Product associations to add to the collection during creation.
string
HTML description displayed on collection pages.
boolean
Whether visible on Online Store channel. Defaults to true if not specified.
array
Custom metadata fields with key, value, type, and namespace.
string ("manual" | "alpha-asc" | "alpha-desc" | "best-selling" | "created" | "created-desc" | "price-asc" | "price-desc")
Product ordering method within the collection.
string ("web" | "global")
Publication scope: ‘web’ (Online Store only) or ‘global’ (Online Store and Point of Sale).
string
Liquid template variant suffix for custom collection page templates.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: SHOPIFY_CREATE_CUSTOMERCreate a new Shopify customer with contact details, addresses, tags, and notes. Requires an email, phone number, or both first and last name.

Input Parameters

string
An optional note about the customer.
string
A comma-separated string of tags to associate with the customer.
string
The customer’s unique email address. Must be unique across all customers in the store. At least one of email, phone, or (first_name and last_name) must be provided.
string
The customer’s phone number in E.164 format (e.g., +16135551212) or other dialable formats (6135551212, (613)555-1212). At least one of email, phone, or (first_name and last_name) must be provided.
string
(Deprecated) The customer’s password. This field is deprecated for creating customer accounts. If provided, password_confirmation is also required.
array
A list of addresses for the customer.
string
The customer’s last name. At least one of email, phone, or (first_name and last_name) must be provided.
string
The customer’s first name. At least one of email, phone, or (first_name and last_name) must be provided.
boolean
Whether the customer has verified their email address. Note: This is a read-only field and may be ignored by the API.
boolean
If true, sends the customer an email invite to create an account.
boolean
Whether to send the customer a welcome email. When false, suppresses the welcome email. If send_email_invite is true, this can be set to false to avoid sending duplicate emails.
string
(Deprecated) Confirmation of the customer’s password. This field is deprecated for creating customer accounts. Required if password is provided.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: SHOPIFY_CREATE_CUSTOMER_ACCOUNT_ACTIVATION_URLGenerate a one-time account activation URL for a customer whose account is in ‘disabled’ state (not yet activated). Use this when you’ve imported customers and need activation URLs to send in welcome emails. The URL allows customers to set their password and activate their account. Each URL expires after 30 days. Generating a new URL invalidates any previously generated URL for that customer.

Input Parameters

string
required
The unique identifier for the customer whose account activation URL needs to be generated.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: SHOPIFY_CREATE_CUSTOMER_ADDRESSCreate a new address for a customer. Use when you need to add an address to an existing customer’s address list.

Input Parameters

object
required
The address information to be created for the customer.
string
required
The unique identifier for the customer to whom the address will be added.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: SHOPIFY_CREATE_DELEGATE_ACCESS_TOKENCreate a delegate access token with a subset of the parent token’s permissions. Use when you need to securely delegate limited access to subsystems or services. Each delegate token inherits only the specified scopes, ensuring minimal required permissions rather than full app access. Note: Delegate tokens cannot create new delegate tokens.

Input Parameters

integer
Token expiration time in seconds from creation. If not specified, the delegate token expires when the parent token expires. Maximum value depends on parent token lifetime.
array
required
Array of access scopes to delegate (must be subset of parent token scopes). Each scope defines specific permissions like ‘read_products’, ‘write_orders’. The app can only delegate scopes it was originally granted.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: SHOPIFY_CREATE_DISCOUNT_CODECreates a discount code for an existing price rule. Price rules define the discount logic (e.g., 10% off, buy X get Y), and discount codes are the actual codes (e.g., ‘SUMMER10’) customers enter at checkout. Important: The price rule must exist before creating a discount code - use a price rule creation action first if needed. Each price rule can have multiple discount codes associated with it. Use this when you need to generate customer-facing discount codes for an established discount promotion.

Input Parameters

string
required
The case-insensitive discount code that customers enter at checkout. Must be unique across your store. Maximum 255 characters. Can contain letters, numbers, hyphens, and underscores. Examples: ‘SUMMER10’, ‘WELCOME2024’, ‘FREESHIP’.
string
required
The ID of the price rule that the discount code will belong to. This price rule must already exist in your Shopify store and defines the discount logic (amount, eligibility, duration, etc.). You can get price rule IDs by listing price rules or creating a new one.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: SHOPIFY_CREATE_DISCOUNT_CODE_BATCHCreate a discount code creation job for batch processing. Use when you need to asynchronously create up to 100 discount codes for a price rule in a single request.

Input Parameters

integer
required
The ID of the price rule that the discount codes will belong to.
array
required
Array of discount code objects to create. Maximum 100 codes can be created in a single batch request.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: SHOPIFY_CREATE_DRAFT_ORDERCreate a draft order in Shopify. Use when you need to create orders in draft state using product variant line items or custom line items. Draft orders are useful for creating orders on behalf of customers, generating invoices, or reserving inventory.

Input Parameters

string
Merchant note about the draft order.
string
Comma-separated tags.
string
Customer’s email address.
string
Three-letter ISO 4217 currency code.
array
required
Array of line item objects. At least one line item is required. Each line item must have a quantity, and either a variant_id (for product variants) or title and price (for custom items).
boolean
Whether the customer is exempt from taxes.
integer
ID of an existing customer to associate with the draft order.
object
Shipping line for draft order.
object
Billing address for draft order.
array
Custom name/value pairs for additional information.
object
Applied discount with title, description, value, value_type (either ‘fixed_amount’ or ‘percentage’), and amount.
object
Shipping address for draft order.
boolean
Whether to load customer’s default shipping address (default: false).

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: SHOPIFY_CREATE_EVENT_BRIDGE_WEBHOOK_SUBSCRIPTIONCreate an AWS EventBridge webhook subscription in Shopify. Use when you need to configure real-time event notifications to AWS EventBridge for events like order creation, product updates, or customer changes. EventBridge webhooks push events to your AWS partner event source immediately when changes occur, eliminating polling. You can filter events and control payload fields to optimize performance.

Input Parameters

string ("APP_PURCHASES_ONE_TIME_UPDATE" | "APP_SUBSCRIPTIONS_UPDATE" | "APP_UNINSTALLED" | "CARTS_CREATE" | "CARTS_UPDATE" | "CHANNELS_DELETE" | "CHECKOUTS_CREATE" | "CHECKOUTS_DELETE" | "CHECKOUTS_UPDATE" | "COLLECTIONS_CREATE" | "COLLECTIONS_DELETE" | "COLLECTIONS_UPDATE" | "COLLECTION_LISTINGS_ADD" | "COLLECTION_LISTINGS_REMOVE" | "COLLECTION_LISTINGS_UPDATE" | "CUSTOMERS_CREATE" | "CUSTOMERS_DELETE" | "CUSTOMERS_DISABLE" | "CUSTOMERS_ENABLE" | "CUSTOMERS_UPDATE" | "CUSTOMER_GROUPS_CREATE" | "CUSTOMER_GROUPS_DELETE" | "CUSTOMER_GROUPS_UPDATE" | "DISPUTES_CREATE" | "DISPUTES_UPDATE" | "DRAFT_ORDERS_CREATE" | "DRAFT_ORDERS_DELETE" | "DRAFT_ORDERS_UPDATE" | "FULFILLMENTS_CREATE" | "FULFILLMENTS_UPDATE" | "FULFILLMENT_EVENTS_CREATE" | "FULFILLMENT_EVENTS_DELETE" | "INVENTORY_ITEMS_CREATE" | "INVENTORY_ITEMS_DELETE" | "INVENTORY_ITEMS_UPDATE" | "INVENTORY_LEVELS_CONNECT" | "INVENTORY_LEVELS_DISCONNECT" | "INVENTORY_LEVELS_UPDATE" | "LOCATIONS_CREATE" | "LOCATIONS_DELETE" | "LOCATIONS_UPDATE" | "ORDERS_CANCELLED" | "ORDERS_CREATE" | "ORDERS_DELETE" | "ORDERS_EDITED" | "ORDERS_FULFILLED" | "ORDERS_PAID" | "ORDERS_PARTIALLY_FULFILLED" | "ORDERS_UPDATED" | "PRODUCTS_CREATE" | "PRODUCTS_DELETE" | "PRODUCTS_UPDATE" | "PRODUCT_LISTINGS_ADD" | "PRODUCT_LISTINGS_REMOVE" | "PRODUCT_LISTINGS_UPDATE" | "REFUNDS_CREATE" | "SHOP_UPDATE" | "THEMES_CREATE" | "THEMES_DELETE" | "THEMES_PUBLISH" | "THEMES_UPDATE")
required
The event type that triggers the webhook. Choose from available Shopify webhook topics like ORDERS_CREATE, PRODUCTS_UPDATE, CUSTOMERS_CREATE, etc.
object
required
Configuration details for the EventBridge webhook subscription including ARN, format, and optional filters.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: SHOPIFY_CREATE_FULFILLMENTCreates a fulfillment for one or many fulfillment orders for a specific order. This completes the shipping process by marking items as fulfilled. IMPORTANT: You must first retrieve fulfillment orders using a “Get fulfillment orders for order” action to obtain the fulfillment_order_id and line item IDs needed for this action. Use when: You need to mark order items as shipped/fulfilled for orders assigned to merchant-managed locations or third-party fulfillment services. Note: As of API version 2024-10, fulfillments can only be created for merchant-managed locations or third-party fulfillment services owned by your app.

Input Parameters

string
A message associated with the fulfillment. Only available if the fulfillment order is assigned to a third-party fulfillment service.
object
Tracking information for the shipment.
object
The address of the fulfillment location, intended for tax purposes.
boolean
Whether to send a notification to the customer about this fulfillment. Defaults to false.
array
required
Array of fulfillment orders and their line items to fulfill. At least one fulfillment order is required.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: SHOPIFY_CREATE_FULFILLMENT_EVENTCreates a tracking event for a fulfillment to update shipment status. These events appear on the customer’s order status page to track delivery progress (e.g., “in_transit”, “out_for_delivery”, “delivered”). Use this to provide real-time tracking updates from shipping carriers. Requires an existing fulfillment - use after creating a fulfillment for an order.

Input Parameters

string
Postal/zip code of the event location.
string
City of the event location.
string ("attempted_delivery" | "carrier_picked_up" | "confirmed" | "delayed" | "delivered" | "failure" | "in_transit" | "label_printed" | "label_purchased" | "out_for_delivery" | "ready_for_pickup")
required
The status of the fulfillment event. Valid values: attempted_delivery (delivery was attempted), carrier_picked_up (picked up by carrier), confirmed (fulfillment confirmed), delayed (delayed), delivered (successfully delivered), failure (fulfillment request failed), in_transit (shipment in transit), label_printed (shipping label printed), label_purchased (shipping label purchased), out_for_delivery (out for delivery), ready_for_pickup (ready for customer pickup).
string
Country of the event location.
string
An arbitrary message describing the status, can be provided by shipping carrier.
string
Street address of the event location.
number
Geographic latitude coordinate.
integer
required
The ID of the order associated with the fulfillment.
string
Province/state of the event location.
number
Geographic longitude coordinate.
string
The date and time when the fulfillment event occurred (ISO 8601 format).
integer
required
The ID of the fulfillment to create an event for.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: SHOPIFY_CREATE_FULFILLMENT_SERVICERegister a fulfillment service and automatically create its associated location. Use for a warehouse that prepares and ships orders on behalf of the merchant. Requires write_fulfillments. The callback prefix must host fulfillment-order notifications; tracking and stock callbacks depend on their respective flags. REST Admin API is legacy; new public apps must use GraphQL Admin API.

Input Parameters

string
required
The fulfillment service name shown to merchants.
string
required
Required public URL prefix for fulfillment_order_notification, fetch_tracking_numbers and fetch_stock callbacks. Shopify must accept the callback host.
boolean
Whether Shopify retrieves tracking numbers from the service. Omit to use Shopify’s default.
boolean
Whether the service tracks inventory and supplies stock updates. Omit to use Shopify’s default.
boolean
Deprecated: whether products require physical shipping. Omit to use Shopify’s default.
boolean
Deprecated; Shopify defaults to true in 2026-04 and recommends omitting this field. Functioning services must use the fulfillment-order workflow.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: SHOPIFY_CREATE_GIFT_CARDCreate a gift card for a Shopify store. Use when you need to issue a new gift card with a specified value. Requires write_gift_cards access scope. Gift card codes can only be retrieved at creation time.

Input Parameters

object
required
The gift card object containing all necessary information to create a gift card.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: SHOPIFY_CREATE_MARKETING_ENGAGEMENTSCreate engagement data for a marketing event in Shopify. Use when tracking customer interactions like views, clicks, and ad spend on marketing events before customers reach the website.

Input Parameters

array
required
A list of engagement objects containing customer activity data. At least one engagement is required.
string
required
The ID of the marketing event to add engagements to.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: SHOPIFY_CREATE_MARKETING_EVENTCreate a marketing event in Shopify to track promotional actions. Use when you need to track marketing campaigns targeting customers across various channels.

Input Parameters

boolean
Indicates whether the promotion is paid or organic. Defaults to false if not specified.
string
Campaign budget amount as a decimal string. If specified, currency and budget_type are also required.
string
Three-letter ISO 4217 currency code. Required if budget is specified.
string
Actual campaign end time in ISO 8601 format.
string
External identifier for this marketing event. Used for validation of engagement data.
string ("ad" | "post" | "message" | "retargeting" | "transactional" | "affiliate" | "loyalty" | "newsletter" | "abandoned_cart")
required
Type of marketing event. Valid values: ad, post, message, retargeting, transactional, affiliate, loyalty, newsletter, or abandoned_cart.
string
URL where the campaign can be managed or edited.
string
required
The date and time when the marketing action started, in ISO 8601 format.
string
Optional UTM parameter for medium type.
string
Optional UTM parameter for traffic source.
string ("daily" | "lifetime")
Budget type. Valid values: daily or lifetime. Required if budget is specified.
string
Campaign details or description.
string
URL where the campaign content can be previewed.
string
Optional UTM parameter for campaign identification.
string
Destination domain. Required if marketing_channel is ‘search’ or ‘social’.
string ("search" | "display" | "social" | "email" | "referral" | "chat" | "receipt")
required
Distribution channel for the marketing event. Valid values: search, display, social, email, referral, chat, or receipt.
array
Array of resources (products, collections, etc.) being marketed in this campaign.
string
Planned campaign end time in ISO 8601 format.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: SHOPIFY_CREATE_METAFIELDCreates a new metafield for a Shopify blog. Metafields store additional custom information (metadata) on blog resources such as sponsor names, SEO keywords, publication dates, or custom attributes not included in standard blog fields.

Input Parameters

string
required
The unique identifier for the metafield within its namespace. Must be 3-64 characters, alphanumeric, hyphen, or underscore.
string
required
The type of data stored in the metafield. Supported types include: single_line_text_field, multi_line_text_field, number_integer, number_decimal, boolean, json, rating, url, date, date_time, color, weight, volume, dimension, money, and list types.
string
required
The data to store in the metafield. Always stored as string format regardless of type.
string
required
The unique identifier of the blog resource to create a metafield for.
string
required
Container for a group of metafields. Must be 3-255 characters, alphanumeric, hyphen, or underscore.
string
Optional description of the metafield to provide context about its purpose.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: SHOPIFY_CREATE_MOBILE_PLATFORM_APPLICATIONCreate an iOS or Android mobile platform application associated with the app. Configures universal/app links, iOS shared web credentials, or App Clips. Use only application identifiers you control. Shopify Support must enable the mobile_platform_applications scope. Shared web credentials require a custom domain. REST Admin API is legacy; new public apps must use GraphQL Admin API.

Input Parameters

string ("ios" | "android")
required
Mobile application platform: ios or android.
string
required
iOS App ID (team ID and bundle ID) or Android application ID.
boolean
Whether to support iOS App Clips.
string
iOS App ID of the app clip; may be null when unused.
array
SHA256 fingerprints of the app signing certificate; Android only.
boolean
Whether to support iOS shared web credentials; requires a custom domain.
Whether URLs can link directly to the iOS or Android app.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: SHOPIFY_CREATE_ONE_TIME_APPLICATION_CHARGECreate a new one-time application charge in Shopify. Use when you need to bill merchants for one-time features, upgrades, or services. After creation, the merchant must approve the charge via the confirmation_url before it becomes active.

Input Parameters

string
required
The name of the application charge shown to merchants during approval. Must be descriptive and clear about what the charge is for.
boolean
Whether this is a test charge. Test charges do not result in actual credit card charges and are useful for development. Defaults to false.
number
required
The price of the application charge. Must be between 0.50 and 10,000.00 in the shop’s currency.
string
required
The URL where the merchant is redirected after accepting or declining the charge. Shopify appends charge_id and status parameters to this URL.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: SHOPIFY_CREATE_ORDERCreate a fully committed (real) order in Shopify without payment processing. Use when programmatically generating orders with line items, customer information, and addresses. Creates a live order immediately — not a draft; use draftOrderCreate for draft workflows.

Input Parameters

string
Additional order notes for internal use.
string
Comma-separated list of tags for order organization.
string
Customer’s email address. Used for order notifications.
string
Customer phone number for SMS notifications.
string
Three-letter ISO 4217 currency code.
object
Customer information. Can reference existing customer by id or create new with first_name, last_name, email fields.
string
Sum of all tax line amounts in shop currency.
array
required
Collection of items being purchased. Each line item should include at minimum: title, price, grams, quantity, and taxable. Can also include variant_id or product_id for existing products.
boolean
Whether to email order confirmation to customer. Defaults to false.
array
Transaction objects representing payment information. Each includes kind, amount, status, and optionally gateway.
array
Discount codes to apply. Note: Only the first code is applied when creating an order.
array
Shipping method details. Each should include title and price.
object
Mailing address for billing or shipping.
string ("pending" | "authorized" | "partially_paid" | "paid" | "partially_refunded" | "refunded" | "voided")
Payment state of the order. Can only be set when the order is created. Valid values: pending, authorized, partially_paid, paid, partially_refunded, refunded, voided.
object
Mailing address for billing or shipping.
string ("fulfilled" | "partial" | "restocked")
Order completion state. Valid values: fulfilled, partial, restocked, or null.
string ("bypass" | "decrement_ignoring_policy" | "decrement_obeying_policy")
Controls inventory claiming. Valid values: bypass (default, no inventory claimed), decrement_ignoring_policy (claim inventory regardless of policy), decrement_obeying_policy (claim inventory respecting policy).
boolean
Whether to email shipping confirmation to customer. Defaults to false.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: SHOPIFY_CREATE_ORDER_RISKCreates a risk assessment record for a Shopify order, documenting fraud detection findings or security concerns. Use this to record risk evaluations from external fraud detection systems or internal risk analysis tools. Important: This REST API endpoint is deprecated as of API version 2025-10. For new implementations, use the GraphQL orderRiskAssessmentCreate mutation instead. See: https://shopify.dev/docs/api/admin-graphql/latest/mutations/orderRiskAssessmentCreate Common use cases: - Recording fraud detection results from third-party services (e.g., MaxMind, Sift, Signifyd) - Documenting manual fraud reviews - Flagging high-risk orders for merchant review

Input Parameters

string
Numeric risk score as a string, ranging from 0.0 (lowest risk) to 1.0 (highest risk). Higher values indicate greater fraud likelihood.
string
Identifier for the source or system that generated this risk assessment (e.g., fraud detection service name, internal system identifier).
boolean
If true, this risk assessment will be visible on the order details page and will influence Shopify’s overall order risk level calculation. Cannot be changed after creation. Set to false for internal-only assessments.
string
Detailed explanation of the fraud check results that will be displayed to the merchant on the order details page (only visible when display is set to true).
string
required
The unique identifier of the order to create a risk assessment for.
boolean
If true, indicates this risk assessment is severe enough to warrant automatic order cancellation. Use true for high-risk orders that should not be fulfilled.
string ("cancel" | "investigate" | "accept")
Suggested action: ‘cancel’ (high risk), ‘investigate’ (medium risk), or ‘accept’ (low risk).

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: SHOPIFY_CREATE_ORDER_TRANSACTIONCreates an order transaction for authorization, capture, refund, void, or sale. Capture, void, and refund require a parent transaction ID; for multi-currency orders, currency is required for refund and capture transactions.

Input Parameters

string ("authorization" | "capture" | "sale" | "void" | "refund")
required
The transaction type. Valid values: ‘authorization’ (reserve amount), ‘capture’ (transfer reserved money, requires parent_id), ‘sale’ (authorization + capture in one step), ‘void’ (cancel pending authorization/capture), ‘refund’ (return captured money to customer).
boolean
Whether the transaction is a test transaction.
string
The amount of money included in the transaction. If not provided, defaults to the total cost of the order. For multi-currency orders, this field is required when creating refund and capture transactions.
string
The name of the payment gateway through which the transaction is issued.
string
The three-letter ISO 4217 currency code for the transaction. Required for multi-currency orders when creating refund and capture transactions.
string
required
The ID of the order for which the transaction is being created.
integer
The ID of an associated transaction. Required for capture, void, and refund operations to link to the original authorization. Not required for authorization or sale.
string
The origin channel of the transaction (e.g., ‘web’, ‘pos’).
string
The authorization code associated with the transaction.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: SHOPIFY_CREATE_PAGECreate a static web page in Shopify. Use when you need to add long-term static content like About Us, Contact, or Privacy Policy pages. The title and body_html fields are required.

Input Parameters

string
required
The page heading. This field is required; omitting it returns a 422 error.
string
Name of the person who created the page.
string
Human-friendly URL identifier used by Liquid templating. Must be unique across all pages in the store - if a page with this handle already exists, the API will reject the request with a 422 error. To avoid conflicts, omit this field to let Shopify auto-generate a unique handle from the title.
string
Optional HTML content of the page, including markup tags.
boolean
Publication status. Defaults to true (published); set to false for unpublished pages.
array
Additional metadata fields with key, namespace, value, and type.
string
When the page was published in ISO 8601 datetime format; null when hidden.
string
Suffix determining which template renders the page; null uses default template.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: SHOPIFY_CREATE_PRICE_RULECreates a price rule that defines discount logic for Shopify orders. Price rules specify how discounts work (percentage/fixed amount off, which products, which customers, etc.) and can be associated with discount codes for use at checkout. Common use cases: - Percentage off all products (e.g., 20% off sitewide) - Fixed amount off orders (e.g., $10 off orders over $50) - Buy X Get Y (BXGY) discounts - Free shipping offers - Customer segment-specific discounts Note: After creating a price rule, use the discount code creation endpoint to generate codes that customers can apply.

Input Parameters

string
required
The title of the price rule for internal use in Shopify admin. This is NOT the discount code customers enter - codes are created separately. Use descriptive names like ‘Summer Sale 2026’ or ‘BXGY Shirts’.
string
required
The discount amount as a negative string. For percentage discounts: ‘-20.0’ means 20% off. For fixed_amount discounts: ‘-10.0’ means $10 off. For free shipping (shipping_line target_type), must be exactly ‘-100’ (100% off).
string
When the discount expires, in ISO 8601 format. Must be after starts_at. If omitted, the discount never expires (remains active indefinitely). Format: ‘YYYY-MM-DDTHH:MM:SSZ’.
string
required
When the discount becomes active, in ISO 8601 format. Use UTC timezone (Z suffix) or include timezone offset. Format: ‘YYYY-MM-DDTHH:MM:SSZ’ or ‘YYYY-MM-DDTHH:MM:SS±HH:MM’.
string ("fixed_amount" | "percentage")
required
The type of discount. Use ‘fixed_amount’ for a dollar amount off or ‘percentage’ for a percentage off. For shipping_line target_type, only ‘percentage’ is accepted.
string ("line_item" | "shipping_line")
required
What the discount applies to. Use ‘line_item’ for product discounts or ‘shipping_line’ for shipping discounts.
integer
Maximum total number of times any discount code associated with this price rule can be used across all customers. If omitted, unlimited usage. Example: 100 means the discount can be used 100 times total.
integer
Number of times the discount can be allocated on a single cart. Only valid for BXGY discounts.
string ("all" | "entitled")
required
Which items the discount applies to. Use ‘all’ for all items or ‘entitled’ for specific products/collections/variants.
string ("each" | "across")
required
How the discount is allocated. Use ‘each’ to apply the discount to each eligible item or ‘across’ to split the discount across all items. IMPORTANT: Must be ‘across’ when target_selection is ‘all’. Must be ‘each’ when target_type is ‘shipping_line’.
boolean
If true, each customer can only use this discount once (tracked by customer account). If false or omitted, customers can use it multiple times. Useful for new customer offers or preventing abuse.
string ("all" | "prerequisite")
required
Which customers the discount applies to. Use ‘all’ for all customers or ‘prerequisite’ for specific customer segments or IDs.
array
Country IDs eligible for shipping discounts. Only valid when target_type is ‘shipping_line’.
array
Product IDs eligible for the discount. Only valid when target_type is ‘line_item’ and target_selection is ‘entitled’.
array
Variant IDs eligible for the discount. Only valid when target_type is ‘line_item’ and target_selection is ‘entitled’. Cannot include variants of products in entitled_product_ids.
array
Collection IDs eligible for the discount. Only valid when target_type is ‘line_item’ and target_selection is ‘entitled’.
array
Product IDs required in the cart for Buy X Get Y discounts.
array
Variant IDs required in the cart for Buy X Get Y discounts.
array
Specific customer IDs required for the discount to apply. Cannot be used with customer_segment_prerequisite_ids.
array
Collection IDs required in the cart for the discount to apply.
object
Minimum item quantity required for the discount to apply. Cannot be combined with prerequisite_to_entitlement_quantity_ratio.
object
Minimum order subtotal required for the discount to apply. Cannot be combined with prerequisite_to_entitlement_quantity_ratio.
array
Customer segment IDs required for the discount to apply. Cannot be used with prerequisite_customer_ids.
object
Maximum shipping price requirement for the discount to apply. Cannot be combined with prerequisite_to_entitlement_quantity_ratio.
object
Buy/Get ratio for BXGY (Buy X Get Y) discounts. Cannot be combined with prerequisite_subtotal_range, prerequisite_quantity_range, or prerequisite_shipping_price_range.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: SHOPIFY_CREATE_PRODUCTDEPRECATED: Use SHOPIFY_CREATES_A_NEW_PRODUCT instead. Creates a new product in a Shopify store; a product title is generally required. Note: The Product REST API is deprecated as of API version 2025-10. While it continues to function, Shopify recommends migrating to the GraphQL Admin API for product management in new implementations. Inventory Management: inventory_quantity is read-only and cannot be set during product creation. To manage inventory, first create the product, then use the InventoryLevel resource with the variant’s inventory_item_id (returned in the response) to adjust quantities at specific locations. Response: product data nested at data.response_data.product; extract id and variants[0].id for subsequent image or collection calls.

Input Parameters

string
required
The title of the product. Shopify requires this field when creating a product.
string
The name of the product’s vendor or manufacturer.
array
Array of product variants. If not provided, Shopify creates a default variant Start with only price and add attributes incrementally — complex payloads cause 400/422 errors. Deduplicate SKUs and ensure valid handles before calling; duplicate SKUs or missing required variant fields trigger 422 validation errors.
string
A detailed description of the product, which can include HTML formatting for rich text.
string
A category for the product, used for filtering and organizing products in Shopify.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: SHOPIFY_CREATE_PRODUCT_IMAGEDEPRECATED: Use SHOPIFY_CREATE_A_NEW_PRODUCT_IMAGE instead. Creates a new product image for a Shopify product. Use this tool to add images to products either by providing a publicly accessible image URL (src) or by uploading base64-encoded image data (attachment). You can specify the image position (1 is the main image), add alt text for accessibility, and associate the image with specific product variants. Supports PNG, JPG, and GIF formats. Products can have up to 250 images.

Input Parameters

object
required
An object containing the image details including source URL or attachment data, optional position, alt text, and variant associations. src must be a direct, publicly accessible HTTPS URL (no redirects, no HTML responses, no internal/temporary links); file size must be under ~20 MB.
string
required
The unique numeric identifier of the Shopify product to add the image to. Must be a valid product ID from your store. When chaining with other Shopify calls, extract from data.response_data.product.id in prior responses.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: SHOPIFY_CREATE_PRODUCT_METAFIELDCreates a new metafield for a specific Shopify product. Each namespace+key combination must be unique per product; use the update action if the metafield already exists.

Input Parameters

string
required
The key for the metafield. Must be at least 3 characters long.
string
The value type of the metafield. Defaults to single_line_text_field.
string
required
The value for the metafield.
string
required
The namespace for the metafield. Must be at least 3 characters long.
string
required
The unique identifier of the Shopify product to add a metafield to.
string
A description of the information that the metafield contains.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: SHOPIFY_CREATE_PRODUCT_RESOURCE_FEEDBACKSubmit feedback for a product, replacing this app’s previous feedback. Requires a Sales Channel app. Use requires_action for merchant-facing product issues, or success without messages to clear them. Outdated feedback can return 409. REST Admin API is legacy; new public apps must use GraphQL bulkProductResourceFeedbackCreate instead.

Input Parameters

string ("requires_action" | "success")
required
requires_action reports product issues; success removes prior feedback.
array
Required for requires_action; omit for success. One to ten messages, each at most 100 characters, starting with a capital letter (not all caps) and ending with a period.
string
required
ID of the product receiving feedback.
string
required
Forward the product’s updated_at timestamp unchanged for feedback ordering.
string
required
ISO 8601 UTC timestamp when this payload was constructed, not when queued feedback is delivered.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: SHOPIFY_CREATE_PRODUCT_VARIANTCreate a new product variant for an existing product. Use when adding a new variant with specific option values (like size, color). Each product can have up to 3 options and 100 variants maximum.

Input Parameters

object
required
The variant object containing variant details
string
required
The ID of the product to create the variant for

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: SHOPIFY_CREATE_PUB_SUB_WEBHOOK_SUBSCRIPTIONCreate a Google Cloud Pub/Sub webhook subscription in Shopify. Use when you need to configure real-time event notifications to Google Cloud Pub/Sub for events like order creation, product updates, or customer changes. Pub/Sub webhooks push events to your GCP topic immediately when changes occur, eliminating polling. You can filter events and control payload fields to optimize performance.

Input Parameters

string ("APP_PURCHASES_ONE_TIME_UPDATE" | "APP_SUBSCRIPTIONS_UPDATE" | "APP_UNINSTALLED" | "CARTS_CREATE" | "CARTS_UPDATE" | "CHANNELS_DELETE" | "CHECKOUTS_CREATE" | "CHECKOUTS_DELETE" | "CHECKOUTS_UPDATE" | "COLLECTIONS_CREATE" | "COLLECTIONS_DELETE" | "COLLECTIONS_UPDATE" | "COLLECTION_LISTINGS_ADD" | "COLLECTION_LISTINGS_REMOVE" | "COLLECTION_LISTINGS_UPDATE" | "CUSTOMERS_CREATE" | "CUSTOMERS_DELETE" | "CUSTOMERS_DISABLE" | "CUSTOMERS_ENABLE" | "CUSTOMERS_UPDATE" | "CUSTOMER_GROUPS_CREATE" | "CUSTOMER_GROUPS_DELETE" | "CUSTOMER_GROUPS_UPDATE" | "DISPUTES_CREATE" | "DISPUTES_UPDATE" | "DRAFT_ORDERS_CREATE" | "DRAFT_ORDERS_DELETE" | "DRAFT_ORDERS_UPDATE" | "FULFILLMENTS_CREATE" | "FULFILLMENTS_UPDATE" | "FULFILLMENT_EVENTS_CREATE" | "FULFILLMENT_EVENTS_DELETE" | "INVENTORY_ITEMS_CREATE" | "INVENTORY_ITEMS_DELETE" | "INVENTORY_ITEMS_UPDATE" | "INVENTORY_LEVELS_CONNECT" | "INVENTORY_LEVELS_DISCONNECT" | "INVENTORY_LEVELS_UPDATE" | "LOCATIONS_CREATE" | "LOCATIONS_DELETE" | "LOCATIONS_UPDATE" | "ORDERS_CANCELLED" | "ORDERS_CREATE" | "ORDERS_DELETE" | "ORDERS_EDITED" | "ORDERS_FULFILLED" | "ORDERS_PAID" | "ORDERS_PARTIALLY_FULFILLED" | "ORDERS_UPDATED" | "PRODUCTS_CREATE" | "PRODUCTS_DELETE" | "PRODUCTS_UPDATE" | "PRODUCT_LISTINGS_ADD" | "PRODUCT_LISTINGS_REMOVE" | "PRODUCT_LISTINGS_UPDATE" | "REFUNDS_CREATE" | "SHOP_UPDATE" | "THEMES_CREATE" | "THEMES_DELETE" | "THEMES_PUBLISH" | "THEMES_UPDATE")
required
The event type that triggers the webhook. Choose from available Shopify webhook topics like ORDERS_CREATE, PRODUCTS_UPDATE, CUSTOMERS_CREATE, etc.
object
required
Configuration details for the Pub/Sub webhook subscription including GCP project, topic, format, and optional filters.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: SHOPIFY_CREATE_RECURRING_APPLICATION_CHARGECreate a fixed-price, 30-day recurring app charge, optionally with usage billing. The merchant must approve confirmation_url before billing starts. Set test=true for testing without credit-card charges. Activating a new charge replaces the app’s existing recurring charge. REST Admin API is legacy; new public apps must use GraphQL Admin API instead.

Input Parameters

string
required
The recurring charge name shown to the merchant.
boolean
Set true to prevent credit-card billing. Null represents a non-test charge; omit to use Shopify’s default.
number
required
The fixed recurring price, maximum 10,000. Zero supports usage-only billing.
string
Usage-based billing terms presented to the merchant. Required with capped_amount.
string
required
Valid URL where Shopify redirects the merchant after accepting the charge.
integer
Number of free-trial days, starting when the charge is activated.
number
Maximum usage-based amount per billing cycle. Requires terms when provided.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: SHOPIFY_CREATE_REDIRECTCreate a URL redirect in Shopify. Use when you need to redirect an old path to a new location. When a full URL is provided as the path, it will be saved as an absolute path without the domain.

Input Parameters

string
required
The old path to be redirected. When the user visits this path, they will be redirected to the target. Maximum 1024 characters. When a full URL is provided, it will be saved as an absolute path without the domain.
string
required
The target location where the user will be redirected. Can be set to any path on the shop’s site or to an external URL. Maximum 255 characters.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: SHOPIFY_CREATE_REFUNDCreates a refund for a Shopify order with line items, shipping, or transactions. Multi-currency orders require currency; development or trial stores are limited to 5 refunds per minute.

Input Parameters

string
An optional note attached to the refund explaining the reason.
boolean
Whether to send a refund notification email to the customer. Defaults to false.
string
The three-letter currency code (ISO 4217 format) for the entire refund. Required for multi-currency orders. This is separate from the currency field in individual transactions.
string
required
The unique identifier of the order to refund.
object
Shipping refund details.
array
Optional list of refund transactions obtained from the calculate endpoint (with kind changed from ‘suggested_refund’ to ‘refund’).
array
List of line items to refund. Each line item must include line_item_id, quantity, and restock_type.
string ("restock" | "damage" | "customer" | "other")
The reason for any discrepancy between calculated and actual refund amounts.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: SHOPIFY_CREATE_RESOURCE_FEEDBACKCreates shop-level resource feedback to notify Shopify merchants about app setup requirements or successful configuration. Feedback appears on the merchant’s admin home screen. Each new submission automatically replaces previous feedback. Use state=‘requires_action’ to alert merchants about mandatory setup steps, or state=‘success’ to confirm proper configuration.

Input Parameters

string ("requires_action" | "success")
required
Indicates whether merchant action is needed. Must be ‘requires_action’ or ‘success’.
array
Array with exactly one message string (max 100 chars). Required when state is ‘requires_action’, disallowed when state is ‘success’. Message should follow format: ‘[Problem explanation]. [Suggested action].’
string
required
ISO 8601 UTC DateTime when feedback was generated (e.g., ‘2024-04-01T18:56:53.423703Z’).

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: SHOPIFY_CREATES_A_NEW_PRODUCTCreate a new product in Shopify. Use when you need to add a new product to the store with details like title, description, variants, options, and images.

Input Parameters

string
Comma-separated tags for filtering and search (max 250 tags, 255 chars each)
string
required
The name of the product (required)
array
Array of product images
string ("active" | "archived" | "draft")
Product status: ‘active’ (published and visible), ‘archived’ (hidden), or ‘draft’ (unpublished)
string
The name of the product’s vendor or manufacturer
array
Array of product options (max 3 options, e.g., Color, Size). Required if variants use option1/option2/option3
array
Array of product variants. If not provided, Shopify creates a default variant
string
Product description supporting HTML formatting
boolean
Whether to publish the product immediately
array
Custom metadata fields (e.g., for SEO: use namespace=‘global’, key=‘title_tag’ or ‘description_tag’)
string
Categorization for filtering and searching (e.g., ‘Snowboard’, ‘Apparel’)
string
Liquid template suffix for custom product pages

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: SHOPIFY_CREATE_SCRIPT_TAGCreate a new script tag in Shopify to load remote JavaScript into your online store. Script tags allow you to add custom functionality to your storefront by loading external JavaScript files. Requires ‘write_script_tags’ OAuth scope. Note: As of February 1, 2025, creating script tags for order status pages is blocked by Shopify. Use ‘online_store’ display_scope for storefront functionality.

Input Parameters

string
required
URL of the remote script to load. Must be HTTPS.
boolean
Whether the script should be cached by the CDN. Default: false.
string
required
DOM event that triggers the script load. Must be ‘onload’ (the only supported value).
string ("online_store" | "order_status" | "all")
Where the script displays. Options: ‘online_store’ (storefront only), ‘order_status’ (order status page - restricted since Feb 2025), or ‘all’ (both). Defaults to ‘online_store’ (recommended).

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: SHOPIFY_CREATE_SMART_COLLECTIONSCreate a new smart collection with automated product rules. Use when you need to create dynamic collections that automatically include products matching specific criteria (e.g., by vendor, price range, tags). Requires write_products scope.

Input Parameters

object
Image object for smart collection.
array
required
Array of rule objects defining which products are automatically included in this collection. Products must match all rules (or any rule if disjunctive is true).
string
required
Collection name, maximum 255 characters. This is the display name shown to customers.
string
HTML description displayed on collection pages. Can include formatting and markup.
boolean
Publishing status of the collection. Defaults to true (published).
string ("manual" | "alpha-asc" | "alpha-desc" | "best-selling" | "created" | "created-desc" | "price-asc" | "price-desc")
Product ordering method within the collection. Defaults to ‘best-selling’ if not specified.
boolean
If true, products match ANY rule; if false (default), products must match ALL rules.
string
Liquid template suffix for custom styling. If ‘custom’, uses collection.custom.liquid template.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: SHOPIFY_CREATES_OR_UPDATES_AN_ASSET_FOR_A_THEMECreates or updates a theme asset file (templates, stylesheets, scripts, or images) within a Shopify theme. This action uploads or modifies files in the theme’s file structure. For text-based files (HTML, Liquid, CSS, JS), use the ‘value’ parameter with file content. For binary files (images), use ‘attachment’ with base64-encoded data or ‘src’ with an external URL. To duplicate an existing asset, use ‘source_key’. Important: Exactly one of value, attachment, src, or source_key must be provided per request. Requirements: - Requires ‘write_themes’ scope with merchant approval - Note: REST Admin API is legacy as of October 2024; new apps should use GraphQL Admin API from April 2025

Input Parameters

string
required
The file path within the theme, consisting of directory and filename. Must follow the theme directory structure (e.g., ‘assets/’ for CSS/JS/images, ‘templates/’ for page templates, ‘layout/’ for layout files, ‘sections/’ for theme sections, ‘snippets/’ for reusable code, ‘config/’ for theme settings).
string
A publicly accessible URL from which Shopify will download the asset file. Typically used for images or other binary assets hosted externally. Shopify will fetch and store the file from this URL. Constraint: Exactly one of value, attachment, src, or source_key must be provided.
string
The text content of the file. Use this for text-based assets including HTML, Liquid templates, CSS stylesheets, JavaScript files, JSON config files, and XML. Provide the raw file content as a string. Constraint: Exactly one of value, attachment, src, or source_key must be provided.
string
required
The unique numeric identifier for the theme where the asset will be created or updated. Obtain theme IDs using the GET_THEMES action.
string
Base64-encoded binary data for non-text assets such as images (PNG, JPG, GIF, SVG), fonts, or other binary files. The binary file must be encoded in base64 format before sending. Constraint: Exactly one of value, attachment, src, or source_key must be provided.
string
Path to an existing asset in the same theme to duplicate. Creates a copy of the specified asset at the new location defined by ‘key’. Useful for creating backups or template variations. Constraint: Exactly one of value, attachment, src, or source_key must be provided.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: SHOPIFY_CREATE_STOREFRONT_ACCESS_TOKENCreates a new storefront access token for unauthenticated Storefront API access. The token delegates unauthenticated access scopes to clients that need to access the Storefront API without authentication. Requirements: - The app must be configured as an ‘extendable’ (Sales Channel) app in the Shopify Partner Dashboard - The app must have at least one unauthenticated access scope granted (e.g., unauthenticated_read_product_listings, unauthenticated_write_checkouts) - The created token inherits all unauthenticated scopes from the app Limitations: Maximum 100 active tokens per shop. Tokens cannot be updated after creation, only deleted.

Input Parameters

string
required
An arbitrary identifier for the token with no constraint on uniqueness. Used for reference purposes.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: SHOPIFY_CREATE_THEMECreates a new theme in Shopify from a ZIP file containing theme assets. Requires a publicly accessible URL to the ZIP file. The theme will default to ‘unpublished’ status unless the role is explicitly set to ‘main’ (which publishes the theme immediately after file extraction). Note: This action requires the ‘write_themes’ scope, which needs merchant approval in Shopify. A store can have a maximum of 20 themes.

Input Parameters

string
Publicly accessible URL where Shopify can download the theme ZIP file. The ZIP must contain valid theme files. If not provided, an empty theme will be created.
string
required
The name to assign to the new theme. This will be displayed in the Shopify admin. Maximum 50 characters.
string ("main" | "unpublished" | "development")
The theme’s role/status: ‘main’ (published and active on store), ‘unpublished’ (not visible to customers), ‘development’ (for testing). Defaults to ‘unpublished’. WARNING: Setting to ‘main’ will immediately publish this theme on your live store after file extraction completes.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: SHOPIFY_CREATE_USAGE_CHARGECreate a variable usage fee against the app’s existing recurring charge. Requires a recurring application charge configured with capped_amount and terms. This bills the merchant; for testing use only your own test=true recurring charge. There is no separate test flag for usage charges. Charges exceeding the remaining cap fail. REST Admin API is legacy; new public apps must use GraphQL appUsageRecordCreate instead.

Input Parameters

string
required
Usage charge price in the shop’s currency, preferably decimal text (for example, ‘1.00’). Must not exceed the recurring charge’s remaining usage balance.
string
required
Description of the usage charge shown to the merchant.
string
required
ID of the app’s recurring application charge with usage billing enabled.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: SHOPIFY_CREATE_WEBHOOKCreates a new webhook subscription in Shopify to receive real-time notifications when specific events occur in the store. Webhooks allow your application to be notified automatically when events like order creation, product updates, or customer changes happen. The webhook will POST event data to the specified address. Required parameters: address (destination URL) and topic (event type). Optional parameters: format (defaults to ‘json’), fields (to limit payload size), metafield_namespaces (to include metafields). Requires ‘write_webhooks’ scope. May also require topic-specific scopes (e.g., ‘read_orders’ for orders/* topics).

Input Parameters

string
required
Event that triggers the webhook. Common topics include: orders/create, orders/updated, products/create, products/update, customers/create, customers/update, app/uninstalled, shop/update, collections/create, inventory_items/update. See Shopify webhook documentation for the complete list of available topics. Note: Some topics may require specific API scopes or permissions.
array
Optional array of top-level resource fields to serialize and send. If omitted, all fields are included.
string
Data format for webhook delivery. Accepts ‘json’ or ‘xml’. Defaults to ‘json’ if not specified.
string
required
Destination URI where the webhook should send POST requests when events occur. Supports standard HTTPS URLs, Google Pub/Sub topics (format: pubsub://projectName:topicName), and Amazon EventBridge ARNs.
array
Array of metafield namespaces to include with each webhook.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: SHOPIFY_CREATE_WEBHOOK_SUBSCRIPTIONCreate a webhook subscription that notifies your app when specific events occur in a Shopify store. Use when you need real-time event notifications for orders, products, customers, or other resources. Supports HTTPS URLs, Google Pub/Sub topics, and AWS EventBridge event sources.

Input Parameters

string ("APP_PURCHASES_ONE_TIME_UPDATE" | "APP_SUBSCRIPTIONS_UPDATE" | "APP_UNINSTALLED" | "CARTS_CREATE" | "CARTS_UPDATE" | "CHANNELS_DELETE" | "CHECKOUTS_CREATE" | "CHECKOUTS_DELETE" | "CHECKOUTS_UPDATE" | "COLLECTIONS_CREATE" | "COLLECTIONS_DELETE" | "COLLECTIONS_UPDATE" | "COLLECTION_LISTINGS_ADD" | "COLLECTION_LISTINGS_REMOVE" | "COLLECTION_LISTINGS_UPDATE" | "CUSTOMERS_CREATE" | "CUSTOMERS_DELETE" | "CUSTOMERS_DISABLE" | "CUSTOMERS_ENABLE" | "CUSTOMERS_UPDATE" | "CUSTOMER_GROUPS_CREATE" | "CUSTOMER_GROUPS_DELETE" | "CUSTOMER_GROUPS_UPDATE" | "DISPUTES_CREATE" | "DISPUTES_UPDATE" | "DRAFT_ORDERS_CREATE" | "DRAFT_ORDERS_DELETE" | "DRAFT_ORDERS_UPDATE" | "FULFILLMENTS_CREATE" | "FULFILLMENTS_UPDATE" | "FULFILLMENT_EVENTS_CREATE" | "FULFILLMENT_EVENTS_DELETE" | "INVENTORY_ITEMS_CREATE" | "INVENTORY_ITEMS_DELETE" | "INVENTORY_ITEMS_UPDATE" | "INVENTORY_LEVELS_CONNECT" | "INVENTORY_LEVELS_DISCONNECT" | "INVENTORY_LEVELS_UPDATE" | "LOCATIONS_CREATE" | "LOCATIONS_DELETE" | "LOCATIONS_UPDATE" | "METAOBJECTS_CREATE" | "METAOBJECTS_DELETE" | "METAOBJECTS_UPDATE" | "ORDERS_CANCELLED" | "ORDERS_CREATE" | "ORDERS_DELETE" | "ORDERS_EDITED" | "ORDERS_FULFILLED" | "ORDERS_PAID" | "ORDERS_PARTIALLY_FULFILLED" | "ORDERS_UPDATED" | "PRODUCTS_CREATE" | "PRODUCTS_DELETE" | "PRODUCTS_UPDATE" | "PRODUCT_LISTINGS_ADD" | "PRODUCT_LISTINGS_REMOVE" | "PRODUCT_LISTINGS_UPDATE" | "REFUNDS_CREATE" | "SHOP_UPDATE" | "THEMES_CREATE" | "THEMES_DELETE" | "THEMES_PUBLISH" | "THEMES_UPDATE")
required
The type of event that triggers the webhook (e.g., ORDERS_CREATE, PRODUCTS_UPDATE, APP_UNINSTALLED).
object
required
Webhook subscription configuration object including callback URL and optional filters.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: SHOPIFY_CUSTOMIZE_RECURRING_APPLICATION_CHARGERequest a new usage-based cap for an active recurring application charge. Only capped_amount can be changed; annual subscriptions are not supported. Return update_capped_amount_url to the merchant for approval; a successful response does not mean the merchant has accepted the new cap. Uses the legacy REST Admin API; Shopify recommends appSubscriptionLineItemUpdate.

Input Parameters

string
required
New usage-based billing cap in the shop’s currency, sent as recurring_application_charge[capped_amount] in the query string.
string
required
ID of the active recurring application charge to customize.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: SHOPIFY_DELETE_ARTICLEDelete an article from a blog in Shopify. Use when you need to permanently remove blog content. This action is irreversible.

Input Parameters

string
required
The ID of the blog containing the article to be deleted.
string
required
The ID of the article to be deleted.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: SHOPIFY_DELETE_BLOGPermanently deletes a blog from a Shopify store using its blog_id; this action is irreversible and requires the ‘content’ access scope.

Input Parameters

string
required
The unique numeric identifier for the blog to be deleted. This ID is assigned by Shopify when the blog is created. Can be provided as an integer or string.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: SHOPIFY_DELETE_CARRIER_SERVICEPermanently remove a carrier service from a Shopify store by its numeric ID. Removes the service used to provide real-time shipping rates at checkout. Requires write_shipping permission and carrier service access on the store. Successful deletion returns an empty JSON object.

Input Parameters

string
required
Numeric ID of the carrier service to permanently delete. Obtain it from a carrier service list or get response.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: SHOPIFY_DELETE_COLLECTRemoves a product from a custom collection by deleting the collect. Use when you need to unlink a specific product from a custom collection using the collect ID.

Input Parameters

string
required
The unique numeric identifier of the collect to remove. A collect represents the relationship between a specific product and a custom collection. To find collect IDs, use the ‘Get collects’ action to list all product-collection relationships. Note: This endpoint only works with custom collections, not smart collections.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: SHOPIFY_DELETE_COMMENTRemove a comment from a Shopify blog. Use when you need to hide a comment from blog readers while preserving the data. The comment status will be changed to ‘removed’. Note: This action requires ‘write_content’ scope and protected customer data access approval from Shopify, as comments contain customer information (author, email, IP address).

Input Parameters

string
required
The numeric identifier for the comment to be removed. The comment will be marked as removed and hidden from blog readers.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: SHOPIFY_DELETE_COUNTRYDeletes a country from the shop’s tax configuration. Removes a country that was previously added to the shop’s tax settings. The country must have been added via the API or Shopify admin for this operation to succeed. Requires the ‘write_shipping’ scope. DEPRECATION WARNING: This REST API endpoint was deprecated in API version 2024-07 (effective July 1, 2024). The recommended alternative is the GraphQL Countries in Shipping Zone API. This endpoint may not be available in newer API versions or may have restricted access in many Shopify stores.

Input Parameters

string
required
The unique identifier (as a string) for the country to be removed from the shop’s tax configuration. This ID can be obtained from the GET countries endpoint.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: SHOPIFY_DELETE_CUSTOM_COLLECTIONDEPRECATED: Use SHOPIFY_DELETES_A_CUSTOM_COLLECTION instead. Permanently deletes a custom collection from a Shopify store using its collection_id; this action is irreversible and requires a valid, existing collection_id.

Input Parameters

string
required
The unique identifier for the custom collection that needs to be deleted. This ID is a numerical string assigned by Shopify when the collection is created.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: SHOPIFY_DELETE_CUSTOMERDeletes a customer from the Shopify store. Use when you need to permanently remove a customer who has no existing orders. Cannot delete customers with existing orders.

Input Parameters

string
required
The unique identifier for the customer to be deleted. Note: A customer cannot be deleted if they have existing orders.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: SHOPIFY_DELETE_CUSTOMER_ADDRESSRemoves an address from a customer’s address list. Cannot delete the customer’s default address - to delete a default address, first assign a different address as the default.

Input Parameters

string
required
The unique identifier for the address to be removed from the customer’s address list. Note: Cannot delete the customer’s default address without first assigning a different address as default.
string
required
The unique identifier for the customer whose address will be deleted.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: SHOPIFY_DELETE_DISPUTE_EVIDENCE_FILEDelete an uploaded evidence file from a Shopify Payments dispute. Requires Shopify-approved write_shopify_payments_dispute_file_uploads access. Uses the legacy REST Admin API; new public apps must use GraphQL. Returns an empty result for the documented successful response.

Input Parameters

string
required
Numeric Shopify Payments dispute ID.
string
required
Numeric ID of the dispute evidence file to delete.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: SHOPIFY_DELETE_DRAFT_ORDERDelete a draft order from Shopify. Use when you need to remove an existing draft order permanently.

Input Parameters

string
required
The unique identifier of the draft order to delete. This ID is required to target the correct draft order for removal.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: SHOPIFY_DELETE_FULFILLMENT_EVENTDeletes a fulfillment event (tracking status update) from an order’s fulfillment. Use this action when you need to remove an incorrect or outdated tracking event from a fulfillment. Fulfillment events represent tracking status updates like ‘in_transit’, ‘out_for_delivery’, or ‘delivered’ that are displayed to customers on the order status page. Common use cases: - Removing duplicate tracking events - Correcting erroneous status updates - Cleaning up test events Prerequisites: You must have valid order_id, fulfillment_id, and event_id. These can be obtained from order retrieval actions or fulfillment event list actions. Note: This REST endpoint is deprecated. For new integrations, consider using the GraphQL Admin API. Requires ‘write_orders’ scope and approval for protected customer data access.

Input Parameters

string
required
The unique numeric identifier for the fulfillment event to delete. You can obtain this from fulfillment event retrieval actions (e.g., get_fulfillment_events) or from the event.id field when creating fulfillment events.
string
required
The unique numeric identifier for the order. You can obtain this from order retrieval actions (e.g., list_order, get_order) or from the order.id field in order objects.
string
required
The unique numeric identifier for the fulfillment within the order. You can obtain this from the fulfillments array in an order object (e.g., order.fulfillments[0].id) or from fulfillment creation/retrieval actions.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: SHOPIFY_DELETE_FULFILLMENT_SERVICERemove an existing fulfillment service from a Shopify store. Use when you need to permanently delete a third-party fulfillment service.

Input Parameters

string
required
The unique identifier of the fulfillment service to remove. This is the numeric ID of the fulfillment service you want to delete.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: SHOPIFY_DELETE_INVENTORY_LEVELDeletes an inventory level of an inventory item at a location. Deleting an inventory level removes that item from the specified location. Every inventory item must have at least one inventory level.

Input Parameters

integer
required
The ID of the location that the inventory level belongs to. To find the ID of the location, use the Location resource.
integer
required
The ID for the inventory item. This identifies the specific inventory item to remove from the location.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: SHOPIFY_DELETE_MARKETING_EVENTDelete a marketing event from Shopify. Use when you need to remove an existing marketing event from the system.

Input Parameters

string
required
The unique identifier of the marketing event to delete. This ID is required to target the specific marketing event for removal.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: SHOPIFY_DELETE_METAFIELDDeletes a metafield by its ID from any Shopify resource. Use this action to permanently remove metafields from: - Shop-level metafields (use resource=‘shop’ or ‘metafields’) - Product metafields (resource=‘products’) - Collection metafields (resource=‘collections’) - Customer metafields (resource=‘customers’) - Order metafields (resource=‘orders’) - Other resource-specific metafields The deletion is permanent and cannot be undone. Returns an empty response on success.

Input Parameters

string
required
The resource type that owns the metafield. Use ‘shop’ or ‘metafields’ for shop-level metafields. Use specific resource types like ‘products’, ‘customers’, ‘orders’, ‘collections’, ‘blogs’, etc. for resource-specific metafields.
string
required
The unique identifier of the parent resource that owns the metafield. This parameter is required but ignored for shop-level metafields (when resource is ‘shop’ or ‘metafields’). For other resource types, provide the actual resource ID.
string
required
The unique identifier of the metafield to delete. This is the metafield’s ID, not the owner resource ID.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: SHOPIFY_DELETE_METAOBJECTDeletes a metaobject and its associated metafields using GraphQL mutation. Use when you need to permanently remove a metaobject from the Shopify store. The deletion is permanent and cannot be undone.

Input Parameters

string
required
The ID of the metaobject to delete. Must be a Shopify GID in the format ‘gid://shopify/Metaobject/{id}’ or just the numeric ID.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: SHOPIFY_DELETE_METAOBJECT_DEFINITIONDelete a metaobject definition and all its associated data. Use when you need to completely remove a metaobject definition schema. This mutation also asynchronously deletes all related metafield definitions, metaobjects, and metafields.

Input Parameters

string
required
The ID of the metaobject definition to delete. Must be in the format: gid://shopify/MetaobjectDefinition/{id} where {id} is the numeric ID. This mutation also deletes all related metafield definitions, metaobjects, and metafields asynchronously.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: SHOPIFY_DELETE_MOBILE_PLATFORM_APPLICATIONPermanently delete a mobile platform application association by its ID. Removes the Shopify association, not the installed iOS or Android app. Requires the mobile_platform_applications scope, which Shopify Support must enable for the app. Uses the legacy REST Admin API. Returns an empty object.

Input Parameters

string
required
Numeric ID of the mobile platform application to permanently delete, supplied as a string. Obtain it from a list or get response.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: SHOPIFY_DELETE_ORDERPermanently delete an order from Shopify. Use when you need to remove test orders, orders paid with manual payment methods, or draft orders marked as paid. Orders must be archived or canceled before deletion. Orders that interact with an online gateway, are paid via Shopify POS, online checkout, or with gift cards cannot be deleted.

Input Parameters

string
required
The unique identifier of the Shopify order to delete. Orders that interact with an online gateway cannot be deleted. The order must be archived or canceled before deletion.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: SHOPIFY_DELETE_ORDER_RISKRequests deletion of an order risk by order ID and risk ID using the configured Shopify REST API version. This deprecated action can delete only risks created by the application.

Input Parameters

string
required
The unique identifier of the order risk to be removed. Note: You can only delete an order risk that was created by your application - risks created by other applications cannot be deleted.
string
required
The unique identifier of the order containing the risk to be deleted.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: SHOPIFY_DELETE_PAGEDelete a page from a Shopify store permanently. Use when you need to remove an existing page; this operation is irreversible and requires content access scope.

Input Parameters

string
required
The unique numeric identifier for the page to be deleted. This can be obtained from page listing endpoints or page creation responses. The deletion is permanent and irreversible.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: SHOPIFY_DELETE_PRICE_RULEDeletes an existing price rule from the Shopify store permanently. Use this action to remove price rules that are no longer needed. Note that deleting a price rule will also delete any discount codes associated with it. This operation is idempotent - deleting an already-deleted price rule will return an error. Common use cases: - Removing expired or outdated promotional campaigns - Cleaning up test price rules from development - Deactivating seasonal sales or limited-time offers To get a price rule ID: use the list price rules action or reference the ID from when you created the price rule.

Input Parameters

integer
required
The unique identifier of the price rule to delete. You can obtain price rule IDs by listing price rules or from the response when creating a price rule.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: SHOPIFY_DELETE_PRODUCTPermanently deletes a product from a Shopify store by its product ID. This action is irreversible - deleted products cannot be recovered. Deleting a product also removes all associated variants, images, inventory, and removes the product from all collections and sales channels store-wide. If the goal is collection-only cleanup, adjust collection membership instead.

Input Parameters

string
required
The unique numeric identifier of the product to delete. You can obtain this ID from product creation responses or by listing products. Example: ‘8313381814466’ Must be a numeric REST ID (e.g., ‘8313381814466’); GraphQL GID formats (e.g., ‘gid://shopify/Product/123’) are not accepted.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: SHOPIFY_DELETE_PRODUCT_IMAGEDeletes a specific image from a product in Shopify, requiring the product_id of an existing product and the image_id of an image currently associated with that product.

Input Parameters

string
required
The unique identifier of the specific product image to be deleted.
string
required
The unique identifier of the product from which the image is to be deleted.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: SHOPIFY_DELETE_PRODUCT_METAFIELDDeletes a specific Shopify product metafield using the product ID and metafield ID. A not-found response is returned in userErrors rather than raised as an HTTP error.

Input Parameters

string
required
The unique identifier of the Shopify product.
string
required
The unique identifier of the metafield to delete. Deletion is permanent and irreversible. Verify the correct metafield by checking its namespace, key, and value before deletion, as multiple metafields can share similar keys across different namespaces.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: SHOPIFY_DELETE_PRODUCT_VARIANTDeletes a specific product variant from a Shopify store using its unique product ID and variant ID; this action is irreversible. Use when you need to permanently remove a variant from a product.

Input Parameters

string
required
The unique identifier of the Shopify product that contains the variant to be deleted.
string
required
The unique identifier of the specific product variant to be deleted.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: SHOPIFY_DELETE_REDIRECTPermanently deletes a URL redirect from a Shopify store. Use this tool to remove redirect rules that are no longer needed. A redirect automatically forwards visitors from an old URL path to a new target location. When you delete a redirect, visitors to the old path will no longer be automatically forwarded. Note: This operation is destructive and cannot be undone. If the redirect ID doesn’t exist, the API will return a 404 error.

Input Parameters

string
required
The unique numeric identifier of the redirect to delete. You can obtain redirect IDs by listing redirects or from redirect creation responses.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: SHOPIFY_DELETES_A_CUSTOM_COLLECTIONPermanently delete a custom collection from a Shopify store. Use when you need to remove a custom collection that is no longer needed. This operation is irreversible and requires the ‘write_products’ access scope.

Input Parameters

string
required
The unique identifier for the custom collection to be deleted. This ID is included in the URL path.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: SHOPIFY_DELETES_A_DISCOUNT_CODEDelete a discount code from a price rule. Use when you need to remove a specific discount code associated with a price rule.

Input Parameters

integer
required
The unique identifier of the price rule associated with the discount code. You can obtain price rule IDs by listing price rules using the ‘Get Price Rules List’ action or by creating a price rule.
integer
required
The unique identifier of the discount code to delete. You can obtain discount code IDs by listing discount codes for a price rule using the ‘Get Discount Codes’ action.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: SHOPIFY_DELETE_SAVED_SEARCHDelete a saved search in Shopify. Use when you need to remove a saved search by its ID. The ID must be provided in GID format (gid://shopify/SavedSearch/[ID]).

Input Parameters

string
required
The ID of the saved search to delete. Must be in GID format: gid://shopify/SavedSearch/[ID]. Example: gid://shopify/SavedSearch/123456789

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: SHOPIFY_DELETE_SCRIPT_TAGDelete a script tag from your Shopify store. Permanently removes a script tag using its unique identifier. Script tags are JavaScript files that load on your storefront. Use this action to clean up deprecated scripts or remove third-party integrations. Requires ‘write_script_tags’ OAuth scope. Common use cases: - Remove outdated analytics or tracking scripts - Clean up after uninstalling third-party apps - Delete test scripts from development Note: Script tags are automatically deleted when the app that created them is uninstalled.

Input Parameters

string
required
Unique identifier of the script tag to delete. Obtain this ID from list/get script tag endpoints.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: SHOPIFY_DELETE_SMART_COLLECTIONPermanently removes a smart collection from a Shopify store using its smart_collection_id; this action is irreversible and requires a valid, existing smart collection ID.

Input Parameters

string
required
The unique identifier for the smart collection to be deleted. This ID is a numerical string assigned by Shopify when the smart collection is created.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: SHOPIFY_DELETE_STOREFRONT_ACCESS_TOKENDelete an existing storefront access token from a Shopify store. Use when you need to permanently revoke access for a storefront access token. This operation is irreversible.

Input Parameters

string
required
The unique identifier of the storefront access token to delete. This is the numeric ID of the token.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: SHOPIFY_DELETE_THEMEDeletes a Shopify theme by ID using the write_themes scope. Deleted theme details may be returned, but a successful empty response contains no theme details.

Input Parameters

string
required
The unique numeric identifier for the theme to delete. Can be obtained from GET /themes.json endpoint or from the theme’s admin_graphql_api_id (extract the numeric portion). Must be a valid, existing theme ID.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: SHOPIFY_DELETE_THEME_ASSETDelete an asset from a Shopify theme. Use when you need to remove a specific asset file (such as CSS, JavaScript, images, or template files) from a theme by providing the theme ID and asset key. Note that required theme assets like layout/theme.liquid cannot be deleted and will result in an error.

Input Parameters

string
required
The ID of the theme containing the asset to delete.
string
required
The key representing the asset’s path within the theme to delete (e.g., ‘assets/bg-body.gif’, ‘templates/index.liquid’). Maximum 100 characters.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: SHOPIFY_DELETE_WEBHOOKDelete a webhook subscription from Shopify. Use when you need to remove an existing webhook. Only the app that registered the webhook can delete it; attempting to delete another app’s webhook will return a 404 error.

Input Parameters

string
required
The unique numeric identifier of the webhook subscription to delete. Only the app that registered the webhook can delete it.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: SHOPIFY_DELETE_WEBHOOK_SUBSCRIPTIONDelete a webhook subscription and stop all future webhooks to its endpoint. Use when you need to remove a webhook subscription that is no longer needed. Returns the deleted subscription’s ID for confirmation. Note: If you only use app-specific webhooks, this may not be needed. App-specific webhook subscriptions in shopify.app.toml are automatically managed by Shopify.

Input Parameters

string
required
The ID of the webhook subscription to delete. Must be in the format gid://shopify/WebhookSubscription/{id}. This is the globally unique identifier (GID) for the webhook subscription, not the numeric ID.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: SHOPIFY_DELETE_WEB_PRESENCEDelete a web presence from Shopify. Use when you need to remove a web presence by its ID.

Input Parameters

string
required
The ID of the web presence to delete. Must be in the format gid://shopify/WebPresence/{numeric_id} or just the numeric ID.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: SHOPIFY_DISABLE_GIFT_CARDDisable a gift card in Shopify. Use when you need to permanently deactivate a gift card. WARNING: This operation is irreversible and the gift card cannot be re-enabled once disabled.

Input Parameters

integer
required
The unique identifier of the gift card to disable. This operation is irreversible and cannot be undone.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: SHOPIFY_ENABLE_STANDARD_METAOBJECT_DEFINITIONEnable a standard metaobject definition from its template. Use when you need to activate a predefined Shopify metaobject template for use in your store.

Input Parameters

string
required
The type of the standard metaobject definition to enable. This is a predefined template type provided by Shopify (e.g., ‘product_review’).

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: SHOPIFY_GET_ABANDONMENTRetrieves an abandonment record from Shopify using its unique ID. Use when you need to query customer abandonment data including type, customer info, email state, and timing details.

Input Parameters

string
required
The ID of the abandonment in GID format (e.g., ‘gid://shopify/Abandonment/1’).

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: SHOPIFY_GET_ABANDONMENT_BY_ABANDONED_CHECKOUT_IDQuery abandonment information by abandoned checkout ID using Shopify’s GraphQL Admin API. Use when you need to retrieve customer journey data, abandonment type, and email state for a specific abandoned checkout. Returns null if the checkout doesn’t exist or has no abandonment tracking.

Input Parameters

string
required
The ID of the abandoned checkout to query. Must be in Shopify GID format (e.g., ‘gid://shopify/AbandonedCheckout/12345’) or a numeric ID that will be converted to GID format.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: SHOPIFY_GET_ACCESS_SCOPESRetrieves a list of access scopes associated with the access token. Use when you need to view the permissions that merchants have granted during app installation.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: SHOPIFY_GET_APPQuery information about a Shopify app using the GraphQL API. Use when you need to retrieve details about the currently authenticated app or a specific app by its ID.

Input Parameters

string
The ID of the app to retrieve. Must be in the format gid://shopify/App/{ID}. If omitted, returns the currently authenticated app.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: SHOPIFY_GET_APP_BY_HANDLEQuery app information by handle using the Shopify Admin GraphQL API. Use when you need to retrieve details about a specific Shopify app using its handle.

Input Parameters

string
required
Handle of the App - a URL-friendly identifier (e.g., ‘shopify-flow’, ‘product-reviews’).

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: SHOPIFY_GET_APP_INSTALLATIONQuery a specific app installation on a Shopify store. Use when you need to retrieve details about an app installation including access scopes, launch URL, and uninstall URL.

Input Parameters

string
The ID of the AppInstallation to retrieve. If omitted, returns the AppInstallation for the currently authenticated app.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: SHOPIFY_GET_APPLICATION_CHARGE_BY_IDRetrieve a single application charge by its unique identifier. Use when you need detailed information about a specific one-time charge.

Input Parameters

string
required
The unique identifier of the application charge to retrieve.
string
A comma-separated list of fields to include in the response (e.g., ‘id,name,price,status’). By default, all fields are returned.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: SHOPIFY_GET_APPLICATION_CHARGESRetrieves a list of one-time application charges for the current app installation. Application charges are one-time fees charged to merchants for app usage. This endpoint returns all charges with their status (pending, accepted, active, declined, expired). Use this to monitor billing history, verify charge status, or implement pagination with since_id. Returns an empty list if no charges exist, which is normal for new app installations.

Input Parameters

string
A comma-separated list of fields to include in the response (e.g., ‘id,name,price,status’). By default, all fields are returned.
string
Retrieve only application charges with an ID greater than this specified ID. This is used for paginating through results.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: SHOPIFY_GET_APPLICATION_CREDITRetrieve a single application credit issued to a shop by your app. Requires an existing credit ID and an app that uses Shopify’s Billing API. Uses the legacy REST Admin API. The provider’s creation deprecation does not deprecate this read endpoint. This action does not create financial credits.

Input Parameters

string
A comma-separated list of fields to include in the response. By default, all fields are returned.
string
required
The numeric ID of the application credit issued by your app.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: SHOPIFY_GET_APPLICATION_CREDITSRetrieve all application credits for a shop. Use when you need to view credits issued to merchants that can be used towards future app purchases.

Input Parameters

string
A comma-separated list of fields to include in the response (e.g., ‘id,amount,description,test,currency’). By default, all fields are returned.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: SHOPIFY_GET_ARTICLERetrieves a single article from a Shopify blog by its ID. Use this action when you need to: - Get detailed information about a specific blog article - Retrieve article content, metadata, or publication status - Access article properties like title, author, tags, or images The optional ‘fields’ parameter allows you to retrieve only specific article properties, reducing response size and improving performance when you don’t need the full article data. Requires the ‘read_content’ OAuth scope.

Input Parameters

string
Comma-separated list of article fields to include in the response. Use this to retrieve only specific fields and reduce payload size. Example: ‘id,title,author’ returns only those three fields.
string
required
The unique identifier (ID) of the blog containing the article.
string
required
The unique identifier (ID) of the article to retrieve.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: SHOPIFY_GET_BATCH_DISCOUNT_CODESRetrieves discount codes from a batch creation job, showing which succeeded and which failed. Workflow: After batch job completes (status=‘completed’), use this to get the actual codes. 1. Create price rule (get price_rule_id) 2. Create batch job (get batch_id) 3. Poll until completed 4. Use this action to retrieve codes Response: Successful codes have id populated and errors={}. Failed codes have id=null and errors with validation details. Use Cases: Verify created codes, identify validation errors, get IDs for further operations. Note: Requires ‘read_price_rules’ scope. Max 100 codes per batch.

Input Parameters

integer
required
The ID of the batch discount code creation job. Get this from the ‘id’ field in the response when creating a batch via POST /price_rules/{price_rule_id}/batch.json or from polling GET /price_rules/{price_rule_id}/batch/{batch_id}.json.
integer
required
The ID of the price rule associated with the batch discount code creation job. Get this from creating or listing price rules.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: SHOPIFY_GET_BLOGRetrieve a single blog by its unique identifier. Use when you need to access detailed information about a specific blog in the Shopify store.

Input Parameters

string
Comma-separated list of specific blog properties to include in the response (e.g., ‘id,title,handle’). If not specified, all properties are returned.
string
required
The unique numeric identifier for the blog to retrieve.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: SHOPIFY_GET_BLOG_ARTICLE_TAGSRetrieve a list of all article tags from a specific blog. Use when you need to get all unique tags that have been applied to articles in a particular blog, optionally sorted by popularity.

Input Parameters

integer
The maximum number of tags to retrieve. If not specified, all tags are returned.
string
required
The unique identifier for the blog to retrieve article tags from.
A flag for ordering retrieved tags by popularity. If present (set to any value like 1), results are ordered by popularity, starting with the most popular tag. If not present, tags are returned in default order.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: SHOPIFY_GET_BULK_OPERATIONQuery the status and details of a Shopify bulk operation by its ID. Use when you need to check the progress, status, or results of a previously initiated bulk operation. Returns metadata including status, completion time, result URLs, and error information if applicable. Note: The bulkOperation query requires API version 2025-10 or later.

Input Parameters

string
required
The ID of the BulkOperation to return in GID format (e.g., ‘gid://shopify/BulkOperation/6117019975874’). This is the unique identifier for the bulk operation created by bulkOperationRunQuery mutation.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: SHOPIFY_GET_CARRIER_SERVICERetrieve a single carrier service by ID to inspect its shipping-rate configuration. Uses the legacy Shopify REST Admin API. Unlike the list endpoint, this endpoint retrieves a specific service rather than listing active services.

Input Parameters

string
required
The numeric ID of the carrier service to retrieve.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: SHOPIFY_GET_CARRIER_SERVICESRetrieves all active carrier services configured in a Shopify store. Carrier services allow apps to provide real-time shipping rates at checkout. This endpoint returns only carrier services where active=true. Requirements: - Store must be on Advanced Shopify plan or higher, OR - Store must be on Shopify plan with yearly billing (with carrier service feature), OR - Store must be a development store Use this to view active carrier services for shipping rate calculations.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: SHOPIFY_GET_CATALOGS_COUNTQuery the count of catalogs in the Shopify store. Use when you need to know how many catalogs exist, optionally filtered by type or search query.

Input Parameters

string ("APP" | "COMPANY_LOCATION" | "MARKET")
Enum for catalog type values.
string
A filter made up of terms for searching catalogs. Filterable fields: app_id, company_id, company_location_id, id, managed_country_id, market_id, status, title. Example: ‘status:ACTIVE’

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: SHOPIFY_GET_CHECKOUT_PAYMENTRetrieve an existing checkout payment by checkout token and payment ID. Returns payment, transaction, card, and checkout details, including nullable processing and authentication information. Requires elevated sales-channel payment processing access and protected customer data approval. Uses the legacy REST Admin API; this action does not create or charge a payment.

Input Parameters

string
required
Token of the existing checkout: URL-safe letters, digits, underscores or hyphens.
string
required
ID of an existing payment on that checkout.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: SHOPIFY_GET_CHECKOUT_PROFILERetrieves a checkout profile from Shopify using its unique ID. Use when you need to query checkout profile details including name, publication status, and timestamps.

Input Parameters

string
required
The ID of the checkout profile in GID format (e.g., ‘gid://shopify/CheckoutProfile/691503298’).

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: SHOPIFY_GET_CHECKOUTS_COUNTRetrieve a count of abandoned checkouts from the past 90 days, optionally filtered by date ranges or status. A 403 response is returned as a count of zero, so zero can also indicate denied access.

Input Parameters

string ("open" | "closed")
Count checkouts with a given status. Default is ‘open’ if not specified
integer
Restrict results to after the specified ID
string
Count checkouts created before the specified date in ISO 8601 format
string
Count checkouts created after the specified date in ISO 8601 format
string
Count checkouts last updated before the specified date in ISO 8601 format
string
Count checkouts last updated after the specified date in ISO 8601 format

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: SHOPIFY_GET_COLLECT_BY_IDRetrieves a specific collect by its ID. Use when you need to get details about a specific product-collection relationship.

Input Parameters

string
Comma-separated list of fields to retrieve (e.g., ‘id,collection_id,product_id’). If omitted, all fields are returned.
string
required
The unique identifier for the collect resource. A collect represents the relationship between a product and a custom collection.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: SHOPIFY_GET_COLLECTION_BY_IDRetrieves a specific Shopify collection by its collection_id, optionally filtering returned data to specified fields.

Input Parameters

string
Comma-separated list of fields to retrieve. Note: The Shopify collections endpoint may not fully support field filtering and might return all fields regardless of this parameter. E.g., ‘id,title,handle’.
string
required
The unique numeric identifier of the Shopify collection to retrieve. Must be a numeric ID, not a GraphQL GID.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: SHOPIFY_GET_COLLECTION_BY_IDENTIFIERQuery a collection by identifier (ID or handle) using the Shopify GraphQL Admin API. Use when you need to fetch collection details by either its global ID or unique handle.

Input Parameters

object
required
The identifier used to fetch the collection. Must provide either id or handle field.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: SHOPIFY_GET_COLLECTION_LISTINGRetrieve a specific collection listing published to your sales channel app. Uses the legacy REST Admin API. Requires a collection listing visible to the current app and merchant-approved read_product_listings access. Publishing a collection does not automatically publish its products to your channel.

Input Parameters

string
required
The numeric ID of the collection listing to retrieve.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: SHOPIFY_GET_COLLECTSRetrieves a list of collects from a Shopify store, where a collect links a product to a custom collection. Returns only collect mapping records (collect_id, collection_id, product_id, position, etc.), not full product details — use SHOPIFY_GET_PRODUCTS_IN_COLLECTION if product details are needed.

Input Parameters

integer
Maximum number of collects to retrieve (1-250).
string
Comma-separated list of fields to retrieve (e.g., id,collection_id,product_id); if unspecified, all fields are returned.
integer
Retrieve only collects created after this ID, for pagination.
integer
Filter collects by product ID to retrieve only collections that contain a specific product.
integer
Filter collects by custom collection ID to retrieve only products linked to a specific collection.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: SHOPIFY_GET_COLLECTS_COUNTRetrieves a count of collects (product-collection relationships). Use when you need to know the total number of collects, optionally filtered by collection_id or product_id.

Input Parameters

string
Filter counts to a specific product. Returns only collects for this product.
string
Filter counts to a specific custom collection. Returns only collects belonging to this collection.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: SHOPIFY_GET_COMMENTRetrieve a single article comment by ID using the legacy REST Admin API. Returns comment content, author information and moderation status. Use fields to select specific properties. Requires read_content (or write_content) and protected customer data access.

Input Parameters

string
Comma-separated comment fields to include, such as ‘id,body,author’.
string
required
The positive numeric ID of the comment to retrieve.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: SHOPIFY_GET_COMMENTS_COUNTRetrieves a count of comments. Use when you need to know how many comments exist, optionally filtered by article, blog, status, or date ranges.

Input Parameters

string ("pending" | "published" | "unapproved")
Filter results by their status. Options: pending, published, unapproved.
integer
Identifier for the blog containing articles to count comments from.
integer
Identifier for the specific article whose comments to count.
string
Count comments created before this date in ISO 8601 format.
string
Count comments created after this date in ISO 8601 format.
string
Count comments last updated before this date in ISO 8601 format.
string
Count comments last updated after this date in ISO 8601 format.
string
Count comments published before this date in ISO 8601 format.
string
Count comments published after this date in ISO 8601 format.
string ("published" | "unpublished" | "any")
Filter by published status. Default: any. Options: published, unpublished, any.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: SHOPIFY_GET_COUNTRIESRetrieve a list of countries configured in the Shopify store with tax rates and provinces. Use when you need to get countries and their tax configuration for the store.

Input Parameters

string
Show only certain fields, specified by a comma-separated list of field names (e.g., ‘id,name,code’).
string
Restrict results to countries after the specified ID. Used for pagination.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: SHOPIFY_GET_COUNTRIES_COUNTRetrieves the count of countries configured in a Shopify store. Use when you need to determine how many countries are available in the store’s tax and shipping settings. DEPRECATION WARNING: This endpoint is deprecated as of API version 2024-07. Consider using the GraphQL Admin API’s ‘CountriesInShippingZones’ object as an alternative. This REST endpoint will continue to work but may be removed in future API versions.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: SHOPIFY_GET_COUNTRIES_PARAM_COUNTRY_ID_PROVINCES_COUNTRetrieves a count of provinces for a country. Use when you need to determine how many provinces or states are configured for a specific country in Shopify.

Input Parameters

string
required
The unique identifier for the country in Shopify. Used to retrieve the province count for this specific country.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: SHOPIFY_GET_COUNTRIES_PARAM_COUNTRY_ID_PROVINCES_PARAM_PROVIGet Province for Country

Input Parameters

string
Restrict response to specified fields (comma-separated list of field names).
string
required
The unique identifier for the country containing the province.
string
required
The unique identifier for the specific province to retrieve.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: SHOPIFY_GET_COUNTRYRetrieve a specific country by its ID from Shopify. Use when you need to get tax information, country details, and province-level tax rates for a particular country.

Input Parameters

string
Show only certain fields, specified by a comma-separated list of field names (e.g., ‘id,name,code’).
string
required
The unique identifier for the country to retrieve.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: SHOPIFY_GET_COUNTRY_PROVINCESRetrieve a list of provinces for a specified country. Use when you need to get province information, tax rates, and shipping zones for a specific country.

Input Parameters

string
Comma-separated list of fields to include in the response (e.g., ‘id,code,name’).
integer
Restrict results to provinces after the specified ID.
string
required
The unique identifier for the country whose provinces are being retrieved.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: SHOPIFY_GET_CURRENCIESRetrieve a list of currencies enabled on a Shopify store. This action fetches all currencies that the merchant has enabled for multi-currency transactions through Shopify Payments. Each currency includes its ISO 4217 code, the timestamp when its conversion rate was last updated, and its enabled status. Use this when you need to: - Check which currencies are available for customer transactions - Verify currency configurations for the shop - Get conversion rate update timestamps - Determine multi-currency support capabilities Note: This is a read-only endpoint that requires no parameters and returns all enabled currencies for the authenticated shop.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: SHOPIFY_GET_CURRENT_USERRetrieve the staff user associated with the access token. Requires a token created for a specific shop user, not an app-only token. Available only to private/custom apps installed on Shopify Plus stores; Shopify Plus Support must approve the read_users scope. Uses the legacy Shopify REST Admin API.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: SHOPIFY_GET_CUSTOM_COLLECTION_BY_IDRetrieve a single custom collection by its unique ID from Shopify. Use when you need to fetch detailed information about a specific custom collection.

Input Parameters

string
Comma-separated list of specific fields to return in the response (e.g., ‘id,title,handle’). If omitted, all fields are returned.
string
required
The unique identifier of the custom collection to retrieve.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: SHOPIFY_GET_CUSTOM_COLLECTIONSRetrieves a list of custom collections from a Shopify store. Supports filtering by IDs, handle, title, product ID, publication status, and date ranges (published/updated). Use the fields parameter to retrieve only specific properties, and limit/since_id for pagination. Combining multiple filters (handle, ids, product_id) simultaneously may return empty sets; use broad filters first. Newly created collections may not appear immediately; use GetCollectionById to verify a specific collection shortly after creation.

Input Parameters

string
Show only collections specified by a comma-separated list of IDs.
integer
The maximum number of custom collections to return (between 1 and 250, default: 50).
string
Show custom collections with a given title.
string
Show only certain fields, specified by a comma-separated list of field names.
string
Filter results by the custom collection’s unique, human-readable string identifier (e.g., ‘summer-specials’).
integer
Restrict results to after the specified ID (for pagination).
integer
Show custom collections that include a given product ID.
string
Show custom collections last updated before this date (format: 2014-04-25T16:15:47-04:00).
string
Show custom collections last updated after this date (format: 2014-04-25T16:15:47-04:00).
string
Show custom collections published before this date (format: 2014-04-25T16:15:47-04:00).
string
Show custom collections published after this date (format: 2014-04-25T16:15:47-04:00).
string
Show custom collections with a given published status. Valid values: published, unpublished, any (default: any).

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: SHOPIFY_GET_CUSTOM_COLLECTIONS_COUNTRetrieves the total count of custom collections in a Shopify store with optional filters. Use this action to get the number of custom collections, optionally filtered by: - Product ID (collections containing a specific product) - Publication date range (when collections were published) - Publication status (published, unpublished, or any) - Title (exact title match) - Update date range (when collections were last modified) Returns a simple count integer without collection details. For full collection data, use get collection list actions.

Input Parameters

string
Count only custom collections with this exact title.
string
Count only custom collections that include this specific product ID.
string
Count only custom collections last updated before this date (ISO 8601 format, e.g., 2024-04-25T16:15:47-04:00).
string
Count only custom collections last updated after this date (ISO 8601 format, e.g., 2024-04-25T16:15:47-04:00).
string
Count only custom collections published before this date (ISO 8601 format, e.g., 2024-04-25T16:15:47-04:00).
string
Count only custom collections published after this date (ISO 8601 format, e.g., 2024-04-25T16:15:47-04:00).
string ("published" | "unpublished" | "any")
Filter collections by publication status: ‘published’ (published only), ‘unpublished’ (unpublished only), or ‘any’ (both). Defaults to ‘any’ if not specified.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: SHOPIFY_GET_CUSTOMERRetrieve a single customer by their unique identifier. Use when you need to fetch detailed information about a specific customer.

Input Parameters

string
Comma-separated list of fields to include in the response. Allows optimization by limiting the response payload to only necessary fields.
string
required
The unique identifier for the customer.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: SHOPIFY_GET_CUSTOMER_ADDRESSRetrieve details of a single customer address from Shopify. Use when you need to get complete information about a specific address for a customer, including address lines, city, province, country, postal code, and phone number.

Input Parameters

string
required
The unique identifier for the customer address in Shopify.
string
required
The unique identifier for the customer in Shopify.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: SHOPIFY_GET_CUSTOMER_ADDRESSESRetrieves a customer’s addresses, including address and contact details and default-address indicators. A limit can restrict the number returned; access to protected customer data may require Shopify approval.

Input Parameters

integer
Maximum number of addresses to return in the response. If not specified, all addresses are returned. Pagination is handled via Link headers in the response when using this parameter.
string
required
The unique numeric identifier for the customer in Shopify. Must be provided as a string.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: SHOPIFY_GET_CUSTOMER_ORDERSRetrieves a page of orders for a specific Shopify customer by customer ID, with optional status filtering and pagination parameters.

Input Parameters

integer
Maximum number of orders to return. Accepted values are 1 to 250. Default is 50.
string
Filter orders by status. Valid values: open, closed, cancelled, any. Default is open.
integer
Return only orders after the specified ID. Use for cursor-based pagination through large result sets.
string
A cursor value for cursor-based pagination. Use the page_info value from the Link header of a previous response to fetch the next page of results.
string
required
Unique identifier for the customer whose orders are to be retrieved.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: SHOPIFY_GET_CUSTOMERS_COUNTRetrieves a count of all customers. Use when you need to know the total number of customers, optionally filtered by creation or update dates.

Input Parameters

string
Show customers created before a specified date. Format: ISO 8601 datetime string (e.g., ‘2024-12-31T23:59:59-00:00’).
string
Show customers created after a specified date. Format: ISO 8601 datetime string (e.g., ‘2024-01-01T00:00:00-00:00’).
string
Show customers last updated before a specified date. Format: ISO 8601 datetime string.
string
Show customers last updated after a specified date. Format: ISO 8601 datetime string.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: SHOPIFY_GET_CUSTOMERS_SEARCHSearch for customers matching a supplied query. Use when you need to find customers based on specific criteria like email, name, location, order count, or spending.

Input Parameters

integer
Maximum number of results to return per page. Must be between 1 and 250. Defaults to 50.
string
Sort order for results. Supported fields: ‘last_order_date’, ‘orders_count’, ‘updated_at’, ‘name’, ‘location’, ‘id’. Format: ‘field_name ASC’ or ‘field_name DESC’. Note: Many other fields including ‘created_at’ are not supported for sorting. If not specified or if an unsupported field is used, results are returned in default order.
string
required
Search query using Shopify search syntax to filter customers. Supports fields like email, first_name, last_name, orders_count, total_spent, city, country, customer_tag, and more. Use wildcards (*) for broad matches, logical operators (AND, OR), and comparisons (>, <, >=, <=). Example: ‘email:customer@example.com’, ‘first_name:John AND country:US’, ‘orders_count:>5’.
string
Comma-separated list of fields to include in response. If not specified, all fields are returned. Example: ‘id,email,first_name,last_name,orders_count’.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: SHOPIFY_GET_DISCOUNT_CODERetrieves a single discount code for a price rule. Use when you need to get details about a specific discount code including its usage count and timestamps.

Input Parameters

string
required
The ID of the price rule that the discount code belongs to.
string
required
The ID of the discount code to retrieve.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: SHOPIFY_GET_DISCOUNT_CODE_BATCH_JOBRetrieves the status and progress of an asynchronous batch discount code creation job for a specific price rule. Use this to monitor a job that creates up to 100 discount codes at once. Check the ‘status’ field (‘queued’, ‘running’, or ‘completed’) and ‘imported_count’/‘failed_count’ to track progress. The job is created via POST /price_rules/{price_rule_id}/batch and this endpoint lets you poll for its completion.

Input Parameters

integer
required
The ID of the discount code creation job to retrieve. Obtain this from the response when creating a batch discount code creation job via POST /price_rules/{price_rule_id}/batch.
integer
required
The ID of the price rule associated with the discount code creation job. Obtain this from creating or listing price rules.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: SHOPIFY_GET_DISCOUNT_CODES_COUNTRetrieves a count of discount codes for a shop. Use when you need to know how many discount codes exist, optionally filtered by usage statistics.

Input Parameters

integer
Count discount codes by exact number of times used. Returns only codes used this many times.
integer
Count discount codes with usage less than or equal to this value. Use to find infrequently used codes.
integer
Count discount codes with usage greater than or equal to this value. Use to find frequently used codes.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: SHOPIFY_GET_DISCOUNT_CODES_LOOKUPLook up a discount code by its code name and retrieve its resource location and IDs. Use this when you have a discount code (e.g., “SUMMER2024”) and need to find its price_rule_id and discount_code_id for use with other API endpoints. This is faster than listing all discount codes when you know the specific code name. The API returns a 303 redirect with the location in the header.

Input Parameters

string
required
The discount code name to look up. This parameter is case-insensitive and retrieves the location of the discount code resource. Maximum 100 characters.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: SHOPIFY_GET_DISPUTE_EVIDENCERetrieve evidence for one Shopify Payments dispute using the legacy REST API. Requires Shopify approval for dispute-evidence access scopes and a shop with Shopify Payments disputes. This read does not update or submit evidence.

Input Parameters

string
required
The numeric REST ID of the dispute.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: SHOPIFY_GET_DRAFT_ORDERRetrieve detailed information for a specific draft order from a Shopify store. Use when you need to access a draft order’s status, customer details, line items, pricing, or shipping information.

Input Parameters

string
Comma-separated list of fields to include in the response (e.g., ‘id,name,status’).
string
required
The unique identifier for the draft order to retrieve.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: SHOPIFY_GET_EVENTRetrieve a specific Shopify event by its ID. Events track actions performed on store resources like products, orders, collections, and articles. Use this to get detailed information about a specific event, including what action occurred, when it happened, and which resource was affected. Common use cases: auditing changes, tracking resource history, debugging workflows. Note: This endpoint contains protected customer data and may require explicit approval from Shopify for access. For development/testing, request protected customer data access in the Shopify Partner Dashboard.

Input Parameters

string
Comma-separated list of fields to include in the response (e.g., ‘id,subject_id,verb’).
string
required
The unique identifier of the event to retrieve.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: SHOPIFY_GET_EVENTSRetrieve a list of Shopify store audit trail events, with optional filters for resource type, action, dates and ID. The legacy REST action returns event data but does not expose pagination Link headers.

Input Parameters

string
Filter events by action type (verb). Common values: ‘create’ (resource creation), ‘update’ (resource modification), ‘destroy’ (resource deletion). Other possible verbs include ‘published’, ‘unpublished’, ‘placement’, ‘removal’, ‘confirmed’, ‘cancelled’, ‘pending’, ‘fulfilled’, ‘paid’.
integer
The number of results to show. Maximum: 250, Default: 50.
string
Show only certain fields, specified by a comma-separated list of field names.
string
Filter events by resource type(s). Comma-separated list of resource names that generated the events. Valid values: Article, Blog, Collection, Comment, Order, Page, PriceRule, Product, ApiPermission. For example, ‘Order,Product’ shows only events from orders and products.
string
Show only results after the specified ID.
string
Show events created at or before this date and time. Format: ISO 8601 (e.g., 2014-04-25T16:15:47-04:00).
string
Show events created at or after this date and time. Format: ISO 8601 (e.g., 2014-04-25T16:15:47-04:00).

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: SHOPIFY_GET_FULFILLMENTRetrieves all fulfillments (shipments) associated with a specific fulfillment order. A fulfillment order represents a group of line items that are to be fulfilled from a specific location. This action returns tracking information, shipment status, line item details, and delivery information for each fulfillment. Use this when you need to: - Check tracking numbers and carrier information for shipped items - Monitor shipment status (in_transit, delivered, etc.) - View which line items were included in specific shipments - Get fulfillment location and origin address details Prerequisites: You must first obtain a fulfillment_order_id by using the ‘Get fulfillment orders for order’ action with an order_id.

Input Parameters

string
required
The unique identifier of the fulfillment order. To obtain this ID, first use the ‘Get fulfillment orders for order’ action with an order_id.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: SHOPIFY_GET_FULFILLMENT_EVENTRetrieves a specific fulfillment event by its ID, providing detailed shipment tracking information. Use this when you need to check the status and location of a specific tracking event for a fulfilled order. The event contains information such as status (in_transit, out_for_delivery, delivered), timestamps, geographic location data (city, province, country, coordinates), and carrier messages. Fulfillment events track the shipment progress from the carrier and are displayed on the customer’s order status page. Each event represents a status update (e.g., package picked up, in transit, out for delivery, delivered). Note: This REST API endpoint is deprecated as of Shopify API 2024-10. Consider using the GET fulfillment events list endpoint or GraphQL API for new integrations. Requires valid order_id, fulfillment_id, and event_id - all three IDs must correspond to existing resources in the store.

Input Parameters

string
required
The unique numeric identifier for the specific fulfillment event to retrieve. You can obtain this from the GET fulfillment events list action or from the event.id field when creating fulfillment events.
string
required
The unique numeric identifier for the order. You can obtain this from order creation/retrieval actions, or from the order.id field in order objects.
string
required
The unique numeric identifier for the fulfillment within the order. You can obtain this from the fulfillments array in an order object (e.g., order.fulfillments[0].id) or from fulfillment creation actions.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: SHOPIFY_GET_FULFILLMENT_EVENTSRetrieves tracking events for a specific fulfillment, showing shipment status updates (e.g., in_transit, out_for_delivery, delivered) with timestamps and location information. Use this when you need to check the tracking history or current delivery status of a fulfilled order. Note: Returns events only for fulfillments that have tracking information from carriers.

Input Parameters

string
required
The unique numeric identifier for the order. You can obtain this from order creation/retrieval actions, or from the order.id field in order objects.
string
required
The unique numeric identifier for the fulfillment within the order. You can obtain this from the fulfillments array in an order object (e.g., order.fulfillments[0].id) or from fulfillment creation actions.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: SHOPIFY_GET_FULFILLMENT_ORDERRetrieve all fulfillment orders for a specific order. Use when you need to check fulfillment status, assigned locations, or line items for an order.

Input Parameters

string
required
The unique identifier of the order whose fulfillment orders you want to retrieve.
boolean
Include the financial summary data for each line item, if available. Defaults to false.
boolean
Indicates whether the order reference fields should be returned in the result. Defaults to false.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: SHOPIFY_GET_FULFILLMENT_ORDER_FULFILLMENTSRetrieves all fulfillments associated with a specific fulfillment order. Returns detailed shipment tracking information, delivery status, line items, and fulfillment metadata. Use this action when you need to check the status of completed or in-progress fulfillments for a fulfillment order.

Input Parameters

string
required
The unique identifier of the fulfillment order whose associated fulfillments should be retrieved.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: SHOPIFY_GET_FULFILLMENT_ORDER_LOCATIONS_FOR_MOVERetrieve locations that a fulfillment order can potentially move to. Use when you need to identify which locations are available for transferring a specific fulfillment order. The resulting list is sorted alphabetically in ascending order by location name.

Input Parameters

string
required
The ID of the fulfillment order to query for potential move locations.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: SHOPIFY_GET_FULFILLMENT_ORDER_MOVE_LOCATIONSRetrieve a list of locations that a fulfillment order can potentially move to. Use when you need to identify available destination locations for relocating a fulfillment order.

Input Parameters

string
required
The unique identifier of the fulfillment order to retrieve potential move locations for.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: SHOPIFY_GET_FULFILLMENT_ORDERS_FOR_ORDERRetrieves a list of fulfillment orders for a specific order. Use when you need to get fulfillment order details including line items, delivery method, assigned location, and fulfillment status for a given order.

Input Parameters

string
required
The ID of the order for which to retrieve fulfillment orders.
boolean
Include financial summary data for each line item if available. Defaults to false if not specified.
boolean
Return order reference fields in the result. Defaults to false if not specified.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: SHOPIFY_GET_FULFILLMENT_SERVICERetrieve a single fulfillment service by ID, including its location and capabilities. Uses Shopify’s legacy REST Admin API. Obtain an existing service ID from Get Fulfillment Services; this action does not modify the service.

Input Parameters

string
required
The numeric ID of the fulfillment service to retrieve.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: SHOPIFY_GET_FULFILLMENT_SERVICESRetrieve fulfillment services available on the Shopify store, including third-party services that prepare and ship orders. By default the request selects services created by the requesting app; the scope can be set to all store services.

Input Parameters

string ("current_client" | "all")
Specifies which fulfillment services to retrieve. ‘current_client’ returns services created by the requesting app (default). ‘all’ returns all store services.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: SHOPIFY_GET_GIFT_CARD_BY_IDRetrieves detailed information about a specific gift card by its ID. Returns the gift card’s balance, status, creation date, and other metadata. Note: The full gift card code is never returned by this endpoint - only the last 4 characters are available for security reasons. The full code is only visible at creation time. Requires: read_gift_cards scope (Shopify Plus only, requires Shopify Support approval).

Input Parameters

string
required
The unique identifier of the gift card to retrieve.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: SHOPIFY_GET_GIFT_CARDSRetrieve a list of gift cards from Shopify. Use when you need to fetch gift cards with optional filtering by status and pagination support.

Input Parameters

integer
Maximum number of results to return. Must be ≤250, default is 50.
string
Show only certain fields, specified by a comma-separated list of field names (e.g., ‘id,balance,currency’).
string ("enabled" | "disabled")
Filter gift cards by status. Accepted values: “enabled” or “disabled”.
string
Restrict results to after the specified ID (for pagination).

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: SHOPIFY_GET_GIFT_CARDS_COUNTRetrieves the total count of gift cards in the store. Use when you need to know how many gift cards exist, optionally filtered by enabled or disabled status.

Input Parameters

string ("enabled" | "disabled")
Filter by gift card status. Use ‘enabled’ to count only enabled gift cards, ‘disabled’ to count only disabled gift cards. If omitted, returns count of all gift cards regardless of status.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: SHOPIFY_GET_INVENTORY_ITEMRetrieves a single inventory item by ID. Use when you need to get detailed information about an inventory item including SKU, cost, tracking status, and shipping requirements.

Input Parameters

string
required
The unique identifier of the inventory item to retrieve.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: SHOPIFY_GET_INVENTORY_ITEMSRetrieves inventory items by specified IDs, including details such as SKU, cost, shipping requirements, and tracking status. The response does not include pagination links.

Input Parameters

string
required
Comma-separated list of inventory item IDs to retrieve. Maximum 100 IDs per request. Required parameter.
integer
Maximum number of results to return per page. Range: 1-250, Default: 50.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: SHOPIFY_GET_INVENTORY_LEVELSRetrieves a list of inventory levels for specified items and locations. Use when you need to check inventory quantities at specific locations. At least one of inventory_item_ids or location_ids must be provided as a filter parameter.

Input Parameters

integer
Maximum number of results to return per page. Range: 1-250, Default: 50.
string
Comma-separated list of location IDs to filter by. Maximum 50 IDs per request. At least one of inventory_item_ids or location_ids must be provided.
string
Show inventory levels updated at or after this date. ISO 8601 datetime format.
string
Comma-separated list of inventory item IDs to filter by. Maximum 50 IDs per request. At least one of inventory_item_ids or location_ids must be provided.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: SHOPIFY_GET_INVENTORY_LEVELS_FOR_LOCATIONRetrieves a list of inventory levels for a specific location. Use when you need to check inventory quantities at a particular location. This endpoint implements cursor-based pagination via Link headers in the response.

Input Parameters

integer
Maximum number of results to return per page. Range: 1-250, Default: 50.
string
Used for cursor-based pagination. When using page_info, only limit parameter can be combined with it.
string
required
The ID of the location to retrieve inventory levels for.
string
Show inventory levels updated at or after this date. ISO 8601 datetime format.
string
Comma-separated list of inventory item IDs to filter results. Maximum 50 items.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: SHOPIFY_GET_LOCATIONRetrieve a single location by its ID. Use when you need to get details about a specific physical or virtual place where inventory is stocked and orders are fulfilled.

Input Parameters

string
required
The unique identifier for the location to retrieve.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: SHOPIFY_GET_LOCATIONS_COUNTQuery the count of locations in a Shopify store using the GraphQL API, returning the count and its precision.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: SHOPIFY_GET_MARKETING_EVENTRetrieves detailed information about a specific marketing event by its ID. Use this action to: - Get full details of a marketing campaign including UTM parameters, budget, and timeline - Check the status and configuration of a specific marketing event - Access information about resources (products, collections) being marketed - Retrieve tracking URLs (manage_url, preview_url) for the event Returns comprehensive event data including event type, marketing channel, budget details, UTM parameters, and associated resources.

Input Parameters

string
required
The unique numeric identifier for the marketing event. You can obtain this ID from the list of marketing events or from the response when creating a marketing event.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: SHOPIFY_GET_MARKETING_EVENTS_COUNTRetrieves a count of all marketing events in the store. Use when you need to know the total number of marketing events.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: SHOPIFY_GET_METAFIELDRetrieve a list of metafields from a blog resource. Use when you need to fetch metafields attached to a specific Shopify blog.

Input Parameters

string
Filter metafields by key. The key is a unique identifier within the namespace (3-64 characters).
integer
Maximum number of results per page. Must be ≤ 250, defaults to 50.
string
Comma-separated list of specific fields to return in the response (e.g., ‘id,namespace,key,value’).
string
required
The unique identifier of the blog resource to retrieve metafields for.
string
Show metafields created after the specified ID. Used for pagination.
string
Filter metafields by namespace. The namespace is a container for grouping metafields (3-255 characters).
string
Show metafields created before this date. Format: ISO 8601 (e.g., 2022-02-25T16:15:47-04:00).
string
Show metafields created after this date. Format: ISO 8601 (e.g., 2022-02-25T16:15:47-04:00).
string
Filter metafields by data type (e.g., ‘single_line_text_field’, ‘number_integer’, ‘json’).
string
Show metafields last updated before this date. Format: ISO 8601 (e.g., 2022-02-25T16:15:47-04:00).
string
Show metafields last updated after this date. Format: ISO 8601 (e.g., 2022-02-25T16:15:47-04:00).

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: SHOPIFY_GET_METAFIELD_BY_IDRetrieve a single metafield from a resource by its ID. Use when you need to fetch metafield details without knowing the parent resource.

Input Parameters

string
Comma-separated list of field names to retrieve only specific fields instead of the complete metafield object. Example: ‘id,key,value,namespace’
string
required
The unique identifier of the metafield to retrieve.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: SHOPIFY_GET_METAFIELDSRetrieve a list of metafields. Use when you need to fetch metafields across resources or for specific resources by providing owner_id and owner_resource filters.

Input Parameters

string
Filter metafields by key. The key is a unique identifier within the namespace (3-64 characters). Only used if namespace is also provided.
integer
Maximum number of results per page. Must be ≤ 250, defaults to 50.
string
Comma-separated list of specific fields to return in the response (e.g., ‘id,namespace,key,value’).
integer
Show metafields created after the specified ID. Used for pagination.
string
Filter metafields by namespace. The namespace is a container for grouping metafields (3-255 characters).
string
Show metafields created before this date. Format: ISO 8601 (e.g., 2022-02-25T16:15:47-04:00).
string
Show metafields created after this date. Format: ISO 8601 (e.g., 2022-02-25T16:15:47-04:00).
string
Show metafields last updated before this date. Format: ISO 8601 (e.g., 2022-02-25T16:15:47-04:00).
string
Show metafields last updated after this date. Format: ISO 8601 (e.g., 2022-02-25T16:15:47-04:00).
integer
Filter metafields by the unique ID of the resource that owns them.
string
Filter metafields by the type of resource that owns them (e.g., ‘product’, ‘collection’, ‘customer’, ‘product_image’). Only used if metafield_owner_id is also provided.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: SHOPIFY_GET_METAFIELDS_COUNTRetrieves the count of shop-level metafields only. This action returns how many metafields are directly attached to the shop itself, not metafields on other resources like products, customers, or orders. Use this when you need a quick count without fetching the full list of shop metafields. Note: To count metafields on specific resources (products, customers, etc.), use the SHOPIFY_GET_RESOURCE_METAFIELDS_COUNT action instead.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: SHOPIFY_GET_MOBILE_PLATFORM_APPLICATIONRetrieve one mobile platform application’s configuration by its existing ID. Uses Shopify’s legacy REST Admin API. Shopify Support must enable the mobile_platform_applications scope for the app before this resource is available. This read does not enable links, shared web credentials, or app clips.

Input Parameters

string
required
The numeric mobile platform application ID, supplied as a string.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: SHOPIFY_GET_ORDERRetrieve a specific order using its unique identifier. Returns detailed order information including line items, customer data, addresses, financial status, fulfillment status, and more.

Input Parameters

string
Comma-separated list of specific fields to return (e.g., ‘id,line_items,name,total_price’). When omitted, all order fields are returned.
string
required
The unique identifier of the order to retrieve.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: SHOPIFY_GET_ORDER_FULFILLMENTSRetrieve fulfillments associated with a Shopify order. Use when you need to get delivery tracking information, shipment status, or fulfillment details for a specific order.

Input Parameters

integer
Limit the amount of results (default: 50, max: 250).
string
Comma-separated list of fields to include in the response.
string
required
The unique numeric identifier for the order.
integer
Restrict results to after the specified fulfillment ID.
string
Show fulfillments created before this date (ISO 8601 format).
string
Show fulfillments created after this date (ISO 8601 format: 2014-04-25T16:15:47-04:00).
string
Show fulfillments last updated before this date (ISO 8601 format).
string
Show fulfillments last updated after this date (ISO 8601 format: 2014-04-25T16:15:47-04:00).

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: SHOPIFY_GET_ORDER_LISTRetrieves a page of Shopify orders with optional filters for status, dates, IDs, and name. Supports cursor pagination with a maximum of 250 orders per page; when using a cursor, only the page limit can accompany it. This legacy action is deprecated.

Input Parameters

string
Comma-separated list of order IDs to return. You may provide a list of integers; it will be converted to a comma-separated string.
string
Filter orders by name (for example, #1001). The ’#’ prefix is required (e.g., ‘#1001’); omitting it returns no results.
integer
Maximum number of results per page (default 50, maximum 250).
string
Comma-separated list of fields to include in the response. You may provide a list; it will be converted to a comma-separated string.
string
Filter by order status. Valid values: open, closed, cancelled, any.
string
Return orders with IDs greater than this ID.
string
Cursor for pagination. When using page_info for cursor pagination, only limit may accompany it.
string
Show orders created at or before this ISO 8601 timestamp (for example, 2024-12-31T23:59:59Z).
string
Show orders created at or after this ISO 8601 timestamp (for example, 2024-01-01T00:00:00Z).
string
Show orders last updated at or before this ISO 8601 timestamp.
string
Show orders last updated at or after this ISO 8601 timestamp.
string
Filter by financial status. Valid values: authorized, pending, paid, partially_paid, refunded, voided, partially_refunded, any, unpaid.
string
Show orders imported at or before this ISO 8601 timestamp.
string
Show orders imported at or after this ISO 8601 timestamp.
string
Show orders attributed to a specific app ID. Use ‘current’ to show orders for the calling app.
string
Filter by fulfillment status. Valid values: shipped, partial, unshipped, any, unfulfilled.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: SHOPIFY_GET_ORDER_REFUND_BY_IDRetrieves a specific refund by refund ID for an order. Use this action when you need to: - Get detailed information about a particular refund - Review specific refund transactions and payment details - Check refunded line items, shipping costs, and adjustments - Verify duty and additional fee refunds Key Features: - Returns comprehensive refund data including line items and transactions - Supports field filtering to retrieve only specific data - Optional in_shop_currency parameter for currency conversion - Includes refund_shipping_lines for refunded shipping costs (added in API version 2024-10) Important Notes: - REST Admin API is legacy as of Oct 2024; consider GraphQL API for new integrations - Requires ‘read_orders’ access scope for authentication - Access to protected customer data may require additional Shopify app approval

Input Parameters

string
Comma-separated list of specific field names to return in the refund object.
string
required
The unique identifier of the order to retrieve the refund from.
string
required
The unique identifier of the refund to retrieve.
boolean
When set to true, displays amounts in the shop currency for the underlying transactions.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: SHOPIFY_GET_ORDER_REFUNDSRetrieves a list of refunds for a specific order, with optional field selection, shop-currency amounts, and a result limit. The action makes one request, so results may not include every refund.

Input Parameters

integer
Maximum number of results to retrieve per page (default 50, maximum 250).
string
Comma-separated list of specific field names to return in the refund objects.
string
required
The unique identifier of the order to retrieve refunds for.
boolean
When set to true, displays amounts in the shop currency for the underlying transactions.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: SHOPIFY_GET_ORDER_RISKRetrieves all fraud risk assessments for a specific order. Returns a list of risk assessments indicating potential fraud. Each risk includes a recommendation (cancel/investigate/accept) and a fraud likelihood score. Only risks with display=true are factored into Shopify’s overall order risk calculation. Note: Returns an empty array if the app lacks permission to access order risks (requires read_orders or write_orders scope with merchant approval for protected customer data).

Input Parameters

string
required
The unique numeric identifier of the order. Retrieve this from order creation or list operations.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: SHOPIFY_GET_ORDER_RISKSRetrieves fraud risk assessments for a specific Shopify order, including available recommendations and fraud likelihood scores. An empty risks array can also indicate authentication failure or insufficient permission.

Input Parameters

string
required
The unique numeric identifier of the order to retrieve risk assessments for. Accepts string representation of the order ID.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: SHOPIFY_GET_ORDERSBY_IDRetrieves a specific Shopify order by its unique ID, which must correspond to an existing order.

Input Parameters

string
Comma-separated list of fields to include in the response (e.g., ‘id,line_items’).
string
required
The unique identifier of the Shopify order to retrieve.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: SHOPIFY_GET_ORDERS_WITH_FILTERSRetrieves a page of Shopify orders using server-side date, status, ID, and other filters. An optional pagination cursor is accepted, and each page contains at most 250 orders. Protected customer data may be redacted or access blocked if the connection is not approved.

Input Parameters

string
Comma-separated list of numeric order IDs to retrieve.
string
Filter by order name (e.g., #1001). The ’#’ prefix is required; omitting it may return no results. Multiple orders can share the same name value.
integer
Maximum number of orders to return per page (1-250). Defaults to 50.
string
Comma-separated list of order fields to include in the response. Reduces response payload size; recommended at scale to avoid rate limit exhaustion.
string
Filter by order status (open,closed,cancelled,any). Defaults to ‘open’; set to ‘any’ for historical or cross-status lookups to avoid silently missing closed or cancelled orders.
integer
Restrict results to after the specified ID.
string
A cursor for use in pagination. When present, only limit (and fields where supported) should accompany this parameter.
string
Show orders created at or before this ISO 8601 timestamp.
string
Show orders created at or after this ISO 8601 timestamp. Timezone must match the shop’s local timezone (use SHOPIFY_GET_SHOP_DETAILS) — do not assume UTC, to avoid missing edge-of-day orders.
string
Show orders last updated at or before this ISO 8601 timestamp.
string
Show orders last updated at or after this ISO 8601 timestamp.
string
Filter by financial status (authorized,pending,paid,partially_paid,refunded,voided,partially_refunded,any,unpaid).
string
Show orders imported/processed at or before this ISO 8601 timestamp.
string
Show orders imported/processed at or after this ISO 8601 timestamp.
string
Filter to orders attributed to a given app ID; use ‘current’ to show orders for the calling app.
string
Filter by fulfillment status (shipped/fulfilled,partial,unshipped/null,any,unfulfilled).

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: SHOPIFY_GET_ORDER_TRANSACTIONS_COUNTRetrieve a count of an order’s transactions in Shopify. Use when you need to know how many transactions (authorization, sale, capture, void, refund) are associated with a specific order without fetching the full transaction details.

Input Parameters

string
required
The unique identifier for the order whose transaction count is needed. This must be a valid Shopify order ID.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: SHOPIFY_GET_PAGE_BY_IDRetrieve a single Shopify page by its unique ID. Use when you need to fetch detailed information about a specific page.

Input Parameters

string
Comma-separated list of specific field names to return. Use this to limit the response to only the fields you need.
string
required
The unique numeric identifier for the page to retrieve.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: SHOPIFY_GET_PAYMENT_DISPUTERetrieve one Shopify Payments dispute by its numeric ID. Returns the disputed amount, reason, status, and evidence deadlines. Requires Shopify Payments dispute access. Uses the legacy Shopify REST Admin API.

Input Parameters

string
required
The numeric ID of the Shopify Payments dispute to retrieve.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: SHOPIFY_GET_PAYMENTS_BALANCERetrieve the current Shopify Payments balance for each currency. Includes transactions not yet included in a payout. Requires a shop using Shopify Payments. Uses the legacy Shopify REST Admin API.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: SHOPIFY_GET_PAYMENTS_PAYOUTRetrieve one Shopify Payments payout by its numeric ID. Returns the transfer status, date, currency, amount, and transaction summary. Requires a shop using Shopify Payments and payout access. Uses the legacy Shopify REST Admin API.

Input Parameters

string
required
The numeric ID of the Shopify Payments payout to retrieve.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: SHOPIFY_GET_POLICIESRetrieve a list of the shop’s policies. Use when you need to view configured shop policies such as refund policy, privacy policy, or terms of service.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: SHOPIFY_GET_PRICE_RULERetrieves a single price rule by ID from Shopify. Returns discount configuration including type (percentage/fixed), value, target items, customer eligibility, and prerequisites. Note: The PriceRule REST API is deprecated as of October 2024; consider using GraphQL Admin API for new implementations.

Input Parameters

string
required
The unique identifier for the price rule to retrieve.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: SHOPIFY_GET_PRICE_RULE_BATCH_INFORequests batch listing information for a price rule. If Shopify returns 404, it returns guidance about retrieving a specific batch by ID; other successful responses are validated as batch information.

Input Parameters

integer
required
The ID of the price rule to check batch support for.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: SHOPIFY_GET_PRICE_RULE_DISCOUNT_CODESRetrieves a page of discount codes associated with a Shopify price rule. The action does not expose pagination controls or response Link headers.

Input Parameters

string
required
The ID of the price rule to retrieve discount codes for.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: SHOPIFY_GET_PRODUCTRetrieves details for an existing Shopify product using its unique product ID.

Input Parameters

string
required
The unique numeric identifier of the Shopify product to be retrieved (e.g., ‘8301757563074’). Note: Use the numeric ID, not the GraphQL GID format.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: SHOPIFY_GET_PRODUCT_IMAGERetrieve a single product image by ID for a specific product. Use when you need to get details about a specific image associated with a product.

Input Parameters

string
required
The unique numerical identifier of the image associated with the product.
string
required
The unique numerical identifier of the Shopify product.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: SHOPIFY_GET_PRODUCT_IMAGESRetrieves all images for a Shopify product, specified by its product_id which must correspond to an existing product.

Input Parameters

string
A comma-separated list of fields to include in the response. Available fields include: id, product_id, position, created_at, updated_at, alt, width, height, src.
string
Restricts the results to product images created after the specified image ID. Useful for pagination.
string
required
The unique identifier of the Shopify product for which to retrieve images.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: SHOPIFY_GET_PRODUCT_LISTINGRetrieve one product listing published to your sales channel app. Uses the legacy REST Admin API and requires merchant-approved read_product_listings access. The listing ID is the product ID; only listings published to the calling app are visible. Listing attributes are read-only.

Input Parameters

string
required
The product ID of the listing published to your app.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: SHOPIFY_GET_PRODUCT_METAFIELDRetrieves a specific metafield for a Shopify product using the product ID and metafield ID.

Input Parameters

string
required
The unique identifier of the Shopify product.
string
required
The unique identifier of the metafield to retrieve.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: SHOPIFY_GET_PRODUCT_METAFIELDSRetrieves all metafields for a specific Shopify product. Metafields are returned under data.response_data.metafields. Can be filtered by namespace and/or key; empty results are valid when no metafields match. Always fetch current metafield IDs via this tool rather than using cached values, as IDs can change after schema updates.

Input Parameters

string
Filter metafields by key. If omitted, returns all metafields (or all within namespace if specified). Use both namespace and key together when targeting a specific metafield, since the same key can exist across multiple namespaces.
string
Filter metafields by namespace. If omitted, returns all metafields.
string
required
The unique identifier of the Shopify product to retrieve metafields for.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: SHOPIFY_GET_PRODUCTSRetrieves a list of products from a Shopify store. Results are paginated; for large catalogs, use SHOPIFY_GET_PRODUCTS_PAGINATED to iterate all pages, as this tool may return only a partial set. Product handles and SKUs must be unique — use this tool to check for existing products before creating new ones.

Input Parameters

string
A comma-separated string of product IDs to retrieve. If this field is not provided (i.e., defaults to None), all products will be fetched.
integer
Maximum number of products to return. Accepted values are 1 to 250. Default is 50.
integer
Return only products after the specified ID. Use for cursor-based pagination through large result sets.
string
A cursor value for cursor-based pagination. Use the page_info value from the Link header of a previous response to fetch the next page of results.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: SHOPIFY_GET_PRODUCTS_IN_COLLECTIONRetrieves a limited page of products in a Shopify collection, including product details such as variants, images, and options. Products are sorted according to the collection’s configured sort order.

Input Parameters

integer
Maximum number of products to retrieve per request. Must be between 1 and 250. Default is 50.
string
required
The unique identifier for the Shopify collection. Can be obtained from the collection list endpoint or from the Shopify admin collection URL. Must be a numeric REST ID (e.g., 408267178229); GraphQL gid formats will fail validation.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: SHOPIFY_GET_PRODUCTS_PAGINATEDList products with Shopify cursor-based pagination. Iterate until next_page_info is null; stopping early silently truncates the product list. Products are at data.response_data.products; the next cursor is at data.next_page_info.

Input Parameters

integer
Number of products per page. Defaults to 50; maximum 250.
string
Comma-separated list of product fields to include in the response.
string
Cursor token for next or previous page. Use the token value from the Link header. The cursor is exposed at data.next_page_info in the response. Pass the value exactly as returned — any truncation or modification triggers a 400 error.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: SHOPIFY_GET_PRODUCT_VARIANTRetrieves detailed information about a single product variant by its ID from Shopify. A product variant represents a specific version of a product (e.g., different sizes, colors, or materials). This action returns comprehensive details including pricing, inventory, weight, SKU, barcode, and shipping requirements. Use this when you need to: - Get current pricing and inventory levels for a specific variant - Check variant details like SKU, barcode, weight, or options (size, color, etc.) - Retrieve variant configuration (taxable, requires_shipping, fulfillment_service) - Fetch only specific fields using the optional ‘fields’ parameter to reduce response size Note: You must know the variant_id beforehand. Use list products or list variants actions to discover variant IDs.

Input Parameters

string
A comma-separated list of fields to include in the response. Use this to retrieve only specific fields and reduce response size.
string
required
The unique numeric identifier for the product variant to retrieve.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: SHOPIFY_GET_RECURRING_APPLICATION_CHARGERetrieve one recurring application charge for the authenticated app by ID. Use an existing charge ID, optionally projecting fields. This read uses Shopify’s legacy REST Admin API and does not create or activate a subscription charge.

Input Parameters

string
A comma-separated list of fields to include in the response. Omit to return all fields.
string
required
The numeric ID of the recurring application charge.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: SHOPIFY_GET_RECURRING_APPLICATION_CHARGESRetrieve a list of recurring application charges for the app. Use when you need to view subscription charges, check billing status, or audit recurring payments.

Input Parameters

string
A comma-separated list of fields to include in the response (e.g., ‘id,name,price,status’).
integer
Restrict results to after the specified ID. Used for pagination.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: SHOPIFY_GET_REDIRECTRetrieve details of a specific URL redirect by its ID. Returns the redirect’s path (source) and target (destination) configuration. Use this when you have a specific redirect ID and need its details; for finding redirects or getting multiple redirects, use the list redirects action instead.

Input Parameters

string
Comma-separated list of fields to include in the response (e.g., ‘id,path,target’).
string
required
The unique identifier of the redirect to retrieve.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: SHOPIFY_GET_REDIRECT_BY_IDRetrieve a single redirect by its ID. Use when you need to get details about a specific URL redirect configuration in a Shopify store.

Input Parameters

string
Comma-separated list of fields to include in the response (e.g., ‘id,path,target’).
string
required
The unique identifier of the redirect to retrieve.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: SHOPIFY_GET_REDIRECTSRetrieve a list of URL redirects from a Shopify store, optionally filtered by path or target. Results can be limited and continued using a since-ID filter.

Input Parameters

string
Filters results to show redirects with a specific path value (the old/original URL path).
integer
Maximum number of results to return per page. Must be ≤ 250. Defaults to 50 if not specified.
string
Comma-separated list of field names to include in the response. Only specified fields will be returned.
string
Filters results to show redirects with a specific target value (the new URL destination).
string
Restricts results to redirects created after the specified ID. Used for cursor-based pagination.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: SHOPIFY_GET_REDIRECTS_COUNTRetrieves a count of URL redirects in the store. Use when you need to know how many URL redirects are configured, optionally filtered by path or target.

Input Parameters

string
Filter redirects by the original path. Only counts redirects with this specific path.
string
Filter redirects by the target URL. Only counts redirects pointing to this specific target.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: SHOPIFY_GET_REFUNDRetrieves detailed information about a specific refund for an order. Use this action when you need complete refund details including refunded line items, transactions, order adjustments, duties, and shipping costs. Both order_id and refund_id are required. To list all refunds for an order, use the ‘Retrieve refunds for order’ action instead.

Input Parameters

string
Comma-separated list of specific fields to include in the refund response. When omitted, all fields are returned. Useful for optimizing response size.
string
required
The unique identifier of the order containing the refund. You can obtain this from order retrieval or creation actions.
string
required
The unique identifier of the specific refund to retrieve. You can obtain this from the list refunds for order action.
boolean
When true, transaction amounts are displayed in the shop’s base currency instead of presentment currency. Default is false.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: SHOPIFY_GET_SCRIPTTAGRetrieves a single script tag by its ID. Use when you need to get details of a specific script tag configuration.

Input Parameters

string
Comma-separated list of specific fields to include in the response. Use this to restrict the returned script tag to only the specified properties.
string
required
The unique identifier for the script tag to retrieve.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: SHOPIFY_GET_SEGMENTS_COUNTQuery the number of segments for a shop. Use when you need to know how many customer segments exist.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: SHOPIFY_GET_SHIPPING_ZONESRetrieve all configured shipping zones with countries, provinces, tax rates, and shipping rates. Use when you need to view or analyze shipping configuration.

Input Parameters

string
A comma-separated list of field names to show only specific fields in the response. Example: ‘id,name,countries’

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: SHOPIFY_GET_SHOP_BILLING_ADDRESSRetrieves the billing address for the shop via GraphQL query. Returns the shop’s billing information including address details, city, province, country, and phone number.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: SHOPIFY_GET_SHOP_CONFIGURATIONDEPRECATED: Use SHOPIFY_GET_SHOP_DETAILS instead. Retrieve the complete configuration and settings for the authenticated Shopify shop account. Use when you need to access shop information such as business details, address, timezone, currency, plan information, or feature availability.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: SHOPIFY_GET_SHOP_DETAILSRetrieves administrative information about the authenticated Shopify store, including its IANA timezone when available. The timezone can help interpret date boundaries in other queries.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: SHOPIFY_GET_SHOP_METAFIELDRetrieve a metafield by its ID directly. Use when you know the metafield ID and need to fetch its details without specifying the resource type or owner.

Input Parameters

string
Comma-separated list of specific fields to return in the response. If not specified, all fields are returned.
string
required
The unique identifier of the metafield to retrieve.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: SHOPIFY_GET_SHOP_METAFIELDSDEPRECATED: Use SHOPIFY_GET_METAFIELDS instead (apps/shopify/actions/get_metafields.py). Retrieve a list of metafields attached to resources. Use when you need to fetch metafields that can be filtered by namespace, key, type, and date ranges.

Input Parameters

string
Filter metafields by key. The key is a unique identifier within the namespace (3-64 characters).
string
Filter metafields by the data type stored in the metafield value (e.g., ‘single_line_text_field’, ‘number_integer’, ‘json’).
integer
Maximum number of results per page. Default: 50, Maximum: 250.
string
Comma-separated list of specific fields to retrieve from the metafield object.
string
Optional owner resource ID filter for legacy resource-scoped metafield queries.
string
Show metafields created after the specified ID. Used for pagination.
string
Filter metafields by namespace. The namespace is a container for grouping metafields (3-255 characters).
string
Show metafields created before this date. Format: ISO 8601 (e.g., 2024-12-31T23:59:59Z).
string
Show metafields created after this date. Format: ISO 8601 (e.g., 2024-01-01T00:00:00Z).
string
Optional owner resource filter for legacy resource-scoped metafield queries, for example product, collection, customer, order, blog, page, or article.
string
Show metafields updated before this date. Format: ISO 8601 (e.g., 2024-12-31T23:59:59Z).
string
Show metafields updated after this date. Format: ISO 8601 (e.g., 2024-01-01T00:00:00Z).

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: SHOPIFY_GET_SMART_COLLECTIONRetrieve a single smart collection by its ID from Shopify. Use when you need to get detailed information about a specific smart collection including its rules, products ordering, and metadata. Requires read_products access scope.

Input Parameters

string
Comma-separated list of specific field names to include in the response. Allows you to limit which fields are returned to optimize the response. E.g., ‘id,title,handle’.
string
required
The unique identifier for the smart collection to retrieve.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: SHOPIFY_GET_SMART_COLLECTION_BY_IDRetrieve a single smart collection by its ID. Use when you need to get details about a specific smart collection including its rules, settings, and associated image.

Input Parameters

string
Comma-separated list of fields to retrieve; if omitted, all fields are returned. E.g., ‘id,title,handle’.
string
required
The unique identifier for the smart collection to retrieve.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: SHOPIFY_GET_SMART_COLLECTIONSRetrieve a list of smart collections from a Shopify store. Use when you need to fetch smart collections with optional filtering by IDs, handle, title, product ID, publication status, or date ranges. Supports pagination via since_id parameter.

Input Parameters

string
Comma-separated list of collection IDs to retrieve.
integer
Number of results to return. Maximum 250, default 50.
string
Filter by smart collection title.
string
Comma-separated list of fields to include in the response.
string
Filter by smart collection handle (URL-friendly identifier).
string
Restrict results to collections after the specified ID (for pagination).
string
Show collections containing the specified product ID.
string
Filter collections updated before this date (ISO 8601 format).
string
Filter collections updated after this date (ISO 8601 format).
string
Filter collections published before this date (ISO 8601 format).
string
Filter collections published after this date (ISO 8601 format).
string
Filter by publication status: ‘published’, ‘unpublished’, or ‘any’ (default).

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: SHOPIFY_GET_SMART_COLLECTIONS_COUNTRetrieve a count of smart collections in a Shopify store. Use when you need to know the total number of smart collections, optionally filtered by publication status, title, product association, or date ranges.

Input Parameters

string
Filter results by collection name.
string
Return count for collections containing a specific product. Provide the product ID.
string
Collections modified at or before this date. Format: ISO 8601 datetime.
string
Collections modified at or after this date. Format: ISO 8601 datetime.
string
Collections published at or before this date. Format: ISO 8601 datetime.
string
Collections published at or after this date. Format: ISO 8601 datetime.
string ("published" | "unpublished" | "any")
Filter by publication state. Valid values: ‘published’, ‘unpublished’, or ‘any’ (default).

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: SHOPIFY_GET_STOREFRONT_ACCESS_TOKENSRetrieves a list of storefront access tokens that have been issued for the shop. Use when you need to view all active storefront access tokens and their permissions.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: SHOPIFY_GET_TENDER_TRANSACTIONSRetrieve Shopify tender transactions for financial reconciliation and review of payment activity. Filter by processing date or date range, sort by processing time, and use a since-ID to retrieve subsequent transactions. The requested limit defaults to 50 and has a maximum of 250.

Input Parameters

integer
The maximum number of results to retrieve. Maximum value is 250, default is 50.
string
Sort by processed_at in ascending or descending order. Valid values: ‘processed_at ASC’ or ‘processed_at DESC’.
string
Retrieve only transactions after the specified ID. Used for pagination.
string
Filter transactions processed on the specified date. Format: ISO 8601 datetime string (e.g., ‘2024-01-15T00:00:00Z’).
string
Show tender transactions processed at or before the specified date. Format: ISO 8601 datetime string.
string
Show tender transactions processed at or after the specified date. Format: ISO 8601 datetime string.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: SHOPIFY_GET_THEMERetrieves a single Shopify theme by its unique ID. Use this action when you need to: - Get details about a specific theme (name, role, timestamps, store ID) - Check if a theme is the currently published theme (role=‘main’) - Verify theme processing status before modifying assets - Inspect theme metadata like theme_store_id for identifying Shopify Theme Store themes Note: Requires the ‘read_themes’ OAuth scope which may need merchant approval.

Input Parameters

string
Comma-separated list of specific fields to include in the response. If not specified, all theme fields are returned. Common fields: id, name, role, created_at, updated_at, theme_store_id, previewable, processing.
string
required
The unique identifier for the theme to retrieve. This is a numeric ID returned from theme listing endpoints or visible in the Shopify admin.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: SHOPIFY_GET_THEMESRetrieves a list of themes from a Shopify store. Use when you need to access theme information including name, role, and metadata.

Input Parameters

string
Show only certain fields, specified by a comma-separated list of field names (e.g., ‘id,name,role’).

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: SHOPIFY_GET_THEMES_PARAM_THEME_ID_ASSETSRetrieve a single asset for a theme by its key. Use when you need to fetch the content or metadata of a specific theme file such as templates, stylesheets, or scripts.

Input Parameters

string
Comma-separated list of specific fields to return from the asset object (e.g., ‘key,value,public_url’).
string
required
The unique identifier for the theme.
string
required
The path within a theme to an existing asset (e.g., templates/index.liquid, assets/base.css). Max 100 characters.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: SHOPIFY_GET_TRANSACTIONRetrieve a specific transaction for an order. Use when you need to get detailed information about a payment transaction. Transactions in multi-currency orders are in presentment currency by default; use in_shop_currency parameter to get shop currency.

Input Parameters

string
Comma-separated list of fields to include in the response (e.g., ‘id,kind,status’).
string
required
The unique identifier of the order that the transaction belongs to.
string
required
The unique identifier of the specific transaction to retrieve.
boolean
Display amounts in shop currency instead of presentment currency. Defaults to false.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: SHOPIFY_GET_USAGE_CHARGERetrieve one usage charge belonging to a recurring charge for the authenticated app. Optionally project response fields. Uses the legacy REST Admin API and does not create a charge or bill the merchant.

Input Parameters

string
A comma-separated list of fields to include in the response. Omit to return all fields.
string
required
The ID of the usage charge to retrieve.
string
required
The ID of the recurring application charge owning the usage charge.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: SHOPIFY_GET_USERRetrieve one Shopify staff user and their staff permissions by ID. Uses the legacy REST Admin API. Available only to private and custom apps installed on Shopify Plus stores. Contact Shopify Plus Support to request the read_users scope; ordinary app scopes or staff permissions do not suffice.

Input Parameters

string
required
The numeric ID of the staff user to retrieve.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: SHOPIFY_GET_WEBHOOKRetrieves a single webhook subscription by its ID. Use when you need to get details of a specific webhook configuration.

Input Parameters

string
Comma-separated list of properties to return for the webhook. Use this to restrict the returned webhook to only the specified properties.
string
required
The unique numeric identifier for the webhook subscription to retrieve.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: SHOPIFY_GET_WEBHOOK_SUBSCRIPTIONS_COUNTQuery the number of webhook subscriptions for a shop. Use when you need to know how many webhook subscriptions exist, optionally filtered by query criteria.

Input Parameters

string
Filter webhook subscriptions by query string. Use this to filter by specific topics or other attributes. Example: topic:“orders/create”

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: SHOPIFY_GRAPH_QL_ADMIN_EXECUTEExecute a Shopify Admin GraphQL query or mutation with variables. Returns a response envelope containing GraphQL data and available error, pagination, and extension information.

Input Parameters

string
required
A complete Shopify Admin GraphQL query or mutation document. Use this for GraphQL-only Admin API capabilities such as productCreate, productOptionsCreate, inventoryActivate, collectionReorderProducts, discountCodeBxgyCreate, customerEmailMarketingConsentUpdate, themeFilesUpsert, marketWebPresenceCreate, or appUsageRecordCreate.
object
Variables object passed with the GraphQL document.
string
Optional Shopify Admin API version override, for example 2026-04. Defaults to the API version in the connected account base_url when present; otherwise defaults to 2026-04.
string
Optional GraphQL operationName when the document contains multiple operations.
boolean
Raise ExecutionFailed when mutation payloads contain userErrors. Defaults to false so agents can inspect and repair validation errors.
boolean
Raise ExecutionFailed when Shopify returns top-level GraphQL errors.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: SHOPIFY_GRAPH_QL_COLLECTIONSList, retrieve, or count Shopify collections using GraphQL presets, or execute a custom Admin GraphQL document, including mutations. Returns GraphQL data and available error, pagination, and extension information.

Input Parameters

integer
Backward page size for list/search presets.
string
Cursor after which to read.
integer
Forward page size for list/search presets.
string
Shopify search query string, when supported by the preset.
string
Cursor before which to read.
string
Optional GraphQL field selection for nodes returned by read presets.
boolean
Reverse sort order, when supported.
string
Shopify GraphQL sort key enum value, when supported.
string ("list_collections" | "get_collection" | "count_collections")
required
Canonical operation preset to execute.
object
GraphQL variables for the selected operation or custom_document.
string
Optional Shopify Admin API version override, for example 2026-04. Defaults to the API version in the connected account base_url when present; otherwise defaults to 2026-04.
string
Operation name for custom_document, if it contains multiple operations.
string
Complete GraphQL document to execute instead of a preset. Use variables for user input.
boolean
Raise on mutation userErrors.
boolean
Raise on top-level GraphQL errors.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: SHOPIFY_GRAPH_QL_CUSTOMERSList, search, retrieve, or count Shopify customers using GraphQL presets, or execute a custom Admin GraphQL document, including mutations. Returns GraphQL data and available error, pagination, and extension information.

Input Parameters

integer
Backward page size for list/search presets.
string
Cursor after which to read.
integer
Forward page size for list/search presets.
string
Shopify search query string, when supported by the preset.
string
Cursor before which to read.
string
Optional GraphQL field selection for nodes returned by read presets.
boolean
Reverse sort order, when supported.
string
Shopify GraphQL sort key enum value, when supported.
string ("list_customers" | "search_customers" | "get_customer" | "count_customers")
required
Canonical operation preset to execute.
object
GraphQL variables for the selected operation or custom_document.
string
Optional Shopify Admin API version override, for example 2026-04. Defaults to the API version in the connected account base_url when present; otherwise defaults to 2026-04.
string
Operation name for custom_document, if it contains multiple operations.
string
Complete GraphQL document to execute instead of a preset. Use variables for user input.
boolean
Raise on mutation userErrors.
boolean
Raise on top-level GraphQL errors.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: SHOPIFY_GRAPH_QL_DISCOUNTSList, search, or retrieve Shopify discounts using GraphQL presets, or execute a custom Admin GraphQL document, including mutations. Returns GraphQL data and available error, pagination, and extension information.

Input Parameters

integer
Backward page size for list/search presets.
string
Cursor after which to read.
integer
Forward page size for list/search presets.
string
Shopify search query string, when supported by the preset.
string
Cursor before which to read.
string
Optional GraphQL field selection for nodes returned by read presets.
boolean
Reverse sort order, when supported.
string
Shopify GraphQL sort key enum value, when supported.
string ("list_discountNodes" | "get_discountNode")
required
Canonical operation preset to execute.
object
GraphQL variables for the selected operation or custom_document.
string
Optional Shopify Admin API version override, for example 2026-04. Defaults to the API version in the connected account base_url when present; otherwise defaults to 2026-04.
string
Operation name for custom_document, if it contains multiple operations.
string
Complete GraphQL document to execute instead of a preset. Use variables for user input.
boolean
Raise on mutation userErrors.
boolean
Raise on top-level GraphQL errors.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: SHOPIFY_GRAPH_QL_DRAFT_ORDERSLists, retrieves, and counts Shopify draft orders using GraphQL, or executes a custom GraphQL document that may perform mutations. Responses may include pagination and cost metadata; inspect mutation errors in the returned data.

Input Parameters

integer
Backward page size for list/search presets.
string
Cursor after which to read.
integer
Forward page size for list/search presets.
string
Shopify search query string, when supported by the preset.
string
Cursor before which to read.
string
Optional GraphQL field selection for nodes returned by read presets.
boolean
Reverse sort order, when supported.
string
Shopify GraphQL sort key enum value, when supported.
string ("list_draftOrders" | "get_draftOrder" | "count_draftOrders")
required
Canonical operation preset to execute.
object
GraphQL variables for the selected operation or custom_document.
string
Optional Shopify Admin API version override, for example 2026-04. Defaults to the API version in the connected account base_url when present; otherwise defaults to 2026-04.
string
Operation name for custom_document, if it contains multiple operations.
string
Complete GraphQL document to execute instead of a preset. Use variables for user input.
boolean
Raise on mutation userErrors.
boolean
Raise on top-level GraphQL errors.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: SHOPIFY_GRAPH_QL_INVENTORYLists and retrieves Shopify inventory items and their levels using GraphQL, or executes a custom GraphQL document that may perform mutations. Responses may include pagination and cost metadata; inspect mutation errors in the returned data.

Input Parameters

integer
Backward page size for list/search presets.
string
Cursor after which to read.
integer
Forward page size for list/search presets.
string
Shopify search query string, when supported by the preset.
string
Cursor before which to read.
string
Optional GraphQL field selection for nodes returned by read presets.
boolean
Reverse sort order, when supported.
string
Shopify GraphQL sort key enum value, when supported.
string ("list_inventoryItems" | "get_inventoryItem")
required
Canonical operation preset to execute.
object
GraphQL variables for the selected operation or custom_document.
string
Optional Shopify Admin API version override, for example 2026-04. Defaults to the API version in the connected account base_url when present; otherwise defaults to 2026-04.
string
Operation name for custom_document, if it contains multiple operations.
string
Complete GraphQL document to execute instead of a preset. Use variables for user input.
boolean
Raise on mutation userErrors.
boolean
Raise on top-level GraphQL errors.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: SHOPIFY_GRAPH_QL_METAFIELDS_METAOBJECTSReads Shopify metafields, metafield definitions, and metaobjects using GraphQL presets, or executes a custom GraphQL document that may perform mutations.

Input Parameters

string
Cursor after which to read.
integer
Forward page size.
string
Optional field selection for metafield/metaobject nodes.
string ("get_owner_metafields" | "get_metafield_definitions" | "get_metaobject" | "list_metaobjects_by_type" | "custom_query")
required
Metafield/metaobject operation.
object
Variables for the selected operation.
string
Optional Shopify Admin API version override, for example 2026-04. Defaults to the API version in the connected account base_url when present; otherwise defaults to 2026-04.
string
Operation name for custom_document.
string
Complete GraphQL query for custom_query or schema-new fields.
boolean
Raise on top-level GraphQL errors.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: SHOPIFY_GRAPH_QL_ORDERSLists, retrieves, counts, and searches Shopify orders using GraphQL, or executes a custom GraphQL document that may perform mutations. Responses may include pagination and cost metadata; inspect mutation errors in the returned data.

Input Parameters

integer
Backward page size for list/search presets.
string
Cursor after which to read.
integer
Forward page size for list/search presets.
string
Shopify search query string, when supported by the preset.
string
Cursor before which to read.
string
Optional GraphQL field selection for nodes returned by read presets.
boolean
Reverse sort order, when supported.
string
Shopify GraphQL sort key enum value, when supported.
string ("list_orders" | "get_order" | "count_orders")
required
Canonical operation preset to execute.
object
GraphQL variables for the selected operation or custom_document.
string
Optional Shopify Admin API version override, for example 2026-04. Defaults to the API version in the connected account base_url when present; otherwise defaults to 2026-04.
string
Operation name for custom_document, if it contains multiple operations.
string
Complete GraphQL document to execute instead of a preset. Use variables for user input.
boolean
Raise on mutation userErrors.
boolean
Raise on top-level GraphQL errors.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: SHOPIFY_GRAPH_QL_PRODUCTSRuns Shopify GraphQL operations for products, variants, options, media, and publications. It accepts variables for the selected operation and provides pagination metadata when available; inspect mutation errors in the returned data.

Input Parameters

integer
Backward page size for list_products.
string
Cursor after which to read products.
integer
Forward page size for list_products.
string
Shopify product search query for list_products/count_products.
string
Cursor before which to read products.
string
Optional node field selection for product read operations. Keep it valid GraphQL, for example: id title handle status updatedAt variants(first: 10) { nodes { id title sku } }.
boolean
Reverse sort order.
string
Shopify ProductSortKeys value.
string ("list_products" | "get_product" | "count_products" | "create_product" | "update_product" | "set_product" | "delete_product" | "duplicate_product" | "create_options" | "update_option" | "delete_options" | "reorder_options" | "bulk_create_variants" | "bulk_update_variants" | "bulk_delete_variants" | "bulk_reorder_variants" | "create_media" | "update_media" | "delete_media" | "reorder_media" | "attach_variant_media" | "detach_variant_media" | "publish_product" | "unpublish_product")
required
Product operation to run.
object
GraphQL variables for the selected operation. Examples: list_products accepts first/after/query/sortKey/reverse; create_product accepts input; update_product accepts input; set_product accepts input; variant/media/option operations accept the exact Shopify GraphQL mutation variables.
string
Optional Shopify Admin API version override, for example 2026-04. Defaults to the API version in the connected account base_url when present; otherwise defaults to 2026-04.
boolean
Raise on mutation userErrors.
boolean
Raise on top-level GraphQL errors.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: SHOPIFY_GRAPH_QL_QUERYExecutes a GraphQL query against the Shopify Admin API for flexible data retrieval and mutations including metafields. Response data is nested under result[‘data’][‘data’], not result[‘data’]. Always inspect both response_data.errors (top-level) and mutation-level userErrors—HTTP 200 can accompany GraphQL validation failures. Query costs draw from a ~1000-point bucket (~50 points/second refill); monitor extensions.cost.throttleStatus to avoid THROTTLED errors. Paginate list queries using pageInfo.hasNextPage and endCursor to avoid silently missing records. productUpdate replaces the entire tags array—send the complete final tag list. refundCreate requires orderId at both the top level and inside each transactions element. transaction parentId must reference a CAPTURE-kind transaction. Numeric fields like numberOfOrders may be returned as strings—cast before aggregating.

Input Parameters

string
required
The GraphQL query string to execute against the Shopify Admin API. Include pageInfo { hasNextPage endCursor } on all list fields; the first argument caps results and silently omits remaining records without pagination.
object
Variables to be used in the GraphQL query as a dictionary. IDs use gid://shopify/Type/ID format; query legacyResourceId when a numeric ID is needed for interoperability with REST-based tools.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: SHOPIFY_GRAPH_QL_SHOPReads Shopify shop and app installation metadata using GraphQL, or executes a custom GraphQL document that may perform mutations.

Input Parameters

string
Shop field selection. Defaults to core shop identity, plan, currency, and scopes-friendly fields.
object
Variables for custom_document.
string
Optional Shopify Admin API version override, for example 2026-04. Defaults to the API version in the connected account base_url when present; otherwise defaults to 2026-04.
string
Complete GraphQL query to execute instead of the default shop query.
boolean
Raise on top-level GraphQL errors.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: SHOPIFY_GRAPH_QL_WEBHOOKSLists, retrieves, and counts Shopify webhook subscriptions using GraphQL, or executes a custom GraphQL document that may perform mutations. Responses may include pagination and cost metadata; inspect mutation errors in the returned data.

Input Parameters

integer
Backward page size for list/search presets.
string
Cursor after which to read.
integer
Forward page size for list/search presets.
string
Shopify search query string, when supported by the preset.
string
Cursor before which to read.
string
Optional GraphQL field selection for nodes returned by read presets.
boolean
Reverse sort order, when supported.
string
Shopify GraphQL sort key enum value, when supported.
string ("list_webhookSubscriptions" | "get_webhookSubscription" | "count_webhookSubscriptions")
required
Canonical operation preset to execute.
object
GraphQL variables for the selected operation or custom_document.
string
Optional Shopify Admin API version override, for example 2026-04. Defaults to the API version in the connected account base_url when present; otherwise defaults to 2026-04.
string
Operation name for custom_document, if it contains multiple operations.
string
Complete GraphQL document to execute instead of a preset. Use variables for user input.
boolean
Raise on mutation userErrors.
boolean
Raise on top-level GraphQL errors.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: SHOPIFY_GRAPH_QL_WRITE_OPERATIONSCanonical GraphQL write surface for Shopify orders, customers, inventory, discounts, collections, webhooks, fulfillments, metafields, and bulk operations.

Input Parameters

string ("orderCreate" | "orderUpdate" | "refundCreate" | "orderEditBegin" | "orderEditCommit" | "draftOrderCreate" | "draftOrderUpdate" | "draftOrderComplete" | "customerCreate" | "customerUpdate" | "customerDelete" | "metafieldsSet" | "metafieldsDelete" | "metaobjectUpsert" | "collectionCreate" | "collectionUpdate" | "collectionDelete" | "collectionAddProducts" | "collectionRemoveProducts" | "inventoryAdjustQuantities" | "inventorySetQuantities" | "discountCodeBasicCreate" | "discountCodeBasicUpdate" | "discountCodeDelete" | "webhookSubscriptionCreate" | "webhookSubscriptionUpdate" | "webhookSubscriptionDelete" | "fulfillmentCreate" | "fulfillmentTrackingInfoUpdate" | "bulkOperationRunQuery" | "bulkOperationRunMutation")
required
Mutation preset to execute.
object
Variables for the mutation preset.
string
Optional Shopify Admin API version override, for example 2026-04. Defaults to the API version in the connected account base_url when present; otherwise defaults to 2026-04.
string
Operation name for custom_document.
string
Override preset with an exact GraphQL mutation document.
boolean
Raise on mutation userErrors.
boolean
Raise on top-level GraphQL errors.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: SHOPIFY_LIST_ABANDONED_CHECKOUTSRetrieves a list of abandoned checkouts with customer contact information. An abandoned checkout occurs when a customer adds contact information but doesn’t complete the purchase. Use this to recover abandoned carts, send recovery emails, or analyze checkout abandonment patterns. Note: This endpoint requires ‘Protected Customer Data’ access in your Shopify app settings. Without this permission, the endpoint returns a 403 error (gracefully handled by returning an empty list). The REST Checkout API is deprecated as of 2024-07; consider GraphQL Admin API for new implementations.

Input Parameters

integer
Maximum number of abandoned checkouts to retrieve per request. Defaults to 50 if not specified, maximum is 250.
string
Filter checkouts by status. Valid values: ‘open’ (default) for active abandoned checkouts, or ‘closed’ for completed/cancelled ones.
string
Restrict results to checkouts created after this checkout ID. Use for pagination to fetch the next set of results.
string
Show checkouts created before specified date (ISO 8601 format).
string
Show checkouts created after specified date (ISO 8601 format, e.g., ‘2024-01-01T00:00:00Z’).
string
Show checkouts last updated before specified date (ISO 8601 format).
string
Show checkouts last updated after specified date (ISO 8601 format).

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: SHOPIFY_LIST_APPLICATION_CREDITSRetrieve all application credits issued to a shop by your app. Use when you need to view credits that can be applied towards future app purchases.

Input Parameters

string
A comma-separated list of fields to include in the response (e.g., ‘id,amount,description,test,currency’). By default, all fields are returned.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: SHOPIFY_LIST_ARTICLE_AUTHORSRetrieve a list of all article authors from the store. Use when you need to get all unique author names who have created articles across all blogs.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: SHOPIFY_LIST_ARTICLE_TAGSRetrieve a list of all article tags from the store. Use when you need to get all unique tags that have been applied to articles, optionally sorted by popularity.

Input Parameters

integer
The maximum number of tags to retrieve. If not specified, all tags are returned.
A flag for ordering retrieved tags by popularity. If present (set to any value like 1), results are ordered by popularity, starting with the most popular tag. If not present, tags are returned in default order.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: SHOPIFY_LIST_ASSIGNED_FULFILLMENT_ORDERSList fulfillment orders assigned to locations managed by this app’s fulfillment services. Optionally filter by assignment status or location IDs. Without a status filter, closed orders are excluded. Uses the legacy Shopify REST Admin API.

Input Parameters

array
IDs of assigned locations to include. If omitted, includes all shop locations managed by the app.
string ("fulfillment_unsubmitted" | "fulfillment_requested" | "fulfillment_accepted" | "cancellation_requested")
Filter by assignment status. If omitted, returns all assigned fulfillment orders except closed orders.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: SHOPIFY_LIST_AVAILABLE_LOCALESQuery available locales for the Shopify store using the Admin GraphQL API. Use when you need to retrieve the list of supported language/region combinations.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: SHOPIFY_LIST_BLOG_ARTICLESRetrieves articles from a specified Shopify blog, with optional filtering by author, dates, handle, or publication status. Supports pagination using a since-ID parameter.

Input Parameters

integer
The maximum number of results to retrieve. Default is 50, maximum is 250.
string
Filter articles by the author name.
string
Comma-separated list of fields to include in the response (e.g., ‘id,title,author’).
string
Retrieve an article with a specific handle (URL-friendly unique string).
string
required
The unique identifier for the blog whose articles should be retrieved.
integer
Restrict results to articles after the specified ID. Useful for pagination.
string
Show only articles created at or before this ISO 8601 timestamp.
string
Show only articles created at or after this ISO 8601 timestamp.
string
Show only articles published at or before this ISO 8601 timestamp.
string
Show only articles published at or after this ISO 8601 timestamp.
string ("published" | "unpublished" | "any")
Filter by publication status. ‘published’ returns only published articles, ‘unpublished’ returns only unpublished articles, ‘any’ returns all articles. Defaults to ‘any’ if not specified.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: SHOPIFY_LIST_BLOGSRetrieve a list of all blogs from a Shopify store. Use when you need to get blog information, list available blogs, or paginate through blogs using since_id.

Input Parameters

integer
Maximum number of results to return. Maximum value is 250, default is 50.
string
Comma-separated list of fields to include in the response (e.g., ‘id,title,handle’). If not specified, all fields are returned.
string
Filter results by blog handle. Returns only the blog with the specified handle.
integer
Restrict results to blogs with IDs greater than the specified ID. Used for pagination.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: SHOPIFY_LIST_BULK_OPERATIONSRetrieve a paginated list of bulk operations from Shopify. Use when you need to view the history of bulk operations, check their statuses, or retrieve result URLs for completed operations. Supports filtering by status, creation date, and operation type.

Input Parameters

integer
Number of elements to return before the before cursor. Maximum value is typically 250. Cannot be used with ‘first’.
string
Cursor for forward pagination. Returns elements after this cursor.
integer
Number of elements to return from the start. Maximum value is typically 250. Cannot be used with ‘last’.
string
Filter query string. Supports filtering by created_at, id, operation_type, and status. Example: ‘status:COMPLETED’ or ‘created_at:>2024-01-01’.
string
Cursor for backward pagination. Returns elements before this cursor.
boolean
Reverse the result order. When true, results are returned in reverse chronological order.
string ("CREATED_AT")
Sort key options for bulk operations list.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: SHOPIFY_LIST_CHANNELSRetrieves a list of sales channels available in the Shopify store using GraphQL. Use when you need to fetch channel information including Online Store, Point of Sale, and other active sales channels. Supports cursor-based pagination for large result sets.

Input Parameters

integer
Number of channels to retrieve from the end of the list. Use for backward pagination. Cannot be used with ‘first’.
string
Cursor to retrieve channels after. Used for forward pagination with ‘first’. Obtain from the ‘endCursor’ in pageInfo from a previous query.
integer
Number of channels to retrieve from the start of the list. Use for forward pagination. Cannot be used with ‘last’.
string
Cursor to retrieve channels before. Used for backward pagination with ‘last’. Obtain from the ‘startCursor’ in pageInfo from a previous query.
boolean
Whether to reverse the order of the returned list. Default is false (channels returned in ascending order).

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: SHOPIFY_LIST_CHECKOUT_PROFILESQuery Shopify checkout profiles with pagination and optional publication-status filtering. Returns profile metadata, including publication status, timestamps, and whether extensibility is active on thank-you and order-status pages.

Input Parameters

integer
The last n elements before the before cursor. Use for backward pagination. Mutually exclusive with ‘first’.
string
Cursor pointing to the position after which to fetch elements. Use for forward pagination with ‘first’.
integer
The first n elements from the paginated list. Use for forward pagination. Mutually exclusive with ‘last’.
string
Search filter using Shopify API syntax. Supports ‘id’ and ‘is_published’ fields. Examples: ‘is_published:true’, ‘id:12345’.
string
Cursor pointing to the position before which to fetch elements. Use for backward pagination with ‘last’.
boolean
Reverses the order of the list. Default is false.
string ("CREATED_AT" | "EDITED_AT" | "ID" | "IS_PUBLISHED" | "UPDATED_AT")
Sort keys for checkout profiles.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: SHOPIFY_LIST_COLLECTION_LISTING_PRODUCT_IDSList one page of published product IDs in a collection listing for your sales channel. Both the collection and each product must be published to your channel. Uses the legacy REST Admin API; follow the returned cursors to retrieve more pages.

Input Parameters

integer
Maximum results per page (1-1000). Shopify defaults to 50.
string
Opaque pagination cursor from a previous response. Pass unchanged with the same collection_listing_id.
string
required
ID of the collection listing published to your sales channel.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: SHOPIFY_LIST_COLLECTION_LISTINGSList one page of collections published to your sales-channel app. Uses the legacy REST Admin API and requires merchant-approved read_product_listings access. Collections must be available to the calling sales channel; products must be published separately. Follow next_page_info to continue; this action does not automatically fetch further pages.

Input Parameters

integer
Maximum results on this page (1-1000). Shopify defaults to 50.
string
Opaque next_page_info or previous_page_info cursor from a prior response. Pass unchanged; only limit can accompany it.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: SHOPIFY_LIST_COLLECTION_PRODUCTSRetrieve products belonging to a specific Shopify collection. Choose which fields to return, retrieve products after a specified ID, or provide a page cursor; the default limit is 50 products and the maximum is 250. The response does not include the Link header needed to obtain the next page cursor. Requires read_products access.

Input Parameters

integer
Number of products to retrieve. Default: 50, Maximum: 250.
string
Comma-separated list of fields to include in response.
string
Retrieve products after a specified product ID.
string
Unique ID used to access a certain page of results (provided in Link header of previous response). When using page_info, only limit and fields parameters can be added.
string
required
The ID of the collection to retrieve products from. This is the unique identifier for the Shopify collection.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: SHOPIFY_LIST_COLLECTSRetrieve a list of collects (product-collection associations). Use when you need to find which products belong to which custom collections.

Input Parameters

integer
Maximum number of results per request. Default is 50, maximum is 250.
string
Show only certain fields, specified by a comma-separated list of field names.
integer
Restrict results to after the specified ID for pagination.
integer
Filter results to a specific product ID.
integer
Filter results to a specific custom collection ID.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: SHOPIFY_LIST_COMMENTSRetrieve a list of comments from Shopify. Use when you need to get comments with optional filtering by dates, status, or pagination.

Input Parameters

integer
Maximum results to retrieve (≤250, default: 50).
string
Comma-separated field names to display (e.g., ‘id,body,author’).
string
Filter by status: pending, published, or unapproved.
string
Restrict results to after specified ID. Used for pagination.
string
Show comments created before specified date (ISO 8601 format, e.g., ‘2024-12-31T23:59:59Z’).
string
Show comments created after specified date (ISO 8601 format, e.g., ‘2024-01-01T00:00:00Z’).
string
Show comments last updated before specified date (ISO 8601 format).
string
Show comments last updated after specified date (ISO 8601 format).
string
Show comments published before specified date (ISO 8601 format).
string
Show comments published after specified date (ISO 8601 format).
string
Filter by published status: published, unpublished, or any (default).

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: SHOPIFY_LIST_COUNTRIESRetrieve a list of all countries where the merchant sells products with tax rates. Use when you need to access country-level tax configuration and regional settings. Note: This endpoint is deprecated as of API version 2024-07.

Input Parameters

string
Comma-separated list of specific fields to return (e.g., ‘id,name,code’). If not specified, all fields are returned.
integer
Filter to retrieve results after specified country ID. Use for pagination.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: SHOPIFY_LIST_CURRENCIESRetrieves a list of currencies enabled on a Shopify store. This action fetches all currencies that the merchant has enabled for multi-currency transactions through Shopify Payments. Each currency includes its ISO 4217 code, the timestamp when its conversion rate was last updated, and its enabled status. Use this when you need to: - Check which currencies are available for customer transactions - Verify currency configurations for the shop - Get conversion rate update timestamps - Determine multi-currency support capabilities Note: This is a read-only endpoint that requires no parameters and returns all enabled currencies for the authenticated shop.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: SHOPIFY_LIST_CUSTOM_COLLECTIONSRetrieve a list of custom collections from Shopify. Use when you need to query collections with filtering options like handle, title, publication status, or date ranges.

Input Parameters

string
Show only collections specified by a comma-separated list of IDs.
integer
The maximum number of results to retrieve (max: 250, default: 50).
string
Show custom collections with a given title.
string
Show only certain fields, specified by a comma-separated list of field names.
string
Filter by custom collection handle.
string
Restrict results to after the specified ID.
string
Show custom collections that include a given product.
string
Show custom collections last updated before date (format: 2014-04-25T16:15:47-04:00).
string
Show custom collections last updated after date (format: 2014-04-25T16:15:47-04:00).
string
Show custom collections published before date (format: 2014-04-25T16:15:47-04:00).
string
Show custom collections published after date (format: 2014-04-25T16:15:47-04:00).
string
Filter by status - published, unpublished, or any (default: any).

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: SHOPIFY_LIST_CUSTOMER_ORDERSRetrieves a page of orders for a specific Shopify customer by customer ID, with optional status, date and other filters. Order details can include line items, fulfillment status, payment information and shipping address.

Input Parameters

integer
Maximum number of results to return (default: 50, max: 250).
string
Comma-separated list of specific fields to include in the response (returns all fields if omitted). Common fields: id, name, email, total_price, created_at, updated_at, financial_status, fulfillment_status, line_items, customer, billing_address, shipping_address.
string
Filter orders by their status. Valid values: open, closed, cancelled, any.
integer
Restrict results to orders after the specified ID (for cursor-based pagination).
string
required
The unique identifier for the customer whose orders you want to retrieve.
string
Show orders created at or before this date (ISO 8601 datetime).
string
Show orders created at or after this date (ISO 8601 datetime).
string
Show orders last updated at or before this date (ISO 8601 datetime).
string
Show orders last updated at or after this date (ISO 8601 datetime).
string
Filter by financial status. Valid values: authorized, pending, paid, partially_paid, refunded, voided, partially_refunded, any, unpaid.
string
Show orders processed at or before this date (ISO 8601 datetime).
string
Show orders processed at or after this date (ISO 8601 datetime).
string
Filter by fulfillment status. Valid values: shipped, partial, unshipped, any, unfulfilled.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: SHOPIFY_LIST_CUSTOMERSRetrieve a list of customers from a Shopify store. Use when you need to fetch customer data with optional filtering by IDs, creation dates, update dates, or account status. Supports pagination using cursor-based navigation via page_info parameter.

Input Parameters

string
Comma-separated list of customer IDs to retrieve specific customers. Example: ‘207119551,562393516’
integer
Number of results to return per page. Default: 50, Maximum: 250
string
Comma-separated list of fields to include in the response. Example: ‘id,email,first_name,last_name’
string
Filter customers by account status. Valid values: enabled, disabled, invited, declined
string
Restrict results to customers after the specified ID. Used for pagination.
string
Pagination cursor for navigating through results. Use the value from the Link header in previous response.
string
Show customers created before this date (ISO 8601 format). Example: ‘2024-12-31T23:59:59Z’
string
Show customers created after this date (ISO 8601 format). Example: ‘2024-04-25T16:15:47-04:00’
string
Show customers last updated before this date (ISO 8601 format).
string
Show customers last updated after this date (ISO 8601 format).

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: SHOPIFY_LIST_DEPRECATED_API_CALLSList the authenticated legacy custom app’s deprecated API calls from the past 30 days. Returns migration guidance, deadlines, and the last data update time. Only legacy custom apps created directly in Shopify admin are eligible. Apps created in the Dev Dashboard, including custom-distribution apps, receive 404 Not Found even when successfully authenticated. Uses the legacy REST Admin API; the documented operation has no filters or pagination parameters.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: SHOPIFY_LIST_DRAFT_ORDERSRetrieve a list of Shopify draft orders, optionally filtered by status, IDs, or update dates. Supports pagination using since_id and limit; response-header pagination links are not returned.

Input Parameters

string
Filter results by comma-separated list of draft order IDs (e.g., ‘1,2,3’).
integer
Maximum number of results to return (default: 50, maximum: 250).
string
Comma-separated list of specific properties to include in the response (e.g., ‘id,name,status,total_price’).
string
Filter by order status. Valid values: ‘open’, ‘invoice_sent’, ‘completed’.
string
Restrict results to draft orders after the specified ID. Used for pagination.
string
Show draft orders updated before this date in ISO 8601 format (e.g., ‘2024-12-31T23:59:59Z’).
string
Show draft orders updated after this date in ISO 8601 format (e.g., ‘2024-01-01T00:00:00Z’).

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: SHOPIFY_LIST_INVENTORY_LEVELSRetrieves a list of inventory levels for specified items and locations. Use when you need to check inventory quantities at specific locations. At least one of inventory_item_ids or location_ids must be provided as a filter parameter.

Input Parameters

integer
Maximum number of results to return per page. Range: 1-250, Default: 50.
string
Comma-separated list of location IDs to filter by. Maximum 50 IDs per request. At least one of inventory_item_ids or location_ids must be provided.
string
Show inventory levels updated at or after this date. ISO 8601 datetime format.
string
Comma-separated list of inventory item IDs to filter by. Maximum 50 IDs per request. At least one of inventory_item_ids or location_ids must be provided.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: SHOPIFY_LIST_LOCATION_INVENTORY_LEVELSList one page of inventory levels for a location using the legacy REST Admin API. Returns available quantities (null for untracked items). Follow next_page_info with the same location_id to read more pages; never automatically fetches all pages.

Input Parameters

integer
Maximum results per page (1-250). Shopify defaults to 50.
string
Return results after this ID. Cannot be combined with page_info.
string
Opaque cursor from next_page_info or previous_page_info. Pass unchanged with the same location_id; only limit can be combined with it.
string
required
The numeric ID of the location to list inventory for.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: SHOPIFY_LIST_LOCATIONSRetrieve a list of locations for a Shopify store. Use when you need to get physical or virtual places where inventory is stocked and orders are fulfilled.

Input Parameters

integer
The maximum number of locations to retrieve. Defaults to 50, with a maximum value of 250.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: SHOPIFY_LIST_MARKETING_EVENTSRetrieves a list of Shopify marketing events, such as ads, posts, newsletters, and campaigns. Returns up to 250 events per request, with a default limit of 50, including available event metadata such as channel, budget, timestamps, and associated resources.

Input Parameters

integer
Maximum number of results to return per page. Maximum value is 250, defaults to 50. For pagination beyond the first page, use the ‘Link’ header from the response which contains cursor-based pagination URLs.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: SHOPIFY_LIST_MOBILE_PLATFORM_APPLICATIONSList mobile platform applications associated with the calling app. Uses the legacy REST Admin API. Shopify Support must enable the mobile_platform_applications access scope for your app before use. The documented endpoint has no filters or pagination parameters.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: SHOPIFY_LIST_ORDERRetrieves a list of orders from Shopify with optional filtering by status, dates, and other criteria. Use when you need to fetch multiple orders with pagination and filtering support.

Input Parameters

string
Retrieve only orders with specific IDs. Provide as comma-separated values.
integer
Maximum number of orders to return per page. Default is 50, maximum is 250.
string
Comma-separated list of fields to include in the response to reduce payload size.
string
Filter orders by their status. Valid values: open, closed, cancelled, any. Defaults to ‘open’ if not specified.
integer
Retrieve orders after the specified order ID for pagination purposes.
string
Cursor value for pagination. When using page_info, only ‘limit’ and ‘fields’ may be used alongside it. Other filters are not supported with cursor-based pagination.
string
Show orders created at or before this date (ISO 8601 timestamp format: YYYY-MM-DDTHH:MM:SSZ).
string
Show orders created at or after this date (ISO 8601 timestamp format: YYYY-MM-DDTHH:MM:SSZ).
string
Show orders last updated at or before this date (ISO 8601 timestamp).
string
Show orders last updated at or after this date (ISO 8601 timestamp).
string
Filter orders by financial/payment status. Valid values: authorized, pending, paid, partially_paid, refunded, voided, partially_refunded, any, unpaid.
string
Show orders processed at or before this date (ISO 8601 timestamp).
string
Show orders processed at or after this date (ISO 8601 timestamp).
string
Show orders attributed to a specific app ID. Use ‘current’ to filter by the calling app.
string
Filter orders by fulfillment status. Valid values: shipped, partial, unshipped, any, unfulfilled. Use ‘unfulfilled’ or leave empty to get unfulfilled orders.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: SHOPIFY_LIST_ORDER_REFUNDSRetrieve a list of refunds for a Shopify order. Use when you need to check refund history for a specific order.

Input Parameters

integer
The maximum number of results to retrieve. Default is 50, maximum is 250.
string
Show only certain fields, specified by a comma-separated list of field names.
string
required
The unique identifier for the order whose refunds you want to retrieve.
boolean
Display amounts in the shop’s base currency for underlying transactions. Default is false.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: SHOPIFY_LIST_ORDERSRetrieves a list of orders from Shopify. Use when you need to fetch multiple orders with optional filtering by status, financial status, fulfillment status, or date ranges.

Input Parameters

string
Comma-separated list of order IDs to retrieve specific orders. Can be a string or list of integers.
integer
Maximum number of results per page. Range: 1-250. Default: 50.
string
Comma-separated list of fields to include in the response (e.g., id,email,total_price). Can be a string or list of strings.
string ("open" | "closed" | "cancelled" | "any")
Filter orders by status. Valid values: open, closed, cancelled, any. Default: open.
string
Restrict results to orders after the specified ID (for pagination).
string
Show orders created at or before this date (ISO 8601 format).
string
Show orders created at or after this date (ISO 8601 format: YYYY-MM-DDTHH:MM:SS-HH:MM).
string
Show orders last updated at or before this date (ISO 8601 format).
string
Show orders last updated at or after this date (ISO 8601 format).
string ("authorized" | "pending" | "paid" | "partially_paid" | "refunded" | "voided" | "partially_refunded" | "any")
Filter by payment status. Valid values: authorized, pending, paid, partially_paid, refunded, voided, partially_refunded, any.
string
Show orders imported/processed at or before this date (ISO 8601 format).
string
Show orders imported/processed at or after this date (ISO 8601 format).
string
Filter orders attributed to a specific app ID. Use ‘current’ for the calling app.
string ("shipped" | "partial" | "unshipped" | "any" | "unfulfilled")
Filter by fulfillment status. Valid values: shipped, partial, unshipped, any, unfulfilled.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: SHOPIFY_LIST_PAGESRetrieve a page of Shopify store pages, including content or metadata, with optional filters and since-ID pagination.

Input Parameters

integer
Maximum number of results to show. Max: 250, default: 50
string
Retrieve pages with a given title
string
Comma-separated list of specific field names to display in response
string
Retrieve a page with a given handle
string
Restrict results to pages after the specified ID
string
Show pages created before specified date. Format: ISO 8601
string
Show pages created after specified date. Format: ISO 8601 (e.g., ‘2014-04-25T16:15:47-04:00’)
string
Show pages last updated before specified date. Format: ISO 8601
string
Show pages last updated after specified date. Format: ISO 8601
string
Show pages published before specified date. Format: ISO 8601
string
Show pages published after specified date. Format: ISO 8601
string
Filter by publication status. Valid values: ‘published’, ‘unpublished’, or ‘any’. Default: any

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: SHOPIFY_LIST_PAYMENT_DISPUTESList one page of Shopify Payments disputes, most recently initiated first. Filter by initiation date, dispute ID boundaries, or status. Follow the returned page_info cursors to continue without filters; no further pages are fetched automatically. Requires Shopify Payments and read_shopify_payments_disputes access. Uses the legacy REST Admin API; API version comes from the connection.

Input Parameters

integer
Page size (1-250); Shopify defaults to 50.
string ("needs_response" | "under_review" | "charge_refunded" | "accepted" | "won" | "lost")
Return only disputes with this status.
string
Return only disputes before this dispute ID.
string
Return only disputes after this dispute ID.
string
Opaque next_page_info or previous_page_info cursor. Pass unchanged with only limit, not filters.
string
Return disputes initiated on this ISO 8601 date.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: SHOPIFY_LIST_PAYMENTS_BALANCE_TRANSACTIONSList one page of Shopify Payments balance transactions, newest first. Filter by ID boundaries, payout, payout status, or test mode. Continue using returned page_info cursors without filters; pages are not automatically fetched. Requires Shopify Payments and read_shopify_payments_payouts access. Uses the legacy REST Admin API; the connection base URL supplies the API version.

Input Parameters

boolean
Filter transactions by whether they were placed in test mode.
integer
Page size, 1-250; Shopify defaults to 50.
string
Return transactions exclusively before this ID.
string
Return transactions exclusively after this ID.
string
Opaque next_page_info or previous_page_info cursor; pass unchanged with only limit, not filters.
string
Return transactions paid out in this payout.
string
Filter transactions by payout status.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: SHOPIFY_LIST_PAYMENTS_PAYOUTSList one page of Shopify Payments payouts, newest payout date first. Filter by date, ID boundaries, or transfer status. Continue using returned page_info cursors without filters; pages are never automatically fetched. Requires Shopify Payments and read_shopify_payments_payouts access. Uses the legacy REST Admin API; the connection base URL supplies the API version.

Input Parameters

string
Only payouts issued on this ISO 8601 date.
integer
Page size, 1-250; Shopify defaults to 50.
string ("scheduled" | "in_transit" | "paid" | "failed" | "canceled")
Return payouts with this transfer status.
string
Return payouts before this payout ID.
string
Payout date upper bound, inclusive (ISO 8601).
string
Payout date lower bound, inclusive (ISO 8601).
string
Return payouts after this payout ID.
string
Opaque next_page_info or previous_page_info cursor; pass unchanged with only limit, not filters.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: SHOPIFY_LIST_PAYMENT_TERMS_TEMPLATESQuery payment terms templates from Shopify using the GraphQL API. Use when you need to retrieve available payment terms templates, optionally filtered by payment terms type.

Input Parameters

string ("RECEIPT" | "FULFILLMENT" | "NET" | "FIXED")
Payment terms type classification.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: SHOPIFY_LIST_PRODUCT_IMAGESRetrieves a page of images for a Shopify product, with optional limit, since-ID and field selection.

Input Parameters

integer
Maximum number of product images to return. Accepted values are 1 to 250. Default is 50.
string
A comma-separated list of fields to include in the response. Use to limit the returned data to only the fields you need.
integer
Return only product images after the specified ID. Use for cursor-based pagination through large result sets.
string
required
The unique identifier of the Shopify product for which to retrieve all images.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: SHOPIFY_LIST_PRODUCT_LISTING_PRODUCT_IDSList one page of IDs of products published to your sales-channel app. Uses the legacy REST Admin API and requires merchant-approved read_product_listings access. Follow the returned cursors for more pages; no additional pages are fetched automatically.

Input Parameters

integer
Maximum results per page (1-1000). Shopify defaults to 50.
string
Opaque next_page_info or previous_page_info cursor. Pass unchanged; only limit can accompany a cursor.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: SHOPIFY_LIST_PRODUCT_LISTINGSList one page of products published to your sales-channel app. Uses the legacy REST Admin API and requires merchant-approved read_product_listings access. Follow next_page_info to continue; no further pages are fetched automatically. Listings inherit read-only product attributes.

Input Parameters

integer
Page size (1-1000); Shopify defaults to 50.
string
Filter by product handle.
string
Opaque next_page_info or previous_page_info cursor. Pass unchanged; only limit can accompany a cursor.
string
Comma-separated product IDs to retrieve.
string
Filter by collection ID.
string
Only listings updated after this ISO 8601 timestamp.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: SHOPIFY_LIST_PRODUCT_RESOURCE_FEEDBACKRetrieve this app’s resource feedback for a specific Shopify product. Requires a Sales Channel app with resource-feedback access. Returns feedback states and merchant-facing messages, not feedback from other apps. The REST Admin API is legacy; new public apps must use GraphQL productResourceFeedback.

Input Parameters

string
required
ID of the product whose feedback from this app is retrieved.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: SHOPIFY_LIST_PRODUCT_VARIANTSRetrieve a page of variants for a specified Shopify product, with optional field selection and pagination using limit and since_id.

Input Parameters

integer
Maximum number of results per page. Default: 50, Maximum: 250.
string
A comma-separated list of fields to include in the response. Use this to retrieve only specific fields you need.
integer
Restrict results to after the specified variant ID. Used for pagination to retrieve variants created after a specific ID.
string
required
The unique numeric identifier for the product whose variants you want to retrieve.
string
Return presentment prices in only certain currencies, specified by a comma-separated list of ISO 4217 currency codes.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: SHOPIFY_LIST_RESOURCE_FEEDBACKSRetrieves the current resource feedback for the shop. Resource feedback is how your app communicates its setup/configuration status to merchants via the Shopify admin. Use this to check what feedback your app has previously submitted (e.g., whether you told merchants that action is required or that setup is successful). Returns empty array if no feedback exists, or a single feedback object representing the most recent status your app reported to Shopify.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: SHOPIFY_LIST_SCRIPT_TAGSRetrieves Shopify script tags, with optional filters for URL and date ranges. Supports pagination using a since-ID parameter.

Input Parameters

string
Filters results by script URL. Only script tags with this exact URL will be returned.
integer
Controls the quantity of results returned. Default: 50, Max: 250.
string
Comma-separated list of specific fields to include in the response. Use this to restrict the returned script tags to only the specified properties.
string
Constrains output to records following a designated ID. Use for pagination to retrieve records after a specific script tag ID.
string
Shows tags created before this timestamp. Must be in ISO 8601 format.
string
Shows tags created after this timestamp. Must be in ISO 8601 format.
string
Shows tags modified before this timestamp. Must be in ISO 8601 format.
string
Shows tags modified after this timestamp. Must be in ISO 8601 format.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: SHOPIFY_LIST_THEME_ASSETSRetrieves metadata for theme assets (files that make up a theme: templates, images, stylesheets, snippets). Returns metadata only—not file content. To get actual file content, you must retrieve assets individually using a separate action. Use the asset_key parameter to retrieve a single asset, or omit it to list all assets in the theme.

Input Parameters

string
Comma-separated list of asset fields to include in the response. Available fields: key, public_url, created_at, updated_at, content_type, size, checksum, theme_id. If omitted, all fields are returned.
string
required
The ID of the theme whose assets you want to retrieve.
string
The path of a specific asset within the theme to retrieve (e.g., ‘assets/bg-body.gif’, ‘layout/theme.liquid’). If provided, only that single asset’s metadata is returned instead of all assets.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: SHOPIFY_LIST_TRANSACTIONSRetrieves all transactions for a specific order. Use when you need to view payment exchanges for an order. Transactions include authorization, sale, capture, void, and refund types.

Input Parameters

string
Comma-separated list of field names to show only certain fields in the response (e.g., ‘id,kind,status’).
string
required
The unique identifier of the order whose transactions you want to retrieve.
integer
Retrieve only transactions after the specified transaction ID.
boolean
Set to true to retrieve transactions in the shop currency. Default is false, which returns presentment currency for multi-currency orders.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: SHOPIFY_LIST_USAGE_CHARGESList usage charges for an existing recurring application charge of the app. Optionally project specific fields. Uses Shopify’s legacy REST Admin API; this read does not create charges or change billing.

Input Parameters

string
A comma-separated list of fields to include in the response. Omit to return all fields.
string
required
The numeric ID of an existing recurring application charge.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: SHOPIFY_LIST_USERSList one page of staff users and their permissions. Available only to private/custom apps on Shopify Plus stores. Shopify Plus Support must approve the read_users scope for the app. A general store OAuth grant is not sufficient. Uses the legacy REST Admin API; the connection base URL supplies the API version. Continue with returned page_info cursors; additional pages are never automatically fetched.

Input Parameters

integer
Page size, 1-250; Shopify defaults to 50.
string
Opaque pagination cursor from a response Link header; pass unchanged.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: SHOPIFY_MARK_COMMENT_AS_NOT_SPAMMarks a comment as not spam in Shopify, restoring it to published or unapproved state. Use this to remove the spam designation from a comment that was incorrectly flagged. The comment status will change from ‘spam’ to either ‘published’ (if it was previously approved) or ‘unapproved’ (if it needs review).

Input Parameters

string
required
Unique numeric identifier for the comment to mark as not spam.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: SHOPIFY_MARK_COMMENT_AS_SPAMMark a comment as spam in Shopify. Use when you need to flag a comment as spam and remove it from visibility. When marked as spam, the comment status changes to ‘spam’, published_at is set to null, and it becomes invisible to blog readers.

Input Parameters

string
required
Unique numeric identifier for the comment to mark as spam.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: SHOPIFY_MODIFY_AN_EXISTING_PRODUCT_VARIANTUpdate an existing product variant in Shopify. Use when you need to modify variant properties like price, SKU, weight, or inventory settings.

Input Parameters

string
A unique identifier for the product variant in the shop (Stock Keeping Unit).
string
The selling price of the variant.
number
The weight of the product variant in the unit system specified with weight_unit.
string
The barcode, UPC, or ISBN number for the product variant.
string
The value of the first custom product option (e.g., Size, Color).
string
The value of the second custom product option.
string
The value of the third custom product option.
boolean
Whether a tax is charged when the product variant is sold.
integer
The unique numeric identifier for a product’s image to associate with this variant.
string
The tax code for the product variant.
integer
required
The unique numeric identifier for the product variant to update.
string
The unit of measurement for the product variant’s weight. Valid values: ‘g’, ‘kg’, ‘oz’, ‘lb’.
string
The original price of the item before an adjustment or a sale. Set to null to remove compare at price.
string
Whether customers are allowed to place an order for the product variant when it’s out of stock. Valid values: ‘deny’ (customers cannot order when out of stock), ‘continue’ (customers can order when out of stock).
boolean
Whether the product variant requires shipping.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: SHOPIFY_MODIFY_EXISTING_WEBHOOKModify an existing webhook subscription’s delivery URI, data format, or payload fields; the topic cannot be changed by this tool. Subscriptions are scoped to the app that registered them, and subscriptions created through Shopify admin cannot be accessed through the API.

Input Parameters

array
Array of top-level resource fields to include in webhook POST requests. If omitted, all fields are included in the payload.
string ("json" | "xml")
Data format for transmission - either ‘json’ or ‘xml’. Defaults to ‘json’ if not specified.
string
The destination URI where webhook POST requests are sent. Supports HTTPS endpoints, Google Pub/Sub (pubsub://projectName:topicName), and Amazon EventBridge ARN formats. This is the primary field for updating webhook delivery location.
string
required
The unique numeric identifier for the webhook subscription to modify.
array
Array of metafield namespaces to include in webhook payloads. Allows filtering which metafields are sent with webhook events.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: SHOPIFY_MOVE_FULFILLMENT_ORDERMove a fulfillment order from one merchant managed location to another. Use when you need to relocate unfulfilled items to a different location. The operation will fail if the fulfillment order is closed or if the destination location has never stocked the requested inventory item.

Input Parameters

integer
required
The ID of the destination location where the fulfillment order will be moved. The destination location must have previously stocked the requested inventory item.
string
required
The unique identifier of the fulfillment order to move.
array
Array of fulfillment order line items to move. Each item must contain an ID and quantity. If omitted, all unfulfilled line items will be transferred to the new location.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: SHOPIFY_OPEN_FULFILLMENT_ORDERMark a scheduled fulfillment order open before its fulfill_at datetime. Use to make a scheduled order ready for fulfillment early. Requires access to the order’s merchant-managed or third-party fulfillment location. Does not create a fulfillment or reopen a completed order. Uses the legacy REST Admin API.

Input Parameters

string
required
ID of the scheduled fulfillment order to make ready for fulfillment.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: SHOPIFY_PIN_METAFIELD_DEFINITIONPin a metafield definition in Shopify admin. Use when you need to organize metafields by pinning them to control their display order and visibility. Pinned metafields are automatically displayed in the admin interface.

Input Parameters

object
Alternative method to identify metafield definition by owner type, namespace and key.
string
The ID of the metafield definition to pin. Must be a Shopify GID in the format ‘gid://shopify/MetafieldDefinition/{id}’ or just the numeric ID. Either definitionId or identifier must be provided.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: SHOPIFY_PUBLISH_COLLECTION_LISTINGPublish an existing collection to this app’s sales channel. Only sales-channel apps can publish collection listings. Products in the collection are not automatically published; publish them separately. REST Admin API is legacy; new public apps must use GraphQL Admin API.

Input Parameters

object
required
Collection listing to publish, containing its collection_id.
string
required
Collection ID used in the collection listing URL.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: SHOPIFY_PUBLISH_PRODUCT_LISTINGPublish an existing product to the calling app’s sales channel. Requires merchant-approved product listing access. Listing attributes are inherited from the product and cannot be modified here. Draft or archived products are not published immediately; activate the product first. Subscription-only products can only be listed on the online store. REST Admin API is legacy; new public apps must use GraphQL Admin API.

Input Parameters

object
required
Product listing to publish, containing its product_id.
string
required
Product ID used in the product listing URL.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: SHOPIFY_QUERY_APP_BY_KEYQuery app information by API key using Shopify’s GraphQL Admin API. Use when you need to retrieve metadata about a Shopify app using its client ID. Returns null if no app is found with the provided API key.

Input Parameters

string
required
The client ID of the app to retrieve. This is the unique API key assigned to the application.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: SHOPIFY_QUERY_BUSINESS_ENTITIESRetrieve all business entities associated with the shop. Use when you need to view business entities for assigning to markets, managing payment providers per entity, or checking order attribution.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: SHOPIFY_QUERY_BUSINESS_ENTITYQuery business entity information from Shopify. Use when you need to retrieve business entity details such as company name, address, and payment account information. If no ID is provided, returns the primary business entity.

Input Parameters

string
The ID of the business entity to retrieve. If omitted, returns the primary business entity.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: SHOPIFY_QUERY_CATALOGSQueries catalogs from Shopify using the GraphQL Admin API. Catalogs control which products are published and how they’re priced in different contexts such as international markets, B2B company locations, or specific sales channels.

Input Parameters

integer
Number of final elements to retrieve. Use for backward pagination.
string ("APP" | "COMPANY_LOCATION" | "MARKET" | "NONE")
Type of catalog to filter by.
string
Cursor for elements following a specified position. Use with ‘first’ for forward pagination.
integer
Number of initial elements to retrieve. Use for forward pagination.
string
Custom filter using Shopify API search syntax. Example: ‘status:ACTIVE’ to filter by status.
string
Cursor for elements preceding a specified position. Use with ‘last’ for backward pagination.
boolean
Reverse the order of the results. Defaults to false (ascending order).
string ("ID" | "TITLE")
Sort keys for catalogs.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: SHOPIFY_QUERY_CHANNELQuery a single Shopify channel by ID. Use when you need to retrieve detailed information about a specific sales channel including its associated app, name, handle, and publishing capabilities.

Input Parameters

string
required
The ID of the Channel to return. Must be in the format: gid://shopify/Channel/{numeric_id}

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: SHOPIFY_QUERY_CURRENT_APP_INSTALLATIONQuery the currently authenticated app installation on a Shopify store. Use when you need to retrieve details about the current app’s installation including access scopes, active subscriptions, launch URL, and uninstall URL.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: SHOPIFY_QUERY_CURRENT_BULK_OPERATIONQuery the status of the most recent Shopify bulk query or mutation operation, including its result download URL when available.

Input Parameters

string ("QUERY" | "MUTATION")
Determines whether to retrieve the most recent query or mutation bulk operation. Default: QUERY

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: SHOPIFY_QUERY_CUSTOMER_ACCOUNT_PAGESQuery pagination information for Shopify customer account pages using the GraphQL Admin API. The response contains page cursors and pagination flags, not page details.

Input Parameters

integer
Number of final elements to retrieve from the paginated list. Use for backward pagination.
string
Cursor for elements following a specified position. Use with ‘first’ for forward pagination.
integer
Number of initial elements to retrieve from the paginated list. Use for forward pagination.
string
Cursor for elements preceding a specified position. Use with ‘last’ for backward pagination.
boolean
Reverse the order of the underlying list. Defaults to false (ascending order).

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: SHOPIFY_QUERY_DELETION_EVENTSQuery Shopify deletion events for products and collections, with pagination, sorting, and filtering options.

Input Parameters

integer
The last n elements before the before cursor. Use for backward pagination. Maximum value: 250.
string
Returns elements that come after the specified cursor. Use for forward pagination with the endCursor from pageInfo.
integer
The first n elements from the paginated list. Use for forward pagination. Maximum value: 250.
string
Query filter using search syntax. Supports filtering by ‘id’ and ‘occurred_at’ fields. Example: ‘occurred_at:>2024-01-01’ or ‘id:12345’.
string
Returns elements that come before the specified cursor. Use for backward pagination with the startCursor from pageInfo.
boolean
Reverse the order of results. Default is false (ascending order).
string ("CREATED_AT" | "ID")
Sort keys for deletion events.
array
Filter deletion events by subject type. Defaults to all supported subject types.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: SHOPIFY_QUERY_DISPUTESQuery Shopify Payments disputes using the GraphQL Admin API. Use when you need to retrieve information about payment disputes, including their status and initiation date. Supports pagination and filtering by status or ID.

Input Parameters

integer
Return up to the last n elements from the paginated list. Use for backward pagination.
string
Returns the elements that come after the specified cursor. Use with ‘first’ for forward pagination.
integer
Return up to the first n elements from the paginated list. Use for forward pagination.
string
Search query for filtering results. Supports id and status filters. Example: ‘status:WON’ or ‘id:12345’.
string
Returns the elements that come before the specified cursor. Use with ‘last’ for backward pagination.
boolean
Reverse the order of the underlying list. Defaults to false (ascending order).

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: SHOPIFY_QUERY_DOMAINQuery a specific domain by its ID from Shopify. Use when you need to retrieve domain details including host, URL, SSL status, and localization settings.

Input Parameters

string
required
Globally unique identifier for the domain in the format gid://shopify/Domain/{numeric_id}. Example: gid://shopify/Domain/105313763522

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: SHOPIFY_QUERY_EVENTSQuery events from Shopify using the GraphQL Admin API. Events track actions performed on store resources like products, orders, collections, customers, and more. Use this to retrieve activity history, audit changes, monitor recent actions, or build activity feeds. Returns detailed information about each event including the action type, affected resource, timestamp, and description.

Input Parameters

integer
Number of final elements to retrieve. Use for backward pagination. Maximum: 250.
string
Cursor for elements following a specified position. Use with ‘first’ for forward pagination.
integer
Number of initial elements to retrieve. Use for forward pagination. Maximum: 250.
string
Custom filter using Shopify API search syntax. Supported fields: action, comments, created_at, id, subject_type. Example: ‘subject_type:PRODUCT’ or ‘action:create AND created_at:>2023-01-01’.
string
Cursor for elements preceding a specified position. Use with ‘last’ for backward pagination.
boolean
Reverse the order of the results. Defaults to false (ascending order).
string ("ID" | "CREATED_AT")
Sort keys for events.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: SHOPIFY_QUERY_EVENTS_COUNTQuery the count of events in Shopify using the GraphQL Admin API. Use when you need to get the total number of events with optional filtering by date, subject type, or other criteria. Returns both the count and precision indicator.

Input Parameters

string
Optional filter query for events. Use Shopify search syntax to filter events (e.g., ‘created_at:>=2024-01-01’ to filter by creation date, or ‘subject_type:PRODUCT’ to filter by resource type). If not provided, returns count of all events.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: SHOPIFY_QUERY_JOBQuery a single job by its ID using Shopify’s GraphQL API. Use when you need to check the status of an asynchronous job. Jobs track long-running operations like bulk operations, mutations, or imports.

Input Parameters

string
required
The ID of the job to query. Must be a Shopify global ID format like gid://shopify/Job/00000000-0000-0000-0000-000000000000

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: SHOPIFY_QUERY_METAFIELD_DEFINITIONQuery metafield definition details by ID using Shopify’s GraphQL Admin API. Use when you need to retrieve metadata about a metafield definition including its type, namespace, key, and usage count. Returns null if no metafield definition is found with the provided ID.

Input Parameters

string
required
Global identifier for the metafield definition. Must be in the format: gid://shopify/MetafieldDefinition/XXX where XXX is the numeric ID.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: SHOPIFY_QUERY_METAFIELD_DEFINITIONSQuery metafield definitions from Shopify using the GraphQL Admin API. Use this to retrieve the schema and configuration of metafields for a specific resource type (PRODUCT, COLLECTION, CUSTOMER, etc.). Returns detailed information about each metafield definition including name, namespace, key, type, and validation rules.

Input Parameters

string
Cursor for elements following a specified position. Use with ‘first’ for forward pagination.
integer
Number of metafield definitions to retrieve. Use for pagination. Maximum: 250. Defaults to 250.
string
Filter metafield definitions by namespace. Only returns definitions within the specified namespace.
string ("PRODUCT" | "COLLECTION" | "CUSTOMER" | "ORDER" | "SHOP" | "COMPANY" | "LOCATION" | "COMPANY_LOCATION" | "VARIANT")
required
The resource type to filter metafield definitions by (e.g., PRODUCT, COLLECTION, CUSTOMER, ORDER). This determines which type of resource’s metafield definitions will be returned.
string ("PINNED" | "UNPINNED" | "ANY")
Filter by pinned status of metafield definitions.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: SHOPIFY_QUERY_METAFIELD_DEFINITION_TYPESQueries all available metafield definition types from Shopify using the GraphQL Admin API. Returns comprehensive information about each type including its category, supported validations, and migration capabilities. Use this to discover what metafield types can be created and what validation rules are available for each type.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: SHOPIFY_QUERY_NODEQuery any Shopify resource by its global ID using the node query. Use when you have a GID and need to retrieve the basic resource information.

Input Parameters

string
required
The globally unique identifier (GID) in Relay format for the node to retrieve. Must be in the format gid://shopify/{ResourceType}/{numeric_id}. Examples: gid://shopify/Product/108828309, gid://shopify/Shop/64462848194, gid://shopify/Customer/123456789
string
Optional GraphQL inline fragment to query specific fields based on the node type. Example: ’… on Shop { name email }’ or ’… on Product { title handle status }’. If not provided, only the id field will be returned.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: SHOPIFY_QUERY_NODESQuery nodes by their IDs from the Shopify GraphQL Admin API. Use when you need to retrieve multiple Shopify objects by their global IDs (GIDs). Returns node objects with at least an id field, or null for non-existent nodes.

Input Parameters

array
required
An array of ID values representing the IDs of the Nodes to return. IDs must be in Shopify GID format (e.g., gid://shopify/Product/123, gid://shopify/Shop/1, gid://shopify/Customer/456). Maximum of 250 IDs per request.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: SHOPIFY_QUERY_ONLINE_STOREQuery the online store’s password protection status using Shopify’s GraphQL Admin API.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: SHOPIFY_QUERY_PRODUCT_DUPLICATE_JOBQuery a product duplicate job by its ID using Shopify’s GraphQL API. Use when you need to check the status of a product duplication operation.

Input Parameters

string
required
The ID of the product duplicate job to query. Must be a Shopify global ID format like gid://shopify/ProductDuplicateJob/1234567890

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: SHOPIFY_QUERY_PUBLIC_API_VERSIONSQuery available public API versions from Shopify using the GraphQL Admin API. Returns a list of all API versions with their support status. Use this to check which API versions are currently supported before making version-specific API calls.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: SHOPIFY_QUERY_PUBLICATIONQuery a Shopify publication by ID for its name, auto-publish settings, future publishing support, and associated catalog. Partial publication data may be returned without GraphQL errors when some fields fail.

Input Parameters

string
required
Globally unique identifier for the publication in the format gid://shopify/Publication/{numeric_id}. Example: gid://shopify/Publication/1

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: SHOPIFY_QUERY_SERVER_PIXELQuery Shopify’s server pixel configuration to retrieve its ID, status, and webhook endpoint address. Requires read_pixels or read_server_pixels access.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: SHOPIFY_QUERY_SHOPRetrieve Shopify shop information through the GraphQL Admin API, including configuration such as name, email, domain, currency settings, and enabled features. Fields can be selected, subject to the response’s supported shop fields.

Input Parameters

string
Optional GraphQL field selection string to customize which shop fields to retrieve. If not provided, a default set of commonly used fields will be returned. Example: ‘name email myshopifyDomain currencyCode’

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: SHOPIFY_QUERY_SHOP_BILLING_PREFERENCESQuery the shop’s billing preferences from Shopify using the GraphQL Admin API. Use when you need to retrieve the currency used for billing apps and services.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: SHOPIFY_QUERY_SHOPIFY_FUNCTIONSQuery Shopify Functions owned by the API client installed on the shop. Use when you need to retrieve functions that customize Shopify’s backend logic such as discounts, checkout validation, and fulfillment.

Input Parameters

integer
Number of final elements to retrieve. Use for backward pagination.
string
Cursor for elements following a specified position. Use with ‘first’ for forward pagination.
integer
Number of initial elements to retrieve. Use for forward pagination.
string
Cursor for elements preceding a specified position. Use with ‘last’ for backward pagination.
string
Filter the functions by the API type (e.g., ‘product_discount’, ‘order_discount’, ‘shipping_discount’).
boolean
Reverse the order of the underlying list. Defaults to false (ascending order).
boolean
Filter the functions by whether or not the function uses the creation UI in the Admin.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: SHOPIFY_QUERY_SHOP_PAY_PAYMENT_REQUEST_RECEIPTSQuery Shop Pay payment request receipts from Shopify using the GraphQL Admin API. Use when you need to retrieve and list Shop Pay payment request receipts. Note: This query requires API version 2026-01 or later.

Input Parameters

integer
Number of final elements to return. Use for backward pagination. Cannot be used with ‘first’.
string
Cursor for pagination - returns elements after this cursor. Use with ‘first’ for forward pagination.
integer
Number of initial elements to return. Use for forward pagination. Cannot be used with ‘last’.
string
Filter query supporting created_at, id, source_identifier, and state fields. Use Shopify search syntax (e.g., ‘state:completed’ or ‘created_at:>2024-01-01’).
string
Cursor for pagination - returns elements before this cursor. Use with ‘last’ for backward pagination.
boolean
Reverse the list order. When false (default), results are in ascending order by sort key. When true, results are in descending order.
string ("ID")
Sort keys for Shop Pay payment request receipts.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: SHOPIFY_QUERY_STANDARD_METAFIELD_DEFINITION_TEMPLATESQuery standard metafield definition templates from Shopify using the GraphQL Admin API. Returns preset metafield configurations with reserved namespace-key combinations for common use cases like product subtitles, care guides, or ISBN numbers.

Input Parameters

integer
Number of final elements to retrieve. Use for backward pagination. Maximum: 250.
string
Cursor for elements following a specified position. Use with ‘first’ for forward pagination.
integer
Number of initial elements to retrieve. Use for forward pagination. Maximum: 250.
string
Cursor for elements preceding a specified position. Use with ‘last’ for backward pagination.
boolean
Reverse the order of the underlying list. Defaults to false.
string
Filter templates by constraint status (MetafieldDefinitionConstraintStatus enum). Use this to filter templates based on their constraint validation requirements.
boolean
Exclude templates that have already been activated in the store. Defaults to false.
string
Filter by resource subtype applicability (MetafieldDefinitionConstraintSubtypeIdentifier). Use this to find templates applicable to specific resource subtypes.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: SHOPIFY_QUERY_TAXONOMYQuery Shopify’s product taxonomy using the GraphQL Admin API. Use when you need to explore product categories, discover the taxonomy hierarchy, or find appropriate categories for products. Returns taxonomy categories that can be filtered by search terms or hierarchy relationships.

Input Parameters

integer
Number of items to return from end (backward pagination). Maximum: 250.
string
Cursor for forward pagination. Use the endCursor from previous response.
integer
Number of items to return (forward pagination). Maximum: 250.
string
Cursor for backward pagination. Use the startCursor from previous response.
Search term to locate matching categories across the taxonomy.
string
ID of category to retrieve direct children from. Use this to explore the next level of the taxonomy hierarchy.
string
ID of category to get categories at the same hierarchy level. Returns categories that share the same parent.
string
ID of category to fetch all nested categories below. Returns the complete subtree of categories.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: SHOPIFY_QUERY_WEBHOOK_SUBSCRIPTIONRetrieve webhook subscription details by ID using the Shopify GraphQL Admin API. Use when you need to inspect webhook configuration, endpoint details, or subscription metadata.

Input Parameters

string
required
The globally unique identifier (GID) for the webhook subscription to retrieve. Must be in the format gid://shopify/WebhookSubscription/{numeric_id}.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: SHOPIFY_QUERY_WEBHOOK_SUBSCRIPTIONSQuery a paginated list of Shopify webhook subscriptions through the GraphQL Admin API, including topics, endpoint details, and formats. A custom GraphQL document can be supplied and may perform mutations; its response must contain a webhookSubscriptions connection.

Input Parameters

string
Cursor for elements following a specified position. Use with ‘first’ for forward pagination.
integer
Number of webhook subscriptions to retrieve. Maximum: 250.
string
Custom GraphQL query string to override the default query. If not provided, a default query retrieving id, topic, endpoint, and format will be used.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: SHOPIFY_RECEIVE_A_COUNT_OF_ALL_PRODUCT_IMAGESRetrieves the total count of images for a Shopify product. Use when you need to know how many images are associated with a specific product.

Input Parameters

string
required
The unique identifier for the Shopify product whose images are to be counted.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: SHOPIFY_RECEIVE_A_SINGLE_FULFILLMENTRetrieve detailed information about a specific fulfillment for an order. Use when you need to check the status, tracking details, or line items of a fulfillment.

Input Parameters

string
required
The unique numeric identifier for the order containing the fulfillment.
string
required
The unique identifier for the specific fulfillment to retrieve.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: SHOPIFY_RECEIVE_A_SINGLE_WEBHOOKRetrieves a webhook subscription registered to the requesting app by ID, with optional property selection. The returned details can include its destination, topic, format, timestamps and payload field or metafield settings; subscriptions created in the Shopify admin are not accessible through the API.

Input Parameters

string
Comma-separated list of specific properties to return. Restricts the response to only those properties specified.
string
required
The unique numeric identifier for the webhook subscription to retrieve.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: SHOPIFY_REJECT_FULFILLMENT_CANCELLATION_REQUESTReject a pending cancellation request as the assigned fulfillment service. The fulfillment order must belong to a location managed by this app and have a cancellation request awaiting a response. Optionally provide a reason. Uses the legacy Shopify REST Admin API.

Input Parameters

string
Optional reason for rejecting the cancellation request.
string
required
ID of the fulfillment order whose cancellation request to reject.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: SHOPIFY_REJECT_FULFILLMENT_REQUESTReject a submitted fulfillment request as the assigned fulfillment service. The fulfillment order must be assigned to this app’s fulfillment service. Optionally explain the rejection with a message, reason, and line item details. Line item details are diagnostic, not a partial rejection: after rejection none of the order’s line items can be fulfilled. Returns the updated fulfillment order. Uses the legacy REST Admin API and requires protected customer data access.

Input Parameters

string ("incorrect_address" | "inventory_out_of_stock" | "ineligible_product" | "undeliverable_destination" | "other")
Optional reason for rejecting the fulfillment request.
string
Optional message for rejecting the fulfillment request.
array
Optional line item rejection details. If omitted, all items are assumed unfulfillable. These details document which items could not be fulfilled and why; after rejection none of the order’s items can be fulfilled.
string
required
ID of the fulfillment order with a submitted fulfillment request.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: SHOPIFY_RELEASE_FULFILLMENT_HOLDReleases the fulfillment hold on a fulfillment order, allowing fulfillment work to proceed. Use when you need to resume fulfillment on an order that was previously placed on hold. The fulfillment order status will change from on_hold to open, and the fulfillment_holds array will be emptied.

Input Parameters

string
required
The unique identifier of the fulfillment order to release from hold.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: SHOPIFY_RELEASE_FULFILLMENT_ORDER_HOLDRelease all fulfillment holds on a fulfillment order. Use when you need to resume fulfillment work after holds have been resolved.

Input Parameters

string
required
The unique identifier of the fulfillment order to release holds from.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: SHOPIFY_REOPEN_CLOSED_ORDERReopens a previously closed Shopify order. Use when an order needs to be modified after being closed.

Input Parameters

string
required
The unique identifier of the closed Shopify order to reopen.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: SHOPIFY_RESCHEDULE_FULFILLMENT_ORDERReschedule when a scheduled fulfillment order becomes ready for fulfillment. new_fulfill_at must be in the future. Orders with the same fulfill_at may be merged; use the returned order ID for subsequent operations. Requires the user’s fulfill_and_ship_orders permission. Uses the legacy REST Admin API.

Input Parameters

object
required
Required rescheduling details, including new_fulfill_at.
string
required
ID of the scheduled fulfillment order to reschedule.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: SHOPIFY_RESTORE_COMMENTRestores a previously removed comment, changing its status back to ‘published’. Use when you need to reactivate a comment that was removed. Note: This action requires protected customer data access approval because comments contain customer information (author, email, IP). The app must be approved to access REST endpoints with protected customer data.

Input Parameters

integer
required
The unique numeric identifier for the comment to restore.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: SHOPIFY_RETRIEVE_A_SPECIFIC_METAFIELDRetrieve a metafield by ID for a supported Shopify resource, such as a product, customer, order, or shop. Non-shop resources also require the owner resource ID.

Input Parameters

string
Comma-separated list of field names to retrieve. Limits response to only specified fields. If not provided, all fields are returned.
string
Unique ID of the owner resource. Required for all resource types except ‘shop’. When resource_type is ‘shop’, this parameter should be omitted or set to None.
string
required
Unique ID of the metafield to retrieve.
string ("articles" | "blogs" | "collections" | "customers" | "draft_orders" | "locations" | "orders" | "pages" | "products" | "product_images" | "product_variants" | "shop" | "smart_collections")
required
Type of resource owning the metafield. Must be in plural form (e.g., ‘products’, ‘customers’, ‘orders’).

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: SHOPIFY_RETRIEVE_LIST_METAFIELDS_RESOURCE_S_ENDPOINTRetrieve metafields for a specific supported Shopify resource instance using its resource endpoint, including products, customers, orders, and collections.

Input Parameters

string
Filters metafields by key (3-64 characters). Used with namespace to get a specific metafield.
integer
Number of results per page. Default: 50, Maximum: 250.
string
Comma-separated list of specific fields to retrieve in the response.
string ("articles" | "blogs" | "collections" | "smart_collections" | "customers" | "draft_orders" | "locations" | "orders" | "pages" | "products" | "product_images" | "product_variants")
required
The resource type to retrieve metafields from. Supported types: articles, blogs, collections, smart_collections, customers, draft_orders, locations, orders, pages, products, product_images, product_variants. For shop metafields, use the ‘Get metafields’ action instead.
string
Retrieves metafields created after the specified ID. Used for pagination.
string
Filters metafields by namespace (3-255 characters). If omitted, returns metafields from all namespaces.
string
required
The unique identifier of the specific resource to retrieve metafields for.
string
ISO 8601 format; shows metafields created before this date.
string
ISO 8601 format; shows metafields created after this date.
string
Filters by metafield data type (e.g., ‘single_line_text_field’, ‘number_integer’, ‘json’, ‘date’).
string
ISO 8601 format; shows metafields modified before this date.
string
ISO 8601 format; shows metafields modified after this date.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: SHOPIFY_RETRIEVES_A_LIST_OF_ABANDONED_CHECKOUTSRetrieves a list of abandoned checkouts from Shopify for recovery campaigns, remarketing, or analytics, with optional status, date and since-ID filters. This legacy REST action returns checkout data but does not expose pagination links from response headers.

Input Parameters

integer
Maximum number of abandoned checkouts to retrieve. Must be less than or equal to 250. Defaults to 50 if not specified.
string
Filter checkouts by status. Valid values: ‘open’ or ‘closed’. Defaults to ‘open’ if not specified.
string
Restrict results to checkouts after the specified ID. Used for pagination.
string
Show checkouts created before this date. Format: ISO 8601 datetime (e.g., ‘2024-12-31T23:59:59Z’).
string
Show checkouts created after this date. Format: ISO 8601 datetime (e.g., ‘2024-01-01T00:00:00Z’).
string
Show checkouts updated before this date. Format: ISO 8601 datetime.
string
Show checkouts updated after this date. Format: ISO 8601 datetime.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: SHOPIFY_RETRIEVES_A_LIST_OF_ALL_ARTICLE_TAGSRetrieves all article tags used across all blogs in the Shopify shop. Use this to: - Discover available tags for filtering or categorizing blog content - Identify popular tags to understand trending topics - Build tag clouds or navigation elements for blog sections - Analyze content organization across your blogs Optional: Use ‘limit’ to retrieve a subset, or ‘popular=1’ to get the most frequently used tags first.

Input Parameters

integer
Maximum number of tags to retrieve. If not specified, all tags are returned. Use this to limit the response size when you only need a subset of available tags.
When present (set to any value, typically 1), results are ordered by popularity, starting with the most frequently used tags first. Omit this parameter for default alphabetical ordering.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: SHOPIFY_RETRIEVES_A_LIST_OF_PRICE_RULESRetrieve a page of price rules from a Shopify store, with optional filtering by date ranges and usage and since-ID pagination.

Input Parameters

integer
Maximum number of price rules to retrieve. Must be between 1 and 250. Default is 50.
string
Restricts results to price rules after the specified ID. Used for pagination.
integer
Show price rules with the specified number of times used.
string
Show price rules ending before this date. Format: ISO 8601 (e.g., 2017-03-25T16:15:47-04:00).
string
Show price rules ending after this date. Format: ISO 8601 (e.g., 2017-03-25T16:15:47-04:00).
string
Show price rules starting before this date. Format: ISO 8601 (e.g., 2017-03-25T16:15:47-04:00).
string
Show price rules starting after this date. Format: ISO 8601 (e.g., 2017-03-25T16:15:47-04:00).
string
Show price rules created before this date. Format: ISO 8601 (e.g., 2017-03-25T16:15:47-04:00).
string
Show price rules created after this date. Format: ISO 8601 (e.g., 2017-03-25T16:15:47-04:00).
string
Show price rules last updated before this date. Format: ISO 8601 (e.g., 2017-03-25T16:15:47-04:00).
string
Show price rules last updated after this date. Format: ISO 8601 (e.g., 2017-03-25T16:15:47-04:00).

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: SHOPIFY_RETRIEVES_A_LIST_OF_PRODUCTSRetrieve a list of products from Shopify. Use when you need to fetch products with filtering options like status, vendor, product type, or date ranges. Supports pagination with limit and since_id parameters.

Input Parameters

string
Return only products specified by a comma-separated list of product IDs. Example: ‘632910392,921728736’
integer
Return up to this many results per page. Maximum: 250, Default: 50
string
Return specific fields by comma-separated list. Available fields: admin_graphql_api_id, body_html, created_at, handle, id, image, images, options, product_type, published_at, published_scope, status, tags, template_suffix, title, updated_at, variants, vendor
string
Return only products specified by a comma-separated list of product handles
string
Filter products by status. Valid values: ‘active’, ‘archived’, ‘draft’
string
Filter products by vendor name
string
Return only products after the specified ID (used for pagination)
string
Return products by product type
string
Return products by product collection ID
string
Return products created before specified date (ISO 8601 format)
string
Return products created after specified date (ISO 8601 format: 2014-04-25T16:15:47-04:00)
string
Return products updated before specified date (ISO 8601 format)
string
Return products updated after specified date (ISO 8601 format)
string
Return products published before specified date (ISO 8601 format)
string
Return products published after specified date (ISO 8601 format)
string
Return presentment prices in specific currencies (comma-separated ISO 4217 currency codes)

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: SHOPIFY_RETRIEVES_A_LIST_OF_WEBHOOKSRetrieve a list of Shopify webhook subscriptions registered to the app, optionally filtered by topic, address, creation date, or other criteria. Subscriptions created in the Shopify admin are not returned.

Input Parameters

integer
Maximum number of results to return (must be ≤250, defaults to 50 if not specified).
string
Filter by event type that triggers the webhook. Valid topics include orders/create, products/update, customers/create, etc.
string
Comma-separated list of specific webhook properties to return in the response. If not specified, all properties are returned.
string
Filter webhooks by destination URI where webhook POST requests are sent.
string
Return only webhooks with IDs greater than the specified value. Used for pagination.
string
Filter webhooks created at or before this date and time in ISO 8601 format.
string
Filter webhooks created at or after this date and time in ISO 8601 format.
string
Filter webhooks updated at or before this date and time in ISO 8601 format.
string
Filter webhooks updated at or after this date and time in ISO 8601 format.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: SHOPIFY_RETRIEVES_AN_ORDER_COUNTRetrieves the count of orders matching specified filters. Use when you need to know how many orders exist with specific criteria (status, dates, financial status, etc.).

Input Parameters

string
Filter by specific order IDs. Format: Comma-separated list of order IDs.
string ("open" | "closed" | "cancelled" | "any")
Filter by order status. Valid values: ‘open’, ‘closed’, ‘cancelled’, ‘any’.
string
Count orders created at or before this date. Format: ISO 8601.
string
Count orders created at or after this date. Format: ISO 8601 (e.g., ‘2024-01-01T00:00:00Z’).
string
Count orders updated at or before this date. Format: ISO 8601.
string
Count orders updated at or after this date. Format: ISO 8601. When using updated_at parameters, add status=any to include all orders regardless of status.
string ("authorized" | "pending" | "paid" | "partially_paid" | "refunded" | "voided" | "partially_refunded" | "any" | "unpaid")
Filter by financial/payment status. Valid values: ‘authorized’, ‘pending’, ‘paid’, ‘partially_paid’, ‘refunded’, ‘voided’, ‘partially_refunded’, ‘any’, ‘unpaid’.
string
Count orders processed at or before this date. Format: ISO 8601.
string
Count orders processed at or after this date. Format: ISO 8601.
string
Filter by attribution app. Use ‘current’ to retrieve orders created by your app.
string ("fulfilled" | "partial" | "not_eligible" | "any")
Filter by fulfillment status. Valid values: null (unfulfilled), ‘fulfilled’, ‘partial’, ‘not_eligible’, ‘any’. Note: Use empty string or omit for unfulfilled orders.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: SHOPIFY_RETRIEVES_A_SINGLE_LOCATION_BY_ITS_IDRetrieves detailed information about a specific Shopify location by its ID. A location represents a physical or virtual place where a shop’s products are stocked, and from which orders can be fulfilled. This includes retail stores, warehouses, pop-up shops, and dropshipping locations. Use this action when you need to: - Get complete details about a specific location (address, contact info, status) - Verify if a location is active and can fulfill orders - Check location attributes before inventory or fulfillment operations - Display location information to users Requires the ‘read_locations’ OAuth scope.

Input Parameters

string
required
The unique numeric identifier of the location to retrieve. You can find location IDs by listing all locations or in the Shopify admin under Settings > Locations.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: SHOPIFY_RETRIEVES_A_SINGLE_ORDER_RISK_BY_ITS_IDRetrieves a single order risk assessment by its unique ID. Use this action when you need details about a specific risk assessment (e.g., to check its recommendation, score, or message). If you need all risk assessments for an order, use the “Get order risks” action instead. Important: This REST API endpoint is deprecated as of API version 2025-10. For new implementations, use the GraphQL OrderRiskAssessment API. See: https://shopify.dev/docs/api/admin-graphql/latest/objects/OrderRiskAssessment Access requirements: Requires read_orders scope with merchant approval for protected customer data.

Input Parameters

string
required
The unique identifier of the specific risk record to retrieve.
string
required
The unique identifier of the order containing the risk assessment.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: SHOPIFY_RETRIEVES_A_SINGLE_PRICE_RULERetrieves a single price rule by its unique identifier. Use when you need to get detailed information about a specific discount rule including its value, target type, customer selection, prerequisites, and entitlements.

Input Parameters

string
required
The unique identifier for the price rule to retrieve.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: SHOPIFY_RETRIEVES_A_SINGLE_PRODUCTRetrieves a single product by its unique product ID. Use when you need to get detailed information about a specific product including its variants, images, and options.

Input Parameters

string
A comma-separated list of fields to include in the response. This allows you to retrieve only specific fields instead of the entire product object.
string
required
The unique identifier for the product to retrieve.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: SHOPIFY_RETRIEVES_A_SPECIFIC_FULFILLMENT_EVENTRetrieves a specific fulfillment event by its ID. DEPRECATED: This endpoint is deprecated as of Shopify REST Admin API 2024-10. Consider using the list fulfillment events endpoint instead to retrieve all events and filter by ID. Use this tool when you need detailed tracking information for a specific fulfillment event, including delivery status, location data (address, city, country, coordinates), timestamps, and carrier messages. Fulfillment events track the shipment progress and are displayed on customer order status pages. Note: Requires valid order_id, fulfillment_id, and event_id. All three IDs must correspond to existing resources in the store.

Input Parameters

string
required
The ID of the fulfillment event to retrieve.
string
required
The ID of the order that’s associated with the fulfillment event.
string
required
The ID of the fulfillment that’s associated with the fulfillment event.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: SHOPIFY_RETRIEVES_LIST_ALL_ARTICLE_TAGS_SPECIFIC_BLOGRetrieve a list of all article tags from a specific blog. Use when you need to get all unique tags that have been applied to articles within a particular blog, optionally sorted by popularity.

Input Parameters

integer
The maximum number of tags to retrieve. If not specified, all tags are returned.
string
required
The unique identifier for the blog from which to retrieve article tags.
A flag for ordering retrieved tags by popularity. When set to 1, orders the retrieved tags by popularity, starting with the most popular tag. If not present, tags are returned in default order.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: SHOPIFY_RETRIEVES_LIST_DISCOUNT_CODES_DISCOUNT_CODERetrieve a list of discount codes for a discount code creation job. Use when you need to check the status of a batch discount code creation job and see which codes were successfully created and which encountered errors.

Input Parameters

integer
required
The ID of the discount code creation job.
integer
required
The ID of the price rule associated with the batch discount code creation job.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: SHOPIFY_RETRIEVES_LIST_STOREFRONT_ACCESS_TOKENS_THAT_HAVERetrieves a list of storefront access tokens that have been issued for the shop. Use when you need to view all active storefront access tokens and their associated permissions. The app must have at least one unauthenticated access scope to use this endpoint.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: SHOPIFY_RETRIEVE_SPECIFIC_FULFILLMENT_ORDERRetrieve a specific fulfillment order by its ID. Use when you need detailed information about a particular fulfillment order including line items, destination, and status.

Input Parameters

string
required
The unique identifier for the fulfillment order to retrieve.
boolean
Include the financial summary data for each line item, if available. Defaults to false.
boolean
Indicates whether the order reference fields should be returned in the result. Defaults to false.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: SHOPIFY_RETRIEVES_THE_SHOP_S_CONFIGURATIONRetrieve the shop’s configuration and general business settings. Use when you need to access shop information such as name, domain, timezone, currency, contact details, or plan information.

Input Parameters

string
A comma-separated list of fields to include in the response. This allows you to retrieve only specific fields from the shop object instead of the entire object.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: SHOPIFY_REVOKE_APP_ACCESS_SCOPESRevoke previously granted access scopes from an app installation. Use when you need to reduce an app’s permissions without completely uninstalling it, providing granular control over what data and functionality the app can access.

Input Parameters

array
required
List of scope handles to revoke from the app installation. Each handle follows the format ‘{action}_{resource}’ (e.g., ‘read_products’, ‘write_customers’). Only scopes currently granted to the app can be revoked.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: SHOPIFY_RUN_BULK_MUTATION_OPERATIONCreate and run a bulk operation to import data asynchronously by executing a GraphQL mutation multiple times. Use when you need to perform bulk mutations like creating/updating many products, variants, or other resources from a JSONL file. Each line in your JSONL file is processed as a separate mutation execution. Results are delivered in a JSONL file when complete. Note: Only one bulk mutation operation can run at a time per shop (though bulkOperationRunQuery can run simultaneously).

Input Parameters

string
required
The GraphQL mutation to be executed in bulk for each line in the JSONL file. Must be a valid Shopify GraphQL mutation that accepts input variables. The mutation will be executed once for each line in the staged JSONL file, with the line data passed as variables.
string
An optional identifier which may be used for querying the bulk operation. Helpful for tracking and debugging specific bulk mutation operations.
string
required
The staged upload path of the JSONL file containing mutation variables for each bulk operation execution. Each line in the JSONL file represents one mutation execution with its input data. Must be a valid path returned from a prior staged upload operation (e.g., ‘tmp/64462848194/bulk/2a868b95-25df-4a26-b6e6-e82a6a7e4b5b/bulk-mutation-input.jsonl’).

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: SHOPIFY_RUN_BULK_OPERATION_QUERYCreate and start a Shopify GraphQL bulk operation for asynchronous data fetching. Use when you need to retrieve large datasets from Shopify without pagination. The operation runs in the background and results are available in a JSONL file for up to seven days after completion. Only one bulk query operation can run at a time per shop. Query must include at least one connection field.

Input Parameters

string
required
The GraphQL query that will be executed asynchronously. Must include at least one connection field (edges/nodes structure). Supports up to five connections with maximum nesting depth of two levels. The query should NOT include the mutation wrapper - only provide the inner query part.
boolean
Enables grouping objects directly under their corresponding parent objects in JSONL output. When true, groups related objects together which is useful for nested data but slows down bulk operations and increases likelihood of timeouts. Only enable if you specifically need the grouped format. Default is false.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: SHOPIFY_SEARCHES_FOR_GIFT_CARDSSearch for gift cards matching a query across indexed fields such as dates, balance, email, and last characters. A cursor can be supplied to request a page, but response Link headers are not returned.

Input Parameters

integer
Maximum number of gift cards to return per page. Must be between 1 and 250. Default: 50.
string
The field and direction to order results by. Default: disabled_at DESC.
string
Text to search for gift cards. Supports field-specific syntax (field:value) for indexed fields: created_at, updated_at, disabled_at, balance, initial_value, amount_spent, email, last_characters. Examples: ‘last_characters:mnop’, ‘balance:100.00’, ‘email:customer@example.com’, ‘amount_spent:50.00’. Use ’*’ to return all gift cards.
string
Comma-separated list of field names to return only specific fields in the response.
string
Cursor token for pagination. Obtained from Link header in previous responses. When using page_info, only limit and fields parameters can be included.
string
Show gift cards created at or before this date. Format: ISO 8601 date/datetime string.
string
Show gift cards created at or after this date. Format: ISO 8601 date/datetime string.
string
Show gift cards last updated at or before this date. Format: ISO 8601 date/datetime string.
string
Show gift cards last updated at or after this date. Format: ISO 8601 date/datetime string.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: SHOPIFY_SEND_CUSTOMER_ACCOUNT_INVITESends an account activation invite email to an existing customer, allowing them to set up their online store account. Use this action to: - Send account activation emails to newly created customers who haven’t activated their accounts yet - Resend activation invites to customers who didn’t receive or lost the original email - Send custom invitation emails with personalized subject lines and messages The customer must not already have an active account. If the customer has already activated their account, this action will fail with a 422 error.

Input Parameters

string
The recipient’s email address for the account invitation. If not provided, uses the customer’s existing email address.
array
Email addresses to receive blind carbon copies of the invitation.
string
The sender’s email address (typically the shop owner’s email). If not provided, uses the default shop email.
string
Custom subject line for the invitation email. If not provided, uses the default subject line ‘Customer account activation’.
string
required
The unique identifier for the customer to send the account invite to.
string
Additional personalized text to include in the invitation body. If not provided or empty, uses the default message.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: SHOPIFY_SEND_CUSTOMER_INVITESends a customer an invitation email to activate a legacy Shopify customer account. The invitation can use the store’s default template or a custom subject and message; legacy customer accounts must be enabled.

Input Parameters

string
The recipient’s email address for the account invitation. If not provided, the invitation will be sent to the customer’s existing email address on file. Use this when you want to send the invite to a different email than the one associated with the customer record.
array
Email addresses to receive blind carbon copies of the invitation.
string
The sender’s email address shown in the ‘From’ field of the invitation email. If not provided, uses the store’s default notification email address. This is typically the shop owner’s email.
string
Custom subject line for the invitation email. If not provided, Shopify uses the default subject line ‘You’ve been invited to activate your account’. Customize this to make the invitation more personal or relevant to your brand.
string
required
The unique identifier for the customer to send the account invite to.
string
Additional personalized text to include in the body of the invitation email. This message appears in the email along with the standard invitation text and activation link. Use this to add a personal touch or provide additional context about your store.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: SHOPIFY_SEND_INVOICESend an invoice email for a draft order to a customer. Use when you need to email an invoice to a customer for a specific draft order.

Input Parameters

string
required
The numeric identifier of the draft order to send the invoice for.
object
Draft order invoice details for sending an invoice email.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: SHOPIFY_SET_DEFAULT_CUSTOMER_ADDRESSSet a specific address as the default address for a customer. Use when you need to mark an address as default for tax and shipping calculations. The default address cannot be deleted.

Input Parameters

string
required
The unique identifier for the address to set as the default address for the customer. The default address is used for tax and shipping calculations.
string
required
The unique identifier for the customer whose address will be set as default.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: SHOPIFY_SET_FULFILLMENT_ORDERS_DEADLINESet the latest fulfillment deadline for multiple fulfillment orders. Use when you need to update deadline for one or more fulfillment orders.

Input Parameters

string
required
The new fulfillment deadline in ISO 8601 format with timezone (e.g., ‘2025-12-30T10:00:00-05:00’)
array
required
Array of fulfillment order IDs for which the deadline applies

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: SHOPIFY_SET_INVENTORY_LEVELSet inventory level for an item at a location. Use when you need to establish or update inventory quantity for a specific item at a designated location. If the location isn’t already connected, the connection occurs automatically. The inventory item must have inventory tracking enabled before setting inventory levels.

Input Parameters

integer
required
The quantity to be set in inventory. This is the available quantity of the inventory item at the location.
string
required
The ID of the location where the inventory level will be set. To find the ID of the location, use the Location resource.
string
required
The ID of the inventory item to set the level for. The inventory item must have inventory tracking enabled. To find the ID of the inventory item, use the Inventory Item resource.
boolean
Whether inventory for any previously connected locations will be set to 0 and the locations disconnected. Omit unless Shopify requires this for fulfillment service locations.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: SHOPIFY_SET_METAFIELDSCreate or update multiple metafields in a single operation using the metafieldsSet GraphQL mutation. Use when you need to set custom metadata on Shopify resources like shops, products, customers, or orders. Supports up to 25 metafields per request.

Input Parameters

array
required
Array of metafield inputs to set. Maximum of 25 metafields per request. Minimum of 1 metafield required.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: SHOPIFY_SUBMIT_FULFILLMENT_CANCELLATION_REQUESTRequest cancellation from the fulfillment service handling a fulfillment order. This sends a request, not an immediate cancellation: the service can accept or reject it. Optionally supply a reason. Uses the legacy REST Admin API.

Input Parameters

object
Cancellation request containing an optional reason.
string
required
ID of the fulfillment order assigned to a fulfillment service.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: SHOPIFY_SUBMIT_FULFILLMENT_REQUESTRequest fulfillment from the service assigned to a fulfillment order. Select line items and quantities or leave them blank to request all items. Partial requests can split the fulfillment order. This submits a request, not a completed fulfillment; the service may accept or reject it. Uses the legacy REST Admin API.

Input Parameters

object
Optional message, customer notification and line item selection.
string
required
Fulfillment order ID assigned to a fulfillment service.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: SHOPIFY_TRIGGER_SHOPIFY_FLOWTrigger Shopify Flow workflows that begin with the specified trigger handle. Use when you need to manually activate Flow automation workflows from your app. The payload must be under 50 KB and match the trigger’s expected schema. To learn more, refer to Create Shopify Flow triggers documentation.

Input Parameters

string
The unique handle of the Flow trigger to activate. This identifies which Shopify Flow workflows should be triggered. If not provided, all workflows that use this trigger will be activated.
object
The JSON payload data needed to run the trigger (must be under 50 KB). This data is passed to the Flow workflows that begin with the specified trigger. The structure should match the trigger’s expected input schema.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: SHOPIFY_UNPUBLISH_COLLECTION_LISTINGUnpublish a collection from this app’s sales channel by deleting its listing. Does not delete the underlying collection. Requires a sales-channel app with merchant-approved product listing access. Uses the legacy REST Admin API; new public apps must use the GraphQL Admin API.

Input Parameters

string
required
ID of the collection listing to unpublish from this app’s sales channel.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: SHOPIFY_UNPUBLISH_PRODUCT_LISTINGUnpublish a product from this app’s sales channel by deleting its listing. Does not delete the underlying product. Requires a sales-channel app with merchant-approved product listing access. Uses the legacy REST Admin API; new public apps must use the GraphQL Admin API.

Input Parameters

string
required
Product ID of the listing to unpublish from this app’s sales channel.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: SHOPIFY_UPDATE_APP_SUBSCRIPTION_LINE_ITEMUpdate the capped amount on usage-based billing for an app subscription line item. Use when adjusting usage limits based on merchant needs or changing pricing models. The mutation returns a confirmation URL where the merchant must approve the new pricing limit before it takes effect. Learn more at https://shopify.dev/docs/apps/launch/billing/subscription-billing/update-max-charge.

Input Parameters

string
required
The global ID of the app subscription line item to update. Must be in the format: gid://shopify/AppSubscriptionLineItem/{id}
object
required
The new maximum amount of usage charges that can be incurred within a subscription billing interval. This cap prevents merchants from exceeding the specified threshold.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: SHOPIFY_UPDATE_ARTICLEUpdate an existing article in a Shopify blog. Use when you need to modify article properties such as title, content, tags, or publication status.

Input Parameters

string
A comma-separated list of tags. Tags are additional short descriptors for the article.
object
Image object for an article
string
The headline of the article.
string
Name credited as the article’s creator.
string
required
The ID of the blog containing the article to update.
string
The text of the body of the article, complete with HTML markup.
boolean
Whether the article is visible.
string
required
The ID of the article to update.
array
Custom metadata fields with key, namespace, value, and type.
string
Date and time (ISO 8601 format) when the article becomes visible.
string
Brief summary with HTML markup for display on other pages.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: SHOPIFY_UPDATE_BLOGUpdates an existing blog’s configuration in your Shopify store. Use this to change the blog title, URL handle, comment moderation settings, custom templates, or attach metadata. Common use cases: rebranding blogs, enabling/disabling comments, switching to custom themes, or fixing SEO-friendly handles. Requires the blog_id and at least one field to update. WARNING: Changing the handle affects URLs and SEO - consider redirects when modifying established blogs.

Input Parameters

string
New title for the blog (max 255 characters). Updates the blog’s display name.
string
URL-friendly unique identifier for the blog (auto-generated from title if not provided). Used in blog URLs like /blogs/{handle}. WARNING: Changing the handle affects SEO and may break existing links - consider implementing redirects.
string
required
The unique numeric identifier for the blog to modify. Can be obtained from the blog list or creation response.
string
FeedBurner identifier for RSS feed integration. NOTE: FeedBurner has been discontinued by Google and is not recommended for new implementations.
array
Array of metafield objects to attach custom metadata to the blog. Each requires: key (max 30 chars), namespace (max 20 chars), value, and type. Useful for storing custom data like sponsorship info, internal tracking codes, or integration data.
string ("no" | "moderate" | "yes")
Comment policy for blog articles: ‘no’ (disables all comments), ‘moderate’ (requires approval before publishing), or ‘yes’ (allows immediate public comments).
string
Name of alternate Liquid template file to use instead of default blog.liquid. For example, ‘custom’ uses blog.custom.liquid. Set to null to revert to default template.
string
Full URL to the FeedBurner RSS feed location. NOTE: FeedBurner has been discontinued by Google.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: SHOPIFY_UPDATE_CARRIER_SERVICEUpdate a carrier service created by the connected app. Changes its name, callback URL, activation or service discovery settings. Requires write_shipping and a store eligible for carrier-calculated shipping (including an eligible development store). Only the creating app can update the service. Uses Shopify’s legacy REST Admin API.

Input Parameters

object
required
Properties to update. Omit properties that should not change.
string
required
Numeric ID of the carrier service created by the connected app.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: SHOPIFY_UPDATE_COMMENTUpdate an existing comment on a blog article in Shopify. Use when you need to modify comment properties such as body text, author, or publication date. Note: This endpoint requires ‘protected customer data’ access because comments contain customer information (author name, email, IP address). Ensure the app has proper permissions before using this action.

Input Parameters

string
The basic Textile markup of the comment.
string
The email address of the author of the comment. This is protected customer data.
string
The name of the author of the comment. This is protected customer data.
string
required
The unique identifier for the comment to update.
string
The date and time when the comment was published in ISO 8601 format.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: SHOPIFY_UPDATE_COUNTRIES_PARAM_COUNTRY_IDDEPRECATED: Updates an existing country’s tax configuration in Shopify. This endpoint is deprecated as of API version 2024-07 and may return 403 Forbidden errors. The tax field has been read-only since API version 2020-10. Shopify recommends migrating to the GraphQL Admin API’s Countries in shipping zone API instead. This action should not be used for new implementations.

Input Parameters

number
The national sales tax rate applied to orders from this country, expressed as decimal (e.g., 0.05 for 5%). READ-ONLY since API version 2020-10 - this field cannot be modified via the API. The entire Country PUT endpoint is deprecated as of 2024-07 and may return 403 Forbidden.
string
required
The unique identifier for the country to update.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: SHOPIFY_UPDATE_COUNTRIES_PARAM_COUNTRY_ID_PROVINCES_PARAM_PRUpdate Province Tax Information

Input Parameters

number
Sales tax rate as a decimal (e.g., 0.05 = 5%). DEPRECATED as of API version 2020-10. Avoid using this field.
string
The display name for the tax applied to the province. Common values: ‘GST’, ‘HST’, ‘PST’, ‘VAT’, ‘QST’.
string ("normal" | "harmonized" | "compounded")
The type of provincial tax calculation. ‘normal’: standard tax, ‘harmonized’: combines federal and provincial taxes, ‘compounded’: tax on tax.
string
required
The unique identifier of the country containing the province. Get this from the countries list endpoint.
string
required
The unique identifier of the province to update. Get this from the provinces list for a country.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: SHOPIFY_UPDATE_COUNTRYUpdate an existing country’s tax configuration in Shopify. Use when you need to modify tax settings for a country. Note: This action is DEPRECATED as of 2024-07, and custom tax values cannot be created or updated as of 2020-10.

Input Parameters

number
The national sales tax rate applied to orders as a decimal value (e.g., 0.1 for 10%). DEPRECATED: As of 2020-10, custom tax values can no longer be created or updated.
integer
required
The unique identifier for the country to update.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: SHOPIFY_UPDATE_CUSTOM_COLLECTIONUpdate an existing custom collection in Shopify. Use when you need to modify properties of a custom collection such as title, description, publication status, or sorting order.

Input Parameters

object
Image to attach to the custom collection.
string
The title of the custom collection. Maximum length: 255 characters.
string
A human-friendly unique string for the custom collection automatically generated from its title. Maximum length: 255 characters.
string
The description of the custom collection, including HTML markup.
boolean
Whether the custom collection is published to the Online Store channel.
string
The order in which products in the custom collection appear. Valid values: ‘alpha-asc’, ‘alpha-desc’, ‘best-selling’, ‘created’, ‘created-desc’, ‘manual’, ‘price-asc’, ‘price-desc’.
string
The date and time (ISO 8601 format) when the collection was published.
string
Whether the collection is published to the Point of Sale channel. Valid values: ‘web’ (Online Store only) or ‘global’ (both Online Store and Point of Sale).
string
The suffix of the Liquid template being used (e.g., ‘custom’ for collection.custom.liquid).
string
required
The ID of the custom collection to update. This is a required path parameter.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: SHOPIFY_UPDATE_CUSTOMERUpdate an existing customer in Shopify. Use when you need to modify customer details such as name, email, phone, tags, addresses, or marketing consent preferences.

Input Parameters

string
Store owner’s notes about the customer.
string
A comma-separated string of tags to associate with the customer.
string
The customer’s unique email address. Must be unique across all customers.
string
The customer’s phone number in E.164 format. Must be unique across all customers.
array
A list of addresses for the customer (up to 10).
string
The customer’s last name.
string
The customer’s first name.
boolean
Whether the customer is exempt from taxes.
string
required
The unique identifier of the customer to update.
array
Array of applicable tax exemptions.
boolean
Whether the customer has verified their email address.
boolean
Whether to send an account invitation email to the customer.
boolean
Whether to send a welcome email to the customer.
string
Multipass identifier for the customer.
SMS marketing consent information.
Email marketing consent information.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: SHOPIFY_UPDATE_CUSTOMER_ADDRESSUpdates an existing address for a Shopify customer. This action allows you to modify address details such as street address, city, province, country, postal code, and contact information. At least one address field must be provided to update. Requires Protected Customer Data access approval and write_customers scope. Common use cases: - Correct shipping address errors for customers - Update customer contact information - Change billing addresses for customer accounts

Input Parameters

string
Postal code or ZIP code.
string
City, town, or village name.
string
Contact phone number.
string
Business or company name.
string
Country name.
string
Primary street address line.
string
Secondary address field (apartment, suite, etc.).
string
Province or state name.
string
Customer’s last name.
string
required
The unique identifier of the address to update.
string
Customer’s first name.
string
required
The unique identifier of the customer whose address is to be updated.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: SHOPIFY_UPDATE_CUSTOMERS_PARAM_CUSTOMER_ID_ADDRESSES_SETPerforms bulk operations on multiple customer addresses. Currently supports the ‘destroy’ operation to delete multiple addresses at once. Use this when you need to remove several addresses for a customer in a single API call instead of deleting them one by one.

Input Parameters

string
required
The bulk operation to execute on the specified addresses. Currently only ‘destroy’ is supported, which removes multiple addresses at once.
array
required
Array of address IDs to operate on. Multiple address IDs can be provided to perform bulk operations. At least one address ID must be provided.
string
required
The unique identifier for the customer in Shopify.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: SHOPIFY_UPDATE_DISPUTE_EVIDENCEUpdate Shopify Payments dispute evidence using the legacy REST Admin API. The submit_evidence parameter has no effect: the API cannot submit evidence. Merchants must confirm submission in Shopify admin before the due date; submission sends evidence directly to the bank and is final. Requires Shopify-approved access to write_shopify_payments_dispute_evidences.

Input Parameters

string
required
Numeric Shopify Payments dispute ID.
object
required
Evidence to update; omitted fields remain unchanged.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: SHOPIFY_UPDATE_DRAFT_ORDERUpdate an existing draft order in Shopify. Use when you need to modify draft order details like customer information, line items, addresses, discounts, notes, or status before completion.

Input Parameters

boolean
B2B order designation.
string
Optional merchant note attached to the draft order.
string
Comma-separated order tags.
string
Customer email address.
string ("open" | "invoice_sent" | "completed")
Status - ‘open’, ‘invoice_sent’, or ‘completed’.
object
Customer resource object.
array
Array of line item objects. Each item can contain product variant or custom line items with details.
boolean
Customer tax exemption status.
integer
Customer identifier to associate with the draft order.
object
Shipping line for draft order.
string
required
The unique identifier of the draft order to modify.
boolean
Whether taxes are included in prices.
object
Billing address for draft order.
array
Custom metadata objects containing name and value pairs.
object
Discount applied to draft order or line item.
object
Shipping address for draft order.
boolean
Load customer’s default shipping information (default: false).
boolean
Enable discount codes at checkout.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: SHOPIFY_UPDATE_EVENT_BRIDGE_WEBHOOK_SUBSCRIPTIONUpdate an Amazon EventBridge webhook subscription in Shopify. Use when you need to modify the ARN or data format of an existing EventBridge webhook. Note: This mutation is deprecated; consider using webhookSubscriptionUpdate for new implementations. For app-specific webhooks, using shopify.app.toml configurations may be easier as they are automatically maintained by Shopify.

Input Parameters

string
required
The ID of the webhook subscription to update in GID format (e.g., gid://shopify/WebhookSubscription/1601501331650)
object
required
Input object containing the EventBridge webhook subscription configuration to update (ARN and/or format)

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: SHOPIFY_UPDATE_FULFILLMENT_SERVICEUpdate an existing fulfillment service’s name, callback URL or capabilities. Only supplied fields are sent. Uses the legacy REST Admin API; the fulfillment_orders_opt_in and requires_shipping_method properties are deprecated.

Input Parameters

object
required
Fields to update. Omitted fields remain unchanged; explicit false and null values are forwarded.
string
required
ID of the fulfillment service to update.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: SHOPIFY_UPDATE_FULFILLMENT_TRACKINGUpdates tracking information (carrier company, tracking number, or custom URL) for an existing fulfillment. Use this action when: - You need to add or update tracking details for a shipment after the fulfillment was created - The carrier information was not provided during fulfillment creation - Tracking numbers become available after shipment - You want to notify customers about updated tracking information Prerequisites: Requires a valid fulfillment_id from a previously created fulfillment.

Input Parameters

object
required
The fulfillment object containing tracking information and notification preferences.
string
required
The unique identifier of the fulfillment to update. This ID is returned when creating a fulfillment or can be retrieved from order fulfillment lists.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: SHOPIFY_UPDATE_GIFT_CARDUpdates an existing gift card in Shopify. Use when you need to modify a gift card’s expiration date, merchant note, template suffix, or assign it to a customer. Only four properties can be updated after creation: expires_on (expiration date), note (merchant-only note), template_suffix (Liquid template suffix), and customer_id (can only be set if currently null). Note: Gift card balance and initial value cannot be modified through this endpoint.

Input Parameters

string
Internal merchant note about the gift card (not visible to customers). Leave empty to keep the current note unchanged.
string
Expiration date for the gift card in YYYY-MM-DD format. Leave empty to keep the current expiration date unchanged. Set to null to remove expiration.
integer
ID of the customer to associate with this gift card. IMPORTANT: Can only be set if the gift card is not currently assigned to a customer (i.e., customer_id is currently null). Leave empty to keep the current customer assignment unchanged.
integer
required
The unique identifier of the gift card to update. This is a required parameter.
string
Suffix for the Liquid template used to render the gift card online (e.g., ‘birthday’ renders gift_card.birthday.liquid). Leave empty to keep the current template suffix unchanged.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: SHOPIFY_UPDATE_INVENTORY_ITEMUpdates properties of an inventory item in Shopify. An inventory item represents the physical good behind a product variant, containing metadata like SKU, cost, origin, and shipping requirements. Use this action to modify these properties - NOT to adjust inventory quantities (use inventory level actions for quantity changes). Common use cases: updating product costs, changing SKUs, setting country of origin for customs, or toggling inventory tracking.

Input Parameters

object
required
The inventory item object containing properties to update. Only include fields you want to change - all fields are optional.
string
required
The unique identifier of the inventory item to update. You can get this from a product variant’s inventory_item_id field.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: SHOPIFY_UPDATE_MARKETING_EVENTUpdate an existing Shopify marketing event, including its budget, timing, and remote identifier. Budget updates require currency and budget type.

Input Parameters

boolean
Whether the event is paid or organic (deprecated). READ-ONLY after creation - cannot be updated.
string
Campaign budget amount. If specified, currency and budget_type are required. UPDATABLE.
string
Budget currency code (ISO 4217). Required if budget is specified. UPDATABLE.
string
Actual campaign completion timestamp in ISO 8601 format. UPDATABLE.
string
Remote identifier for validation of engagement data. UPDATABLE.
string
Marketing event classification. Valid values: ad, post, message, retargeting, transactional, affiliate, loyalty, newsletter, abandoned_cart. READ-ONLY after creation - cannot be updated.
string
Link to campaign management interface. READ-ONLY after creation - cannot be updated.
string
Campaign commencement timestamp in ISO 8601 format. UPDATABLE.
string
Traffic channel specification. READ-ONLY after creation - cannot be updated.
string
Traffic origin identifier. READ-ONLY after creation - cannot be updated.
string
Budget model: daily or lifetime. Required if budget is specified. UPDATABLE.
string
Campaign narrative details. READ-ONLY after creation - cannot be updated.
string
Campaign preview destination. READ-ONLY after creation - cannot be updated.
string
Campaign identifier for traffic attribution. READ-ONLY after creation - cannot be updated.
string
Destination domain (deprecated). Required if marketing_channel is search or social at creation. READ-ONLY after creation - cannot be updated.
string
Distribution channel. Valid values: search, display, social, email, referral. READ-ONLY after creation - cannot be updated.
string
required
The unique identifier of the marketing event to update.
string
Planned campaign conclusion timestamp in ISO 8601 format. UPDATABLE.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: SHOPIFY_UPDATE_METAFIELDUpdate an existing metafield for a blog. Use when you need to modify metafield properties like value, type, or description for a blog resource.

Input Parameters

string
The new value type of the metafield. If not provided, the existing type will be kept.
string
The new value for the metafield. If not provided, the existing value will be kept.
string
required
The unique identifier of the blog that owns the metafield.
string
A new description of the information that the metafield contains. If not provided, the existing description will be kept.
string
required
The unique identifier of the metafield to update.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: SHOPIFY_UPDATE_METAFIELD_BY_IDUpdate an existing Shopify metafield by its ID. Use when you need to modify metafield properties like value, type, or description.

Input Parameters

string
The new value type of the metafield. If not provided, the existing type will be kept.
string
The new value for the metafield. If not provided, the existing value will be kept.
string
A new description of the information that the metafield contains. If not provided, the existing description will be kept.
string
required
The unique identifier of the metafield to update.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: SHOPIFY_UPDATE_METAFIELD_DEFINITIONUpdate a Shopify metafield definition’s configuration including name, description, validation rules, access settings, and capabilities. Use when you need to modify an existing metafield definition to change display text, add/remove validations, adjust API access permissions, or enable/disable capabilities like admin filtering or unique value constraints. Note: The type, namespace, key, and owner type identify the definition and cannot be changed - only the configuration settings can be updated.

Input Parameters

string
required
The unique key identifier within the namespace. Along with namespace and ownerType, this identifies the definition to update. Cannot be changed after creation.
boolean
Whether to pin this metafield definition at the top of the list in the Shopify admin interface for easy access.
string
The human-readable display name for the metafield definition. This is shown in the Shopify admin interface.
object
Access control settings for metafield visibility across different APIs.
string
required
The namespace identifier for the metafield definition. Along with key and ownerType, this identifies the definition to update. Cannot be changed after creation.
string ("API_PERMISSION" | "ARTICLE" | "BLOG" | "CARTTRANSFORM" | "COLLECTION" | "COMPANY" | "COMPANY_LOCATION" | "CUSTOMER" | "DELIVERY_CUSTOMIZATION" | "DISCOUNT" | "DRAFTORDER" | "FULFILLMENT_CONSTRAINT_RULE" | "GIFT_CARD_TRANSACTION" | "LOCATION" | "MARKET" | "ORDER" | "ORDER_ROUTING_LOCATION_RULE" | "PAGE" | "PAYMENT_CUSTOMIZATION" | "PRODUCT" | "PRODUCTVARIANT" | "SELLING_PLAN" | "SHOP" | "VALIDATION")
required
The resource type this metafield definition is attached to. Along with namespace and key, this identifies the definition to update. Cannot be changed after creation.
string
A description explaining the purpose and usage of this metafield definition. Helps other users understand what data should be stored.
array
List of validation rules to enforce on metafield values. Common validations include min/max for numbers, regex patterns for strings, and allowed choices for enums.
object
Capabilities that can be enabled for metafield definitions.
boolean
Deprecated field that determines if the metafield can be used as a collection condition. Use capabilities.smartCollectionCondition instead.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: SHOPIFY_UPDATE_METAFIELD_GENERICUpdate an existing metafield’s value, type, or description for supported Shopify resource types, including products, customers, orders, collections, and shops.

Input Parameters

string
The new value type of the metafield. If not provided, the existing type will be kept.
string
The new value for the metafield. If not provided, the existing value will be kept.
string
A new description of the information that the metafield contains. If not provided, the existing description will be kept.
string
required
The unique identifier of the resource (product, customer, order, etc.) that owns the metafield.
string
required
The unique identifier of the metafield to update.
string ("products" | "customers" | "orders" | "collections" | "blogs" | "pages" | "variants" | "draft_orders" | "articles" | "product_images" | "shop")
required
The type of resource that owns the metafield. Must be one of: products, customers, orders, collections, blogs, pages, variants, draft_orders, articles, product_images, or shop.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: SHOPIFY_UPDATE_METAFIELD_RESOURCEUpdate an existing metafield for any Shopify resource. Use when modifying metafield properties like value, type, or description for products, customers, orders, collections, shops, or other resources. Note: The namespace and key of an existing metafield cannot be changed.

Input Parameters

string
The data type of the metafield value. Common types include: single_line_text_field, multi_line_text_field, number_integer, number_decimal, url, json, boolean, color, date, date_time. If not provided, the existing type will be kept.
string
The new value to store in the metafield. Can be a string, number, or boolean depending on the metafield type. If not provided, the existing value will be kept.
string
required
The ID of the resource that owns the metafield. This is the unique identifier of the parent resource (shop ID, product ID, customer ID, etc.).
string
A human-readable description of what information the metafield contains. If not provided, the existing description will be kept.
string
required
The ID of the metafield to update. This is the unique identifier of the metafield itself, not the owner resource.
string
required
The type of resource that owns the metafield (e.g., shop, product, customer, blog, collection, page, draft_order, variant, order, article, product_image). Determines the resource type in the API endpoint path. Both singular (product) and plural (products) forms are accepted.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: SHOPIFY_UPDATE_MOBILE_PLATFORM_APPLICATIONUpdate a mobile platform application’s identity, links and iOS capabilities. Only supplied properties are sent. Requires the mobile_platform_applications scope, which Shopify Support must enable for the app. Shared web credentials require a custom domain. Uses the legacy Shopify REST Admin API.

Input Parameters

object
required
Properties to update. Omitted properties stay unchanged; explicit false and null are forwarded.
string
required
ID of the mobile platform application to update.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: SHOPIFY_UPDATE_ORDERUpdates mutable fields on an existing Shopify order.

Input Parameters

string
required
The unique identifier of the Shopify order to update.
string
Merchant note attached to the order.
string
Comma-separated tags for the order.
string
Customer email address for the order.
string
Order phone number. E.164 format (e.g., ‘+15551234567’) is recommended.
string
Purchase order reference.
array
Metafields to attach or update on the order.
boolean
Whether the order is tax exempt.
boolean
Whether Shopify should send an order receipt.
object
Billing address fields to update.
array
Custom note attributes for the order.
object
Shipping address fields to update.
boolean
Whether the buyer accepts marketing.
boolean
Whether Shopify should send a fulfillment receipt.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: SHOPIFY_UPDATE_ORDER_RISKUpdates an order risk assessment for fraud detection in Shopify. Use when modifying existing risk evaluations. IMPORTANT - API DEPRECATION: This REST API endpoint is deprecated as of version 2025-10. If using API version 2025-10 or later, you must use the GraphQL Admin API’s orderRiskAssessmentCreate mutation instead. See: https://shopify.dev/docs/api/admin-graphql/latest/mutations/orderRiskAssessmentCreate Note: You cannot modify a risk created by another application.

Input Parameters

string
Numeric risk score as a string representing a decimal value between 0.0 and 1.0. Higher values (closer to 1.0) indicate higher fraud risk. Example: ‘0.85’ for 85% risk probability.
string
Identifier for the source system or service that generated this risk assessment. Use this to track which fraud detection service provided the assessment (e.g., your app name, third-party service name).
string
Detailed message explaining the risk assessment findings that will be visible to the merchant. Use this to provide context about why the risk level was assigned and any relevant details from fraud detection analysis.
string
required
The unique identifier of the risk assessment to update. Note: You cannot modify a risk created by another application.
string
required
The unique identifier of the order containing the risk assessment to update.
boolean
Boolean flag indicating whether this risk assessment is severe enough to warrant automatic order cancellation. Set to true for high-risk orders that should not be fulfilled, false otherwise.
string ("cancel" | "investigate" | "accept")
Recommended action for the merchant to take. Must be one of: ‘cancel’ (high risk, recommend canceling order), ‘investigate’ (medium risk, recommend manual review), or ‘accept’ (low risk, safe to fulfill).

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: SHOPIFY_UPDATE_PAGEUpdates an existing page in a Shopify store. Use this to modify page properties such as title, HTML content (body_html), author, URL handle, publication status, or template. Requires a valid page_id and at least one field to update. All update fields are optional - provide only the fields you want to change.

Input Parameters

string
The title/heading of the page.
string
The name of the person who created the page.
string
A unique, human-friendly string for the page URL, generated automatically from title if not provided.
string
required
The unique identifier of the page to update.
string
The text content of the page, complete with HTML markup.
boolean
Controls page visibility - true for published, false/null for unpublished/hidden.
string
The suffix of the template used to render the page. If empty or null, the default template is used.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: SHOPIFY_UPDATE_PRICE_RULEUpdate an existing Shopify price rule’s properties, such as its title, value, dates, or prerequisites. Only non-null supplied fields are sent; null values are omitted.

Input Parameters

string
The title of the price rule, used in admin search and displayed on Discounts page.
string
The value of the price rule, must be negative (e.g., ‘-10.0’ for $10 off or 10% off).
string
The date and time when the price rule ends (ISO 8601 format). Can be null for open-ended rules.
string
The date and time when the price rule starts (ISO 8601 format).
string
The value type of the price rule. Valid values: ‘fixed_amount’, ‘percentage’, ‘shipping’.
string
The target type the price rule applies to. Valid values: ‘line_item’ (applies to cart’s line items), ‘shipping_line’ (applies to cart’s shipping lines).
integer
The maximum number of times the price rule can be used in total. Null for unlimited.
string
required
The ID of the price rule to update.
integer
The maximum number of times the price rule can be allocated onto an order (for Buy X Get Y discounts).
string
Target selection method. Valid values: ‘all’ (applies to all line items), ‘entitled’ (applies to selected entitlements only).
string
How the discount is applied. Valid values: ‘each’ (applied to each entitled item), ‘across’ (applied across entitled items). Must be ‘each’ when target_type is ‘shipping_line’.
boolean
Whether the price rule can be applied only once per customer.
string
Customer selection for the price rule. Valid values: ‘all’ (available to all customers), ‘prerequisite’ (customer must match prerequisite conditions).
array
List of country IDs where shipping discounts apply.
array
List of product IDs that the discount can be applied to.
array
List of variant IDs that the discount can be applied to.
array
List of collection IDs that the discount can be applied to.
array
List of product IDs that must be in the cart for the discount to apply.
array
List of variant IDs that must be in the cart.
array
List of customer IDs that can use this price rule.
array
List of collection IDs that must be in the cart.
object
Minimum quantity requirement.
object
Minimum purchase amount requirement.
array
List of customer segment IDs eligible for the discount.
object
Shipping price requirements.
object
Spend X Get Y configuration.
object
Buy X Get Y quantity ratio configuration.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: SHOPIFY_UPDATE_PRODUCT_IMAGEModify an existing product image. Use when you need to update image properties such as position, alt text, or variant associations.

Input Parameters

object
required
An object containing the image details to update. At least one field must be provided.
string
required
The unique identifier for the specific image to be updated.
string
required
The unique identifier for the product containing the image.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: SHOPIFY_UPDATE_PRODUCT_METAFIELDUpdates an existing metafield for a specific Shopify product.

Input Parameters

string
The new value type of the metafield. If not provided, the existing type will be kept. Changing type must be compatible with the existing metafield type; incompatible changes return a 422 validation error.
string
The new value for the metafield. If not provided, the existing value will be kept.
string
required
The unique identifier of the Shopify product.
string
A new description of the information that the metafield contains. If not provided, the existing description will be kept.
string
required
The unique identifier of the metafield to update.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: SHOPIFY_UPDATE_PRODUCTS_PARAM_PRODUCT_IDDEPRECATED: Use SHOPIFY_UPDATES_A_PRODUCT instead. Update an existing Shopify product including its variants and images. Use when you need to modify product details, variants, options, images, or SEO metadata.

Input Parameters

string
Comma-separated tags (max 250 tags).
string
Product name.
array
Product images to update or add.
string
Product status. Valid values: ‘active’ (published), ‘archived’ (hidden), ‘draft’ (unpublished).
string
Manufacturer or supplier name.
array
Product customization options (max 3 options).
array
Product variant objects to update or create.
string
HTML-formatted product description.
array
Custom metadata fields for extended attributes.
string
required
Unique identifier of the product to update.
string
Product category.
string
Publication timestamp in ISO 8601 format. Set to null to unpublish.
string
Visibility scope. Valid values: ‘web’ (online store only) or ‘global’ (includes Point of Sale).
string
Custom Liquid template reference.
string
SEO title for <meta name=‘title’> tag.
string
SEO description for <meta name=‘description’> tag.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: SHOPIFY_UPDATE_PRODUCT_VARIANTS_BULKUpdates product variants grouped by product using Shopify’s productVariantsBulkUpdate mutation. Supports pricing, barcode, tax, inventory policy, and media association, and returns per-variant success or errors.

Input Parameters

array
required
Array of variant update inputs. Recommended 20-50+ items for optimal bulk operation efficiency.
integer
Maximum polling attempts before timeout. Default 60 (5 minutes with 5s interval).
integer
Seconds to wait between status polls. Default 5.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: SHOPIFY_UPDATE_PROVINCEUpdates an existing province for a country in Shopify. IMPORTANT: This endpoint is deprecated as of API version 2024-07. Additionally, custom tax values for provinces cannot be updated as of version 2020-10. While the endpoint accepts update requests and returns 200 OK, province values (especially tax-related fields) may not actually be modified. Consider using the GraphQL Admin API for country/province management.

Input Parameters

number
The sales tax rate as a decimal. Note: Custom tax values cannot be updated as of API version 2020-10.
string
Standard abbreviation for the province.
string
Full name of the province.
string
Label for the tax type.
string
Valid values: null, ‘normal’, ‘harmonized’, or ‘compounded’.
string
required
The unique identifier of the country.
string
required
The unique identifier of the province to update.
number
The province’s tax expressed as a percentage. Note: Custom tax values cannot be updated as of API version 2020-10.
integer
The shipping zone identifier this province belongs to.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: SHOPIFY_UPDATE_PUB_SUB_WEBHOOK_SUBSCRIPTIONUpdates a Google Cloud Pub/Sub webhook subscription configuration. Use when modifying the GCP project, topic, or message format for an existing Pub/Sub webhook.

Input Parameters

string
required
The ID of the webhook subscription to update (format: gid://shopify/WebhookSubscription/{id}).
string
Message format for webhook payloads. Omit to keep the current format.
string
Google Cloud Pub/Sub topic name to receive webhook events.
string
Google Cloud Platform project identifier for the Pub/Sub topic.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: SHOPIFY_UPDATE_REDIRECTUpdate an existing Shopify redirect. Use when you need to modify the path or target of a redirect. At least one of path or target must be provided.

Input Parameters

string
The old path to be redirected from. When users visit this path, they will be redirected to the target. Maximum 1,024 characters. At least one of ‘path’ or ‘target’ must be provided.
string
The target location where users will be redirected. Can be any path on the shop’s site or an external URL. Maximum 255 characters. At least one of ‘path’ or ‘target’ must be provided.
string
required
The unique identifier of the redirect to update.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: SHOPIFY_UPDATE_REDIRECT_ALTUpdate an existing Shopify redirect. Use when you need to modify the path or target of a redirect.

Input Parameters

string
The old path to be redirected from. When users visit this path, they will be redirected to the target. Maximum 1,024 characters. At least one of ‘path’ or ‘target’ must be provided.
string
The target location where users will be redirected. Can be any path on the shop’s site or an external URL. Maximum 255 characters. At least one of ‘path’ or ‘target’ must be provided.
string
required
The unique identifier of the redirect to update.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: SHOPIFY_UPDATES_AN_ARTICLEDEPRECATED: Use SHOPIFY_UPDATE_ARTICLE instead. Update an existing article in a Shopify blog. Use when you need to modify article properties such as title, body content, tags, author, or publication status.

Input Parameters

string
A comma-separated list of tags. Tags are additional short descriptors for the article.
object
Image object for an article
string
The headline of the article.
string
Name credited as the article’s creator.
string
required
The ID of the blog containing the article to update.
string
The text of the body of the article, complete with HTML markup.
boolean
Whether the article is visible.
string
required
The ID of the article to update.
array
Custom metadata fields with key, namespace, value, and type.
string
Date and time (ISO 8601 format) when the article becomes visible.
string
Brief summary with HTML markup for display on other pages.
string
Custom template identifier for the article.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: SHOPIFY_UPDATES_AN_EXISTING_DISCOUNT_CODEUpdates the code value of an existing discount code associated with a price rule. This action allows you to change the discount code string that customers use at checkout. The code is case-insensitive and can be up to 255 characters. Only the code value can be updated; to modify discount logic (percentage, amount, conditions), update the price rule itself. Required: Both the price_rule_id and discount_code_id must exist in your Shopify store. The new code must be unique and not already in use by another discount.

Input Parameters

string
required
The case-insensitive discount code that customers use at checkout. Maximum 255 characters.
string
required
The ID of the price rule that the discount code belongs to.
string
required
The ID of the discount code to update.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: SHOPIFY_UPDATES_A_PRODUCTUpdates a product and its variants and images. Use when modifying existing product details, pricing, variants, images, or SEO information.

Input Parameters

string
Comma-separated tags (max 250 tags, each max 255 characters)
string
The name of the product
string
Unique human-friendly identifier (auto-generated from title if not provided)
array
Array of product image objects to update. Include image id to update existing images.
string
Product status - must be one of: active, archived, or draft
string
The name of the product’s vendor
array
Custom product properties (max 3 options). Include option id to update existing options.
array
Array of product variant objects to update. Include variant id to update existing variants.
string
Product description with HTML formatting support
string
required
The unique identifier of the product to update. This is required to specify which product to modify.
string
Categorization for filtering and searching products
string
Publication timestamp in ISO 8601 format; set to null to unpublish from Online Store
string
Publication scope - ‘web’ for Online Store only or ‘global’ for Point of Sale channel
string
Suffix for custom Liquid template (e.g., ‘special’ uses product.special.liquid)
string
SEO title metadata for search engines
string
SEO description metadata for search engines

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: SHOPIFY_UPDATE_SCRIPT_TAGModify an existing script tag in Shopify. Use when you need to update script properties like the source URL, display scope, or caching behavior.

Input Parameters

string
URL of the remote script to load. Must be HTTPS.
boolean
Whether the script should be cached by the CDN.
string
DOM event that triggers the script load. Valid value: ‘onload’ (deprecated but still supported).
string ("online_store" | "order_status" | "all")
Where the script displays. Options: ‘online_store’ (storefront only), ‘order_status’ (order status page only), or ‘all’ (both).
string
required
The unique identifier for the script tag being updated.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: SHOPIFY_UPDATE_SHOP_METAFIELDUpdate an existing metafield’s value and type by its numeric ID using the Shopify REST Admin API.

Input Parameters

string
required
The metafield type. Common types include ‘single_line_text_field’, ‘multi_line_text_field’, ‘number_integer’, ‘number_decimal’, ‘url’, ‘json’, ‘boolean’, ‘color’, ‘date’, ‘date_time’.
string
required
The new value for the metafield. Values are always stored as strings regardless of the declared type.
string
required
The unique identifier of the metafield to update.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: SHOPIFY_UPDATE_SMART_COLLECTIONUpdate an existing smart collection. Use when you need to modify a smart collection’s properties, rules, or settings.

Input Parameters

object
Image object for the smart collection.
array
Collection of rule objects defining product inclusion criteria.
string
The name of the smart collection. Maximum length: 255 characters.
string
A human-friendly unique string for the smart collection. Automatically generated from the title if not provided. Maximum length: 255 characters.
string
The description of the smart collection. Includes HTML markup. Can be null.
boolean
Controls visibility; true publishes, false hides the collection.
string ("alpha-asc" | "alpha-desc" | "best-selling" | "created" | "created-desc" | "manual" | "price-asc" | "price-desc")
The order of products in the smart collection.
boolean
Whether products matching ANY rule are included (true) or ALL rules (false).
string
Publication timestamp in ISO 8601 format; null when collection is hidden.
string ("web" | "global")
Publishing channel.
string
The suffix of the Liquid template that the shop uses.
string
required
The unique identifier of the smart collection to update.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: SHOPIFY_UPDATE_SMART_COLLECTION_ALTUpdate an existing smart collection. Use when you need to modify smart collection properties like title, rules, or settings.

Input Parameters

object
Image input for updating smart collection image
array
Array of rule objects defining collection membership criteria
string
The name of the smart collection. Maximum length: 255 characters
string
A human-friendly unique string for the smart collection
string
The description of the smart collection. Includes HTML markup
string ("alpha-asc" | "alpha-desc" | "best-selling" | "created" | "created-desc" | "manual" | "price-asc" | "price-desc")
Ordering of products. Valid values: ‘alpha-asc’, ‘alpha-desc’, ‘best-selling’, ‘created’, ‘created-desc’, ‘manual’, ‘price-asc’, ‘price-desc’
boolean
Whether products need to match one rule (true) or all rules (false)
string
ISO 8601 formatted publication timestamp
string
Liquid template suffix for custom collection pages
string
required
The ID of the smart collection to update

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: SHOPIFY_UPDATE_SMART_COLLECTION_ORDERUpdates the display order of products already in a smart collection with manual sorting enabled, requiring the write_products scope. Returns an empty response after successfully parsing Shopify’s JSON response.

Input Parameters

array
required
Ordered array of product IDs defining the new product sequence. List product IDs in the exact order you want them displayed. Only products already in the collection (matching its rules) can be reordered. The collection must have sort_order=‘manual’ for this to work.
string
required
The unique numeric identifier of the smart collection whose product order will be updated. The collection must have sort_order=‘manual’ for this operation to take effect.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: SHOPIFY_UPDATE_THEMEUpdate an existing theme’s properties such as name or role. Use when you need to modify a theme. Note that a theme cannot be modified while uploading, updating, or if it’s the last published theme.

Input Parameters

string
The display name of the theme. Use this to rename the theme.
string ("main" | "unpublished" | "development")
How the theme functions within the shop. Valid values: ‘main’ (published theme visible to customers), ‘unpublished’ (hidden from customers), or ‘development’ (temporary development theme that cannot be published). When changing role to ‘main’, the previously published theme becomes unpublished.
string
required
The unique numeric identifier for the theme to update.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: SHOPIFY_UPDATE_WEBHOOK_SUBSCRIPTIONUpdate a Shopify webhook subscription’s endpoint, format, event filter, included fields, or metafield namespaces without recreating the subscription. Specify the subscription ID and the configuration fields to change.

Input Parameters

string
required
The ID of the webhook subscription to update (format: gid://shopify/WebhookSubscription/{id}).
object
required
The new configuration for the webhook subscription. Specify only the fields you want to update. You can switch between endpoint types (HTTP, Pub/Sub, EventBridge) by providing a different callback_url format.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: SHOPIFY_UPLOAD_DISPUTE_EVIDENCE_FILEUpload a PNG, JPEG, or PDF evidence file to a Shopify Payments dispute. Uses the legacy REST Admin API and JSON base64 data. Total size of all files on the dispute must be less than 4 MB. Uploading does not submit evidence to the bank. Requires Shopify-approved write_shopify_payments_dispute_file_uploads access and an existing editable dispute.

Input Parameters

string
required
Numeric Shopify Payments dispute ID.
object
required
Evidence file metadata and base64-encoded contents to upload.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: SHOPIFY_VALIDATE_ACCESSChecks Shopify access and retrieves granted OAuth scopes to help troubleshoot authorization issues. DEPRECATED: Use SHOPIFY_GET_SHOP_DETAILS instead.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not

Triggers

Slug: SHOPIFY_BULK_OPERATION_FINISHEDType: webhookTriggers when a bulk operation started by this app finishes, whether it completed, failed, was canceled or expired. Shopify sends no result URL on this event; read currentBulkOperation to get one.

Payload

string
GraphQL global id of the bulk operation, e.g. gid://shopify/BulkOperation/8318582423710.
string
When the operation finished, ISO 8601.
string
When the operation was started, ISO 8601.
string
Why the operation failed, e.g. ACCESS_DENIED, INTERNAL_SERVER_ERROR, TIMEOUT. Null when it succeeded.
string
How the operation ended: completed, failed, canceled or expired.
string
What the operation did: query for a bulk read, mutation for a bulk write.
Slug: SHOPIFY_COLLECTION_CREATEDType: webhookTriggers when a collection is created. Automated collections carry rules and disjunctive; manual ones omit both.

Payload

string
The collection’s GraphQL global id, e.g. gid://shopify/Collection/349572300958.
string
The collection description, as HTML.
boolean
For an automated collection, whether a product needs to match any rule (true) or every rule (false). Absent on manual collections.
string
URL slug for the collection, unique within the store.
integer
required
Shopify’s numeric id for the collection.
string
When the collection was published to its sales channels, ISO 8601.
string
Where the collection is published: web for the online store only, global for every channel.
array
Conditions selecting the collection’s products. Present only on automated collections; absent when the merchant curates by hand.
string
How products are ordered inside the collection, e.g. most-relevant, best-selling, manual.
string
Suffix of the theme template rendering this collection. Null when the default template is used.
string
The collection’s name.
string
When the collection was last modified, ISO 8601.
Slug: SHOPIFY_COLLECTION_DELETEDType: webhookTriggers when a collection is deleted. Shopify sends only the collection’s ids and publication scope, not its title, rules or products.

Payload

string
The deleted collection’s GraphQL global id.
integer
required
Numeric id of the deleted collection.
string
Where the collection had been published: web for the online store only, global for every channel.
Slug: SHOPIFY_COLLECTION_UPDATEDType: webhookTriggers when a collection’s own fields change, and also when a product is added to or removed from a manual collection. The body never lists the collection’s products — read them with SHOPIFY_LIST_COLLECTION_PRODUCTS.

Payload

string
The collection’s GraphQL global id, e.g. gid://shopify/Collection/349572300958.
string
The collection description, as HTML.
boolean
For an automated collection, whether a product needs to match any rule (true) or every rule (false). Absent on manual collections.
string
URL slug for the collection, unique within the store.
integer
required
Shopify’s numeric id for the collection.
string
When the collection was published to its sales channels, ISO 8601.
string
Where the collection is published: web for the online store only, global for every channel.
array
Conditions selecting the collection’s products. Present only on automated collections; absent when the merchant curates by hand.
string
How products are ordered inside the collection, e.g. most-relevant, best-selling, manual.
string
Suffix of the theme template rendering this collection. Null when the default template is used.
string
The collection’s name.
string
When the collection was last modified, ISO 8601.
Slug: SHOPIFY_CUSTOMER_SEGMENT_CREATEDType: webhookTriggers when a customer segment is created. The body carries the segment’s query, not the customers it selects.

Payload

string
When the segment was created, ISO 8601.
integer
required
Shopify’s numeric id for the segment.
string
When the segment was last edited, ISO 8601.
string
Name the merchant gave the segment.
string
The segment’s membership rule in Shopify’s segment query language, e.g. customer_account_status = 'DISABLED'.
Slug: SHOPIFY_CUSTOMER_SEGMENT_DELETEDType: webhookTriggers when a customer segment is deleted. Shopify sends only the segment id.

Payload

integer
required
Numeric id of the deleted customer segment.
Slug: SHOPIFY_CUSTOMER_SEGMENT_UPDATEDType: webhookTriggers when a customer segment is renamed or its query is edited. Customers entering or leaving a segment as they meet the query are not reported.

Payload

string
When the segment was created, ISO 8601.
integer
required
Shopify’s numeric id for the segment.
string
When the segment was last edited, ISO 8601.
string
Name the merchant gave the segment.
string
The segment’s membership rule in Shopify’s segment query language, e.g. customer_account_status = 'DISABLED'.
Slug: SHOPIFY_DISCOUNT_CODE_ADDEDType: webhookTriggers when a redeemable code is added to a discount, once per code. Discount Updated fires alongside it, because the discount’s own record changes too.

Payload

string
GraphQL global id of the discount the code belongs to.
object
One redeemable code belonging to a discount.
string
When the discount’s code list changed, ISO 8601.
Slug: SHOPIFY_DISCOUNT_CODE_REMOVEDType: webhookTriggers when a redeemable code is removed from a discount, once per code. The code stops working immediately; the discount itself survives.

Payload

string
GraphQL global id of the discount the code belongs to.
object
One redeemable code belonging to a discount.
string
When the discount’s code list changed, ISO 8601.
Slug: SHOPIFY_DISCOUNT_CREATEDType: webhookTriggers when a discount is created, whether it applies automatically or through a code. The body is a summary — read the discount’s value and conditions with SHOPIFY_GRAPH_QL_DISCOUNTS.

Payload

string
The discount’s GraphQL global id, e.g. gid://shopify/DiscountCodeNode/1577218769054. Discounts have no numeric id on this topic, so this is the identifier to use with the Admin GraphQL API.
string
When the discount was created, ISO 8601.
string
Where the discount is in its schedule: ACTIVE, SCHEDULED or EXPIRED. Arrives upper-cased.
string
Name of the discount as the merchant sees it.
string
When the discount was last modified, ISO 8601.
Slug: SHOPIFY_DISCOUNT_DELETEDType: webhookTriggers when a discount is deleted. Its codes stop working at the same moment and are not reported separately.

Payload

string
GraphQL global id of the deleted discount. Discounts have no numeric id on this topic, so this is the only handle on it.
string
When the discount was deleted, ISO 8601. Shopify leaves this null in practice; use the delivery’s own arrival time instead.
Slug: SHOPIFY_DISCOUNT_UPDATEDType: webhookTriggers when a discount is edited, and when it reaches its scheduled start or end and status changes. Adding or removing a code fires this as well as the dedicated code triggers.

Payload

string
The discount’s GraphQL global id, e.g. gid://shopify/DiscountCodeNode/1577218769054. Discounts have no numeric id on this topic, so this is the identifier to use with the Admin GraphQL API.
string
When the discount was created, ISO 8601.
string
Where the discount is in its schedule: ACTIVE, SCHEDULED or EXPIRED. Arrives upper-cased.
string
Name of the discount as the merchant sees it.
string
When the discount was last modified, ISO 8601.
Slug: SHOPIFY_INVENTORY_ITEM_CREATEDType: webhookTriggers when an inventory item is created, which Shopify does once per new product variant. It carries the variant’s stock-keeping fields — SKU, cost, weight, customs — but no quantities.

Payload

string
The inventory item’s GraphQL global id, e.g. gid://shopify/InventoryItem/50334998462622.
string
Unit cost the merchant records for margin reporting, as a decimal string in the shop’s currency.
string
ISO 3166-1 alpha-2 country the item was made in.
array
HS tariff codes that override harmonized_system_code for particular destination countries.
string
When the inventory item was created, ISO 8601.
string
HS tariff code used to calculate customs duty.
integer
required
Shopify’s numeric id for the inventory item.
string
Province or state the item was made in, where recorded.
boolean
Whether the item is physical and has to be shipped.
string
Stock keeping unit shared with the variant.
boolean
Whether Shopify counts stock for this item. Untracked items never fire the inventory-level topics.
string
When the inventory item was last modified, ISO 8601.
string
Unit weight_value is expressed in, e.g. lb, kg.
number
Shipping weight of the item, in weight_unit.
Slug: SHOPIFY_INVENTORY_ITEM_DELETEDType: webhookTriggers when an inventory item is deleted, which happens for each variant of a deleted product. Shopify sends the item’s ids and customs fields only, not its SKU or cost.

Payload

string
The deleted inventory item’s GraphQL global id.
string
ISO 3166-1 alpha-2 country the item was made in.
array
HS tariff codes that had overridden harmonized_system_code for particular destination countries.
string
HS tariff code that had been set for customs.
integer
required
Numeric id of the deleted inventory item.
string
Province or state the item was made in, where recorded.
Slug: SHOPIFY_INVENTORY_ITEM_UPDATEDType: webhookTriggers when an inventory item’s stock-keeping fields change, such as its SKU, unit cost, weight or customs codes. Quantity changes are not here; those come through Inventory Level Updated.

Payload

string
The inventory item’s GraphQL global id, e.g. gid://shopify/InventoryItem/50334998462622.
string
Unit cost the merchant records for margin reporting, as a decimal string in the shop’s currency.
string
ISO 3166-1 alpha-2 country the item was made in.
array
HS tariff codes that override harmonized_system_code for particular destination countries.
string
When the inventory item was created, ISO 8601.
string
HS tariff code used to calculate customs duty.
integer
required
Shopify’s numeric id for the inventory item.
string
Province or state the item was made in, where recorded.
boolean
Whether the item is physical and has to be shipped.
string
Stock keeping unit shared with the variant.
boolean
Whether Shopify counts stock for this item. Untracked items never fire the inventory-level topics.
string
When the inventory item was last modified, ISO 8601.
string
Unit weight_value is expressed in, e.g. lb, kg.
number
Shipping weight of the item, in weight_unit.
Slug: SHOPIFY_INVENTORY_LEVEL_UPDATEDType: webhookTriggers when the quantity of an inventory item changes at a location, in either direction, once per location affected. Shopify sends the new available count but no delta.

Configuration

integer
Only deliver events for this Shopify location, as its numeric id. Use SHOPIFY_LIST_LOCATIONS to find location ids. Leave unset to deliver every location.

Payload

string
The inventory level’s GraphQL global id, which carries the inventory item id as a query parameter.
integer
Units available to sell at this location after the change. Null while Shopify is still settling the count.
integer
Numeric id of the inventory item. Join it to a variant’s inventory_item_id to find the product.
integer
Numeric id of the location holding the stock.
string
When the level was last changed, ISO 8601.
Slug: SHOPIFY_INVENTORY_SHIPMENT_CREATEDType: webhookTriggers when a shipment is created against a stock transfer, once per consignment. It starts as DRAFT and moves on through Inventory Shipment In Transit and Inventory Shipment Items Received.

Payload

string
When the shipment was created, ISO 8601.
string
required
GraphQL global id of the shipment, e.g. gid://shopify/InventoryShipment/3256352926. Shipments have no numeric id on this topic.
array
The shipment’s lines and the units each one carries.
string
Where the shipment stands, DRAFT when it is first created. Arrives upper-cased.
object
Carrier tracking recorded against an inventory shipment.
Slug: SHOPIFY_INVENTORY_SHIPMENT_IN_TRANSITType: webhookTriggers when a stock shipment is marked in transit. Shopify sends the status change only, with no lines and no tracking.

Payload

string
When the shipment was marked in transit, ISO 8601.
string
required
GraphQL global id of the shipment now in transit.
string
Where the shipment stands, IN_TRANSIT on this event. Arrives upper-cased.
Slug: SHOPIFY_INVENTORY_SHIPMENT_ITEMS_RECEIVEDType: webhookTriggers when items from a stock shipment are received, once per receiving step. status reads PARTIALLY_RECEIVED until the last step, and each line carries its accepted and rejected counts before and after.

Payload

string
When the items were received, ISO 8601.
string
required
GraphQL global id of the shipment being received.
array
The lines touched by this receipt, each with its counts before and after and what is still outstanding.
string
Where the shipment stands after this step, e.g. PARTIALLY_RECEIVED, RECEIVED. Arrives upper-cased.
Slug: SHOPIFY_INVENTORY_SHIPMENT_TRACKING_UPDATEDType: webhookTriggers when the carrier tracking on a stock shipment is set or changed. The body carries the tracking as it now stands, not what it replaced.

Payload

string
When the tracking was changed, ISO 8601.
string
GraphQL global id of the shipment. This topic names the shipment as shipment_id, unlike the other shipment topics which use id.
object
Carrier tracking recorded against an inventory shipment.
Slug: SHOPIFY_INVENTORY_STOCKED_AT_LOCATIONType: webhookTriggers when an inventory item starts being stocked at a location. This is the item being activated there, not its quantity changing — later quantity changes come through Inventory Level Updated.

Configuration

integer
Only deliver events for this Shopify location, as its numeric id. Use SHOPIFY_LIST_LOCATIONS to find location ids. Leave unset to deliver every location.

Payload

string
The inventory level’s GraphQL global id, which carries the inventory item id as a query parameter.
integer
Units available to sell at this location after the change. Null while Shopify is still settling the count.
integer
Numeric id of the inventory item. Join it to a variant’s inventory_item_id to find the product.
integer
Numeric id of the location holding the stock.
string
When the level was last changed, ISO 8601.
Slug: SHOPIFY_INVENTORY_TRANSFER_READY_TO_SHIPType: webhookTriggers when a stock transfer between the merchant’s locations is marked ready to ship, before any shipment exists against it. Its lines name transfer-line ids rather than products.

Payload

string
When the transfer was marked ready to ship, ISO 8601.
string
required
GraphQL global id of the transfer, e.g. gid://shopify/InventoryTransfer/6167298206. Transfers have no numeric id on this topic.
array
The transfer’s lines and the units each one moves.
string
Where the transfer stands, READY_TO_SHIP on this event. Arrives upper-cased.
Slug: SHOPIFY_INVENTORY_UNSTOCKED_AT_LOCATIONType: webhookTriggers when an inventory item stops being stocked at a location, either because the merchant deactivated it there or because the product was deleted. The body is just the item and location ids.

Configuration

integer
Only deliver events for this Shopify location, as its numeric id. Use SHOPIFY_LIST_LOCATIONS to find location ids. Leave unset to deliver every location.

Payload

integer
Numeric id of the inventory item that is no longer stocked here. Join it to a variant’s inventory_item_id to find the product.
integer
Numeric id of the location that stopped stocking the item.
Slug: SHOPIFY_LOCATION_ACTIVATEDType: webhookTriggers when a location is activated and can hold stock and fulfil orders again. Its previous stock is not restored; that arrives as Inventory Stocked At Location.

Payload

boolean
Whether the location can hold stock and fulfil orders. Deactivating one leaves it on the store, unusable.
string
First line of the address.
string
Second line of the address.
string
The location’s GraphQL global id, e.g. gid://shopify/Location/89748275358.
string
City of the address.
string
ISO 3166-1 alpha-2 country code, e.g. CA.
string
ISO 3166-1 alpha-2 country code, same as country.
string
Country name in full, e.g. Canada.
string
When the location was created, ISO 8601.
integer
required
Shopify’s numeric id for the location.
boolean
Whether this is the implicit location Shopify created before multi-location inventory, rather than one the merchant added.
string
Name the merchant gave the location.
string
Contact phone number for the location.
string
Province or state name, e.g. Ontario.
string
Short province or state code, e.g. ON.
string
When the location was last modified, ISO 8601.
string
Postal or ZIP code.
Slug: SHOPIFY_LOCATION_CREATEDType: webhookTriggers when a location is added to the store. A new location can hold inventory straight away, so this is the first sight of a location_id that will appear on the inventory triggers.

Payload

boolean
Whether the location can hold stock and fulfil orders. Deactivating one leaves it on the store, unusable.
string
First line of the address.
string
Second line of the address.
string
The location’s GraphQL global id, e.g. gid://shopify/Location/89748275358.
string
City of the address.
string
ISO 3166-1 alpha-2 country code, e.g. CA.
string
ISO 3166-1 alpha-2 country code, same as country.
string
Country name in full, e.g. Canada.
string
When the location was created, ISO 8601.
integer
required
Shopify’s numeric id for the location.
boolean
Whether this is the implicit location Shopify created before multi-location inventory, rather than one the merchant added.
string
Name the merchant gave the location.
string
Contact phone number for the location.
string
Province or state name, e.g. Ontario.
string
Short province or state code, e.g. ON.
string
When the location was last modified, ISO 8601.
string
Postal or ZIP code.
Slug: SHOPIFY_LOCATION_DEACTIVATEDType: webhookTriggers when a location is deactivated. It stays on the store with active reading false, but can no longer hold stock or fulfil orders.

Payload

boolean
Whether the location can hold stock and fulfil orders. Deactivating one leaves it on the store, unusable.
string
First line of the address.
string
Second line of the address.
string
The location’s GraphQL global id, e.g. gid://shopify/Location/89748275358.
string
City of the address.
string
ISO 3166-1 alpha-2 country code, e.g. CA.
string
ISO 3166-1 alpha-2 country code, same as country.
string
Country name in full, e.g. Canada.
string
When the location was created, ISO 8601.
integer
required
Shopify’s numeric id for the location.
boolean
Whether this is the implicit location Shopify created before multi-location inventory, rather than one the merchant added.
string
Name the merchant gave the location.
string
Contact phone number for the location.
string
Province or state name, e.g. Ontario.
string
Short province or state code, e.g. ON.
string
When the location was last modified, ISO 8601.
string
Postal or ZIP code.
Slug: SHOPIFY_LOCATION_DELETEDType: webhookTriggers when a location is deleted. Shopify sends only the location id, and a location must be deactivated first, so Location Deactivated normally arrives before it.

Payload

integer
required
Numeric id of the deleted location. This is the same id the inventory topics carry as location_id.
Slug: SHOPIFY_LOCATION_UPDATEDType: webhookTriggers when a location’s own details change, such as its name, address or fulfilment settings. Activation and deactivation have their own triggers and are not reported here.

Payload

boolean
Whether the location can hold stock and fulfil orders. Deactivating one leaves it on the store, unusable.
string
First line of the address.
string
Second line of the address.
string
The location’s GraphQL global id, e.g. gid://shopify/Location/89748275358.
string
City of the address.
string
ISO 3166-1 alpha-2 country code, e.g. CA.
string
ISO 3166-1 alpha-2 country code, same as country.
string
Country name in full, e.g. Canada.
string
When the location was created, ISO 8601.
integer
required
Shopify’s numeric id for the location.
boolean
Whether this is the implicit location Shopify created before multi-location inventory, rather than one the merchant added.
string
Name the merchant gave the location.
string
Contact phone number for the location.
string
Province or state name, e.g. Ontario.
string
Short province or state code, e.g. ON.
string
When the location was last modified, ISO 8601.
string
Postal or ZIP code.
Slug: SHOPIFY_MARKET_CREATEDType: webhookTriggers when a market is created. New markets start as draft and sell nothing until they are activated, which arrives as Market Updated.

Payload

integer
required
Shopify’s numeric id for the market.
string
Name the merchant gave the market.
string
Whether the market is live: active sells to it, draft does not.
string
What the market is scoped by, e.g. region, none for a market with no regions assigned yet.
Slug: SHOPIFY_MARKET_UPDATEDType: webhookTriggers when a market is renamed, activated or otherwise changed. The body is a summary; the market’s regions, currencies, domains and price lists are not included.

Payload

integer
required
Shopify’s numeric id for the market.
string
Name the merchant gave the market.
string
Whether the market is live: active sells to it, draft does not.
string
What the market is scoped by, e.g. region, none for a market with no regions assigned yet.
Slug: SHOPIFY_METAFIELD_DEFINITION_CREATEDType: webhookTriggers when a metafield definition is created, i.e. the schema for one custom field on a resource. Shopify follows every creation with a Metafield Definition Updated for the same definition moments later.

Payload

boolean
Whether the definition only grants access to metafields another owner defined, rather than defining them itself.
string
Filterability as a status string, e.g. not_filterable. Shopify sends this alongside admin_filterable_status.
boolean
Whether staff can filter admin lists by this field.
string
Why the field is or is not filterable in the admin.
boolean
Whether an app owns the definition through its configuration, in which case staff cannot edit it.
string
When the definition was created, ISO 8601.
string
What customer-account surfaces may read the metafield, e.g. none, read.
boolean
Whether Shopify is removing the definition and its metafields in the background.
string
Help text shown to staff under the field.
integer
required
Shopify’s numeric id for the definition.
string
Key of the metafield within its namespace.
boolean
Whether staff can edit the metafield in the admin.
string
Label shown to staff in the Shopify admin.
string
Namespace grouping the definition’s metafields, e.g. custom. Namespace and key together identify a metafield on a resource.
boolean
Whether product option values can be linked to this field’s metaobject entries.
array
Validation rules the definition enforces on values written against it, such as a minimum or a regular expression.
string
Resource the definition applies to, title-cased on this topic — Product, Collection, Shop — not the GraphQL enum casing.
integer
Position of the field among those pinned to the top of the admin editor. 0 when it is not pinned.
boolean
Whether the field can be used as a rule in an automated collection.
string
Id of the Shopify standard definition this was created from, if the merchant picked one instead of defining their own.
boolean
Whether the Storefront API exposes the metafield.
string
Metafield type the definition enforces, e.g. single_line_text_field, number_integer.
boolean
Whether Shopify rejects a value already used on another resource.
string
When the definition was last modified, ISO 8601.
boolean
Whether the merchant has turned the field on as an automated collection rule.
string
Whether existing metafields satisfy the definition’s validations: all_valid, in_progress or some_invalid.
Slug: SHOPIFY_METAFIELD_DEFINITION_DELETEDType: webhookTriggers when a metafield definition is deleted. Shopify sends only its id, type class and creating app — no namespace, key or owner resource — so this trigger cannot offer the filters its create and update siblings do.

Payload

string
required
GraphQL global id of the deleted definition, e.g. gid://shopify/MetafieldDefinition/254184521886. The create and update topics send a numeric id instead; the digits at the end of this one are that same id.
string
Internal class name of the metafield type the definition used, e.g. ShopifyMetafields::Types::SingleLineTextFieldType. Not the type_name the create and update topics send.
Slug: SHOPIFY_METAFIELD_DEFINITION_UPDATEDType: webhookTriggers when a metafield definition’s name, description, validations, pinning or storefront access change. Values written into the metafields it defines are not reported.

Payload

boolean
Whether the definition only grants access to metafields another owner defined, rather than defining them itself.
string
Filterability as a status string, e.g. not_filterable. Shopify sends this alongside admin_filterable_status.
boolean
Whether staff can filter admin lists by this field.
string
Why the field is or is not filterable in the admin.
boolean
Whether an app owns the definition through its configuration, in which case staff cannot edit it.
string
When the definition was created, ISO 8601.
string
What customer-account surfaces may read the metafield, e.g. none, read.
boolean
Whether Shopify is removing the definition and its metafields in the background.
string
Help text shown to staff under the field.
integer
required
Shopify’s numeric id for the definition.
string
Key of the metafield within its namespace.
boolean
Whether staff can edit the metafield in the admin.
string
Label shown to staff in the Shopify admin.
string
Namespace grouping the definition’s metafields, e.g. custom. Namespace and key together identify a metafield on a resource.
boolean
Whether product option values can be linked to this field’s metaobject entries.
array
Validation rules the definition enforces on values written against it, such as a minimum or a regular expression.
string
Resource the definition applies to, title-cased on this topic — Product, Collection, Shop — not the GraphQL enum casing.
integer
Position of the field among those pinned to the top of the admin editor. 0 when it is not pinned.
boolean
Whether the field can be used as a rule in an automated collection.
string
Id of the Shopify standard definition this was created from, if the merchant picked one instead of defining their own.
boolean
Whether the Storefront API exposes the metafield.
string
Metafield type the definition enforces, e.g. single_line_text_field, number_integer.
boolean
Whether Shopify rejects a value already used on another resource.
string
When the definition was last modified, ISO 8601.
boolean
Whether the merchant has turned the field on as an automated collection rule.
string
Whether existing metafields satisfy the definition’s validations: all_valid, in_progress or some_invalid.
Slug: SHOPIFY_PRODUCT_CREATEDType: webhookTriggers when a product is created, from the admin, the API, an import or an app. A product with tracked inventory also fires Inventory Item Created and Inventory Stocked At Location.

Configuration

string
Only deliver products carrying this product type, as set on the product. Leave unset to deliver every type.
string
Only deliver products in this state: active, draft or archived. Leave unset to deliver every state.

Payload

string
The product’s GraphQL global id, e.g. gid://shopify/Product/8860969205918.
string
The product description, as HTML.
object
A product’s node in Shopify’s standard product taxonomy.
string
When the product was created, ISO 8601 with the shop’s UTC offset.
string
URL slug for the product, unique within the store, e.g. merino-crew-neck.
boolean
Whether any variant is a bundle assembled from other products, which cannot be stocked directly.
integer
required
Shopify’s numeric id for the product.
object
One image on a product.
array
Product images, in the order they appear on the product.
array
Images, videos and 3D models attached to the product.
array
The axes the variants vary along, such as Size or Colour.
string
The merchant’s own product-type label, a free-text field.
string
When the product was published to its sales channels, ISO 8601. Null while it is unpublished.
string
Where the product is published: web for the online store only, global for every channel.
string
Whether the product is active, draft or archived. Only active products can be sold.
string
The product’s tags as one comma-separated string, e.g. new, sale. Shopify sends this as text, not an array.
string
Suffix of the theme template rendering this product, e.g. bold for product.bold.liquid. Null when the default template is used.
string
The product’s name.
string
When the product was last modified, ISO 8601.
array
The same variants as GraphQL ids with their modification times — Shopify’s own index for spotting which variant changed.
array
Every purchasable variant of the product.
string
Vendor or brand recorded on the product.
Slug: SHOPIFY_PRODUCT_DELETEDType: webhookTriggers when a product is deleted. Shopify sends only the product id, and a product with tracked inventory also fires Inventory Unstocked At Location and Inventory Item Deleted per variant.

Payload

integer
required
Numeric id of the deleted product. The record is already gone, so this is the only handle on it — match it against your own copy.
Slug: SHOPIFY_PRODUCT_UPDATEDType: webhookTriggers when any field of a product changes, as one delivery per edit rather than one per field. It also fires when a variant’s inventory quantity changes and when a metafield is written on the product, which makes it the highest-volume product trigger.

Configuration

string
Only deliver products carrying this product type, as set on the product. Leave unset to deliver every type.
string
Only deliver products in this state: active, draft or archived. Leave unset to deliver every state.

Payload

string
The product’s GraphQL global id, e.g. gid://shopify/Product/8860969205918.
string
The product description, as HTML.
object
A product’s node in Shopify’s standard product taxonomy.
string
When the product was created, ISO 8601 with the shop’s UTC offset.
string
URL slug for the product, unique within the store, e.g. merino-crew-neck.
boolean
Whether any variant is a bundle assembled from other products, which cannot be stocked directly.
integer
required
Shopify’s numeric id for the product.
object
One image on a product.
array
Product images, in the order they appear on the product.
array
Images, videos and 3D models attached to the product.
array
The axes the variants vary along, such as Size or Colour.
string
The merchant’s own product-type label, a free-text field.
string
When the product was published to its sales channels, ISO 8601. Null while it is unpublished.
string
Where the product is published: web for the online store only, global for every channel.
string
Whether the product is active, draft or archived. Only active products can be sold.
string
The product’s tags as one comma-separated string, e.g. new, sale. Shopify sends this as text, not an array.
string
Suffix of the theme template rendering this product, e.g. bold for product.bold.liquid. Null when the default template is used.
string
The product’s name.
string
When the product was last modified, ISO 8601.
array
The same variants as GraphQL ids with their modification times — Shopify’s own index for spotting which variant changed.
array
Every purchasable variant of the product.
string
Vendor or brand recorded on the product.
Slug: SHOPIFY_PRODUCT_VARIANT_BACK_IN_STOCKType: webhookTriggers when a variant’s stock crosses back above zero across every location, not on every restock. It arrives a few seconds after the inventory change that caused it, so it is not ordered against Inventory Level Updated.

Payload

string
The variant’s GraphQL global id, e.g. gid://shopify/ProductVariant/48209618862238. This is the id form the Admin GraphQL API takes.
string
Barcode, UPC, ISBN or GTIN recorded on the variant.
string
Price the variant is compared against to show a markdown, as a decimal string. Null when the variant is not on sale.
string
When the variant was created, ISO 8601 with the shop’s UTC offset.
integer
required
Shopify’s numeric id for the variant.
integer
Numeric id of the product image assigned to this variant.
integer
Numeric id of the inventory item that holds this variant’s stock. The join key to the inventory topics, which name the item rather than the variant.
string
What Shopify does once stock reaches zero: deny stops the sale, continue allows overselling.
integer
Units available across every location, after the event.
integer
Units available across every location before the event.
string
Value for the product’s first option, e.g. Small when option one is Size.
string
Value for the product’s second option, if it has one.
string
Value for the product’s third option, if it has one.
integer
1-based order of the variant within its product.
string
Current price in the shop’s currency, as a decimal string, e.g. 9.99. Shopify sends money as strings to avoid float rounding.
integer
Numeric id of the product this variant belongs to.
string
The merchant’s stock keeping unit for the variant.
boolean
Whether tax is charged when the variant is sold.
string
The variant’s name, built from its option values, e.g. Small / Blue. Single-variant products get Default Title.
string
When the variant was last modified, ISO 8601.
Slug: SHOPIFY_PRODUCT_VARIANT_OUT_OF_STOCKType: webhookTriggers when a variant’s stock crosses to zero across every location, not on every sale. It arrives a few seconds after the inventory change that caused it, so it is not ordered against Inventory Level Updated.

Payload

string
The variant’s GraphQL global id, e.g. gid://shopify/ProductVariant/48209618862238. This is the id form the Admin GraphQL API takes.
string
Barcode, UPC, ISBN or GTIN recorded on the variant.
string
Price the variant is compared against to show a markdown, as a decimal string. Null when the variant is not on sale.
string
When the variant was created, ISO 8601 with the shop’s UTC offset.
integer
required
Shopify’s numeric id for the variant.
integer
Numeric id of the product image assigned to this variant.
integer
Numeric id of the inventory item that holds this variant’s stock. The join key to the inventory topics, which name the item rather than the variant.
string
What Shopify does once stock reaches zero: deny stops the sale, continue allows overselling.
integer
Units available across every location, after the event.
integer
Units available across every location before the event.
string
Value for the product’s first option, e.g. Small when option one is Size.
string
Value for the product’s second option, if it has one.
string
Value for the product’s third option, if it has one.
integer
1-based order of the variant within its product.
string
Current price in the shop’s currency, as a decimal string, e.g. 9.99. Shopify sends money as strings to avoid float rounding.
integer
Numeric id of the product this variant belongs to.
string
The merchant’s stock keeping unit for the variant.
boolean
Whether tax is charged when the variant is sold.
string
The variant’s name, built from its option values, e.g. Small / Blue. Single-variant products get Default Title.
string
When the variant was last modified, ISO 8601.
Slug: SHOPIFY_SHIPPING_PROFILE_CREATEDType: webhookTriggers when a shipping profile is created. The body is a summary; the profile’s zones, rates and products are not included.

Payload

string
The profile’s GraphQL global id, e.g. gid://shopify/DeliveryProfile/109752320158.
boolean
Whether this is the store’s General profile, which covers every product no custom profile claims.
integer
required
Shopify’s numeric id for the shipping profile.
string
Name the merchant gave the profile.
string
What the profile governs, e.g. shipping.
integer
Revision counter Shopify increments on every edit to the profile.
Slug: SHOPIFY_SHIPPING_PROFILE_DELETEDType: webhookTriggers when a shipping profile is deleted. Unusually for a Shopify delete event the body is the whole profile, and the products it covered fall back to the store’s General profile.

Payload

string
The profile’s GraphQL global id, e.g. gid://shopify/DeliveryProfile/109752320158.
boolean
Whether this is the store’s General profile, which covers every product no custom profile claims.
integer
required
Shopify’s numeric id for the shipping profile.
string
Name the merchant gave the profile.
string
What the profile governs, e.g. shipping.
integer
Revision counter Shopify increments on every edit to the profile.
Slug: SHOPIFY_SHIPPING_PROFILE_UPDATEDType: webhookTriggers when a shipping profile is renamed, or its zones, rates or product assignments change. Which of those changed is not reported, only that version advanced.

Payload

string
The profile’s GraphQL global id, e.g. gid://shopify/DeliveryProfile/109752320158.
boolean
Whether this is the store’s General profile, which covers every product no custom profile claims.
integer
required
Shopify’s numeric id for the shipping profile.
string
Name the merchant gave the profile.
string
What the profile governs, e.g. shipping.
integer
Revision counter Shopify increments on every edit to the profile.
Slug: SHOPIFY_SHOP_SETTINGS_UPDATEDType: webhookTriggers when the store’s own record changes — its address, currency, timezone, plan, tax or checkout settings. It also fires when a metafield on the store is written or deleted, with none of these fields moving.

Payload

string
First line of the store’s business address.
string
Second line of the store’s business address.
boolean
Whether Shopify decides tax inclusivity per market rather than using one setting for the store.
boolean
Whether the store may use the Checkout API.
string
City of the business address.
string
ISO 3166-1 alpha-2 country code, e.g. US.
string
ISO 3166-1 alpha-2 country code, same as country.
string
Country name in full, e.g. United States.
boolean
Whether county tax rates are applied on top of state rates.
string
When the store was created, ISO 8601.
string
ISO 4217 code of the currency the store prices in, e.g. USD.
string
Address shoppers see as the sender and reply-to on store email.
string
The store’s primary customer-facing domain, which is the custom one once the merchant has connected it.
boolean
Whether the store may use Shopify Payments.
string
The merchant’s own contact address for account matters.
array
Every currency shoppers may be shown prices in.
boolean
Whether financial data is available for the store.
string
Google Workspace domain linked to the store, where one is.
boolean
Whether staff sign in with that Google Workspace domain.
boolean
Whether the store has ever created a discount.
boolean
Whether the store has ever issued a gift card.
boolean
Whether the store has an online storefront at all.
string
The same timezone as an IANA name, e.g. America/New_York. Use this one for date arithmetic.
integer
required
Shopify’s numeric id for the store.
number
Latitude Shopify geocoded from the business address.
number
Longitude Shopify geocoded from the business address.
Whether checkout offers shoppers email marketing consent.
Whether checkout offers shoppers SMS marketing consent.
string
Liquid template the storefront renders prices with, e.g. ${{amount}}.
string
Price template used in the store’s email notifications.
string
Price template including the currency code.
string
Email price template including the currency code.
boolean
Whether the store can stock inventory at more than one location.
string
The store’s permanent *.myshopify.com domain. This never changes, unlike domain.
string
The store’s name.
boolean
Whether the storefront is behind a password page and closed to the public.
string
The store’s contact phone number.
string
The plan’s name as the merchant sees it, e.g. Shopify.
string
Internal handle of the store’s Shopify plan, e.g. professional.
boolean
Whether the store is still in its pre-launch state.
string
ISO code of the store’s default language, e.g. en.
integer
Numeric id of the location Shopify fulfils from by default. Joins to the location_id on the inventory topics.
string
Province or state name of the business address.
string
Short province or state code, e.g. ON.
boolean
Whether Shopify needs an extra payments agreement before the store can take payments.
boolean
Whether Shopify still requires setup steps before selling.
string
Name of the account owner.
string
How the store was signed up, where Shopify recorded it.
boolean
Whether tax is charged on shipping.
boolean
Whether product prices already include tax.
string
The store’s timezone as Shopify displays it, e.g. (GMT-05:00) Eastern Time (US & Canada).
boolean
Whether the store has turned off transactional SMS to shoppers.
string
When the store’s record was last modified, ISO 8601.
string
Default unit for product weights, e.g. lb, kg.
string
Postal or ZIP code.
Slug: SHOPIFY_STORE_LANGUAGE_ADDEDType: webhookTriggers when a language is added to the store. It is normally added unpublished, so published reads false until the merchant makes it visible, which arrives as Store Language Updated.

Payload

string
ISO language code for the language, e.g. fr or pt-BR. This is the identifier Shopify uses for the store’s locales.
boolean
Whether shoppers can browse the storefront in this language. A language can be added unpublished while translations are prepared.
Slug: SHOPIFY_STORE_LANGUAGE_REMOVEDType: webhookTriggers when a language is removed from the store, taking its stored translations with it. published describes the language as it stood at removal.

Payload

string
ISO language code for the language, e.g. fr or pt-BR. This is the identifier Shopify uses for the store’s locales.
boolean
Whether shoppers can browse the storefront in this language. A language can be added unpublished while translations are prepared.
Slug: SHOPIFY_STORE_LANGUAGE_UPDATEDType: webhookTriggers when a store language is published or unpublished. published is what changes; the language stays on the store either way.

Payload

string
ISO language code for the language, e.g. fr or pt-BR. This is the identifier Shopify uses for the store’s locales.
boolean
Whether shoppers can browse the storefront in this language. A language can be added unpublished while translations are prepared.