Shopify Connector

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

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

• A Shopify Partners account
• Access to the Dev Dashboard or Shopify CLI for app creation
• A development store for testing

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.flowbuilder.eu.lansweeper.com/callback for EU sites or https://oauth2.flowbuilder.us.lansweeper.com/callback for US sites

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.

App Distribution

Shopify vets all apps intended for distribution to multiple merchants through a formal App Store review to ensure quality and security standards. The distribution type (custom or public) is chosen at app creation and is permanent. Understanding the difference upfront avoids having to rebuild the app later.

Shopify app distribution determines which merchants can install the app and is a permanent, non-reversible choice.

Custom apps are created directly within a merchant's Shopify admin and are restricted to that single store. Custom apps do not appear in the Shopify App Store and cannot be installed by other merchants. This is the appropriate choice for single-merchant integrations.

Public apps are created through the Shopify Partners program and can be distributed to multiple merchants. Public apps must be submitted for review and listed in the Shopify App Store before other merchants can install them.

For information on the App Store review process, refer to Shopify's app distribution documentation.

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

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.

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.

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.

New and Updated Customers

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

New and Updated Orders

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

New and Updated Products

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

Webhook

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

Actions

Cancel Order

Cancels an existing order.

Close Order

Closes an existing order.

Complete Draft Order

Marks a draft order as complete.

Connect Inventory Item To Location

Connects an existing inventory item to a location.

Count Collections

Returns a count of all collections.

Count Customers

Returns a count of all customers.

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.

Count Locations

Returns a count of all locations.

Count Orders

Returns a count of all orders.

Count Product Images

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

Count Products

Returns a count of all products.

Count Variants

Returns a count of all product variants.

Create Account Activation URL

Creates an account activation URL for an existing customer.

Create Customer

Creates a new customer.

Create Draft Order

Creates a new draft order.

Create Fulfillment Service

Creates a new fulfillment service.

Create Order

Creates a new order.

Create Product

Creates a new product.

Create Product Image

Creates a new image for an existing product.

Create Variant

Creates a new variant for the specified product.

Create Webhook

Creates a webhook for the specified topic.

Delete Collection

Deletes a collection by ID.

Delete Customer

Deletes an existing customer.

Delete Draft Order

Deletes an existing draft order.

Delete Fulfillment Service

Deletes an existing fulfillment service.

Delete Instance Webhooks

Deletes all webhooks related to the current instance.

Delete Inventory Levels

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

Delete Order

Deletes an existing order by ID.

Delete Product

Deletes an existing product.

Delete Product Image

Deletes a product image.

Delete Variant

Deletes an existing variant by ID.

Delete Webhook

Deletes a webhook by ID.

Get Collection

Retrieves a collection by ID.

Get Customer

Retrieves a customer by ID.

Get Draft Order

Retrieves a draft order by ID.

Get Fulfillment

Retrieves a fulfillment by ID.

Get Fulfillment Order

Retrieves a specific fulfillment order by ID.

Get Fulfillment Service

Retrieves a fulfillment service by ID.

Get Inventory Item

Retrieves an inventory item by ID.

Get Inventory Levels

Retrieves an inventory level by ID.

Get Location

Retrieves a location by ID.

Get Order

Retrieves an order by ID.

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.

Get Product

Retrieves a product by ID.

Get Product Image

Retrieves a product image by ID.

Get Shop Configuration

Retrieves the shop configuration.

Get Variant

Retrieves a product variant by ID.

List Collections

Lists all collections.

List Currencies

Lists all enabled currencies.

List Customers

Lists all customers.

List Draft Orders

Lists all draft orders.

List Fulfillment Orders

Lists all fulfillment orders for a specific order.

List Fulfillments

Lists all fulfillments for a specified order.

List Fulfillment Services

Lists all fulfillment services.

List Inventory Items

Lists all inventory items.

List Inventory Levels At Location

Lists all inventory levels at a specified location.

List Locations

Lists all locations.

List Metafields

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

List Orders

Lists all orders.

List Orders (Deprecated)

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

List Product Images

Lists all product images for the specified product.

List Products

Lists all products.

List Variants

Lists all variants for the specified product.

List Webhooks

Lists all webhooks or webhooks for the current instance.

Raw Request

Sends a raw GraphQL request to Shopify.

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.

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.

Update Customer

Updates an existing customer by ID.

Update Fulfillment Service

Updates an existing fulfillment service.

Update Inventory Item

Updates an existing inventory item.

Update Product

Updates an existing product by ID.

Update Variant

Updates an existing product variant by ID.