Skip to main content

Shopify Connector

Shopify Shopify is a multinational e-commerce company. They offer a subscription-based software that allows anyone to set up an online store and sell their products. This component allows managing the products and customers connected to a Shopify account.

API Documentation

This component was built using the Shopify GraphQL Admin API Reference.

Connections

Access Token

Authenticate requests to Shopify using an Admin API access token.

An admin API access token can be used for testing purposes during integration development.

Personal access tokens are recommended for testing only. For production integrations, use OAuth 2.0 to allow users to authenticate with their own credentials.

Prerequisites

  • A Shopify store (for testing purposes)

Setup Steps

To generate an admin API access token:

  1. Log in to the Shopify admin dashboard.
  2. Navigate to Settings > Apps and sales channels.
  3. Click Develop apps.
  4. If prompted, click Allow custom app development.
  5. Click Create an app and provide a name for the app.
  6. Click Configure Admin API scopes and select the required scopes for the integration.
  7. Click Save.
  8. Navigate to the API credentials tab.
  9. Under Admin API access token, click Install app to generate the token.
  10. Copy the Admin API access token value.

The token will have a format similar to shpat_00000000000000000000000000000000.

Refer to Shopify's Admin API access token documentation for more information.

Configure the Connection

Create a connection of type Access Token and configure the following fields:

  • Enter the Admin API Access Token into the connection configuration.
  • Enter the Host (the Shopify domain without https://, e.g., example-store.myshopify.com).
  • Optionally configure the API Version (defaults to latest version).
Production Use

Admin API access tokens are tied to custom apps and recommended for testing only. For production integrations, OAuth 2.0 authentication provides a better user experience and allows users to authenticate with their own credentials.

InputCommentsDefault
Admin API Access TokenGenerate from the 'API credentials' tab of a private Shopify app. Learn more at Shopify Admin API.
HostThe domain of the Shopify store without https:// (e.g., my-store.myshopify.com).YOUR-SHOPIFY-DOMAIN.myshopify.com
API VersionShopify API version to use. See Shopify API versioning for available versions.2026-01

OAuth 2.0

Authenticate requests to Shopify using values obtained from the Developer Console. Allows for using a single domain input instead of entering separate authorization URLs.

Shopify uses OAuth 2.0 for app authentication. This connection type simplifies configuration by using a single Shop Name input to automatically construct the authorization and token URLs.

Prerequisites

Legacy Custom App Deprecation

As of January 1, 2026, merchants can no longer create new legacy custom apps. Existing apps are not affected. Partners can still create new custom apps and transfer stores to merchants, but once transferred, new custom app creation is disabled on the store. Use the Partner Dashboard or Shopify CLI to create apps going forward.

Creating a Shopify App

Choose one of the following methods to create a Shopify app.

Create App from Dev Dashboard

For backend-focused apps (API utilities, webhook handlers, sync jobs), create an app directly through the Dev Dashboard without scaffolding code.

  1. Log in to the Dev Dashboard, or navigate from the Partner Dashboard via App Distribution > Visit Dev Dashboard.

  2. Click Create app.

  3. Select Create app manually and provide an app name.

  4. Navigate to the Configuration section of the created app.

  5. Under App URL, enter a valid URL (this is required but can be a placeholder).

  6. Under Allowed redirection URL(s), enter:

    https://oauth2.integrations.acme.com/callback

  7. Click Save.

Refer to the Dev Dashboard documentation for more details.

Create App with Shopify CLI

The Shopify CLI scaffolds a complete app project with best practices built in. This method is suitable for apps that need embedded UI, checkout extensions, or full-stack capabilities.

  1. Install the Shopify CLI if not already installed.
  2. Navigate to the desired project directory and run:
    shopify app init
  3. When prompted, provide an app name and select a template (the React Router template is recommended for most use cases).
  4. Navigate to the new app directory and start the development server:
    cd my-new-app
    shopify app dev
  5. The CLI prompts for login to a developer account, creates the app in the Dev Dashboard, and establishes a connection to a dev store.
  6. Once the dev server is running, press p to open the preview URL and install the app on the dev store.

Refer to Shopify's scaffold app documentation for detailed instructions.

Retrieve App Credentials

Regardless of the creation method, retrieve the OAuth credentials:

  1. Open the app in the Dev Dashboard.
  2. Navigate to the Configuration section.
  3. Scroll to the Client credentials section.
  4. Copy the Client ID (labeled as API key in Shopify).
  5. Copy the Client secret (labeled as API secret key in Shopify).

Configure the Connection

Create a connection of type OAuth 2.0 and configure the following fields:

  • API Key: Enter the Client ID copied from the Shopify app credentials (Shopify labels this as "API key").
  • API Secret: Enter the Client secret copied from the Shopify app credentials (Shopify labels this as "API secret key").
  • Shop Name: Enter the Shopify domain without .myshopify.com (e.g., example-store).
  • Scopes: Configure based on the required permissions. Default scopes include:
    read_customers read_draft_orders read_fulfillments read_inventory
    read_orders read_products read_locations write_customers
    write_draft_orders write_fulfillments write_inventory
    write_orders write_products write_locations
    Refer to Shopify's access scopes documentation for a complete list of available scopes.
  • API Version (optional): Specify the Shopify API version to use. Defaults to 2026-01. Refer to Shopify API versioning for available versions.

Save the integration to connect and authenticate to Shopify.

Shop Name Format

The Shop Name should be the subdomain portion of the Shopify store URL. For example, if the store URL is example-store.myshopify.com, enter example-store as the Shop Name.

This connection uses OAuth 2.0, a common authentication mechanism for integrations. Read about how OAuth 2.0 works here.

InputCommentsDefault
Shop NameThe Shopify shop name without the .myshopify.com suffix (e.g., my-store).
ScopesSpace-separated list of OAuth permission scopes. See Shopify access scopes for all available scopes.read_customers read_draft_orders read_fulfillments read_inventory read_orders read_products read_locations write_customers write_draft_orders write_fulfillments write_inventory write_orders write_products write_locations
Client ID (API Key)The Client ID (also called API Key) from the Shopify app credentials.
Client Secret (API Secret)The Client Secret (also called API Secret) from the Shopify app credentials.
API VersionShopify API version to use. See Shopify API versioning for available versions.2026-01

OAuth 2.0 (Deprecated)

Authenticate requests to Shopify using values obtained from the Developer Console.

This connection uses OAuth 2.0, a common authentication mechanism for integrations. Read about how OAuth 2.0 works here.

InputCommentsDefault
Authorize URLThe OAuth 2.0 Authorization URL for Shopify.https://YOUR-SHOPIFY-DOMAIN.myshopify.com/admin/oauth/authorize
Token URLThe OAuth 2.0 Token URL for Shopify.https://YOUR-SHOPIFY-DOMAIN.myshopify.com/admin/oauth/access_token
ScopesSpace-separated list of OAuth permission scopes. See Shopify access scopes for all available scopes.read_customers read_draft_orders read_fulfillments read_inventory read_orders read_products read_locations write_customers write_draft_orders write_fulfillments write_inventory write_orders write_products write_locations
Client ID (API Key)The Client ID (also called API Key) from the Shopify app credentials.
Client Secret (API Secret)The Client Secret (also called API Secret) from the Shopify app credentials.
HostThe domain of the Shopify store without https:// (e.g., my-store.myshopify.com).YOUR-SHOPIFY-DOMAIN.myshopify.com
API VersionShopify API version to use. See Shopify API versioning for available versions.2026-01

Triggers

Event Topic Subscription

Receive event notifications from Shopify. Automatically creates and manages a webhook subscription for selected event topics when the instance is deployed, and removes the subscription when the instance is deleted.

InputCommentsDefault
ConnectionThe Shopify connection to use.
Secret KeyThe Shopify app's client secret, viewable from the Partner Dashboard.
Webhook TopicThe topic for the webhook. This is the event that will trigger the webhook.

Event Topic Webhook (Deprecated)

Set event based webhooks and get notified when these event types are created, updated, or deleted. This version of the trigger is being deprecated. Please replace trigger with Event Topic Webhook.

InputCommentsDefault
Secret KeyThe Shopify app's client secret, viewable from the Partner Dashboard.
ConnectionThe Shopify connection to use.
Event Topic NameEvent that triggers the webhook.

New and Updated Customers

Checks for new and updated customers in Shopify on a configured schedule.

InputCommentsDefault
ConnectionThe Shopify connection to use.

New and Updated Orders

Checks for new and updated orders in Shopify on a configured schedule.

InputCommentsDefault
ConnectionThe Shopify connection to use.

New and Updated Products

Checks for new and updated products in Shopify on a configured schedule.

InputCommentsDefault
ConnectionThe Shopify connection to use.

Webhook

Receive and validate webhook requests from Shopify for manually configured webhook subscriptions.

InputCommentsDefault
Secret KeyThe Shopify app's client secret, viewable from the Partner Dashboard.

Actions

Cancel Order

Cancels an existing order.

InputCommentsDefault
ConnectionThe Shopify connection to use.
Order IDThe unique identifier for the order.
ReasonThe reason for the cancellation.
RefundWhether to refund the amount paid by the customer.false
RestockWhether to restock the inventory committed to the order.false
Notify CustomerWhether the customer should be notified of the cancellation.false
Staff NoteA staff-facing note about the order cancellation. This is not visible to the customer.

Close Order

Closes an existing order.

InputCommentsDefault
ConnectionThe Shopify connection to use.
Order IDThe unique identifier for the order.

Complete Draft Order

Marks a draft order as complete.

InputCommentsDefault
ConnectionThe Shopify connection to use.
Draft Order IdThe unique identifier for the draft order.

Connect Inventory Item To Location

Connects an existing inventory item to a location.

InputCommentsDefault
ConnectionThe Shopify connection to use.
Location IDThe ID of the location that the inventory level belongs to.
Inventory Item IdThe unique identifier for the inventory item.

Count Collections

Returns a count of all collections.

InputCommentsDefault
ConnectionThe Shopify connection to use.

Count Customers

Returns a count of all customers.

InputCommentsDefault
ConnectionThe Shopify connection to use.

Count Draft Orders

Returns a count of all draft orders. Note: this action currently utilizes an unstable version of the Shopify Admin GraphQL API and is subject to change.

InputCommentsDefault
ConnectionThe Shopify connection to use.

Count Locations

Returns a count of all locations.

InputCommentsDefault
ConnectionThe Shopify connection to use.

Count Orders

Returns a count of all orders.

InputCommentsDefault
ConnectionThe Shopify connection to use.

Count Product Images

Returns a count of all product images for the specified product.

InputCommentsDefault
ConnectionThe Shopify connection to use.
Product IDThe unique identifier for the product.

Count Products

Returns a count of all products.

InputCommentsDefault
ConnectionThe Shopify connection to use.

Count Variants

Returns a count of all product variants.

InputCommentsDefault
ConnectionThe Shopify connection to use.

Create Account Activation URL

Creates an account activation URL for an existing customer.

InputCommentsDefault
ConnectionThe Shopify connection to use.
CustomerThe unique identifier for the customer.

Create Customer

Creates a new customer.

InputCommentsDefault
ConnectionThe Shopify connection to use.
First NameThe first name of the customer.
Last NameThe last name of the customer.
EmailThe email address of the customer.
PhoneThe phone number of the customer in E.164 format.
NotesAdditional notes about the customer.
Verified EmailWhen true, emails will be sent to the customer.false
Address ListA JSON array of address objects for the customer. Each object should include fields like address1, city, province, country, and zip.
ValuesKey-value pairs for creating or updating a record. Specify any property key and value.
Currency FormatThe currency format code.
TagsTags for the product. Each list item is a tag string.
Tax ExemptWhen true, the customer is tax exempt.false
MetafieldsJSON array containing metadata objects.

Create Draft Order

Creates a new draft order.

InputCommentsDefault
ConnectionThe Shopify connection to use.
CustomerThe unique identifier for the customer.
Line itemsProvide a JSON array containing line item objects.
Use Customer AddressThis flag determines if the order will use the customers default address.true
NoteA note on the draft order.
Tax ExemptWhether or not taxes are exempt for the draft order.false
TagsProvide a list of tags for the draft order.
Additional FieldsAdditional fields that might not be covered by the standard inputs. This is a JSON object.

Create Fulfillment Service

Creates a new fulfillment service.

InputCommentsDefault
ConnectionThe Shopify connection to use.
Fulfillment Service NameThe name of the fulfillment service.
Callback URLThe callback URL that the fulfillment service has registered for request.
Inventory ManagementWhether the fulfillment services tracks product inventory and provides updates to Shopify.false
Tracking SupportWhether the fulfillment service supports tracking numbers for packages.false

Create Order

Creates a new order.

InputCommentsDefault
ConnectionThe Shopify connection to use.
Order DataJSON data to be sent as the Order payload.

Create Product

Creates a new product.

InputCommentsDefault
ConnectionThe Shopify connection to use.
TitleProvide a string value for the title of the product.
Description HTMLProvide an HTML string for the description of the product.
Product TypeProvide a value for the type of product.
VendorProvide a value for the vendor of the product.
Product StatusSpecify the status of the product.
Image URLProvide a URL for the image of the product.
Image Alt TextProvide the alt text for the image of the product.
TagsProvide a list of tags for the product.
Additional FieldsAdditional fields that might not be covered by the standard inputs. This is a JSON object.

Create Product Image

Creates a new image for an existing product.

InputCommentsDefault
ConnectionThe Shopify connection to use.
Product IDThe unique identifier for the product.
Image URLProvide the URL of the image.
Image Alt TextProvide the alt text for the image.

Create Variant

Creates a new variant for the specified product.

InputCommentsDefault
ConnectionThe Shopify connection to use.
Product IDThe unique identifier for the product.
VariantProvide a JSON object containing the variant data.

Create Webhook

Creates a webhook for the specified topic.

InputCommentsDefault
ConnectionThe Shopify connection to use.
Webhook TopicThe event topic for the webhook. See Shopify webhook topics for all available topics.
Post URLThe URL where the newly created webhook will post to. Used to configure the Shopify trigger.
Webhook FormatThe format for the webhook response.json

Delete Collection

Deletes a collection by ID.

InputCommentsDefault
ConnectionThe Shopify connection to use.
Collection IDThe unique identifier for the collection.

Delete Customer

Deletes an existing customer.

InputCommentsDefault
ConnectionThe Shopify connection to use.
CustomerThe unique identifier for the customer.

Delete Draft Order

Deletes an existing draft order.

InputCommentsDefault
ConnectionThe Shopify connection to use.
Draft Order IdThe unique identifier for the draft order.

Delete Fulfillment Service

Deletes an existing fulfillment service.

InputCommentsDefault
ConnectionThe Shopify connection to use.
Fulfillment Service IDThe unique identifier for the fulfillment service.

Delete Instance Webhooks

Deletes all webhooks related to the current instance.

InputCommentsDefault
ConnectionThe Shopify connection to use.

Delete Inventory Levels

Deletes an inventory level.

InputCommentsDefault
ConnectionThe Shopify connection to use.
Inventory Level IdThe unique identifier for the inventory level.

Delete Metafield

Deletes a resource metafield. Note: This action currently utilizes an unstable version of the Shopify Admin GraphQL API and is subject to change.

InputCommentsDefault
ConnectionThe Shopify connection to use.
KeyProvide the key of the metafield to delete.
Owner IDProvide the owner ID of the metafield to delete.
NamespaceProvide the namespace of the metafield to delete.

Delete Order

Deletes an existing order by ID.

InputCommentsDefault
ConnectionThe Shopify connection to use.
Order IDThe unique identifier for the order.

Delete Product

Deletes an existing product.

InputCommentsDefault
ConnectionThe Shopify connection to use.
Product IDThe unique identifier for the product.

Delete Product Image

Deletes a product image.

InputCommentsDefault
ConnectionThe Shopify connection to use.
Product IDThe unique identifier for the product.
Image IDThe unique identifier for the product image.

Delete Variant

Deletes an existing variant by ID.

InputCommentsDefault
ConnectionThe Shopify connection to use.
Product IDThe unique identifier for the product.
Variant IDThe unique identifier for the product variant.

Delete Webhook

Deletes a webhook by ID.

InputCommentsDefault
ConnectionThe Shopify connection to use.
Webhook IDThe ID of an existing webhook.

Get Collection

Retrieves a collection by ID.

InputCommentsDefault
ConnectionThe Shopify connection to use.
Collection IDThe unique identifier for the collection.

Get Customer

Retrieves a customer by ID.

InputCommentsDefault
CustomerThe unique ID of the customer.
ConnectionThe Shopify connection to use.

Get Draft Order

Retrieves a draft order by ID.

InputCommentsDefault
ConnectionThe Shopify connection to use.
Draft Order IdThe unique identifier for the draft order.

Get Fulfillment

Retrieves a fulfillment by ID.

InputCommentsDefault
ConnectionThe Shopify connection to use.
Fulfillment IdThe unique identifier for the fulfillment.

Get Fulfillment Order

Retrieves a specific fulfillment order by ID.

InputCommentsDefault
ConnectionThe Shopify connection to use.
Fulfillment Order IDThe unique identifier for the fulfillment order.

Get Fulfillment Service

Retrieves a fulfillment service by ID.

InputCommentsDefault
ConnectionThe Shopify connection to use.
Fulfillment Service IDThe unique identifier for the fulfillment service.

Get Inventory Item

Retrieves an inventory item by ID.

InputCommentsDefault
Inventory Item IdThe unique identifier for the inventory item.
ConnectionThe Shopify connection to use.

Get Inventory Levels

Retrieves an inventory level by ID.

InputCommentsDefault
ConnectionThe Shopify connection to use.
Inventory Level IdThe unique identifier for the inventory level.

Get Location

Retrieves a location by ID.

InputCommentsDefault
ConnectionThe Shopify connection to use.
Location IDThe ID of the location that the inventory level belongs to.

Get Order

Retrieves an order by ID.

InputCommentsDefault
ConnectionThe Shopify connection to use.
Order IDThe unique identifier for the order.

Get Order (Deprecated)

Get the information and metadata about an order. This version of the action is being deprecated. Please replace action with Get Order.

InputCommentsDefault
Order IDThe unique ID of the order.
ConnectionThe Shopify connection to use.

Get Product

Retrieves a product by ID.

InputCommentsDefault
Product IDThe unique ID of the product.
ConnectionThe Shopify connection to use.

Get Product Image

Retrieves a product image by ID.

InputCommentsDefault
ConnectionThe Shopify connection to use.
Product IDThe unique identifier for the product.
Image IDProvide a unique ID of a product image. Use only the ID number.

Get Shop Configuration

Retrieves the shop configuration.

InputCommentsDefault
ConnectionThe Shopify connection to use.

Get Variant

Retrieves a product variant by ID.

InputCommentsDefault
ConnectionThe Shopify connection to use.
Variant IDThe unique identifier for the product variant.

List Collections

Lists all collections.

InputCommentsDefault
ConnectionThe Shopify connection to use.
LimitThe maximum number of results to return per page. Maximum: 250.
Fetch AllWhen true, automatically fetches all pages of results using pagination. The API is limited to 250 records per page max.false
Page Offset CursorCursor for pagination. Use the value from the previous response to retrieve the next page of results.

List Currencies

Lists all enabled currencies.

InputCommentsDefault
ConnectionThe Shopify connection to use.
LimitThe maximum number of results to return per page. Maximum: 250.
Fetch AllWhen true, automatically fetches all pages of results using pagination. The API is limited to 250 records per page max.false
Page Offset CursorCursor for pagination. Use the value from the previous response to retrieve the next page of results.

List Customers

Lists all customers.

InputCommentsDefault
Get All DataWhen true, fetches all data from all pages (API is limited to 250 records per page max). The limit input will be ignored when enabled.false
LimitThe maximum number of results to return per page. Maximum: 250.
Page Offset TokenCursor for pagination. Use the value from the previous response to retrieve the next page of results.
ConnectionThe Shopify connection to use.

List Draft Orders

Lists all draft orders.

InputCommentsDefault
Get All DataWhen true, fetches all data from all pages (API is limited to 250 records per page max). The limit input will be ignored when enabled.false
LimitThe maximum number of results to return per page. Maximum: 250.
Page Offset TokenCursor for pagination. Use the value from the previous response to retrieve the next page of results.
ConnectionThe Shopify connection to use.

List Fulfillment Orders

Lists all fulfillment orders for a specific order.

InputCommentsDefault
ConnectionThe Shopify connection to use.
Order IDThe unique ID of the order.

List Fulfillments

Lists all fulfillments for a specified order.

InputCommentsDefault
Order IDThe unique ID of the order.
Get All DataWhen true, fetches all data from all pages (API is limited to 250 records per page max). The limit input will be ignored when enabled.false
LimitThe maximum number of results to return per page. Maximum: 250.
Page Offset TokenCursor for pagination. Use the value from the previous response to retrieve the next page of results.
ConnectionThe Shopify connection to use.

List Fulfillment Services

Lists all fulfillment services.

InputCommentsDefault
ConnectionThe Shopify connection to use.

List Inventory Items

Lists all inventory items.

InputCommentsDefault
ConnectionThe Shopify connection to use.
QueryThe query to filter the inventory items.
Fetch AllWhen true, automatically fetches all pages of results using pagination. The API is limited to 250 records per page max.false
LimitThe maximum number of results to return per page. Maximum: 250.
Page Offset CursorCursor for pagination. Use the value from the previous response to retrieve the next page of results.

List Inventory Levels At Location

Lists all inventory levels at a specified location.

InputCommentsDefault
ConnectionThe Shopify connection to use.
Location IDThe ID of the location that the inventory level belongs to.
Fetch AllWhen true, automatically fetches all pages of results using pagination. The API is limited to 250 records per page max.false
LimitThe maximum number of results to return per page. Maximum: 250.
Page Offset CursorCursor for pagination. Use the value from the previous response to retrieve the next page of results.

List Locations

Lists all locations.

InputCommentsDefault
ConnectionThe Shopify connection to use.
LimitThe maximum number of results to return per page. Maximum: 250.
Fetch AllWhen true, automatically fetches all pages of results using pagination. The API is limited to 250 records per page max.false
Page Offset CursorCursor for pagination. Use the value from the previous response to retrieve the next page of results.

List Metafields

Lists resource metafields. Note: This action currently utilizes an unstable version of the Shopify Admin GraphQL API and is subject to change.

InputCommentsDefault
ConnectionThe Shopify connection to use.
ResourceThe unique identifier for the resource.
LimitThe maximum number of results to return per page. Maximum: 250.
Fetch AllWhen true, automatically fetches all pages of results using pagination. The API is limited to 250 records per page max.false
Page Offset CursorCursor for pagination. Use the value from the previous response to retrieve the next page of results.

List Orders

Lists all orders.

InputCommentsDefault
ConnectionThe Shopify connection to use.
QueryThe query to filter the orders.
Fetch AllWhen true, automatically fetches all pages of results using pagination. The API is limited to 250 records per page max.false
LimitThe maximum number of results to return per page. Maximum: 250.
Page Offset CursorCursor for pagination. Use the value from the previous response to retrieve the next page of results.

List Orders (Deprecated)

List all orders. This version of the action is being deprecated. Please replace action with List Orders.

InputCommentsDefault
ConnectionThe Shopify connection to use.
Get All DataWhen true, fetches all data from all pages (API is limited to 250 records per page max). The limit input will be ignored when enabled.false
Page Offset TokenCursor for pagination. Use the value from the previous response to retrieve the next page of results.
LimitThe maximum number of results to return per page. Maximum: 250.
Attribution App IDShow orders attributed to a certain app, specified by the app ID.
Created At MaxShow orders created at or before date. ISO 8601 format like 2021-10-01 or 2021-10-01T00:00:00-04:00 for exact time.
Created At MinShow orders created at or after this date. Use ISO 8601 format (YYYY-MM-DD or YYYY-MM-DDTHH:mm:ss-HH:mm).
FieldsRetrieve only certain fields, specified by a comma-separated list of fields names.
Financial StatusFilter orders by their financial status.
Fulfillment StatusFilter orders by their fulfillment status.
IDsRetrieve only orders specified by a comma-separated list of order IDs.
Processed At MaxShow orders imported at or before date. ISO 8601 format like 2021-10-01 or 2021-10-01T00:00:00-04:00 for exact time.
Processed At MinShow orders imported at or after date. ISO 8601 format like 2021-10-01 or 2021-10-01T00:00:00-04:00 for exact time.
Since IDShow orders after the specified ID.
StatusFilter orders by their status.
Updated At MaxShow orders last updated at or before date. ISO 8601 format like 2021-10-01 or 2021-10-01T00:00:00-04:00 for exact time.
Updated At MinShow orders last updated at or after date. ISO 8601 format like 2021-10-01 or 2021-10-01T00:00:00-04:00 for exact time.

List Product Images

Lists all product images for the specified product.

InputCommentsDefault
Product IDThe unique ID of the product.
ConnectionThe Shopify connection to use.

List Products

Lists all products.

InputCommentsDefault
LimitThe maximum number of results to return per page. Maximum: 250.
Get All DataWhen true, fetches all data from all pages (API is limited to 250 records per page max). The limit input will be ignored when enabled.false
Page Offset TokenCursor for pagination. Use the value from the previous response to retrieve the next page of results.
ConnectionThe Shopify connection to use.

List Variants

Lists all variants for the specified product.

InputCommentsDefault
ConnectionThe Shopify connection to use.
Product IDThe unique identifier for the product.
Fetch AllWhen true, automatically fetches all pages of results using pagination. The API is limited to 250 records per page max.false
LimitThe maximum number of results to return per page. Maximum: 250.
Page Offset CursorCursor for pagination. Use the value from the previous response to retrieve the next page of results.

List Webhooks

Lists all webhooks or webhooks for the current instance.

InputCommentsDefault
ConnectionThe Shopify connection to use.
Show Only Instance WebhooksWhen true, only webhooks that point to this instance are returned.true

Raw Request

Sends a raw GraphQL request to Shopify.

InputCommentsDefault
ConnectionThe Shopify connection to use.
API VersionShopify versions its API. See Shopify API release notes for a list of available versions.2026-01
Query or MutationGraphQL query or mutation. See Shopify's GraphQL API documentation for examples. Ex: { shop { name } }
VariablesVariables to pass to the query or mutation.
Variables ObjectVariables to pass to the query or mutation.

Raw Request (Deprecated)

Send raw HTTP request to Shopify. This version of the action uses REST and is being deprecated. Please replace action with the Raw Request utilizing GraphQL.

InputCommentsDefault
ConnectionThe Shopify connection to use.
URLInput the path only (/users/current.json), The base URL is already included (https://YOUR-DOMAIN.myshopify.com/admin/api/API-VERSION). For example, to connect to https://YOUR-DOMAIN.myshopify.com/admin/api/API-VERSION/users/current.json, only /users/current.json is entered in this field.
MethodThe HTTP method to use.
DataThe HTTP body payload to send to the URL.
Form DataThe Form Data to be sent as a multipart form upload.
File DataFile Data to be sent as a multipart form upload.
File Data File NamesFile names to apply to the file data inputs. Keys must match the file data keys above.
Query ParameterA list of query parameters to send with the request. This is the portion at the end of the URL similar to ?key1=value1&key2=value2.
HeaderA list of headers to send with the request.
Response TypeThe type of data you expect in the response. You can request json, text, or binary data.json
TimeoutThe maximum time that a client will await a response to its request
Debug RequestEnabling this flag will log out the current request.false
Retry Delay (ms)The delay in milliseconds between retries. This is used when 'Use Exponential Backoff' is disabled.0
Retry On All ErrorsIf true, retries on all erroneous responses regardless of type. This is helpful when retrying after HTTP 429 or other 3xx or 4xx errors. Otherwise, only retries on HTTP 5xx and network errors.false
Max Retry CountThe maximum number of retries to attempt. Specify 0 for no retries.0
Use Exponential BackoffSpecifies whether to use a pre-defined exponential backoff strategy for retries. When enabled, 'Retry Delay (ms)' is ignored.false
API VersionShopify versions its API. See Shopify API release notes for a list of available versions.2026-01
Return HeadersWhen true, response headers will be included in the output object.false

Set Metafield

Sets a resource metafield. Note: This action currently utilizes an unstable version of the Shopify Admin GraphQL API and is subject to change.

InputCommentsDefault
ConnectionThe Shopify connection to use.
KeyThe key for the metafield.
ValueThe value for the metafield.
Owner IDThe unique ID of the owner of the metafield.
TypeProvide a type for the metafield. Required when there is no corresponding definition for the given namespace, key, and owner resource type.
NamespaceThe namespace for the metafield.

Update Customer

Updates an existing customer by ID.

InputCommentsDefault
ConnectionThe Shopify connection to use.
CustomerThe unique identifier for the customer.
First NameThe first name of the customer.
Last NameThe last name of the customer.
EmailThe email address of the customer.
Address ListProvide a JSON array containing address objects.
PhoneThe phone number of the customer.
NotesA note about the customer.
TagsFor each list item, provide a string you would like to tag the product with.
Tax ExemptDetermines if the customer is tax exempt.
MetafieldsProvide a JSON array containing metadata objects.
Additional FieldsAdditional fields that might not be covered by the standard inputs. This is a JSON object.

Update Fulfillment Service

Updates an existing fulfillment service.

InputCommentsDefault
ConnectionThe Shopify connection to use.
Fulfillment Service IDThe unique identifier for the fulfillment service.
Fulfillment Service NameThe name of the fulfillment service.
Callback URLThe callback URL that the fulfillment service has registered for request.
Inventory ManagementWhether the fulfillment services tracks product inventory and provides updates to Shopify.
Tracking SupportWhether the fulfillment service supports tracking numbers for packages.

Update Inventory Item

Updates an existing inventory item.

InputCommentsDefault
ConnectionThe Shopify connection to use.
Inventory Item IdThe unique identifier for the inventory item.
SKUThe SKU (stock keeping unit) of the inventory item.
CostUnit cost associated with the inventory item, the currency is the shop's default currency.
TrackedWhether the inventory item is tracked.

Update Product

Updates an existing product by ID.

InputCommentsDefault
ConnectionThe Shopify connection to use.
Product IDThe unique identifier for the product.
TitleProvide a string value for the title of the product.
Description HTMLProvide an HTML string for the description of the product.
Product TypeProvide a value for the type of product.
VendorProvide a value for the vendor of the product.
Product StatusSpecify the status of the product.
Image URLProvide a URL for the image of the product.
Image Alt TextProvide the alt text for the image of the product.
TagsFor each list item, provide a string you would like to tag the product with.
Additional FieldsAdditional fields that might not be covered by the standard inputs. This is a JSON object.

Update Variant

Updates an existing product variant by ID.

InputCommentsDefault
ConnectionThe Shopify connection to use.
Product IDThe unique identifier for the product.
Update VariantProvide a JSON object containing the variant data to update.