- Category: ecommerce
- Auth: OAUTH2, S2S_OAUTH2
- Composio-managed OAuth available? No
- Tools: 407
- Triggers: 45
- Slug:
SHOPIFY - Version: 20261101_00
Frequently Asked Questions
How do I set up custom OAuth credentials for Shopify?
How do I set up custom OAuth credentials for Shopify?
Why am I seeing "App not found" when connecting Shopify?
Why am I seeing "App not found" when connecting Shopify?
Shopify order update 403s can be caused by missing read_all_orders scope
Shopify order update 403s can be caused by missing read_all_orders scope
read_all_orders before retrying.Tools
Accept Fulfillment Cancellation Request
Accept Fulfillment Cancellation Request
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
Output
Accept Fulfillment Request
Accept Fulfillment Request
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
Output
Activate One-Time Charge
Activate One-Time Charge
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
Output
Add product to custom collection (Deprecated)
Add product to custom collection (Deprecated)
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
sort_order is set to manual; ignored silently otherwise.Output
Add product to custom collection
Add product to custom collection
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
Output
Adjust inventory levels
Adjust inventory levels
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
Output
Apply fulfillment hold
Apply fulfillment hold
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
Output
Approve a comment
Approve a comment
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
Output
Bulk create products via GraphQL
Bulk create products via GraphQL
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
Output
Bulk delete customer addresses (Deprecated)
Bulk delete customer addresses (Deprecated)
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
Output
Delete metafields in bulk
Delete metafields in bulk
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
Output
Bulk delete metaobjects
Bulk delete metaobjects
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
Output
Run Shopify bulk query operation
Run Shopify bulk query operation
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
Output
Calculate a refund
Calculate a refund
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
Output
Cancel App Subscription
Cancel App Subscription
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
Output
Cancel Shopify bulk operation
Cancel Shopify bulk operation
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
Output
Cancel a fulfillment
Cancel a fulfillment
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
Output
Cancel a Fulfillment Order
Cancel a Fulfillment Order
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
Output
Cancel an order
Cancel an order
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
Output
Cancel Recurring Application Charge
Cancel Recurring Application Charge
Close Fulfillment Order
Close Fulfillment Order
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
Output
Close an order
Close an order
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
Output
Complete a draft order
Complete a draft order
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
Output
Connect inventory item to location
Connect inventory item to location
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
Output
Count articles in blog
Count articles in blog
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
Output
Get blogs count
Get blogs count
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
Retrieve count of custom collections (Deprecated)
Retrieve count of custom collections (Deprecated)
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
Output
Get draft orders count
Get draft orders count
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
Output
Count all the events (Deprecated)
Count all the events (Deprecated)
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
Output
Count fulfillments for order
Count fulfillments for order
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
Output
Retrieves a count of locations (Deprecated)
Retrieves a count of locations (Deprecated)
Count shop metafields
Count shop metafields
Count orders (Deprecated)
Count orders (Deprecated)
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
Output
Retrieve page count
Retrieve page count
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
Output
Count price rules
Count price rules
Count product images
Count product images
Count product listings
Count product listings
Retrieves a count of products
Retrieves a count of products
Count product variants
Count product variants
Receive a count of all webhooks (Deprecated)
Receive a count of all webhooks (Deprecated)
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
Output
Create a metafield
Create a metafield
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
Output
Create A New Product Image (Deprecated)
Create A New Product Image (Deprecated)
Create app subscription
Create app subscription
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
Output
Create Article
Create Article
Create Comment for Article
Create Comment for Article
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
Output
Create a new blog
Create a new blog
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
Output
Create carrier service
Create carrier service
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
Output
Create checkout payment
Create checkout payment
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
Output
Create Country
Create Country
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 insteadInput Parameters
Output
Create a custom collection
Create a custom collection
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
collection_id for subsequent operations instead of relying on the handle.Output
Create Customer
Create Customer
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
Output
Generate Customer Account Activation URL
Generate Customer Account Activation URL
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
Output
Create customer address
Create customer address
Create delegate access token
Create delegate access token
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
Output
Create Discount Code
Create Discount Code
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
Output
Create Discount Codes Batch
Create Discount Codes Batch
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
Output
Create a new draft order
Create a new draft order
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
Output
Create EventBridge webhook subscription
Create EventBridge webhook subscription
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
Output
Create Fulfillment
Create Fulfillment
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
Output
Create Fulfillment Event
Create Fulfillment Event
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
Output
Create Fulfillment Service
Create Fulfillment Service
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
Output
Create Gift Card
Create Gift Card
Create Marketing Event Engagements
Create Marketing Event Engagements
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
Output
Create Marketing Event
Create Marketing Event
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
Output
Create blog metafield
Create blog metafield
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
Output
Create Mobile Platform Application
Create Mobile Platform Application
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
Output
Create One-Time Application Charge
Create One-Time Application Charge
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
Output
Create an order
Create an order
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
Output
Create order risk
Create order risk
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 reviewInput Parameters
Output
Create transaction for order
Create transaction for order
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
Output
Create a new page
Create a new page
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
Output
Create Price Rule
Create Price Rule
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
Output
Create a product (Deprecated)
Create a product (Deprecated)
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
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.Output
Create Product Image (Deprecated)
Create Product Image (Deprecated)
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
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.data.response_data.product.id in prior responses.Output
Create product metafield
Create product metafield
Create Product Resource Feedback
Create Product Resource Feedback
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
Output
Create a new product variant
Create a new product variant
Create Pub/Sub webhook subscription
Create Pub/Sub webhook subscription
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
Output
Create recurring application charge
Create recurring application charge
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
Output
Create Redirect
Create Redirect
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
Output
Create order refund
Create order refund
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
Output
Create Resource Feedback
Create Resource Feedback
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
Output
Create a new product (Deprecated)
Create a new product (Deprecated)
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
Output
Create Script Tag
Create Script Tag
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
Output
Create Smart Collection
Create Smart Collection
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
Output
Create or Update Theme Asset
Create or Update Theme Asset
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 2025Input Parameters
Output
Create Storefront Access Token
Create Storefront Access Token
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
Output
Create Theme
Create Theme
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
Output
Create Usage Charge
Create Usage Charge
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
Output
Create Webhook (Deprecated)
Create Webhook (Deprecated)
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
Output
Create webhook subscription
Create webhook subscription
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
Output
Customize Recurring Application Charge
Customize Recurring Application Charge
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
Output
Delete Article
Delete Article
Delete a blog
Delete a blog
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
Output
Delete Carrier Service
Delete Carrier Service
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
Output
Remove product from collection
Remove product from collection
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
Output
Remove a comment
Remove a comment
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
Output
Delete country
Delete country
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
Output
Delete custom collection (Deprecated)
Delete custom collection (Deprecated)
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
Output
Delete a customer
Delete a customer
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
Output
Delete customer address
Delete customer address
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
Output
Delete dispute evidence file
Delete dispute evidence file
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
Output
Delete a draft order
Delete a draft order
Delete fulfillment event
Delete fulfillment event
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
Output
Remove fulfillment service
Remove fulfillment service
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
Output
Delete inventory levels
Delete inventory levels
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
Output
Delete a marketing event
Delete a marketing event
Delete a metafield by its ID
Delete a metafield by its ID
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
Output
Delete metaobject
Delete metaobject
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
Output
Delete metaobject definition
Delete metaobject definition
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
Output
Delete Mobile Platform Application
Delete Mobile Platform Application
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
Output
Delete an order
Delete an order
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
Output
Delete order risk
Delete order risk
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
Output
Delete a page
Delete a page
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
Output
Delete price rule
Delete price rule
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
Output
Delete a product
Delete a product
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
Output
Delete product image
Delete product image
Delete product metafield
Delete product metafield
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
Output
Remove product variant
Remove product variant
Delete redirect
Delete redirect
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
Output
Delete a custom collection
Delete a custom collection
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
Output
Delete a discount code
Delete a discount code
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
Output
Delete a saved search
Delete a saved search
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
Output
Delete Script Tag
Delete Script Tag
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
Output
Delete smart collection
Delete smart collection
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
Output
Delete Storefront Access Token
Delete Storefront Access Token
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
Output
Delete theme
Delete theme
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
Output
Delete theme asset
Delete theme asset
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
Output
Delete webhook subscription (Deprecated)
Delete webhook subscription (Deprecated)
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
Output
Delete webhook subscription
Delete webhook subscription
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
Output
Delete web presence
Delete web presence
Disable a Gift Card
Disable a Gift Card
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
Output
Enable standard metaobject definition
Enable standard metaobject definition
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
Output
Get abandonment
Get abandonment
Get abandonment by abandoned checkout ID
Get abandonment by abandoned checkout ID
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
Output
Get a list of access scopes
Get a list of access scopes
Get App
Get App
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
Output
Get app by handle
Get app by handle
Get app installation details
Get app installation details
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
Output
Get Application Charge By ID
Get Application Charge By ID
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
Output
Get Application Charges
Get Application Charges
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
Output
Get application credit
Get application credit
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
Output
Get application credits
Get application credits
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
Output
Get Article
Get Article
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
Output
Get Batch Discount Codes
Get Batch Discount Codes
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
Output
Get Single Blog
Get Single Blog
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
Output
Get bulk operation status
Get bulk operation status
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
Output
Get carrier service
Get carrier service
Get carrier services
Get carrier services
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
Get catalogs count
Get catalogs count
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
Output
Get checkout payment
Get checkout payment
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
Output
Get checkout profile
Get checkout profile
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
Output
Get checkouts count
Get checkouts count
Get collect by ID
Get collect by ID
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
Output
Get collection by ID
Get collection by ID
SHOPIFY_GET_COLLECTION_BY_IDRetrieves a specific Shopify collection by its collection_id, optionally filtering returned data to specified fields.Input Parameters
Output
Get collection by identifier
Get collection by identifier
Get collection listing
Get collection listing
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
Output
Get collects
Get collects
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
id,collection_id,product_id); if unspecified, all fields are returned.Output
Get collects count
Get collects count
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
Output
Get Comment
Get Comment
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
Output
Get count of comments
Get count of comments
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
Output
Get consent policy
Get consent policy
SHOPIFY_GET_CONSENT_POLICYQuery consent policies for privacy compliance requirements. Use when you need to retrieve customer consent requirements for specific regions or countries (GDPR, CCPA, etc.).Input Parameters
Output
Get Countries
Get Countries
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
Output
Get countries count
Get countries count
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
Get provinces count for country
Get provinces count for country
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
Output
Get Province for Country
Get Province for Country
Get country
Get country
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
Output
Get provinces for country
Get provinces for country
Get Currencies
Get Currencies
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
Get current user
Get current user
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
Get custom collection by ID
Get custom collection by ID
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
Output
Get custom collections
Get custom collections
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
Output
Get custom collections count
Get custom collections count
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
Output
Retrieve a single customer
Retrieve a single customer
SHOPIFY_GET_CUSTOMERRetrieve a single customer by their unique identifier. Use when you need to fetch detailed information about a specific customer.Input Parameters
Output
Get Customer Address
Get Customer Address
Get Customer Addresses
Get Customer Addresses
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
Output
Get customer orders
Get customer orders
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
Output
Get customers count
Get customers count
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
Output
Search Customers
Search Customers
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
Output
Get Discount Code
Get Discount Code
Retrieve Discount Code Creation Job
Retrieve Discount Code Creation Job
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
Output
Get discount codes count
Get discount codes count
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
Output
Get Discount Code Location
Get Discount Code Location
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
Output
Get dispute evidence
Get dispute evidence
Receive a single draft order
Receive a single draft order
Get event by ID
Get event by ID
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
Output
Get events list (Deprecated)
Get events list (Deprecated)
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
Output
Get fulfillments by fulfillment order
Get fulfillments by fulfillment order
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
Output
Get Fulfillment Event
Get Fulfillment Event
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
Output
Get fulfillment events
Get fulfillment events
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
Output
Get fulfillment orders for order (Deprecated)
Get fulfillment orders for order (Deprecated)
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
Output
Retrieves fulfillments by fulfillment order (Deprecated)
Retrieves fulfillments by fulfillment order (Deprecated)
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
Output
Get fulfillment order locations for move
Get fulfillment order locations for move
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
Output
Get fulfillment order locations for move (Deprecated)
Get fulfillment order locations for move (Deprecated)
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
Output
Get fulfillment orders for order
Get fulfillment orders for order
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
Output
Get Fulfillment Service
Get Fulfillment Service
Get Fulfillment Services
Get Fulfillment Services
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
Output
Get Gift Card By ID
Get Gift Card By ID
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
Output
Retrieves a list of gift cards
Retrieves a list of gift cards
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
Output
Retrieves a count of gift cards
Retrieves a count of gift cards
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
Output
Get Inventory Item
Get Inventory Item
Get Inventory Items
Get Inventory Items
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
Output
Get Inventory Levels
Get Inventory Levels
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
Output
Get Inventory Levels For Location
Get Inventory Levels For Location
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
Output
Get location
Get location
Get locations count
Get locations count
Retrieve a single marketing event
Retrieve a single marketing event
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
Output
Get marketing events count
Get marketing events count
Get blog metafields
Get blog metafields
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
Output
Get metafield by ID
Get metafield by ID
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
Output
Get metafields
Get metafields
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
Output
Get shop metafields count (Deprecated)
Get shop metafields count (Deprecated)
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
Get mobile platform application
Get mobile platform application
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
Output
Get order
Get order
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
Output
Retrieve order fulfillments
Retrieve order fulfillments
Get order list (Deprecated)
Get order list (Deprecated)
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
Output
Get specific refund for order
Get specific refund for order
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 approvalInput Parameters
Output
Get refunds for order
Get refunds for order
Get Order Risks (Deprecated)
Get Order Risks (Deprecated)
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
Output
Get order risks
Get order risks
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
Output
Get order by id (Deprecated)
Get order by id (Deprecated)
Get orders with filters
Get orders with filters
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
Output
Get order transactions count
Get order transactions count
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
Output
Get page by ID
Get page by ID
Get payment dispute
Get payment dispute
Get payments balance
Get payments balance
Get payments payout
Get payments payout
Get Policies
Get Policies
Get Price Rule
Get Price Rule
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
Output
Check Batch Listing Support for Price Rule
Check Batch Listing Support for Price Rule
Get Discount Codes for Price Rule
Get Discount Codes for Price Rule
Get product
Get product
Get product image
Get product image
Get Product Images (Deprecated)
Get Product Images (Deprecated)
SHOPIFY_GET_PRODUCT_IMAGESRetrieves all images for a Shopify product, specified by its product_id which must correspond to an existing product.Input Parameters
Output
Get product listing
Get product listing
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
Output
Get product metafield
Get product metafield
Get product metafields
Get product metafields
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
namespace and key together when targeting a specific metafield, since the same key can exist across multiple namespaces.Output
Get products (Deprecated)
Get products (Deprecated)
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
None), all products will be fetched.Output
Get products in collection (Deprecated)
Get products in collection (Deprecated)
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
Output
Get products (paginated)
Get products (paginated)
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
data.next_page_info in the response. Pass the value exactly as returned — any truncation or modification triggers a 400 error.Output
Receive a single product variant
Receive a single product variant
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
Output
Get recurring application charge
Get recurring application charge
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
Output
Get recurring application charges
Get recurring application charges
Retrieve a single redirect (Deprecated)
Retrieve a single redirect (Deprecated)
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
Output
Get redirect by ID
Get redirect by ID
Get redirects
Get redirects
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
Output
Get redirects count
Get redirects count
Retrieve a specific refund (Deprecated)
Retrieve a specific refund (Deprecated)
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
Output
Get Script Tag
Get Script Tag
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
Output
Get segments count
Get segments count
Get Shipping Zones
Get Shipping Zones
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
Output
Get shop billing address
Get shop billing address
Get Shop Configuration
Get Shop Configuration
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
Get Shop Details (Deprecated)
Get Shop Details (Deprecated)
Retrieve metafield by ID (Deprecated)
Retrieve metafield by ID (Deprecated)
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
Output
Retrieve metafields from resource endpoint (Deprecated)
Retrieve metafields from resource endpoint (Deprecated)
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
Output
Retrieve a single smart collection (Deprecated)
Retrieve a single smart collection (Deprecated)
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
Output
Get smart collection by ID
Get smart collection by ID
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
Output
Get smart collections
Get smart collections
Get smart collections count
Get smart collections count
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
Output
Get storefront access tokens
Get storefront access tokens
Get tender transactions
Get tender transactions
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
Output
Retrieve a single theme
Retrieve a single theme
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
Output
Get themes
Get themes
Get Theme Asset
Get Theme Asset
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
Output
Retrieve a specific transaction
Retrieve a specific transaction
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
Output
Get usage charge
Get usage charge
Get user
Get user
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
Output
Get Webhook
Get Webhook
SHOPIFY_GET_WEBHOOKRetrieves a single webhook subscription by its ID. Use when you need to get details of a specific webhook configuration.Input Parameters
Output
Get webhook subscriptions count
Get webhook subscriptions count
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
Output
Shopify GraphQL Admin execute
Shopify GraphQL Admin execute
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
Output
Shopify GraphQL collections and publication-ready collection reads
Shopify GraphQL collections and publication-ready collection reads
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
Output
Shopify GraphQL customers and customer search
Shopify GraphQL customers and customer search
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
Output
Shopify GraphQL discounts and discount search
Shopify GraphQL discounts and discount search
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
Output
Shopify GraphQL draft orders
Shopify GraphQL draft orders
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
Output
Shopify GraphQL inventory items and levels
Shopify GraphQL inventory items and levels
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
Output
Shopify GraphQL metafields and metaobjects
Shopify GraphQL metafields and metaobjects
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
Output
Shopify GraphQL orders and order search
Shopify GraphQL orders and order search
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
Output
Shopify GraphQL products, variants, media, and publishing
Shopify GraphQL products, variants, media, and publishing
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
id title handle status updatedAt variants(first: 10) { nodes { id title sku } }.Output
Execute Shopify GraphQL query
Execute Shopify GraphQL query
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
Output
Shopify GraphQL shop and app metadata
Shopify GraphQL shop and app metadata
SHOPIFY_GRAPH_QL_SHOPReads Shopify shop and app installation metadata using GraphQL, or executes a custom GraphQL document that may perform mutations.Input Parameters
Output
Shopify GraphQL webhook subscriptions
Shopify GraphQL webhook subscriptions
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
Output
Shopify GraphQL write operations
Shopify GraphQL write operations
SHOPIFY_GRAPH_QL_WRITE_OPERATIONSCanonical GraphQL write surface for Shopify orders, customers, inventory, discounts, collections, webhooks, fulfillments, metafields, and bulk operations.Input Parameters
Output
List abandoned checkouts
List abandoned checkouts
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
Output
Retrieves all application credits (Deprecated)
Retrieves all application credits (Deprecated)
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
Output
List assigned fulfillment orders
List assigned fulfillment orders
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
Output
List available locales
List available locales
Retrieve list of articles from blog
Retrieve list of articles from blog
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
Output
Retrieve a list of all blogs
Retrieve a list of all blogs
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
Output
List bulk operations
List bulk operations
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
before cursor. Maximum value is typically 250. Cannot be used with ‘first’.Output
List channels
List channels
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
Output
List checkout profiles
List checkout profiles
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
before cursor. Use for backward pagination. Mutually exclusive with ‘first’.Output
List collection listing product IDs
List collection listing product IDs
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
Output
List Collection Listings
List Collection Listings
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
Output
Retrieve products in collection
Retrieve products in collection
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
Output
Retrieve list of collects (Deprecated)
Retrieve list of collects (Deprecated)
Retrieve a list of comments
Retrieve a list of comments
Receive a list of all countries (Deprecated)
Receive a list of all countries (Deprecated)
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
Output
Retrieves a list of currencies enabled on a shop (Deprecated)
Retrieves a list of currencies enabled on a shop (Deprecated)
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
Retrieve custom collections (Deprecated)
Retrieve custom collections (Deprecated)
Get customer orders (Deprecated)
Get customer orders (Deprecated)
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
Output
Retrieves a list of customers
Retrieves a list of customers
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
Output
List Deprecated API Calls
List Deprecated API Calls
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
Retrieve list of draft orders
Retrieve list of draft orders
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
Output
Retrieves a List of Inventory Levels (Deprecated)
Retrieves a List of Inventory Levels (Deprecated)
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
Output
List Location Inventory Levels
List Location Inventory Levels
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
Output
List locations
List locations
Retrieve all marketing events
Retrieve all marketing events
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
Output
List Mobile Platform Applications
List Mobile Platform Applications
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
List orders (Deprecated)
List orders (Deprecated)
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
Output
Retrieve refunds for order (Deprecated)
Retrieve refunds for order (Deprecated)
Retrieves a list of orders (Deprecated)
Retrieves a list of orders (Deprecated)
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
Output
Retrieve list of pages
Retrieve list of pages
List Payment Disputes
List Payment Disputes
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
Output
List Payments Balance Transactions
List Payments Balance Transactions
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
Output
List Payments Payouts
List Payments Payouts
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
Output
List Payment Terms Templates
List Payment Terms Templates
Receive A List Of All Product Images
Receive A List Of All Product Images
SHOPIFY_LIST_PRODUCT_IMAGESRetrieves a page of images for a Shopify product, with optional limit, since-ID and field selection.Input Parameters
Output
List Product Listing Product IDs
List Product Listing Product IDs
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
Output
List Product Listings
List Product Listings
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
Output
List Product Resource Feedback
List Product Resource Feedback
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
Output
Get product variants
Get product variants
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
Output
Get resource feedback
Get resource feedback
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
List Theme Assets (Deprecated)
List Theme Assets (Deprecated)
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
Output
Retrieve order transactions
Retrieve order transactions
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
Output
List usage charges
List usage charges
List Users
List Users
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
Output
Mark Comment as Not Spam
Mark Comment as Not Spam
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
Output
Mark Comment as Spam
Mark Comment as Spam
Modify an existing product variant
Modify an existing product variant
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
Output
Modify existing webhook (Deprecated)
Modify existing webhook (Deprecated)
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
Output
Move Fulfillment Order to New Location
Move Fulfillment Order to New Location
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
Output
Open Fulfillment Order
Open Fulfillment Order
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
Output
Pin metafield definition
Pin metafield definition
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
Output
Publish collection listing
Publish collection listing
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
Output
Publish product listing
Publish product listing
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
Output
Query app by API key
Query app by API key
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
Output
Query business entities
Query business entities
Query business entity
Query business entity
Query catalogs
Query catalogs
Query channel by ID
Query channel by ID
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
Output
Query consent policy regions
Query consent policy regions
Query current app installation
Query current app installation
Query current Shopify bulk operation
Query current Shopify bulk operation
Query customer account pages
Query customer account pages
Query deletion events
Query deletion events
SHOPIFY_QUERY_DELETION_EVENTSQuery Shopify deletion events for products and collections, with pagination, sorting, and filtering options.Input Parameters
before cursor. Use for backward pagination. Maximum value: 250.Output
Query disputes
Query disputes
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
Output
Query domain
Query domain
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
Output
Query events
Query events
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
Output
Query events count
Query events count
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
Output
Query job
Query job
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
Output
Query metafield definition by ID
Query metafield definition by ID
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
Output
Query metafield definitions
Query metafield definitions
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
Output
Query metafield definition types
Query metafield definition types
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
Query node by ID
Query node by ID
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
Output
Query nodes by IDs
Query nodes by IDs
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
Output
Query online store
Query online store
Query product duplicate job
Query product duplicate job
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
Output
Query public API versions
Query public API versions
Query publication by ID
Query publication by ID
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
Output
Query server pixel configuration
Query server pixel configuration
Query Shop (GraphQL)
Query Shop (GraphQL)
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
Output
Query shop billing preferences
Query shop billing preferences
Query Shopify Functions
Query Shopify Functions
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
Output
Query Shop Pay payment request receipts
Query Shop Pay payment request receipts
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
Output
Query standard metafield templates
Query standard metafield templates
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
Output
Query taxonomy
Query taxonomy
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
Output
Query webhook subscription by ID
Query webhook subscription by ID
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
Output
Query webhook subscriptions
Query webhook subscriptions
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
Output
Get product images count (Deprecated)
Get product images count (Deprecated)
Receive a single fulfillment
Receive a single fulfillment
Receive a single webhook (Deprecated)
Receive a single webhook (Deprecated)
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
Output
Reject fulfillment cancellation request
Reject fulfillment cancellation request
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
Output
Reject Fulfillment Request
Reject Fulfillment Request
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
Output
Release fulfillment hold
Release fulfillment hold
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
Output
Release fulfillment order hold (Deprecated)
Release fulfillment order hold (Deprecated)
Reopen a closed order
Reopen a closed order
Reschedule Fulfillment Order
Reschedule Fulfillment Order
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
Output
Restore Comment
Restore Comment
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
Output
Retrieve a specific metafield (Deprecated)
Retrieve a specific metafield (Deprecated)
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
Output
Get resource metafields
Get resource metafields
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
Output
Retrieve abandoned checkouts (Deprecated)
Retrieve abandoned checkouts (Deprecated)
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
Output
Get Price Rules List
Get Price Rules List
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
Output
Retrieve a list of products (Deprecated)
Retrieve a list of products (Deprecated)
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
Output
Retrieves a list of webhooks (Deprecated)
Retrieves a list of webhooks (Deprecated)
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
Output
Retrieves an order count (Deprecated)
Retrieves an order count (Deprecated)
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
Output
Retrieve a single location by its ID (Deprecated)
Retrieve a single location by its ID (Deprecated)
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
Output
Get order risk by ID
Get order risk by ID
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
Output
Retrieve Single Price Rule (Deprecated)
Retrieve Single Price Rule (Deprecated)
Retrieve a single product (Deprecated)
Retrieve a single product (Deprecated)
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
Output
Retrieve Specific Fulfillment Event (Deprecated)
Retrieve Specific Fulfillment Event (Deprecated)
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
Output
Retrieve Discount Codes for Batch Job (Deprecated)
Retrieve Discount Codes for Batch Job (Deprecated)
Retrieve storefront access tokens (Deprecated)
Retrieve storefront access tokens (Deprecated)
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
Retrieve specific fulfillment order
Retrieve specific fulfillment order
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
Output
Retrieve Shop Configuration (Deprecated)
Retrieve Shop Configuration (Deprecated)
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
Output
Revoke app access scopes
Revoke app access scopes
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
Output
Run bulk mutation operation
Run bulk mutation operation
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
Output
Run Shopify bulk operation query
Run Shopify bulk operation query
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
Output
Search Gift Cards
Search Gift Cards
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
Output
Send Account Invite to Customer (Deprecated)
Send Account Invite to Customer (Deprecated)
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
Output
Send Customer Account Invite
Send Customer Account Invite
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
Output
Send an invoice
Send an invoice
Set Default Customer Address
Set Default Customer Address
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
Output
Set Fulfillment Orders Deadline
Set Fulfillment Orders Deadline
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
Output
Set inventory level
Set inventory level
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
Output
Set metafields
Set metafields
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
Output
Submit Fulfillment Cancellation Request
Submit Fulfillment Cancellation Request
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
Output
Submit Fulfillment Request
Submit Fulfillment Request
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
Output
Trigger Shopify Flow
Trigger Shopify Flow
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
Output
Unpublish collection listing
Unpublish collection listing
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
Output
Unpublish product listing
Unpublish product listing
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
Output
Update app subscription line item capped amount
Update app subscription line item capped amount
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
Output
Update Article
Update Article
Modify an existing blog
Modify an existing blog
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
Output
Update carrier service
Update carrier service
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
Output
Update Comment
Update Comment
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
Output
Update Country (Deprecated)
Update Country (Deprecated)
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
Output
Update Province Tax Information
Update Province Tax Information
SHOPIFY_UPDATE_COUNTRIES_PARAM_COUNTRY_ID_PROVINCES_PARAM_PRUpdate Province Tax InformationInput Parameters
Output
Update Country
Update Country
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
Output
Update custom collection
Update custom collection
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
Output
Update Customer
Update Customer
Update Customer Address
Update Customer Address
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 accountsInput Parameters
Output
Bulk delete customer addresses
Bulk delete customer addresses
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
Output
Update dispute evidence
Update dispute evidence
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
Output
Modify an existing draft order
Modify an existing draft order
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
Output
Update EventBridge webhook subscription
Update EventBridge webhook subscription
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
Output
Update Fulfillment Service
Update Fulfillment Service
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
Output
Update Fulfillment Tracking
Update Fulfillment Tracking
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
Output
Update an Existing Gift Card
Update an Existing Gift Card
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
Output
Update inventory item
Update inventory item
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
Output
Update Marketing Event
Update Marketing Event
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
Output
Update blog metafield (Deprecated)
Update blog metafield (Deprecated)
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
Output
Update metafield by ID
Update metafield by ID
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
Output
Update metafield definition
Update metafield definition
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
Output
Update a metafield (Deprecated)
Update a metafield (Deprecated)
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
Output
Update a metafield (Deprecated)
Update a metafield (Deprecated)
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
Output
Update Mobile Platform Application
Update Mobile Platform Application
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
Output
Update Order
Update Order
Update order risk
Update order risk
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
Output
Update Page
Update Page
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
Output
Update Price Rule
Update Price Rule
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
Output
Update Product Image
Update Product Image
Update product metafield
Update product metafield
SHOPIFY_UPDATE_PRODUCT_METAFIELDUpdates an existing metafield for a specific Shopify product.Input Parameters
Output
Update Product
Update Product
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
Output
Bulk update product variants via GraphQL
Bulk update product variants via GraphQL
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
Output
Update Province for Country (Deprecated)
Update Province for Country (Deprecated)
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
Output
Update Pub/Sub webhook subscription
Update Pub/Sub webhook subscription
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
Output
Update redirect
Update redirect
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
Output
Update redirect (Deprecated)
Update redirect (Deprecated)
SHOPIFY_UPDATE_REDIRECT_ALTUpdate an existing Shopify redirect. Use when you need to modify the path or target of a redirect.Input Parameters
Output
Updates An Article (Deprecated)
Updates An Article (Deprecated)
Updates An Existing Discount Code
Updates An Existing Discount Code
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
Output
Update a product (Deprecated)
Update a product (Deprecated)
Update Script Tag
Update Script Tag
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
Output
Update a metafield (Deprecated)
Update a metafield (Deprecated)
SHOPIFY_UPDATE_SHOP_METAFIELDUpdate an existing metafield’s value and type by its numeric ID using the Shopify REST Admin API.Input Parameters
Output
Update Smart Collection
Update Smart Collection
SHOPIFY_UPDATE_SMART_COLLECTIONUpdate an existing smart collection. Use when you need to modify a smart collection’s properties, rules, or settings.Input Parameters
Output
Update smart collection (Deprecated)
Update smart collection (Deprecated)
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
Output
Update smart collection product order
Update smart collection product order
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
Output
Modify existing theme
Modify existing theme
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
Output
Update webhook subscription
Update webhook subscription
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
Output
Upload dispute evidence file
Upload dispute evidence file
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
Output
Triggers
Bulk Operation Finished
Bulk Operation Finished
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
ACCESS_DENIED, INTERNAL_SERVER_ERROR, TIMEOUT. Null when it succeeded.Collection Created
Collection Created
SHOPIFY_COLLECTION_CREATEDType: webhookTriggers when a collection is created. Automated collections carry rules and disjunctive; manual ones omit both.Payload
true) or every rule (false). Absent on manual collections.Collection Deleted
Collection Deleted
Collection Updated
Collection Updated
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
true) or every rule (false). Absent on manual collections.Customer Segment Created
Customer Segment Created
Customer Segment Deleted
Customer Segment Deleted
Customer Segment Updated
Customer Segment Updated
Discount Code Added
Discount Code Added
Discount Code Removed
Discount Code Removed
Discount Created
Discount Created
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
gid://shopify/DiscountCodeNode/1577218769054. Discounts have no numeric id on this topic, so this is the identifier to use with the Admin GraphQL API.Discount Deleted
Discount Deleted
Discount Updated
Discount Updated
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
gid://shopify/DiscountCodeNode/1577218769054. Discounts have no numeric id on this topic, so this is the identifier to use with the Admin GraphQL API.Inventory Item Created
Inventory Item Created
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
Inventory Item Deleted
Inventory Item Deleted
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
harmonized_system_code for particular destination countries.Inventory Item Updated
Inventory Item Updated
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
Inventory Level Updated
Inventory Level Updated
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
SHOPIFY_LIST_LOCATIONS to find location ids. Leave unset to deliver every location.Payload
inventory_item_id to find the product.Inventory Shipment Created
Inventory Shipment Created
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
gid://shopify/InventoryShipment/3256352926. Shipments have no numeric id on this topic.Inventory Shipment In Transit
Inventory Shipment In Transit
Inventory Shipment Items Received
Inventory Shipment Items Received
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
Inventory Shipment Tracking Updated
Inventory Shipment Tracking Updated
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
shipment_id, unlike the other shipment topics which use id.Inventory Stocked At Location
Inventory Stocked At Location
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
SHOPIFY_LIST_LOCATIONS to find location ids. Leave unset to deliver every location.Payload
inventory_item_id to find the product.Inventory Transfer Ready To Ship
Inventory Transfer Ready To Ship
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
gid://shopify/InventoryTransfer/6167298206. Transfers have no numeric id on this topic.Inventory Unstocked At Location
Inventory Unstocked At Location
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
SHOPIFY_LIST_LOCATIONS to find location ids. Leave unset to deliver every location.Payload
inventory_item_id to find the product.Location Activated
Location Activated
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
Location Created
Location Created
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
Location Deactivated
Location Deactivated
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
Location Deleted
Location Deleted
Location Updated
Location Updated
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
Market Created
Market Created
Market Updated
Market Updated
Metafield Definition Created
Metafield Definition Created
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
not_filterable. Shopify sends this alongside admin_filterable_status.custom. Namespace and key together identify a metafield on a resource.Product, Collection, Shop — not the GraphQL enum casing.0 when it is not pinned.Metafield Definition Deleted
Metafield Definition Deleted
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
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.Metafield Definition Updated
Metafield Definition Updated
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
not_filterable. Shopify sends this alongside admin_filterable_status.custom. Namespace and key together identify a metafield on a resource.Product, Collection, Shop — not the GraphQL enum casing.0 when it is not pinned.Product Created
Product Created
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
active, draft or archived. Leave unset to deliver every state.Payload
new, sale. Shopify sends this as text, not an array.bold for product.bold.liquid. Null when the default template is used.Product Deleted
Product Deleted
Product Updated
Product Updated
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
active, draft or archived. Leave unset to deliver every state.Payload
new, sale. Shopify sends this as text, not an array.bold for product.bold.liquid. Null when the default template is used.Product Variant Back In Stock
Product Variant Back In Stock
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
gid://shopify/ProductVariant/48209618862238. This is the id form the Admin GraphQL API takes.9.99. Shopify sends money as strings to avoid float rounding.Small / Blue. Single-variant products get Default Title.Product Variant Out Of Stock
Product Variant Out Of Stock
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
gid://shopify/ProductVariant/48209618862238. This is the id form the Admin GraphQL API takes.9.99. Shopify sends money as strings to avoid float rounding.Small / Blue. Single-variant products get Default Title.Shipping Profile Created
Shipping Profile Created
Shipping Profile Deleted
Shipping Profile Deleted
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
Shipping Profile Updated
Shipping Profile Updated
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
Shop Settings Updated
Shop Settings Updated
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
location_id on the inventory topics.Store Language Added
Store Language Added
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
fr or pt-BR. This is the identifier Shopify uses for the store’s locales.Store Language Removed
Store Language Removed
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
fr or pt-BR. This is the identifier Shopify uses for the store’s locales.Store Language Updated
Store Language Updated
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
fr or pt-BR. This is the identifier Shopify uses for the store’s locales.