Shopify

Adds a product to an existing *custom collection*, optionally specifying its `position` if the collection is manually sorted.

Tool to add 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.

Tool to adjust 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.

Applies 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.

Tool to approve a comment and publish it to the blog. Use when you need to approve pending comments.

Creates many products (20-50+) in one asynchronous Shopify bulk mutation job. Uses stagedUploadsCreate for JSONL upload, then bulkOperationRunMutation with productCreate, polling until completion and returning per-row success/errors.

Tool to calculate refund transactions based on line items and shipping for a Shopify order. Use when you need to determine the refund amount before creating an actual refund. The response includes suggested_refund transactions that must be changed to 'refund' kind before submission.

Tool to cancel a fulfillment order in Shopify. Use when you need to mark a fulfillment order as cancelled. Note that this cancels the order within Shopify but does not communicate the cancellation to the fulfillment service.

Cancels 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.

Tool to cancel an existing fulfillment by ID. Use when a fulfillment needs to be cancelled and line items reverted to unfulfilled state. This action is irreversible.

Cancels a fulfillment order and creates a replacement order for remaining items. Use when you need to cancel an existing fulfillment order. The original order will be marked as closed, and a new open fulfillment order will be created for any remaining unfulfilled items.

Tool to cancel an existing order in Shopify. Use when you need to cancel an order and optionally refund and restock items.

Closes an open Shopify order. Use when all line items have been fulfilled or canceled and all financial transactions are complete.

Closes an open order that has been fulfilled. Use when all line items have been fulfilled and all financial transactions are complete.

Tool to complete 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.

Retrieves a count of all articles from a blog. Use when you need to know how many articles exist in a specific blog, optionally filtered by creation, publication, or update dates and publication status.

Retrieves 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.

Retrieves the total count of locations in a Shopify store. Use when you need to determine how many physical or virtual locations are configured.

Retrieves a count of metafields attached to a blog. Use when you need to know how many metafields are associated with a specific blog resource.

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.

Retrieves a count of all price rules. Use when you need to determine how many price rules (discount campaigns) are configured in the store.

Retrieves the total count of images for a Shopify product, useful for inventory management or display logic; the provided `product_id` must exist in the store.

Retrieves the total count of variants for a Shopify product. Use when you need to know how many variants exist for a specific product.

Retrieves a count of all script tags. Use when you need to know how many script tags are configured, optionally filtered by URL.

Retrieves a count of existing webhook subscriptions. Use when you need to know how many webhooks are configured, optionally filtered by address or topic.

Tool to create a metafield for any Shopify resource. Use when you need to attach custom metadata to products, customers, orders, collections, or other supported resources.

Tool to create 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.

Tool to create a draft order in Shopify. Use when you need to create orders in draft state using product variant line items or custom line items. Draft orders are useful for creating orders on behalf of customers, generating invoices, or reserving inventory.

Tool to create a static web page in Shopify. Use when you need to add long-term static content like About Us, Contact, or Privacy Policy pages. The title and body_html fields are required.

Tool to create a new product image for a Shopify product. Use when you need to add an image to a product by providing either an image URL or base64-encoded image data. Products can have up to 250 images in PNG, GIF, or JPG formats.

Tool to create a new product variant for an existing product. Use when adding a new variant with specific option values (like size, color). Each product can have up to 3 options and 100 variants maximum.

Tool to create a new webhook subscription by specifying both an address and a topic. Use when you need to set up notifications for specific events in a Shopify store. Both address and topic are mandatory parameters.

Tool to create an article for a blog in Shopify. Use when you need to add blog content to a specific blog. The title field is mandatory - requests without titles return a 422 error.

Tool to create 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.

Tool to create 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. Note: As of API version 2020-10, the tax field is deprecated.

Tool to create a country with tax rate configuration in Shopify. Use when you need to add a new country to the store's tax settings.

Tool to create a new custom collection in Shopify. Use when you need to manually curate and group products for easier store browsing. Custom collections require a title and support optional fields like description, image, publication settings, and sort order.

Tool to create a new customer in Shopify. Use when you need to add a new customer record to the store.

Tool to generate an account activation URL for a customer whose account is not yet enabled. Use when importing customers in bulk and need to send activation emails. The URL is for one-time use and expires after 30 days. Generating a new URL invalidates any previously generated URL for the same customer.

Tool to create a new address for a customer. Use when you need to add an address to an existing customer's address list.

Tool to create a fulfillment for one or many fulfillment orders. Use when you need to fulfill line items in orders assigned to a merchant-managed location or third-party fulfillment service.

Tool to create a fulfillment event for tracking shipment status updates. Use when you need to update the tracking status of an order's fulfillment.

Tool to hold fulfillment of a Shopify fulfillment order. Use when you need to halt fulfillment work due to payment issues, fraud risk, address problems, or inventory shortages.

Tool to create a gift card for a Shopify store. Use when you need to issue a new gift card with a specified value. Requires write_gift_cards access scope. Gift card codes can only be retrieved at creation time.

Tool to adjust 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.

Tool to connect an inventory item to a location by creating an inventory level. Use when you need to make an inventory item available at a specific location.

Tool to set inventory level for an item at a location. Use when you need to establish or update inventory quantity for a specific item at a designated location. If the location isn't already connected, the connection occurs automatically.

Tool to create a metafield for a blog resource. Use when you need to attach additional information to Shopify blog resources.

Tool to create a new metafield for a resource. Use when you need to attach additional information to Shopify resources like shops, products, customers, or collections.

Tool to create a new order in Shopify without payment processing. Use when programmatically generating orders with line items, customer information, and addresses.

Creates an order risk for an order in Shopify. Use when documenting fraud detection findings or assessing order risk levels. Note: This resource is deprecated as of version 2024-04; GraphQL Order Risk Assessment API is recommended.

Tool to create a refund for a Shopify order. Use the calculate endpoint to generate accurate transaction data before creating the refund. Requires order_id and transaction details including parent_id, amount, kind, and gateway. Note: For multi-currency orders, the currency property is required when amount is provided. Rate limited to 5 refunds per minute on development/trial stores.

Tool to calculate refund transactions for a Shopify order before creating an actual refund. Use when you need to determine accurate refund amounts, taxes, and transaction details. Returns suggested transactions with kind='suggested_refund' which must be changed to kind='refund' to create an actual refund.

Tool to create a price rule for applying discounts to orders. Use when you need to create a new discount that can be applied via discount codes at checkout.

Tool to create a discount code creation job for batch processing. Use when you need to asynchronously create up to 100 discount codes for a price rule in a single request.

Tool to create a discount code for an existing price rule. Use when you need to generate a new discount code that customers can use at checkout.

Creates a new product in a Shopify store; a product title is generally required.

Tool to create a new product image for a given product. Use when you need to add an image to a product by providing the image source URL or attachment.

Creates a new metafield for a specific Shopify product.

Tool to create 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.

Creates a refund for a Shopify order. Use when you need to refund line items, shipping, or process refund transactions. For multi-currency orders, the currency field is required when specifying amounts.

Tool to create shop resource feedback to notify merchants about required actions for app setup. Use when you need to inform merchants about setup steps or confirm successful configuration. Replaces previous feedback automatically.

Tool to create a discount code for an existing price rule. Use when you need to generate a new discount code that customers can use at checkout.

Tool to create a fulfillment event for tracking shipment status updates. Use when you need to update customers on delivery progress through the order status page.

Tool to create a new gift card in Shopify. Use when you need to issue a gift card with a specified initial value.

Tool to create a marketing event in Shopify to track promotional actions. Use when you need to track marketing campaigns targeting customers across various channels.

Tool to create a new product in Shopify. Use when you need to add a new product to the store with details like title, description, variants, options, and images.

Tool to create a price rule that defines discount logic for Shopify. Use when you need to set up discount rules for products or shipping.

Tool to create 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 value, it will be saved as an absolute path without the domain.

Tool to create a new script tag in Shopify. Use when you need to load remote JavaScript code into the storefront or order status page. The src parameter must be a valid HTTPS URL.

Tool to create 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.

Tool to create a new smart collection in Shopify using specified rules. Use when you need to create a collection that automatically adds products based on conditions.

Tool to create 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.

Tool to create or update an asset for a theme. Use when you need to add a new file or modify an existing file in a Shopify theme, such as templates, stylesheets, images, or scripts. Only one of value, attachment, src, or source_key should be provided per request.

Tool to create a new storefront access token for unauthenticated Storefront API access. Use when you need to generate a public access token for the Shopify Storefront API. Maximum 100 active tokens per shop allowed.

Tool to create a theme in Shopify by providing the public URL of a ZIP file. Use when you need to create a new theme from a ZIP file. A newly created theme defaults to unpublished status unless explicitly set to 'main'.

Creates a transaction for an order to process payment operations. Use when you need to authorize, capture, refund, void, or complete a sale for an order. For multi-currency orders, the currency field is required when creating refund and capture transactions.

Tool to create a new webhook subscription in Shopify. Use when you need to set up notifications for specific events in a shop. Both address and topic parameters are mandatory; requests missing either will return a 422 error.

Deletes a metafield by its ID from any Shopify resource. Use when you need to permanently remove a metafield from products, customers, orders, or other resources.

Deletes an article from a blog permanently. Use when you need to remove an article from a specific blog. This action is irreversible.

Tool to delete an article from a blog in Shopify. Use when you need to permanently remove blog content. This action is irreversible.

Tool to permanently delete an article from a blog in Shopify. Use when you need to remove blog content. This action is irreversible.

Removes a product from a collection by deleting the collect relationship. Use when you need to disconnect a specific product from a custom collection.

Deletes a country from the shop's tax configuration. Use when you need to remove a country from the store's settings. Note: This REST API is deprecated and will be unsupported after July 1, 2025.

Permanently deletes a custom collection from a Shopify store using its `collection_id`; this action is irreversible and requires a valid, existing `collection_id`.

Removes 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.

Deletes 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.

Deletes a discount code from a price rule. Use when you need to remove a specific discount code associated with a price rule.

Tool to delete a fulfillment event from an order's fulfillment. Use when you need to remove a tracking event from a fulfillment. Note: This endpoint is deprecated; consider migrating to GraphQL Admin API.

Tool to remove an existing fulfillment service from a Shopify store. Use when you need to permanently delete a fulfillment service.

Deletes 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.

Tool to delete a metafield by its ID. Use when you need to remove a metafield from any resource type without needing to specify the parent resource.

Permanently deletes a specific order from a Shopify store using its unique order ID; this action is irreversible and requires write_orders access scope.

Deletes an order risk for an order. Use when removing fraud risk assessments from orders. Note: Cannot delete risks created by other applications.

Tool to delete a page from a Shopify store permanently. Use when you need to remove an existing page; this operation is irreversible and requires content access scope.