Shopify

Shopify is an e-commerce platform. This toolkit is GraphQL-first for new Admin API automations while retaining legacy REST compatibility actions for older workflows and numeric-ID interoperability shopify · 407 tools · no triggers

Connect it

run auth shopify
run auth shopify --scope team    # shared with the organization

Or from the Integrations page in the console. See Connections for personal versus shared, and who may remove one.

Use it

run shopify          # common commands
run shopify --all    # every command

import { shopify } from "@boxd/run";

Common tools

Tool	What it does
`bulk-create-products`	Creates many products (20-50+) in one asynchronous Shopify bulk mutation job.
`bulk-query-operation`	Run a Shopify GraphQL bulk query operation and return the result file URL and operation metadata.
`cancel-bulk-operation`	Cancel a running Shopify bulk operation. Use when you need to stop a long-running bulk query or mutation operation that is no longer needed.
`count-product-images`	Retrieves the total count of images for a specific Shopify product.
`create-custom-collection`	Create a new custom (manually curated) collection in Shopify.
`create-customer`	Create a new customer in Shopify. Use to add a customer record to the store with contact details, addresses, and marketing preferences.
`create-order`	Create a fully committed (real) order in Shopify without payment processing.
`create-product`	DEPRECATED: Use SHOPIFY_CREATES_NEW_PRODUCT instead. Creates a new product in a Shopify store; a product title is generally required.
`create-product-image`	DEPRECATED: Use SHOPIFY_CREATE_NEW_PRODUCT_IMAGE instead. Creates a new product image for a Shopify product.
`create-resource-feedback`	Creates shop-level resource feedback to notify Shopify merchants about app setup requirements or successful configuration.
`creates-new-product`	Create 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.
`get-customer`	Retrieve a single customer by their unique identifier. Use when you need to fetch detailed information about a specific customer.
`get-customers-search`	Search 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.
`get-order`	Retrieve a specific order using its unique identifier. Returns detailed order information including line items, customer data, addresses, financial…
`get-shop-configuration`	DEPRECATED: Use SHOPIFY_GET_SHOP_DETAILS instead. Retrieve the complete configuration and settings for the authenticated Shopify shop account.
`get-shop-details`	Retrieves comprehensive administrative information about the authenticated Shopify store.
`graph-ql-admin-execute`	Execute any Shopify Admin GraphQL query or mutation with variables.
`graph-ql-customers`	Shopify GraphQL customers and customer search. The response always includes raw GraphQL data, extracted userErrors, pageInfo, and cost extensions.
`graph-ql-discounts`	Shopify GraphQL discounts and discount search. The response always includes raw GraphQL data, extracted userErrors, pageInfo, and cost extensions.
`graph-ql-inventory`	Shopify GraphQL inventory items and levels. The response always includes raw GraphQL data, extracted userErrors, pageInfo, and cost extensions.
`graph-ql-orders`	Shopify GraphQL orders and order search. The response always includes raw GraphQL data, extracted userErrors, pageInfo, and cost extensions.
`graph-ql-products`	GraphQL-first product toolkit: products, variants, options, media, and publications.
`graph-ql-write-operations`	Canonical GraphQL write surface for Shopify orders, customers, inventory, discounts, collections, webhooks, fulfillments, metafields, and bulk operations.
`list-customers`	Retrieve a list of customers from a Shopify store. Use when you need to fetch customer data with optional filtering by IDs, creation dates, update…
`list-order`	Retrieves a list of orders from Shopify with optional filtering by status, dates, and other criteria.

All 399 tools

Tool	What it does
`activate-one-time-charge`	Activate a one-time application charge in Shopify. Use when you need to finalize billing for an accepted charge.
`add-product-to-collection`	DEPRECATED: Use SHOPIFY_ADDS_A_PRODUCT_TO_A_CUSTOM_COLLECTION instead.
`add-product-to-custom-collection`	Add a product to a custom collection by creating a collect resource.
`adjust-inventory-level`	Adjust the inventory level of an inventory item at a single location.
`apply-fulfillment-hold`	Applies a fulfillment hold to an open fulfillment order, halting all fulfillment work.
`approve-comment`	Approves a pending comment and publishes it to a blog article, making it publicly visible to readers.
`bulk-create-products`	Creates many products (20-50+) in one asynchronous Shopify bulk mutation job.
`bulk-delete-customer-addresses`	Bulk delete multiple customer addresses in a single operation.
`bulk-delete-metafields`	Deletes multiple metafields in bulk using their owner ID, namespace, and key.
`bulk-delete-metaobjects`	Asynchronously delete metaobjects and their associated metafields in bulk.
`bulk-query-operation`	Run a Shopify GraphQL bulk query operation and return the result file URL and operation metadata.
`calculate-refund`	Calculate accurate refund amounts, taxes, and transactions for a Shopify order before creating an actual refund.
`cancel-app-subscription`	Cancel an app subscription in Shopify using the appSubscriptionCancel GraphQL mutation.
`cancel-bulk-operation`	Cancel a running Shopify bulk operation. Use when you need to stop a long-running bulk query or mutation operation that is no longer needed.
`cancel-fulfillment`	Cancels an existing fulfillment by its ID, reverting all line items to an unfulfilled state.
`cancel-fulfillment-order`	Cancels a fulfillment order in Shopify and marks it as closed.
`cancel-order`	Cancels a Shopify order and optionally restocks items and sends email notifications.
`close-order`	Closes an open Shopify order. Use when all line items have been fulfilled or canceled and all financial transactions are complete.
`complete-draft-order`	Complete a draft order in Shopify and transition it to an actual order.
`connect-inventory-level`	Connects an inventory item to a location, establishing where the item can be stocked and fulfilled.
`count-articles`	Retrieves 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…
`count-blogs`	Retrieves 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…
`count-custom-collections`	Retrieves a count of custom collections with optional filters.
`count-draft-orders`	Retrieves 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.
`count-events`	Count all events in a Shopify store with comprehensive filtering.
`count-fulfillments`	Retrieves a count of fulfillments associated with a specific order.
`count-location`	Retrieves a count of locations. Use when you need to determine how many physical or virtual locations are configured in the Shopify store.
`count-metafields`	Retrieves the shop-level count of metafields. Use resource-specific metafield actions for product, customer, order, collection, page, or article metafields.
`count-order`	DEPRECATED: Use SHOPIFY_RETRIEVES_ORDER_COUNT instead. Retrieves the count of orders in a Shopify store.
`count-pages`	Retrieve the total count of pages in a Shopify store. Use when you need to determine how many pages exist, optionally filtered by creation date…
`count-price-rules`	Retrieves a count of all price rules. Use when you need to determine how many price rules (discount campaigns) are configured in the store.
`count-product-images`	Retrieves the total count of images for a specific Shopify product.
`count-products`	Retrieve a count of products in the Shopify store. Use when you need to get the total number of products, optionally filtered by collection, vendor…
`count-product-variants`	Retrieves the total count of variants for a Shopify product.
`count-script-tags`	Retrieves 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.
`count-webhooks`	Retrieves a count of existing webhook subscriptions. Use when you need to know how many webhooks are configured, optionally filtered by address or topic.
`create-metafield`	Creates a new metafield for a Shopify blog. Metafields store additional custom information (metadata) on blog resources such as sponsor names, SEO…
`create-new-product-image`	Create 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.
`create-app-subscription`	Create a recurring or usage-based app subscription for charging Shopify merchants.
`create-article`	Create an article for a blog in Shopify. Use when you need to add blog content to a specific blog.
`create-article-comment`	Create a comment for an article in Shopify. Use when you need to add reader comments to blog articles.
`create-blog`	Create a new blog in Shopify. Use when you need to add a blog to the store for publishing articles and content.
`create-country`	Create a country with tax configuration for the Shopify store.
`create-custom-collection`	Create a new custom (manually curated) collection in Shopify.
`create-customer`	Create a new customer in Shopify. Use to add a customer record to the store with contact details, addresses, and marketing preferences.
`create-customer-account-activation-url`	Generate a one-time account activation URL for a customer whose account is in ‘disabled’ state (not yet activated).
`create-customer-address`	Create a new address for a customer. Use when you need to add an address to an existing customer’s address list.
`create-delegate-access-token`	Create a delegate access token with a subset of the parent token’s permissions.
`create-discount-code`	Creates 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…
`create-discount-code-batch`	Create 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.
`create-draft-order`	Create a draft order in Shopify. Use when you need to create orders in draft state using product variant line items or custom line items.
`create-event-bridge-webhook-subscription`	Create an AWS EventBridge webhook subscription in Shopify. Use when you need to configure real-time event notifications to AWS EventBridge for events…
`create-fulfillment`	Creates a fulfillment for one or many fulfillment orders for a specific order.
`create-fulfillment-event`	Creates a tracking event for a fulfillment to update shipment status.
`create-gift-card`	Create a gift card for a Shopify store. Use when you need to issue a new gift card with a specified value.
`create-marketing-engagements`	Create engagement data for a marketing event in Shopify. Use when tracking customer interactions like views, clicks, and ad spend on marketing events…
`create-marketing-event`	Create a marketing event in Shopify to track promotional actions.
`create-one-time-application-charge`	Create a new one-time application charge in Shopify. Use when you need to bill merchants for one-time features, upgrades, or services.
`create-order`	Create a fully committed (real) order in Shopify without payment processing.
`create-order-risk`	Creates a risk assessment record for a Shopify order, documenting fraud detection findings or security concerns.
`create-order-transaction`	Creates a transaction for an order to process payment operations.
`create-page`	Create a static web page in Shopify. Use when you need to add long-term static content like About Us, Contact, or Privacy Policy pages.
`create-price-rule`	Creates a price rule that defines discount logic for Shopify orders.
`create-product`	DEPRECATED: Use SHOPIFY_CREATES_NEW_PRODUCT instead. Creates a new product in a Shopify store; a product title is generally required.
`create-product-image`	DEPRECATED: Use SHOPIFY_CREATE_NEW_PRODUCT_IMAGE instead. Creates a new product image for a Shopify product.
`create-product-metafield`	Creates 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.
`create-product-variant`	Create a new product variant for an existing product. Use when adding a new variant with specific option values (like size, color).
`create-pub-sub-webhook-subscription`	Create a Google Cloud Pub/Sub webhook subscription in Shopify.
`create-redirect`	Create a URL redirect in Shopify. Use when you need to redirect an old path to a new location.
`create-refund`	Creates a refund for a Shopify order. IMPORTANT: You must call the calculate refund endpoint (SHOPIFY_CREATE_ORDERS_REFUNDS_CALCULATE) first to…
`create-resource-feedback`	Creates shop-level resource feedback to notify Shopify merchants about app setup requirements or successful configuration.
`creates-new-product`	Create 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.
`create-script-tag`	Create a new script tag in Shopify to load remote JavaScript into your online store.
`create-smart-collections`	Create a new smart collection with automated product rules. Use when you need to create dynamic collections that automatically include products…
`creates-or-updates-asset-for-theme`	Creates or updates a theme asset file (templates, stylesheets, scripts, or images) within a Shopify theme.
`create-storefront-access-token`	Creates a new storefront access token for unauthenticated Storefront API access.
`create-theme`	Creates a new theme in Shopify from a ZIP file containing theme assets.
`create-webhook`	Creates a new webhook subscription in Shopify to receive real-time notifications when specific events occur in the store.
`create-webhook-subscription`	Create a webhook subscription that notifies your app when specific events occur in a Shopify store.
`delete-article`	Delete an article from a blog in Shopify. Use when you need to permanently remove blog content.
`delete-blog`	Permanently deletes a blog from a Shopify store using its `blog_id`; this action is irreversible and requires the ‘content’ access scope.
`delete-collect`	Removes a product from a custom collection by deleting the collect.
`delete-comment`	Remove a comment from a Shopify blog. Use when you need to hide a comment from blog readers while preserving the data.
`delete-country`	Deletes a country from the shop’s tax configuration. Removes a country that was previously added to the shop’s tax settings.
`delete-custom-collection`	DEPRECATED: Use SHOPIFY_DELETES_CUSTOM_COLLECTION instead. Permanently deletes a custom collection from a Shopify store using its `collection_id`…
`delete-customer`	Deletes a customer from the Shopify store. Use when you need to permanently remove a customer who has no existing orders.
`delete-customer-address`	Removes an address from a customer’s address list. Cannot delete the customer’s default address - to delete a default address, first assign a…
`delete-draft-order`	Delete a draft order from Shopify. Use when you need to remove an existing draft order permanently.
`delete-fulfillment-event`	Deletes a fulfillment event (tracking status update) from an order’s fulfillment.
`delete-fulfillment-service`	Remove an existing fulfillment service from a Shopify store.
`delete-inventory-level`	Deletes an inventory level of an inventory item at a location.
`delete-marketing-event`	Delete a marketing event from Shopify. Use when you need to remove an existing marketing event from the system.
`delete-metafield`	Deletes a metafield by its ID from any Shopify resource. Use this action to permanently remove metafields from: - Shop-level metafields (use…
`delete-metaobject`	Deletes a metaobject and its associated metafields using GraphQL mutation.
`delete-metaobject-definition`	Delete a metaobject definition and all its associated data. Use when you need to completely remove a metaobject definition schema.
`delete-order`	Permanently 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.
`delete-order-risk`	Deletes an order risk from an order. Only the application that created the risk can delete it - you cannot delete risks created by other…
`delete-page`	Delete 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.
`delete-price-rule`	Deletes an existing price rule from the Shopify store permanently.
`delete-product`	Permanently deletes a product from a Shopify store by its product ID.
`delete-product-image`	Deletes a specific image from a product in Shopify, requiring the `product_id` of an existing product and the `image_id` of an image currently…
`delete-product-metafield`	Deletes a specific metafield from a Shopify product using the product ID and metafield ID.
`delete-product-variant`	Deletes a specific product variant from a Shopify store using its unique product ID and variant ID; this action is irreversible.
`delete-redirect`	Permanently deletes a URL redirect from a Shopify store. Use this tool to remove redirect rules that are no longer needed.
`deletes-custom-collection`	Permanently delete a custom collection from a Shopify store.
`deletes-discount-code`	Delete a discount code from a price rule. Use when you need to remove a specific discount code associated with a price rule.
`delete-saved-search`	Delete a saved search in Shopify. Use when you need to remove a saved search by its ID.
`delete-script-tag`	Delete a script tag from your Shopify store. Permanently removes a script tag using its unique identifier.
`delete-smart-collection`	Permanently removes a smart collection from a Shopify store using its `smart_collection_id`; this action is irreversible and requires a valid…
`delete-storefront-access-token`	Delete an existing storefront access token from a Shopify store.
`delete-theme`	Deletes a theme from the Shopify store by its ID. Use this tool when you need to permanently remove an unwanted theme.
`delete-theme-asset`	Delete 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…
`delete-webhook`	Delete a webhook subscription from Shopify. Use when you need to remove an existing webhook.
`delete-webhook-subscription`	Delete a webhook subscription and stop all future webhooks to its endpoint.
`delete-web-presence`	Delete a web presence from Shopify. Use when you need to remove a web presence by its ID.
`disable-gift-card`	Disable a gift card in Shopify. Use when you need to permanently deactivate a gift card.
`enable-standard-metaobject-definition`	Enable a standard metaobject definition from its template. Use when you need to activate a predefined Shopify metaobject template for use in your store.
`get-abandonment`	Retrieves an abandonment record from Shopify using its unique ID.
`get-abandonment-by-abandoned-checkout-id`	Query abandonment information by abandoned checkout ID using Shopify’s GraphQL Admin API.
`get-access-scopes`	Retrieves a list of access scopes associated with the access token.
`get-app`	Query information about a Shopify app using the GraphQL API.
`get-app-by-handle`	Query app information by handle using the Shopify Admin GraphQL API.
`get-app-installation`	Query a specific app installation on a Shopify store. Use when you need to retrieve details about an app installation including access scopes, launch…
`get-application-charge-by-id`	Retrieve a single application charge by its unique identifier.
`get-application-charges`	Retrieves a list of one-time application charges for the current app installation.
`get-application-credits`	Retrieve all application credits for a shop. Use when you need to view credits issued to merchants that can be used towards future app purchases.
`get-article`	Retrieves 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…
`get-batch-discount-codes`	Retrieves discount codes from a batch creation job, showing which succeeded and which failed. Workflow: After batch job completes…
`get-blog`	Retrieve a single blog by its unique identifier. Use when you need to access detailed information about a specific blog in the Shopify store.
`get-blog-article-tags`	Retrieve 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…
`get-bulk-operation`	Query the status and details of a Shopify bulk operation by its ID.
`get-carrier-services`	Retrieves all active carrier services configured in a Shopify store.
`get-catalogs-count`	Query 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.
`get-checkout-profile`	Retrieves a checkout profile from Shopify using its unique ID.
`get-checkouts-count`	Retrieves a count of abandoned checkouts from the past 90 days.
`get-collect-by-id`	Retrieves a specific collect by its ID. Use when you need to get details about a specific product-collection relationship.
`get-collection-by-id`	Retrieves a specific Shopify collection by its `collection_id`, optionally filtering returned data to specified `fields`.
`get-collection-by-identifier`	Query a collection by identifier (ID or handle) using the Shopify GraphQL Admin API.
`get-collects`	Retrieves a list of collects from a Shopify store, where a collect links a product to a custom collection.
`get-collects-count`	Retrieves a count of collects (product-collection relationships).
`get-comments-count`	Retrieves a count of comments. Use when you need to know how many comments exist, optionally filtered by article, blog, status, or date ranges.
`get-consent-policy`	Query consent policies for privacy compliance requirements. Use when you need to retrieve customer consent requirements for specific regions or…
`get-countries`	Retrieve a list of countries configured in the Shopify store with tax rates and provinces.
`get-countries-count`	Retrieves the count of countries configured in a Shopify store.
`get-countries-param-country-id-provinces-count`	Retrieves 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.
`get-countries-param-country-id-provinces-param-provi`	Get Province for Country
`get-country`	Retrieve 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.
`get-country-provinces`	Retrieve 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.
`get-currencies`	Retrieve a list of currencies enabled on a Shopify store. This action fetches all currencies that the merchant has enabled for multi-currency…
`get-custom-collection-by-id`	Retrieve a single custom collection by its unique ID from Shopify.
`get-custom-collections`	Retrieves a list of custom collections from a Shopify store.
`get-custom-collections-count`	Retrieves the total count of custom collections in a Shopify store with optional filters.
`get-customer`	Retrieve a single customer by their unique identifier. Use when you need to fetch detailed information about a specific customer.
`get-customer-address`	Retrieve details of a single customer address from Shopify. Use when you need to get complete information about a specific address for a customer…
`get-customer-addresses`	Retrieves all addresses associated with a specific customer.
`get-customer-orders`	Retrieves all orders for a specific, existing customer in Shopify using their unique customer ID.
`get-customers-count`	Retrieves a count of all customers. Use when you need to know the total number of customers, optionally filtered by creation or update dates.
`get-customers-search`	Search 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.
`get-discount-code`	Retrieves 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.
`get-discount-code-batch-job`	Retrieves the status and progress of an asynchronous batch discount code creation job for a specific price rule.
`get-discount-codes-count`	Retrieves a count of discount codes for a shop. Use when you need to know how many discount codes exist, optionally filtered by usage statistics.
`get-discount-codes-lookup`	Look up a discount code by its code name and retrieve its resource location and IDs.
`get-draft-order`	Retrieve detailed information for a specific draft order from a Shopify store.
`get-event`	Retrieve a specific Shopify event by its ID. Events track actions performed on store resources like products, orders, collections, and articles.
`get-events`	Retrieves a list of audit trail events from a Shopify store.
`get-fulfillment`	Retrieves all fulfillments (shipments) associated with a specific fulfillment order.
`get-fulfillment-event`	Retrieves a specific fulfillment event by its ID, providing detailed shipment tracking information.
`get-fulfillment-events`	Retrieves tracking events for a specific fulfillment, showing shipment status updates (e.g., in_transit, out_for_delivery, delivered) with timestamps…
`get-fulfillment-order`	Retrieve all fulfillment orders for a specific order. Use when you need to check fulfillment status, assigned locations, or line items for an order.
`get-fulfillment-order-fulfillments`	Retrieves all fulfillments associated with a specific fulfillment order.
`get-fulfillment-order-locations-for-move`	Retrieve locations that a fulfillment order can potentially move to.
`get-fulfillment-order-move-locations`	Retrieve a list of locations that a fulfillment order can potentially move to.
`get-fulfillment-orders-for-order`	Retrieves a list of fulfillment orders for a specific order.
`get-fulfillment-services`	Retrieve a list of fulfillment services available on the Shopify store.
`get-gift-card-by-id`	Retrieves detailed information about a specific gift card by its ID.
`get-gift-cards`	Retrieve a list of gift cards from Shopify. Use when you need to fetch gift cards with optional filtering by status and pagination support.
`get-gift-cards-count`	Retrieves 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.
`get-inventory-item`	Retrieves a single inventory item by ID. Use when you need to get detailed information about an inventory item including SKU, cost, tracking status…
`get-inventory-items`	Retrieves a list of inventory items by specified IDs. Use when you need to get inventory item details like SKU, cost, shipping requirements, and tracking status.
`get-inventory-levels`	Retrieves a list of inventory levels for specified items and locations.
`get-inventory-levels-for-location`	Retrieves a list of inventory levels for a specific location.
`get-location`	Retrieve 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.
`get-locations-count`	Query the count of locations in a Shopify store using the GraphQL API.
`get-marketing-event`	Retrieves detailed information about a specific marketing event by its ID.
`get-marketing-events-count`	Retrieves a count of all marketing events in the store. Use when you need to know the total number of marketing events.
`get-metafield`	Retrieve a list of metafields from a blog resource. Use when you need to fetch metafields attached to a specific Shopify blog.
`get-metafield-by-id`	Retrieve a single metafield from a resource by its ID. Use when you need to fetch metafield details without knowing the parent resource.
`get-metafields`	Retrieve 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.
`get-metafields-count`	Retrieves the count of shop-level metafields only. This action returns how many metafields are directly attached to the shop itself, not metafields…
`get-order`	Retrieve a specific order using its unique identifier. Returns detailed order information including line items, customer data, addresses, financial…
`get-order-fulfillments`	Retrieve fulfillments associated with a Shopify order. Use when you need to get delivery tracking information, shipment status, or fulfillment…
`get-order-list`	Retrieves a list of orders from Shopify with optional filters and pagination.
`get-order-refund-by-id`	Retrieves a specific refund by refund ID for an order. Use this action when you need to: - Get detailed information about a particular refund -…
`get-order-refunds`	Retrieves a list of all refunds for a specific order. Use this action when you need to: - Review refund history and details for an order - Check…
`get-order-risk`	Retrieves all fraud risk assessments for a specific order. Returns a list of risk assessments indicating potential fraud.
`get-order-risks`	Retrieves all fraud risk assessments for a specific order. Returns a list of risk assessments with recommendations (cancel/investigate/accept) and…
`get-ordersby-id`	Retrieves a specific Shopify order by its unique ID, which must correspond to an existing order.
`get-orders-with-filters`	Retrieves Shopify orders filtered by dates and other filters.
`get-order-transactions-count`	Retrieve a count of an order’s transactions in Shopify. Use when you need to know how many transactions (authorization, sale, capture, void, refund)…
`get-page-by-id`	Retrieve a single Shopify page by its unique ID. Use when you need to fetch detailed information about a specific page.
`get-policies`	Retrieve 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.
`get-price-rule`	Retrieves a single price rule by ID from Shopify. Returns discount configuration including type (percentage/fixed), value, target items, customer…
`get-price-rule-batch-info`	Checks if batch listing is supported for a price rule and provides guidance on alternatives. **IMPORTANT: Shopify’s API does not provide an endpoint…
`get-price-rule-discount-codes`	Retrieve a list of discount codes for a price rule. Use when you need to get all discount codes associated with a specific price rule.
`get-product`	Retrieves details for an existing Shopify product using its unique product ID.
`get-product-image`	Retrieve a single product image by ID for a specific product.
`get-product-images`	Retrieves all images for a Shopify product, specified by its `product_id` which must correspond to an existing product.
`get-product-metafield`	Retrieves a specific metafield for a Shopify product using the product ID and metafield ID.
`get-product-metafields`	Retrieves all metafields for a specific Shopify product. Metafields are returned under `data.response_data.metafields`.
`get-products`	Retrieves a list of products from a Shopify store. Results are paginated; for large catalogs, use SHOPIFY_GET_PRODUCTS_PAGINATED to iterate all…
`get-products-in-collection`	Retrieves products that belong to a specific Shopify collection.
`get-products-paginated`	List products with Shopify cursor-based pagination. Iterate until `next_page_info` is null; stopping early silently truncates the product list.
`get-product-variant`	Retrieves detailed information about a single product variant by its ID from Shopify.
`get-recurring-application-charges`	Retrieve a list of recurring application charges for the app.
`get-redirect`	Retrieve details of a specific URL redirect by its ID. Returns the redirect’s path (source) and target (destination) configuration.
`get-redirect-by-id`	Retrieve a single redirect by its ID. Use when you need to get details about a specific URL redirect configuration in a Shopify store.
`get-redirects`	Retrieve a list of URL redirects from a Shopify store. Use when you need to fetch URL redirect configurations, optionally filtered by path or target.
`get-redirects-count`	Retrieves 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.
`get-refund`	Retrieves detailed information about a specific refund for an order.
`get-scripttag`	Retrieves a single script tag by its ID. Use when you need to get details of a specific script tag configuration.
`get-segments-count`	Query the number of segments for a shop. Use when you need to know how many customer segments exist.
`get-shipping-zones`	Retrieve all configured shipping zones with countries, provinces, tax rates, and shipping rates.
`get-shop-billing-address`	Retrieves the billing address for the shop via GraphQL query.
`get-shop-configuration`	DEPRECATED: Use SHOPIFY_GET_SHOP_DETAILS instead. Retrieve the complete configuration and settings for the authenticated Shopify shop account.
`get-shop-details`	Retrieves comprehensive administrative information about the authenticated Shopify store.
`get-shop-metafield`	Retrieve 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.
`get-shop-metafields`	DEPRECATED: Use SHOPIFY_GET_METAFIELDS instead (apps/shopify/actions/get_metafields.py).
`get-smart-collection`	Retrieve a single smart collection by its ID from Shopify. Use when you need to get detailed information about a specific smart collection including…
`get-smart-collection-by-id`	Retrieve 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.
`get-smart-collections`	Retrieve a list of smart collections from a Shopify store. Use when you need to fetch smart collections with optional filtering by IDs, handle…
`get-smart-collections-count`	Retrieve a count of smart collections in a Shopify store. Use when you need to know the total number of smart collections, optionally filtered by…
`get-storefront-access-tokens`	Retrieves a list of storefront access tokens that have been issued for the shop.
`get-tender-transactions`	Retrieve a list of tender transactions from Shopify. Tender transactions represent actual money movement between customers and the merchant (positive…
`get-theme`	Retrieves a single Shopify theme by its unique ID. Use this action when you need to: - Get details about a specific theme (name, role, timestamps…
`get-themes`	Retrieves a list of themes from a Shopify store. Use when you need to access theme information including name, role, and metadata.
`get-themes-param-theme-id-assets`	Retrieve 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.
`get-transaction`	Retrieve a specific transaction for an order. Use when you need to get detailed information about a payment transaction.
`get-webhook`	Retrieves a single webhook subscription by its ID. Use when you need to get details of a specific webhook configuration.
`get-webhook-subscriptions-count`	Query the number of webhook subscriptions for a shop. Use when you need to know how many webhook subscriptions exist, optionally filtered by query criteria.
`graph-ql-admin-execute`	Execute any Shopify Admin GraphQL query or mutation with variables.
`graph-ql-collections`	Shopify GraphQL collections and publication-ready collection reads.
`graph-ql-customers`	Shopify GraphQL customers and customer search. The response always includes raw GraphQL data, extracted userErrors, pageInfo, and cost extensions.
`graph-ql-discounts`	Shopify GraphQL discounts and discount search. The response always includes raw GraphQL data, extracted userErrors, pageInfo, and cost extensions.
`graph-ql-draft-orders`	Shopify GraphQL draft orders. The response always includes raw GraphQL data, extracted userErrors, pageInfo, and cost extensions.
`graph-ql-inventory`	Shopify GraphQL inventory items and levels. The response always includes raw GraphQL data, extracted userErrors, pageInfo, and cost extensions.
`graph-ql-metafields-metaobjects`	Canonical GraphQL read surface for metafields, metafield definitions, and metaobjects.
`graph-ql-orders`	Shopify GraphQL orders and order search. The response always includes raw GraphQL data, extracted userErrors, pageInfo, and cost extensions.
`graph-ql-products`	GraphQL-first product toolkit: products, variants, options, media, and publications.
`graph-ql-query`	Executes a GraphQL query against the Shopify Admin API for flexible data retrieval and mutations including metafields.
`graph-ql-shop`	GraphQL-first shop, app installation, and configuration read action.
`graph-ql-webhooks`	Shopify GraphQL webhook subscriptions. The response always includes raw GraphQL data, extracted userErrors, pageInfo, and cost extensions.
`graph-ql-write-operations`	Canonical GraphQL write surface for Shopify orders, customers, inventory, discounts, collections, webhooks, fulfillments, metafields, and bulk operations.
`list-abandoned-checkouts`	Retrieves a list of abandoned checkouts with customer contact information.
`list-application-credits`	Retrieve all application credits issued to a shop by your app.
`list-article-authors`	Retrieve 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.
`list-article-tags`	Retrieve 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.
`list-available-locales`	Query available locales for the Shopify store using the Admin GraphQL API.
`list-blog-articles`	Retrieves a list of all articles from a blog. Use when you need to access articles from a specific blog, with optional filtering by author, dates, or publication status.
`list-blogs`	Retrieve 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.
`list-bulk-operations`	Retrieve a paginated list of bulk operations from Shopify. Use when you need to view the history of bulk operations, check their statuses, or…
`list-channels`	Retrieves a list of sales channels available in the Shopify store using GraphQL.
`list-checkout-profiles`	Query checkout profiles from Shopify. Use when you need to retrieve checkout profile configurations including branding settings and UI extensions.
`list-collection-products`	Retrieve a list of products belonging to a collection. Use when you need to fetch products from a specific Shopify collection.
`list-collects`	Retrieve a list of collects (product-collection associations).
`list-comments`	Retrieve a list of comments from Shopify. Use when you need to get comments with optional filtering by dates, status, or pagination.
`list-countries`	Retrieve a list of all countries where the merchant sells products with tax rates.
`list-currencies`	Retrieves a list of currencies enabled on a Shopify store. This action fetches all currencies that the merchant has enabled for multi-currency…
`list-custom-collections`	Retrieve 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.
`list-customer-orders`	Retrieves all orders for a specific customer from Shopify. Returns order details including line items, fulfillment status, payment information…
`list-customers`	Retrieve a list of customers from a Shopify store. Use when you need to fetch customer data with optional filtering by IDs, creation dates, update…
`list-draft-orders`	Retrieve a list of draft orders from Shopify. Use when you need to fetch draft orders with optional filtering by status, IDs, or update dates.
`list-inventory-levels`	Retrieves a list of inventory levels for specified items and locations.
`list-locations`	Retrieve 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.
`list-marketing-events`	Retrieves a paginated list of marketing events from a Shopify store.
`list-order`	Retrieves a list of orders from Shopify with optional filtering by status, dates, and other criteria.
`list-order-refunds`	Retrieve a list of refunds for a Shopify order. Use when you need to check refund history for a specific order.
`list-orders`	Retrieves a list of orders from Shopify. Use when you need to fetch multiple orders with optional filtering by status, financial status, fulfillment…
`list-pages`	Retrieve a list of all pages from a Shopify store. Use when you need to fetch page content or metadata.
`list-payment-terms-templates`	Query payment terms templates from Shopify using the GraphQL API.
`list-product-images`	Retrieve all images for a Shopify product. Use when you need to get the complete list of images associated with a specific product.
`list-product-variants`	Retrieve all variants for a specified product. Use when you need to list product variants with optional filtering by fields or pagination.
`list-resource-feedbacks`	Retrieves the current resource feedback for the shop. Resource feedback is how your app communicates its setup/configuration status to merchants via the Shopify admin.
`list-script-tags`	Retrieves a list of all script tags. Use when you need to fetch all script tags or filter by URL, date range, or other criteria.
`list-theme-assets`	Retrieves metadata for theme assets (files that make up a theme: templates, images, stylesheets, snippets).
`list-transactions`	Retrieves all transactions for a specific order. Use when you need to view payment exchanges for an order.
`mark-comment-as-not-spam`	Marks a comment as not spam in Shopify, restoring it to published or unapproved state.
`mark-comment-as-spam`	Mark a comment as spam in Shopify. Use when you need to flag a comment as spam and remove it from visibility.
`modify-existing-product-variant`	Update an existing product variant in Shopify. Use when you need to modify variant properties like price, SKU, weight, or inventory settings.
`modify-existing-webhook`	Modify an existing webhook subscription’s address or other properties.
`move-fulfillment-order`	Move a fulfillment order from one merchant managed location to another.
`pin-metafield-definition`	Pin a metafield definition in Shopify admin. Use when you need to organize metafields by pinning them to control their display order and visibility.
`query-app-by-key`	Query app information by API key using Shopify’s GraphQL Admin API.
`query-business-entities`	Retrieve all business entities associated with the shop. Use when you need to view business entities for assigning to markets, managing payment…
`query-business-entity`	Query business entity information from Shopify. Use when you need to retrieve business entity details such as company name, address, and payment account information.
`query-catalogs`	Queries catalogs from Shopify using the GraphQL Admin API. Catalogs control which products are published and how they’re priced in different contexts…
`query-channel`	Query a single Shopify channel by ID. Use when you need to retrieve detailed information about a specific sales channel including its associated app…
`query-consent-policy-regions`	Query the list of countries and regions for which consent policies can be created in Shopify.
`query-current-app-installation`	Query the currently authenticated app installation on a Shopify store.
`query-current-bulk-operation`	Query the current Shopify bulk operation status. Use when you need to check if a bulk operation is running or to retrieve the status and results of…
`query-customer-account-pages`	Queries customer account pages from Shopify using the GraphQL Admin API.
`query-deletion-events`	Query deletion events from Shopify. Use when you need to retrieve records of deleted resources such as products or collections.
`query-disputes`	Query Shopify Payments disputes using the GraphQL Admin API.
`query-domain`	Query a specific domain by its ID from Shopify. Use when you need to retrieve domain details including host, URL, SSL status, and localization settings.
`query-events`	Query events from Shopify using the GraphQL Admin API. Events track actions performed on store resources like products, orders, collections, customers, and more.
`query-events-count`	Query the count of events in Shopify using the GraphQL Admin API.
`query-job`	Query a single job by its ID using Shopify’s GraphQL API. Use when you need to check the status of an asynchronous job.
`query-metafield-definition`	Query metafield definition details by ID using Shopify’s GraphQL Admin API.
`query-metafield-definitions`	Query metafield definitions from Shopify using the GraphQL Admin API.
`query-metafield-definition-types`	Queries all available metafield definition types from Shopify using the GraphQL Admin API.
`query-node`	Query any Shopify resource by its global ID using the node query.
`query-nodes`	Query nodes by their IDs from the Shopify GraphQL Admin API.
`query-online-store`	Query online store settings from Shopify using the GraphQL Admin API.
`query-product-duplicate-job`	Query a product duplicate job by its ID using Shopify’s GraphQL API.
`query-public-api-versions`	Query available public API versions from Shopify using the GraphQL Admin API.
`query-publication`	Query a single publication by ID using Shopify’s GraphQL Admin API.
`query-server-pixel`	Query the server pixel configuration in Shopify. Use when you need to retrieve the current server pixel settings including its ID, status, and webhook endpoint address.
`query-shop`	Retrieve shop information using the Shopify GraphQL Admin API.
`query-shop-billing-preferences`	Query the shop’s billing preferences from Shopify using the GraphQL Admin API.
`query-functions`	Query Shopify Functions owned by the API client installed on the shop.
`query-shop-pay-payment-request-receipts`	Query Shop Pay payment request receipts from Shopify using the GraphQL Admin API.
`query-standard-metafield-definition-templates`	Query standard metafield definition templates from Shopify using the GraphQL Admin API.
`query-taxonomy`	Query Shopify’s product taxonomy using the GraphQL Admin API.
`query-webhook-subscription`	Retrieve webhook subscription details by ID using the Shopify GraphQL Admin API.
`query-webhook-subscriptions`	Query webhook subscriptions from Shopify using the GraphQL Admin API.
`receive-count-of-all-product-images`	Retrieves the total count of images for a Shopify product. Use when you need to know how many images are associated with a specific product.
`receive-single-fulfillment`	Retrieve detailed information about a specific fulfillment for an order.
`receive-single-webhook`	Retrieves detailed information about a specific webhook subscription by its ID.
`release-fulfillment-hold`	Releases the fulfillment hold on a fulfillment order, allowing fulfillment work to proceed.
`release-fulfillment-order-hold`	Release all fulfillment holds on a fulfillment order. Use when you need to resume fulfillment work after holds have been resolved.
`reopen-closed-order`	Reopens a previously closed Shopify order. Use when an order needs to be modified after being closed.
`restore-comment`	Restores a previously removed comment, changing its status back to ‘published’.
`retrieve-specific-metafield`	Retrieve a metafield by specifying the ID. Use when you need to fetch a specific metafield from any Shopify resource (products, customers, orders, etc.).
`retrieve-list-metafields-resource-s-endpoint`	Retrieve metafields attached to any Shopify resource by using the resource’s endpoint.
`retrieves-list-of-abandoned-checkouts`	Retrieves a list of abandoned checkouts from Shopify. Use this when you need to access abandoned checkout data for recovery campaigns, remarketing, or analytics.
`retrieves-list-of-all-article-tags`	Retrieves all article tags used across all blogs in the Shopify shop.
`retrieves-list-of-price-rules`	Retrieve a list of price rules from a Shopify store. Use when you need to view all discount pricing rules with optional filtering by date ranges and usage.
`retrieves-list-of-products`	Retrieve a list of products from Shopify. Use when you need to fetch products with filtering options like status, vendor, product type, or date ranges.
`retrieves-list-of-webhooks`	Retrieve a list of webhook subscriptions for a Shopify shop.
`retrieves-order-count`	Retrieves 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.).
`retrieves-single-location-by-its-id`	Retrieves detailed information about a specific Shopify location by its ID.
`retrieves-single-order-risk-by-its-id`	Retrieves 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…
`retrieves-single-price-rule`	Retrieves a single price rule by its unique identifier. Use when you need to get detailed information about a specific discount rule including its…
`retrieves-single-product`	Retrieves 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.
`retrieves-specific-fulfillment-event`	Retrieves a specific fulfillment event by its ID. DEPRECATED: This endpoint is deprecated as of Shopify REST Admin API 2024-10.
`retrieves-list-all-article-tags-specific-blog`	Retrieve 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…
`retrieves-list-discount-codes-discount-code`	Retrieve a list of discount codes for a discount code creation job.
`retrieves-list-storefront-access-tokens-that-have`	Retrieves a list of storefront access tokens that have been issued for the shop.
`retrieve-specific-fulfillment-order`	Retrieve a specific fulfillment order by its ID. Use when you need detailed information about a particular fulfillment order including line items…
`retrieves-shop-s-configuration`	Retrieve the shop’s configuration and general business settings.
`revoke-app-access-scopes`	Revoke previously granted access scopes from an app installation.
`run-bulk-mutation-operation`	Create and run a bulk operation to import data asynchronously by executing a GraphQL mutation multiple times.
`run-bulk-operation-query`	Create and start a Shopify GraphQL bulk operation for asynchronous data fetching.
`searches-for-gift-cards`	Search for gift cards that match a supplied query. Use when searching for gift cards by various indexed fields including created_at, updated_at…
`send-customer-account-invite`	Sends an account activation invite email to an existing customer, allowing them to set up their online store account.
`send-customer-invite`	Sends an account invitation email to a customer, allowing them to create or activate their Shopify account.
`send-invoice`	Send 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.
`set-default-customer-address`	Set a specific address as the default address for a customer.
`set-fulfillment-orders-deadline`	Set the latest fulfillment deadline for multiple fulfillment orders.
`set-inventory-level`	Set 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.
`set-metafields`	Create or update multiple metafields in a single operation using the metafieldsSet GraphQL mutation.
`trigger-flow`	Trigger Shopify Flow workflows that begin with the specified trigger handle.
`update-app-subscription-line-item`	Update the capped amount on usage-based billing for an app subscription line item.
`update-article`	Update an existing article in a Shopify blog. Use when you need to modify article properties such as title, content, tags, or publication status.
`update-blog`	Updates an existing blog’s configuration in your Shopify store.
`update-comment`	Update 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.
`update-countries-param-country-id`	DEPRECATED: Updates an existing country’s tax configuration in Shopify.
`update-countries-param-country-id-provinces-param-pr`	Update Province Tax Information
`update-country`	Update an existing country’s tax configuration in Shopify. Use when you need to modify tax settings for a country.
`update-custom-collection`	Update an existing custom collection in Shopify. Use when you need to modify properties of a custom collection such as title, description…
`update-customer`	Update an existing customer in Shopify. Use when you need to modify customer details such as name, email, phone, tags, addresses, or marketing consent preferences.
`update-customer-address`	Updates an existing address for a Shopify customer. This action allows you to modify address details such as street address, city, province, country…
`update-customers-param-customer-id-addresses-set`	Performs bulk operations on multiple customer addresses. Currently supports the ‘destroy’ operation to delete multiple addresses at once.
`update-draft-order`	Update an existing draft order in Shopify. Use when you need to modify draft order details like customer information, line items, addresses…
`update-event-bridge-webhook-subscription`	Update an Amazon EventBridge webhook subscription in Shopify.
`update-fulfillment-tracking`	Updates tracking information (carrier company, tracking number, or custom URL) for an existing fulfillment.
`update-gift-card`	Updates 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.
`update-inventory-item`	Updates properties of an inventory item in Shopify. An inventory item represents the physical good behind a product variant, containing metadata like…
`update-marketing-event`	Updates an existing marketing event in Shopify. UPDATABLE FIELDS: remote_id, budget, currency, budget_type, started_at, ended_at, scheduled_to_end_at.
`update-metafield`	Update an existing metafield for a blog. Use when you need to modify metafield properties like value, type, or description for a blog resource.
`update-metafield-by-id`	Update an existing Shopify metafield by its ID. Use when you need to modify metafield properties like value, type, or description.
`update-metafield-definition`	Update a Shopify metafield definition’s configuration including name, description, validation rules, access settings, and capabilities.
`update-metafield-generic`	Update an existing metafield for any Shopify resource type. Use when you need to modify metafield properties like value, type, or description for…
`update-metafield-resource`	Update an existing metafield for any Shopify resource. Use when modifying metafield properties like value, type, or description for products…
`update-order`	Updates mutable fields on an existing Shopify order.
`update-order-risk`	Updates an order risk assessment for fraud detection in Shopify.
`update-page`	Updates an existing page in a Shopify store. Use this to modify page properties such as title, HTML content (body_html), author, URL handle…
`update-price-rule`	Update an existing price rule (discount) in Shopify. Use when you need to modify price rule properties like title, value, dates, or prerequisites.
`update-product-image`	Modify an existing product image. Use when you need to update image properties such as position, alt text, or variant associations.
`update-product-metafield`	Updates an existing metafield for a specific Shopify product.
`update-products-param-product-id`	DEPRECATED: Use SHOPIFY_UPDATES_PRODUCT instead. Update an existing Shopify product including its variants and images.
`update-product-variants-bulk`	Updates many product variants (20-50+) in one asynchronous Shopify bulk mutation job.
`update-province`	Updates an existing province for a country in Shopify. IMPORTANT: This endpoint is deprecated as of API version 2024-07.
`update-pub-sub-webhook-subscription`	Updates a Google Cloud Pub/Sub webhook subscription configuration.
`update-redirect`	Update an existing Shopify redirect. Use when you need to modify the path or target of a redirect.
`update-redirect-alt`	Update an existing Shopify redirect. Use when you need to modify the path or target of a redirect.
`updates-article`	DEPRECATED: Use SHOPIFY_UPDATE_ARTICLE instead. Update an existing article in a Shopify blog.
`updates-existing-discount-code`	Updates the code value of an existing discount code associated with a price rule.
`updates-product`	Updates a product and its variants and images. Use when modifying existing product details, pricing, variants, images, or SEO information.
`update-script-tag`	Modify an existing script tag in Shopify. Use when you need to update script properties like the source URL, display scope, or caching behavior.

Open Shopify in the console →

Getting started

Guides

Integrations and automations

Use cases

References

Connect it

Use it

Common tools

​Connect it

​Use it

​Common tools

Connect it

Use it

Common tools