⚙Tool
Shopify Tools
List and create products, and list and retrieve orders from a Shopify store via the Admin API
The Shopify provider manages products and orders in a Shopify store through the Shopify Admin REST API (version 2024-01). Use these tools in a workflow to list or create products and to list or fetch individual orders — for example, syncing a catalog, reacting to new orders, or pulling order details for fulfillment.
Overview
| Property | Value |
|---|---|
| Provider | shopify |
| Category | tools |
| Auth | API Key (Shopify Admin API access token via the X-Shopify-Access-Token header) |
Operations
| Operation | Tool ID | Description |
|---|---|---|
| List products | shopify_list_products | List products from a Shopify store |
| Create product | shopify_create_product | Create a new product in a Shopify store |
| List orders | shopify_list_orders | List orders from a Shopify store |
| Get order | shopify_get_order | Get a single order by ID from a Shopify store |
Configuration
shopify_list_products
| Parameter | Type | Required | Description |
|---|---|---|---|
apiKey | string | Yes | Secret. Shopify Admin API access token. Sent as the X-Shopify-Access-Token header. |
storeDomain | string | Yes | Shopify store domain (e.g. mystore.myshopify.com). |
limit | number | No | Number of products to return (default 50, max 250). |
shopify_create_product
| Parameter | Type | Required | Description |
|---|---|---|---|
apiKey | string | Yes | Secret. Shopify Admin API access token. Sent as the X-Shopify-Access-Token header. |
storeDomain | string | Yes | Shopify store domain (e.g. mystore.myshopify.com). |
title | string | Yes | Product title. |
body_html | string | No | Product description (HTML). |
shopify_list_orders
| Parameter | Type | Required | Description |
|---|---|---|---|
apiKey | string | Yes | Secret. Shopify Admin API access token. Sent as the X-Shopify-Access-Token header. |
storeDomain | string | Yes | Shopify store domain (e.g. mystore.myshopify.com). |
status | string | No | Order status filter. One of open, closed, cancelled, any. Defaults to any. |
limit | number | No | Number of orders to return (default 50, max 250). |
shopify_get_order
| Parameter | Type | Required | Description |
|---|---|---|---|
apiKey | string | Yes | Secret. Shopify Admin API access token. Sent as the X-Shopify-Access-Token header. |
storeDomain | string | Yes | Shopify store domain (e.g. mystore.myshopify.com). |
orderId | string | Yes | ID of the order to retrieve. |
Outputs
shopify_list_products
data(json) — Array of Shopify product objects.metadata(json) — List metadata.metadata.count(number) — Number of items returned.
shopify_create_product
data(json) — The created Shopify product object.metadata(json) — Product identifiers.metadata.id(string) — Product ID.
shopify_list_orders
data(json) — Array of Shopify order objects.metadata(json) — List metadata.metadata.count(number) — Number of items returned.
shopify_get_order
data(json) — The Shopify order object.metadata(json) — Order identifiers.metadata.id(string) — Order ID.
YAML Example
shopify_1:
type: shopify
name: "Shopify"
inputs:
operation: "shopify_list_products"
storeDomain: "mystore.myshopify.com"
limit: 50
apiKey: "{{SHOPIFY_API_KEY}}"
connections:
outgoing:
- target: next-block-idTips
- Auth setup: Create an Admin API access token in your Shopify store (Settings → Apps and sales channels → Develop apps). The token starts with
shpat_and is sent in theX-Shopify-Access-Tokenheader. Store it as an environment variable and reference it with{{SHOPIFY_API_KEY}}rather than hardcoding it. - Store domain format:
storeDomainmust be the full*.myshopify.comhost (nohttps://prefix and no trailing slash). All requests target the Admin REST API version2024-01. - Limits and filters:
limitaccepts up to 250 (default 50) for the list operations. Forshopify_list_orders,statusdefaults toany— set it toopen,closed, orcancelledto narrow results. - Chaining results: Reference outputs from a previous step with double braces, e.g. pass
{{shopify_1.metadata.id}}(a created product ID) or{{shopify_1.data}}(the array of orders/products) into a downstream block.