Shopify Component
Manage customers, products, and orders in Shopify.
Component key: shopify · Changelog ↓Description
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.
Example Shopify Integration
An example Shopify integration is available in the GitHub examples repository. Import the integration definition to try it out.
The example integration consists of four flows that demonstrate how to interact with the Shopify API:
-
Initial Product Sync runs when an instance of the integration is deployed. It loops over Shopify's paginated API, fetching pages of products and sending all products to an "Acme API" (replace with the desired API endpoint).
-
Product Update Listener subscribes to
product/create,product/updateandproduct/deleteevents from Shopify. When a product is created, updated, or deleted in Shopify, the integration receives a webhook request from Shopify and sends the create, update, or delete to the "Acme API". -
List Inventory Levels fetches inventory levels for all products in Shopify at a particular location specified as part of the deployment process. The flow is triggered synchronously, so the caller receives a response with a JSON body containing the inventory levels.
-
Create New Product is a flow that creates a new product in Shopify. To invoke the flow, send a POST request to the flow's webhook endpoint with a format that looks like this:
{"name": "Green T-Shirt","description": "A green t-shirt","product_type": "T-Shirt","vendor": "Acme"}
Connections
Access Token
key: adminApiAccessTokenAn 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:
- Log in to the Shopify admin dashboard.
- Navigate to Settings > Apps and sales channels.
- Click Develop apps.
- If prompted, click Allow custom app development.
- Click Create an app and provide a name for the app.
- Click Configure Admin API scopes and select the required scopes for the integration.
- Click Save.
- Navigate to the API credentials tab.
- Under Admin API access token, click Install app to generate the token.
- 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.
| Input | Notes | Example |
|---|---|---|
| Admin API Access Token | Generate from the 'API credentials' tab of a private Shopify app. Learn more at Shopify Admin API. | shpat_a1b2c3d4e5f6g7h8i9j0k1l2m3n4o5p6 |
| API Version | Shopify API version to use. See Shopify API versioning for available versions. | 2026-01 |
| Host | The domain of the Shopify store without https:// (e.g., my-store.myshopify.com). | my-store.myshopify.com |
OAuth 2.0 (Deprecated)
key: oauth2| Input | Notes | Example |
|---|---|---|
| API Version | Shopify API version to use. See Shopify API versioning for available versions. | 2026-01 |
| Authorize URL | The OAuth 2.0 Authorization URL for Shopify. | https://YOUR-SHOPIFY-DOMAIN.myshopify.com/admin/oauth/authorize |
| Client ID (API Key) | The Client ID (also called API Key) from the Shopify app credentials. | a1b2c3d4e5f6g7h8i9j0k1l2m3n4o5p6 |
| Client Secret (API Secret) | The Client Secret (also called API Secret) from the Shopify app credentials. | shpss_a1b2c3d4e5f6g7h8i9j0k1l2m3n4o5p6 |
| Host | The domain of the Shopify store without https:// (e.g., my-store.myshopify.com). | my-store.myshopify.com |
| Scopes | Space-separated list of OAuth permission scopes. See Shopify access scopes for all available scopes. | read_customers read_draft_orders read_fulfillments read_orders |
| Token URL | The OAuth 2.0 Token URL for Shopify. | https://YOUR-SHOPIFY-DOMAIN.myshopify.com/admin/oauth/access_token |
OAuth 2.0
key: oauth2-dynamic-inputsShopify 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
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.
-
Log in to the Dev Dashboard, or navigate from the Partner Dashboard via App Distribution > Visit Dev Dashboard.
-
Click Create app.
-
Select Create app manually and provide an app name.
-
Navigate to the Configuration section of the created app.
-
Under App URL, enter a valid URL (this is required but can be a placeholder).
-
Under Allowed redirection URL(s), enter:
https://oauth2.prismatic.io/callback -
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.
- Install the Shopify CLI if not already installed.
- Navigate to the desired project directory and run:
shopify app init
- When prompted, provide an app name and select a template (the React Router template is recommended for most use cases).
- Navigate to the new app directory and start the development server:
cd my-new-appshopify app dev
- The CLI prompts for login to a developer account, creates the app in the Dev Dashboard, and establishes a connection to a dev store.
- Once the dev server is running, press
pto 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:
- Open the app in the Dev Dashboard.
- Navigate to the Configuration section.
- Scroll to the Client credentials section.
- Copy the Client ID (labeled as API key in Shopify).
- 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:
Refer to Shopify's access scopes documentation for a complete list of available scopes.read_customers read_draft_orders read_fulfillments read_inventoryread_orders read_products read_locations write_customerswrite_draft_orders write_fulfillments write_inventorywrite_orders write_products write_locations
- 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.
| Input | Notes | Example |
|---|---|---|
| API Version | Shopify API version to use. See Shopify API versioning for available versions. | 2026-01 |
| Authorize URL | The OAuth 2.0 Authorization URL for Shopify. | https://{{#domain}}.myshopify.com/admin/oauth/authorize/ |
| Client ID (API Key) | The Client ID (also called API Key) from the Shopify app credentials. | a1b2c3d4e5f6g7h8i9j0k1l2m3n4o5p6 |
| Client Secret (API Secret) | The Client Secret (also called API Secret) from the Shopify app credentials. | shpss_a1b2c3d4e5f6g7h8i9j0k1l2m3n4o5p6 |
| Shop Name | The Shopify shop name without the .myshopify.com suffix (e.g., my-store). | my-store |
| Host | The domain of the Shopify store without the https:// prefix. | {{#domain}}.myshopify.com |
| Scopes | Space-separated list of OAuth permission scopes. See Shopify access scopes for all available scopes. | read_customers read_draft_orders read_fulfillments read_orders |
| Token URL | The OAuth 2.0 Token URL for Shopify. | https://{{#domain}}.myshopify.com/admin/oauth/access_token |
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. | key: eventTopicWebhookGql
| Input | Notes | Example |
|---|---|---|
| Secret Key | The Shopify app's client secret, viewable from the Partner Dashboard. | |
| Connection | The Shopify connection to use. | |
| Webhook Topic | The topic for the webhook. This is the event that will trigger the webhook. | APP_PURCHASES_ONE_TIME_UPDATE |
The Event Topic Webhook trigger manages Shopify webhook subscriptions for an instance. Unlike manual webhook configuration, this trigger handles the entire webhook lifecycle automatically using the Shopify GraphQL API.
When the trigger is used in a flow:
- On Instance Deploy: The trigger automatically creates webhook subscriptions in the Shopify store for the selected event topics (customer creation, order updates, product changes, etc.). The webhook callback URL is set to the instance's unique webhook URL. If subscriptions for the same topics and URL already exist, they are reused to prevent duplication.
- On Instance Deletion: The trigger automatically removes webhook subscriptions from the Shopify store that match the instance's webhook URL. This ensures no orphaned webhook configurations remain after instance cleanup.
Configuration Requirements
This trigger requires:
- Connection: A Shopify connection with appropriate API access permissions
- Secret Key: The Shopify app's client secret for HMAC signature verification, viewable from the app's Configuration section in the Shopify Partner Dashboard
- Webhook Topics: One or more event types to subscribe to (see Event Topics below)
Signature Verification
The trigger includes built-in HMAC-SHA256 signature verification to ensure webhook requests are authentic. When a webhook is received:
- The trigger extracts the
X-Shopify-Hmac-SHA256header from the request - Computes the expected signature using the configured Secret Key
- Compares the computed signature with the received signature
- Rejects requests with mismatched signatures
The trigger automatically returns a 200 OK response with the parsed JSON body for verified webhooks.
Event Topics Configuration
Select which Shopify events should trigger the flow.
Available Event Topics (67)
Customer Events:
CUSTOMERS_CREATE,CUSTOMERS_UPDATE,CUSTOMERS_DELETECUSTOMERS_ENABLE,CUSTOMERS_DISABLE,CUSTOMERS_MERGECUSTOMERS_EMAIL_MARKETING_CONSENT_UPDATE,CUSTOMERS_MARKETING_CONSENT_UPDATE
Order Events:
ORDERS_CREATE,ORDERS_UPDATED,ORDERS_DELETE,ORDERS_CANCELLEDORDERS_FULFILLED,ORDERS_PARTIALLY_FULFILLED,ORDERS_PAID,ORDERS_EDITEDORDERS_RISK_ASSESSMENT_CHANGED,ORDERS_SHOPIFY_PROTECT_ELIGIBILITY_CHANGED
Product Events:
PRODUCTS_CREATE,PRODUCTS_UPDATE,PRODUCTS_DELETEPRODUCT_LISTINGS_ADD,PRODUCT_LISTINGS_REMOVE,PRODUCT_LISTINGS_UPDATEPRODUCT_PUBLICATIONS_CREATE,PRODUCT_PUBLICATIONS_UPDATE,PRODUCT_PUBLICATIONS_DELETE
Fulfillment Events:
FULFILLMENTS_CREATE,FULFILLMENTS_UPDATEFULFILLMENT_ORDERS_CANCELLED,FULFILLMENT_ORDERS_FULFILLMENT_REQUEST_ACCEPTEDFULFILLMENT_ORDERS_FULFILLMENT_REQUEST_REJECTED,FULFILLMENT_ORDERS_HOLD_RELEASED
Inventory Events:
INVENTORY_ITEMS_CREATE,INVENTORY_ITEMS_UPDATE,INVENTORY_ITEMS_DELETEINVENTORY_LEVELS_CONNECT,INVENTORY_LEVELS_DISCONNECT,INVENTORY_LEVELS_UPDATE
Collection Events:
COLLECTIONS_CREATE,COLLECTIONS_UPDATE,COLLECTIONS_DELETECOLLECTION_LISTINGS_ADD,COLLECTION_LISTINGS_REMOVE,COLLECTION_LISTINGS_UPDATE
Company Events (B2B):
COMPANIES_CREATE,COMPANIES_UPDATE,COMPANIES_DELETECOMPANY_CONTACTS_CREATE,COMPANY_CONTACTS_UPDATE,COMPANY_CONTACTS_DELETECOMPANY_LOCATIONS_CREATE,COMPANY_LOCATIONS_UPDATE,COMPANY_LOCATIONS_DELETE
Draft Order Events:
DRAFT_ORDERS_CREATE,DRAFT_ORDERS_UPDATE,DRAFT_ORDERS_DELETE
Other Events:
- App lifecycle:
APP_UNINSTALLED,APP_SUBSCRIPTIONS_UPDATE,APP_SCOPES_UPDATE - Cart:
CARTS_CREATE,CARTS_UPDATE - Checkout:
CHECKOUTS_CREATE,CHECKOUTS_UPDATE,CHECKOUTS_DELETE - Disputes:
DISPUTES_CREATE,DISPUTES_UPDATE - Refunds:
REFUNDS_CREATE - Shop:
SHOP_UPDATE - Themes:
THEMES_CREATE,THEMES_UPDATE,THEMES_DELETE,THEMES_PUBLISH - Subscriptions:
SUBSCRIPTION_CONTRACTS_CREATE,SUBSCRIPTION_CONTRACTS_UPDATE,SUBSCRIPTION_BILLING_ATTEMPTS_SUCCESS
A complete list of webhook topics and their payloads is available in the Shopify Webhook Topics documentation.
Webhook Payload Example
When a webhook is received, the trigger provides the parsed JSON body.
Example: CUSTOMERS_CREATE Event
{
"id": 5940139491234,
"email": "john.doe@example.com",
"created_at": "2024-11-10T10:30:00-05:00",
"updated_at": "2024-11-10T10:30:00-05:00",
"first_name": "John",
"last_name": "Doe",
"phone": "+18005555454",
"state": "enabled",
"tags": "VIP",
"note": null,
"verified_email": true,
"multipass_identifier": null,
"tax_exempt": false,
"accepts_marketing": true,
"addresses": [],
"admin_graphql_api_id": "gid://shopify/Customer/5940139491234"
}
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. | key: eventTopicWebhook
| Input | Notes | Example |
|---|---|---|
| Connection | The Shopify connection to use. | |
| Secret Key | The Shopify app's client secret, viewable from the Partner Dashboard. | |
| Event Topic Name | Event that triggers the webhook. | products/create |
New and Updated Customers
Checks for new and updated customers in Shopify on a configured schedule. | key: customersPollingTrigger
| Input | Notes | Example |
|---|---|---|
| Connection | The Shopify connection to use. |
Checks for new and updated customers in a Shopify store on a configured schedule.
How It Works
The trigger operates by:
- Running on the configured schedule (e.g., every 5 minutes)
- Querying the Shopify GraphQL API for customers modified since the last poll using the
updated_atfilter - Categorizing customers as "created" or "updated" based on their
createdAttimestamp compared to the last poll time - Maintaining state automatically to track the last poll time
- Returning all customers on the first run (when no previous poll state exists)
Configuration
The trigger requires only a Shopify connection. Schedule configuration is handled by the platform.
Returned Data
The trigger returns data with customers categorized by change type:
Example Response
{
"data": {
"created": [
{
"id": "gid://shopify/Customer/5940139491234",
"displayName": "John Doe",
"email": "john.doe@example.com",
"phone": "+18005555454",
"createdAt": "2024-11-10T10:30:00Z",
"updatedAt": "2024-11-10T10:30:00Z",
"state": "ENABLED",
"tags": ["VIP"]
}
],
"updated": [
{
"id": "gid://shopify/Customer/5940139491235",
"displayName": "Jane Smith",
"email": "jane.smith@example.com",
"phone": "+18005555455",
"createdAt": "2024-11-08T09:00:00Z",
"updatedAt": "2024-11-10T14:22:00Z",
"state": "ENABLED",
"tags": []
}
]
}
}
New and Updated Orders
Checks for new and updated orders in Shopify on a configured schedule. | key: ordersPollingTrigger
| Input | Notes | Example |
|---|---|---|
| Connection | The Shopify connection to use. |
Checks for new and updated orders in a Shopify store on a configured schedule.
How It Works
The trigger operates by:
- Running on the configured schedule (e.g., every 5 minutes)
- Querying the Shopify GraphQL API for orders modified since the last poll using the
updated_atfilter - Categorizing orders as "created" or "updated" based on their
createdAttimestamp compared to the last poll time - Maintaining state automatically to track the last poll time
- Returning all orders on the first run (when no previous poll state exists)
Configuration
The trigger requires only a Shopify connection. Schedule configuration is handled by the platform.
Returned Data
The trigger returns data with orders categorized by change type:
Example Response
{
"data": {
"created": [
{
"id": "gid://shopify/Order/10079785100",
"name": "#1001",
"email": "customer@example.com",
"createdAt": "2024-11-10T10:30:00Z",
"updatedAt": "2024-11-10T10:30:00Z",
"displayFinancialStatus": "PAID",
"displayFulfillmentStatus": "UNFULFILLED",
"totalPriceSet": {
"shopMoney": {
"amount": "199.99",
"currencyCode": "USD"
}
}
}
],
"updated": [
{
"id": "gid://shopify/Order/10079785101",
"name": "#1002",
"email": "customer2@example.com",
"createdAt": "2024-11-08T09:00:00Z",
"updatedAt": "2024-11-10T14:22:00Z",
"displayFinancialStatus": "PAID",
"displayFulfillmentStatus": "FULFILLED",
"totalPriceSet": {
"shopMoney": {
"amount": "299.99",
"currencyCode": "USD"
}
}
}
]
}
}
New and Updated Products
Checks for new and updated products in Shopify on a configured schedule. | key: productsPollingTrigger
| Input | Notes | Example |
|---|---|---|
| Connection | The Shopify connection to use. |
Checks for new and updated products in a Shopify store on a configured schedule.
How It Works
The trigger operates by:
- Running on the configured schedule (e.g., every 5 minutes)
- Querying the Shopify GraphQL API for products modified since the last poll using the
updated_atfilter - Categorizing products as "created" or "updated" based on their
createdAttimestamp compared to the last poll time - Maintaining state automatically to track the last poll time
- Returning all products on the first run (when no previous poll state exists)
Configuration
The trigger requires only a Shopify connection. Schedule configuration is handled by the platform.
Returned Data
The trigger returns data with products categorized by change type:
Example Response
{
"data": {
"created": [
{
"id": "gid://shopify/Product/108828309",
"title": "Example Product",
"handle": "example-product",
"vendor": "Burton Inc.",
"productType": "T-shirt",
"status": "ACTIVE",
"createdAt": "2024-11-10T10:30:00Z",
"updatedAt": "2024-11-10T10:30:00Z",
"tags": ["Style", "New"],
"variants": {
"nodes": [
{
"id": "gid://shopify/ProductVariant/1070325177",
"price": "19.99",
"sku": "EXAMPLE-SKU"
}
]
}
}
],
"updated": [
{
"id": "gid://shopify/Product/108828310",
"title": "Updated Product",
"handle": "updated-product",
"vendor": "Acme Corp.",
"productType": "Shoes",
"status": "ACTIVE",
"createdAt": "2024-11-08T09:00:00Z",
"updatedAt": "2024-11-10T14:22:00Z",
"tags": ["Sale"],
"variants": {
"nodes": [
{
"id": "gid://shopify/ProductVariant/1070325178",
"price": "49.99",
"sku": "UPDATED-SKU"
}
]
}
}
]
}
}
Webhook
Receive and validate webhook requests from Shopify for manually configured webhook subscriptions. | key: webhook
| Input | Notes | Example |
|---|---|---|
| Secret Key | The Shopify app's client secret, viewable from the Partner Dashboard. |
A Shopify webhook can be configured manually to send information to a flow's webhook URL when specific events occur (a customer is created, an order is shipped, etc.).
This trigger receives and validates webhook requests from Shopify for manually configured webhook subscriptions.
How It Works
When a webhook request is received, the trigger performs HMAC-SHA256 signature verification to ensure the request originated from Shopify:
- The trigger extracts the
X-Shopify-Hmac-SHA256header from the incoming request - It computes the expected signature using the configured Secret Key and the request body
- If the signatures match, the trigger returns a 200 OK response with the parsed JSON body
- If the signatures do not match, the request is rejected
Configuration
- Secret Key: The Shopify app's client secret, used for HMAC signature verification. This value is available in the app's credentials section of the Shopify Dev Dashboard.
Event Types
A full list of configurable webhook topics is available in the Shopify Webhook Topics documentation.
Data Sources
Select Collection
Selects a collection from a list of all collections. | key: listCollections | type: picklist
| Input | Notes | Example |
|---|---|---|
| Connection | The Shopify connection to use. |
Select Customer
Selects a customer from a list of all customers. | key: listCustomers | type: picklist
| Input | Notes | Example |
|---|---|---|
| Connection | The Shopify connection to use. |
Select Draft Order
Selects a draft order from a list of all draft orders. | key: listDraftOrders | type: picklist
| Input | Notes | Example |
|---|---|---|
| Connection | The Shopify connection to use. |
Select Fulfillment
Selects a fulfillment from a list of all fulfillments. | key: listFulfillments | type: picklist
| Input | Notes | Example |
|---|---|---|
| Order ID | The unique ID of the order. | 450789469 |
| Connection | The Shopify connection to use. |
Select Fulfillment Order
Selects a fulfillment order from a list of all fulfillment orders. | key: listFulfillmentOrders | type: picklist
| Input | Notes | Example |
|---|---|---|
| Order ID | The unique ID of the order. | 450789469 |
| Connection | The Shopify connection to use. |
Select Fulfillment Service
Selects a fulfillment service from a list of all fulfillment services. | key: listFulfillmentServices | type: picklist
| Input | Notes | Example |
|---|---|---|
| Connection | The Shopify connection to use. |
Select Inventory Item
Selects an inventory item from a list of all inventory items. | key: listInventoryItems | type: picklist
| Input | Notes | Example |
|---|---|---|
| Connection | The Shopify connection to use. |
Select Location
Selects a location from a list of all locations. | key: listLocations | type: picklist
| Input | Notes | Example |
|---|---|---|
| Connection | The Shopify connection to use. |
Select Order
Selects an order from a list of all orders. | key: listOrders | type: picklist
| Input | Notes | Example |
|---|---|---|
| Connection | The Shopify connection to use. |
Select Product
Selects a product from a list of all products. | key: listProducts | type: picklist
| Input | Notes | Example |
|---|---|---|
| Connection | The Shopify connection to use. |
Select Product Image
Selects a product image from a list of images for the specified product. | key: listProductImages | type: picklist
| Input | Notes | Example |
|---|---|---|
| Product ID | The unique ID of the product. | 74020090 |
| Connection | The Shopify connection to use. |
Select Variant
Selects a product variant from a list of variants for the specified product. | key: listVariants | type: picklist
| Input | Notes | Example |
|---|---|---|
| Product ID | The unique ID of the product. | 74020090 |
| Connection | The Shopify connection to use. |
Actions
Cancel Order
Cancels an existing order. | key: cancelOrderGql
| Input | Notes | Example |
|---|---|---|
| Notify Customer | Whether the customer should be notified of the cancellation. | false |
| Order ID | The unique identifier for the order. | 10079785100 or gid://shopify/Order/10079785100 |
| Reason | The reason for the cancellation. | CUSTOMER |
| Refund | Whether to refund the amount paid by the customer. | false |
| Restock | Whether to restock the inventory committed to the order. | false |
| Connection | The Shopify connection to use. | |
| Staff Note | A staff-facing note about the order cancellation. This is not visible to the customer. | This is a staff note. |
{
"data": {
"job": {
"id": "gid://shopify/Job/d3dcd8af-2cb6-4995-ab04-634a21891234",
"done": false
},
"orderCancelUserErrors": [],
"userErrors": []
}
}
Close Order
Closes an existing order. | key: closeOrderGql
| Input | Notes | Example |
|---|---|---|
| Order ID | The unique identifier for the order. | 10079785100 or gid://shopify/Order/10079785100 |
| Connection | The Shopify connection to use. |
{
"data": {
"order": {
"id": "gid://shopify/Order/1234567890123",
"name": "#1234",
"app": {
"id": "gid://shopify/App/9876543210987"
},
"clientIp": "0.0.0.0",
"customerAcceptsMarketing": false,
"cancelReason": null,
"cancelledAt": null,
"closedAt": null,
"confirmationNumber": "ABC123XYZ",
"confirmed": true,
"createdAt": "2024-12-08T11:29:38Z",
"currencyCode": "USD",
"currentSubtotalPriceSet": {
"shopMoney": {
"amount": "50.00",
"currencyCode": "USD"
},
"presentmentMoney": {
"amount": "50.00",
"currencyCode": "USD"
}
},
"currentTotalAdditionalFeesSet": null,
"currentTotalDiscountsSet": {
"shopMoney": {
"amount": "5.00",
"currencyCode": "USD"
},
"presentmentMoney": {
"amount": "5.00",
"currencyCode": "USD"
}
},
"currentTotalDutiesSet": null,
"currentTotalPriceSet": {
"shopMoney": {
"amount": "50.00",
"currencyCode": "USD"
},
"presentmentMoney": {
"amount": "50.00",
"currencyCode": "USD"
}
},
"currentTotalTaxSet": {
"shopMoney": {
"amount": "0.00",
"currencyCode": "USD"
},
"presentmentMoney": {
"amount": "0.00",
"currencyCode": "USD"
}
},
"customerLocale": "en",
"discountCodes": [],
"dutiesIncluded": false,
"email": "example@example.com",
"estimatedTaxes": false,
"displayFinancialStatus": "PAID",
"displayFulfillmentStatus": "UNFULFILLED",
"retailLocation": null,
"merchantBusinessEntity": {
"id": "gid://shopify/BusinessEntity/1122334455667"
},
"merchantOfRecordApp": null,
"note": "Example note",
"originalTotalAdditionalFeesSet": null,
"originalTotalDutiesSet": null,
"paymentGatewayNames": [
"manual"
],
"phone": null,
"poNumber": null,
"presentmentCurrencyCode": "USD",
"processedAt": "2024-12-08T11:29:38Z",
"sourceIdentifier": "example-source-id",
"sourceName": "9876543210987",
"registeredSourceUrl": null,
"subtotalPriceSet": {
"shopMoney": {
"amount": "50.00",
"currencyCode": "USD"
},
"presentmentMoney": {
"amount": "50.00",
"currencyCode": "USD"
}
},
"tags": [],
"taxExempt": true,
"taxLines": [],
"taxesIncluded": false,
"test": false,
"totalCashRoundingAdjustment": {
"paymentSet": {
"shopMoney": {
"amount": "0.00",
"currencyCode": "USD"
},
"presentmentMoney": {
"amount": "0.00",
"currencyCode": "USD"
}
},
"refundSet": {
"shopMoney": {
"amount": "0.00",
"currencyCode": "USD"
},
"presentmentMoney": {
"amount": "0.00",
"currencyCode": "USD"
}
}
},
"totalDiscountsSet": {
"shopMoney": {
"amount": "5.00",
"currencyCode": "USD"
},
"presentmentMoney": {
"amount": "5.00",
"currencyCode": "USD"
}
},
"totalOutstandingSet": {
"shopMoney": {
"amount": "0.00",
"currencyCode": "USD"
}
},
"totalPriceSet": {
"shopMoney": {
"amount": "50.00",
"currencyCode": "USD"
},
"presentmentMoney": {
"amount": "50.00",
"currencyCode": "USD"
}
},
"totalShippingPriceSet": {
"shopMoney": {
"amount": "0.00",
"currencyCode": "USD"
},
"presentmentMoney": {
"amount": "0.00",
"currencyCode": "USD"
}
},
"totalTaxSet": {
"shopMoney": {
"amount": "0.00",
"currencyCode": "USD"
},
"presentmentMoney": {
"amount": "0.00",
"currencyCode": "USD"
}
},
"totalTipReceivedSet": {
"shopMoney": {
"amount": "0.00",
"currencyCode": "USD"
}
},
"totalWeight": "5000",
"updatedAt": "2024-12-08T11:29:39Z",
"billingAddress": {
"address1": "123 Example St",
"address2": null,
"name": "John Doe",
"lastName": "Doe",
"company": null,
"phone": null,
"zip": "12345",
"country": "United States",
"countryCodeV2": "US",
"province": "California",
"provinceCode": "CA"
},
"customer": {
"id": "gid://shopify/Customer/4567890123456",
"displayName": "John Doe",
"firstName": "John",
"lastName": "Doe",
"phone": null
},
"lineItems": {
"nodes": [
{
"id": "gid://shopify/LineItem/2345678901234",
"currentQuantity": 3,
"unfulfilledQuantity": 3,
"isGiftCard": false,
"name": "Sample Product",
"originalUnitPriceSet": {
"shopMoney": {
"amount": "16.67",
"currencyCode": "USD"
},
"presentmentMoney": {
"amount": "16.67",
"currencyCode": "USD"
}
},
"product": null,
"quantity": 3,
"requiresShipping": true,
"sku": "EX123",
"taxable": true,
"title": "Sample Product",
"totalDiscountSet": {
"shopMoney": {
"amount": "5.00",
"currencyCode": "USD"
},
"presentmentMoney": {
"amount": "5.00",
"currencyCode": "USD"
}
},
"variant": null,
"vendor": "Example Vendor",
"taxLines": [
{
"channelLiable": false,
"priceSet": {
"shopMoney": {
"amount": "0.00",
"currencyCode": "USD"
},
"presentmentMoney": {
"amount": "0.00",
"currencyCode": "USD"
}
},
"rate": 0.05,
"title": "Example Tax"
}
],
"duties": [],
"discountAllocations": [
{
"allocatedAmountSet": {
"shopMoney": {
"amount": "5.00",
"currencyCode": "USD"
},
"presentmentMoney": {
"amount": "5.00",
"currencyCode": "USD"
}
},
"discountApplication": {
"index": 0
}
}
]
}
]
},
"paymentTerms": null,
"refunds": [],
"shippingAddress": {
"firstName": "John",
"address1": "123 Example St",
"phone": null,
"city": "Example City",
"zip": "12345",
"province": "California",
"country": "United States",
"lastName": "Doe",
"address2": null,
"company": null,
"latitude": null,
"longitude": null,
"name": "John Doe",
"countryCodeV2": "US",
"provinceCode": "CA"
}
},
"userErrors": []
}
}
Complete Draft Order
Marks a draft order as complete. | key: completeDraftOrderGql
| Input | Notes | Example |
|---|---|---|
| Draft Order Id | The unique identifier for the draft order. | 916042021234 or gid://shopify/DraftOrder/916042021234 |
| Connection | The Shopify connection to use. |
{
"data": {
"draftOrder": {
"id": "gid://shopify/DraftOrder/1234567890123",
"note2": "Sample Note",
"email": "example@email.com",
"taxesIncluded": false,
"currencyCode": "USD",
"invoiceSentAt": null,
"createdAt": "2024-12-31T07:30:32Z",
"updatedAt": "2024-12-31T07:30:33Z",
"taxExempt": true,
"completedAt": "2024-12-31T07:30:33Z",
"name": "#D123",
"status": "COMPLETED",
"lineItems": {
"nodes": [
{
"id": "gid://shopify/DraftOrderLineItem/9876543210987",
"variant": null,
"product": null,
"title": "Example Product",
"variantTitle": null,
"sku": null,
"vendor": null,
"quantity": 3,
"requiresShipping": false,
"taxable": true,
"isGiftCard": false,
"fulfillmentService": {
"type": "MANUAL"
},
"weight": {
"unit": "KILOGRAMS",
"value": 2
},
"taxLines": [
{
"channelLiable": null,
"priceSet": {
"shopMoney": {
"amount": "0.0",
"currencyCode": "USD"
}
},
"rate": 0.05,
"ratePercentage": 5,
"source": "Shopify",
"title": "Example State Tax"
}
],
"appliedDiscount": {
"title": "Promo",
"value": 10,
"valueType": "PERCENTAGE",
"description": "Seasonal Discount",
"amountSet": {
"shopMoney": {
"amount": "5.00",
"currencyCode": "USD"
}
}
},
"name": "Example Product",
"custom": true,
"originalUnitPriceSet": {
"shopMoney": {
"currencyCode": "USD",
"amount": "20.00"
}
}
}
]
},
"shippingAddress": {
"firstName": "John",
"address1": "123 Example St",
"phone": "123-456-7890",
"city": "Example City",
"zip": "12345",
"province": "California",
"country": "United States",
"lastName": "Doe",
"address2": "Apt 101",
"company": "Example Corp",
"latitude": null,
"longitude": null,
"name": "John Doe",
"countryCodeV2": "US",
"provinceCode": "CA"
},
"billingAddress": {
"firstName": "John",
"address1": "123 Example St",
"phone": "123-456-7890",
"city": "Example City",
"zip": "12345",
"province": "California",
"country": "United States",
"lastName": "Doe",
"address2": "Apt 101",
"company": "Example Corp",
"latitude": null,
"longitude": null,
"name": "John Doe",
"countryCodeV2": "US",
"provinceCode": "CA"
},
"invoiceUrl": "https://example-store.myshopify.com/123456/invoices/abcdef123456",
"appliedDiscount": null,
"order": {
"id": "gid://shopify/Order/8765432109876"
},
"shippingLine": null,
"taxLines": [],
"tags": [],
"totalPriceSet": {
"shopMoney": {
"amount": "60.00",
"currencyCode": "USD"
}
},
"subtotalPriceSet": {
"shopMoney": {
"amount": "60.00",
"currencyCode": "USD"
}
},
"totalTaxSet": {
"shopMoney": {
"amount": "0.0",
"currencyCode": "USD"
}
},
"paymentTerms": null,
"customer": {
"id": "gid://shopify/Customer/1234567890123",
"email": "example@email.com",
"createdAt": "2022-01-01T10:00:00Z",
"updatedAt": "2024-12-31T07:30:33Z",
"firstName": "John",
"lastName": "Doe",
"numberOfOrders": "5",
"state": "ENABLED",
"amountSpent": {
"amount": "500.00",
"currencyCode": "USD"
},
"lastOrder": {
"id": "gid://shopify/Order/8765432109876",
"name": "#5678"
},
"note": null,
"verifiedEmail": true,
"multipassIdentifier": null,
"taxExempt": false,
"tags": [],
"phone": "123-456-7890",
"taxExemptions": [],
"emailMarketingConsent": {
"marketingState": "SUBSCRIBED",
"consentUpdatedAt": null
},
"smsMarketingConsent": null,
"defaultAddress": {
"id": "gid://shopify/MailingAddress/9876543210987",
"firstName": "John",
"lastName": "Doe",
"company": "Example Corp",
"address1": "123 Example St",
"address2": "Apt 101",
"city": "Example City",
"province": "California",
"country": "United States",
"zip": "12345",
"phone": "123-456-7890",
"name": "John Doe",
"provinceCode": "CA",
"countryCodeV2": "US"
}
}
},
"userErrors": []
}
}
Connect Inventory Item To Location
Connects an existing inventory item to a location. | key: connectInventoryLevelGql
| Input | Notes | Example |
|---|---|---|
| Inventory Item Id | The unique identifier for the inventory item. | gid://shopify/InventoryItem/43933612241234 |
| Location ID | The ID of the location that the inventory level belongs to. | 346779380 or gid://shopify/Location/346779380 |
| Connection | The Shopify connection to use. |
{
"data": {
"inventoryLevel": {
"id": "gid://shopify/InventoryLevel/523463154?inventory_item_id=43729076",
"item": {
"id": "gid://shopify/InventoryItem/43729076"
},
"location": {
"id": "gid://shopify/Location/346779380"
},
"quantities": [
{
"name": "available",
"quantity": 0
}
],
"updatedAt": "2024-11-07T20:59:45Z"
},
"userErrors": []
}
}
Count Collections
Returns a count of all collections. | key: countCollectionsGql
| Input | Notes | Example |
|---|---|---|
| Connection | The Shopify connection to use. |
{
"data": {
"count": 5
}
}
Count Customers
Returns a count of all customers. | key: countCustomersGql
| Input | Notes | Example |
|---|---|---|
| Connection | The Shopify connection to use. |
{
"data": {
"count": 20
}
}
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. | key: countDraftOrdersGql
| Input | Notes | Example |
|---|---|---|
| Connection | The Shopify connection to use. |
{
"data": {
"count": 5
}
}
Count Locations
Returns a count of all locations. | key: countLocationsGql
| Input | Notes | Example |
|---|---|---|
| Connection | The Shopify connection to use. |
{
"data": {
"count": 10
}
}
Count Orders
Returns a count of all orders. | key: countOrdersGql
| Input | Notes | Example |
|---|---|---|
| Connection | The Shopify connection to use. |
{
"data": {
"count": 58
}
}
Count Product Images
Returns a count of all product images for the specified product. | key: countProductImagesGql
| Input | Notes | Example |
|---|---|---|
| Product ID | The unique identifier for the product. | 108828309 or gid://shopify/Product/108828309 |
| Connection | The Shopify connection to use. |
{
"data": {
"count": 5
}
}
Count Products
Returns a count of all products. | key: countProducts
| Input | Notes | Example |
|---|---|---|
| Connection | The Shopify connection to use. |
{
"data": {
"data": {
"count": 5
},
"headers": {
"date": "Wed, 27 Mar 2024 00:52:16 GMT",
"content-type": "application/json; charset=utf-8",
"transfer-encoding": "chunked",
"connection": "close",
"x-sorting-hat-podid": "152",
"x-sorting-hat-shopid": "12345678912",
"vary": "Accept-Encoding, Accept",
"referrer-policy": "origin-when-cross-origin",
"x-frame-options": "DENY",
"x-shopid": "12345678912",
"x-shardid": "152",
"x-stats-userid": "",
"x-stats-apiclientid": "6511123",
"x-stats-apipermissionid": "429538082969",
"x-shopify-api-version": "2023-04",
"x-shopify-api-version-warning": "https://shopify.dev/concepts/about-apis/versioning",
"http_x_shopify_shop_api_call_limit": "3/40",
"x-shopify-shop-api-call-limit": "3/40",
"strict-transport-security": "max-age=7889238",
"x-request-id": "4c63b1a7-fdc1-4113-a2d5-46f6c883c1d9-123456",
"server-timing": "processing;dur=57, cfRequestDuration;dur=134.000063",
"x-shopify-stage": "production",
"content-security-policy": "default-src 'self' data: blob: 'unsafe-inline' 'unsafe-eval' https://* shopify-pos://*; block-all-mixed-content; child-src 'self' https://* shopify-pos://*; connect-src 'self' wss://* https://*; frame-ancestors 'none'; img-src 'self' data: blob: https:; script-src https://cdn.shopify.com https://cdn.shopifycdn.net https://checkout.shopifycs.com https://api.stripe.com https://mpsnare.iesnare.com https://appcenter.intuit.com https://www.paypal.com https://js.braintreegateway.com https://c.paypal.com https://maps.googleapis.com https://www.google-analytics.com https://v.shopify.com 'self' 'unsafe-inline' 'unsafe-eval'; upgrade-insecure-requests; report-uri /csp-report?source%5Baction%5D=show&source%5Bapp%5D=Shopify&source%5Bcontroller%5D=admin%2Fcollects&source%5Bsection%5D=admin_api&source%5Buuid%5D=4c63b1a7-fdc1-4113-a2d5-46f6c883c1d9-123456",
"x-content-type-options": "nosniff",
"x-download-options": "noopen",
"x-permitted-cross-domain-policies": "none",
"x-xss-protection": "1; mode=block; report=/xss-report?source%5Baction%5D=show&source%5Bapp%5D=Shopify&source%5Bcontroller%5D=admin%2Fcollects&source%5Bsection%5D=admin_api&source%5Buuid%5D=4c63b1a7-fdc1-4113-a2d5-46f6c883c1d9-123456",
"x-envoy-upstream-service-time": "59",
"x-dc": "gcp-northamerica-northeast2,gcp-us-central1",
"cf-cache-status": "DYNAMIC",
"report-to": "{\"endpoints\":[{\"url\":\"https:\\/\\/a.nel.cloudflare.com\\/report\\/v4?s=bSI8sLfHnRK2xdtpDsJLmjZsjNiEF9jW2sYK9naPjTlyeKLJ8DBSsj00CktG5DIPBht7esrQCCPe61VrMCWdM6dW3uCwmngxHy8iJi8Caumvx65uVDdkSQIZOZGV5hvWmbubfOW9xyg7HkPcf8sAQcv3\"}],\"group\":\"cf-nel\",\"max_age\":604800}",
"nel": "{\"success_fraction\":0.01,\"report_to\":\"cf-nel\",\"max_age\":604800}",
"server": "cloudflare",
"cf-ray": "86ab65927cbbe283-ORD",
"alt-svc": "h3=\":443\"; ma=86400"
}
}
}
Count Variants
Returns a count of all product variants. | key: countVariantsGql
| Input | Notes | Example |
|---|---|---|
| Connection | The Shopify connection to use. |
{
"data": {
"count": 12
}
}
Create Account Activation URL
Creates an account activation URL for an existing customer. | key: createAccountActivationURLGql
| Input | Notes | Example |
|---|---|---|
| Customer | The unique identifier for the customer. | 5940139491234 or gid://shopify/Customer/5940139491234 |
| Connection | The Shopify connection to use. |
{
"data": {
"accountActivationUrl": "https://activation.example.com",
"userErrors": []
}
}
Create Customer
Creates a new customer. | key: createCustomer
| Input | Notes | Example |
|---|---|---|
| Address List | A JSON array of address objects for the customer. Each object should include fields like address1, city, province, country, and zip. | |
| Currency Format | The currency format code. | USD |
The email address of the customer. | john.doe@example.com | |
| Values | Key-value pairs for creating or updating a record. Specify any property key and value. | |
| First Name | The first name of the customer. | John |
| Last Name | The last name of the customer. | Doe |
| Metafields | JSON array containing metadata objects. | |
| Notes | Additional notes about the customer. | This is an example note. |
| Phone | The phone number of the customer in E.164 format. | +18005555454 |
| Connection | The Shopify connection to use. | |
| Tags | Tags for the product. Each list item is a tag string. | Style |
| Tax Exempt | When true, the customer is tax exempt. | false |
| Verified Email | When true, emails will be sent to the customer. | false |
{
"data": {
"customer": {
"id": 207119551,
"email": "bob.norman@mail.example.com",
"accepts_marketing": false,
"created_at": "2023-07-11T18:25:37-04:00",
"updated_at": "2023-07-11T18:25:37-04:00",
"first_name": "Bob",
"last_name": "Norman",
"orders_count": 1,
"state": "disabled",
"total_spent": "199.65",
"last_order_id": 450789469,
"note": null,
"verified_email": true,
"multipass_identifier": null,
"tax_exempt": false,
"tags": "Léon, Noël",
"last_order_name": "#1001",
"currency": "USD",
"phone": "+16136120707",
"addresses": [
{
"id": 207119551,
"customer_id": 207119551,
"first_name": null,
"last_name": null,
"company": null,
"address1": "Chestnut Street 92",
"address2": "",
"city": "Louisville",
"province": "Kentucky",
"country": "United States",
"zip": "40202",
"phone": "555-625-1199",
"name": "",
"province_code": "KY",
"country_code": "US",
"country_name": "United States",
"default": true
}
],
"accepts_marketing_updated_at": "2005-06-12T11:57:11-04:00",
"marketing_opt_in_level": null,
"tax_exemptions": [],
"email_marketing_consent": {
"state": "not_subscribed",
"opt_in_level": null,
"consent_updated_at": "2004-06-13T11:57:11-04:00"
},
"sms_marketing_consent": {
"state": "not_subscribed",
"opt_in_level": "single_opt_in",
"consent_updated_at": "2023-07-11T18:25:37-04:00",
"consent_collected_from": "OTHER"
},
"admin_graphql_api_id": "gid://shopify/Customer/207119551",
"default_address": {
"id": 207119551,
"customer_id": 207119551,
"first_name": null,
"last_name": null,
"company": null,
"address1": "Chestnut Street 92",
"address2": "",
"city": "Louisville",
"province": "Kentucky",
"country": "United States",
"zip": "40202",
"phone": "555-625-1199",
"name": "",
"province_code": "KY",
"country_code": "US",
"country_name": "United States",
"default": true
}
}
}
}
Create Draft Order
Creates a new draft order. | key: createDraftOrderGql
| Input | Notes | Example |
|---|---|---|
| Additional Fields | Additional fields that might not be covered by the standard inputs. This is a JSON object. | |
| Customer | The unique identifier for the customer. | 5940139491234 or gid://shopify/Customer/5940139491234 |
| Line items | Provide a JSON array containing line item objects. | |
| Note | A note on the draft order. | Test draft order |
| Connection | The Shopify connection to use. | |
| Tags | Provide a list of tags for the draft order. | Style |
| Tax Exempt | Whether or not taxes are exempt for the draft order. | false |
| Use Customer Address | This flag determines if the order will use the customers default address. | true |
{
"data": {
"userErrors": [],
"draftOrder": {
"id": "gid://shopify/DraftOrder/1234567890123",
"note2": "Sample Note",
"email": "example@email.com",
"taxesIncluded": false,
"currencyCode": "USD",
"invoiceSentAt": null,
"createdAt": "2024-12-31T07:30:32Z",
"updatedAt": "2024-12-31T07:30:33Z",
"taxExempt": true,
"completedAt": "2024-12-31T07:30:33Z",
"name": "#D123",
"status": "COMPLETED",
"lineItems": {
"nodes": [
{
"id": "gid://shopify/DraftOrderLineItem/9876543210987",
"variant": null,
"product": null,
"title": "Example Product",
"variantTitle": null,
"sku": null,
"vendor": null,
"quantity": 3,
"requiresShipping": false,
"taxable": true,
"isGiftCard": false,
"fulfillmentService": {
"type": "MANUAL"
},
"weight": {
"unit": "KILOGRAMS",
"value": 2
},
"taxLines": [
{
"channelLiable": null,
"priceSet": {
"shopMoney": {
"amount": "0.0",
"currencyCode": "USD"
}
},
"rate": 0.05,
"ratePercentage": 5,
"source": "Shopify",
"title": "Example State Tax"
}
],
"appliedDiscount": {
"title": "Promo",
"value": 10,
"valueType": "PERCENTAGE",
"description": "Seasonal Discount",
"amountSet": {
"shopMoney": {
"amount": "5.00",
"currencyCode": "USD"
}
}
},
"name": "Example Product",
"custom": true,
"originalUnitPriceSet": {
"shopMoney": {
"currencyCode": "USD",
"amount": "20.00"
}
}
}
]
},
"shippingAddress": {
"firstName": "John",
"address1": "123 Example St",
"phone": "123-456-7890",
"city": "Example City",
"zip": "12345",
"province": "California",
"country": "United States",
"lastName": "Doe",
"address2": "Apt 101",
"company": "Example Corp",
"latitude": null,
"longitude": null,
"name": "John Doe",
"countryCodeV2": "US",
"provinceCode": "CA"
},
"billingAddress": {
"firstName": "John",
"address1": "123 Example St",
"phone": "123-456-7890",
"city": "Example City",
"zip": "12345",
"province": "California",
"country": "United States",
"lastName": "Doe",
"address2": "Apt 101",
"company": "Example Corp",
"latitude": null,
"longitude": null,
"name": "John Doe",
"countryCodeV2": "US",
"provinceCode": "CA"
},
"invoiceUrl": "https://example-store.myshopify.com/123456/invoices/abcdef123456",
"appliedDiscount": null,
"order": {
"id": "gid://shopify/Order/8765432109876"
},
"shippingLine": null,
"taxLines": [],
"tags": [],
"totalPriceSet": {
"shopMoney": {
"amount": "60.00",
"currencyCode": "USD"
}
},
"subtotalPriceSet": {
"shopMoney": {
"amount": "60.00",
"currencyCode": "USD"
}
},
"totalTaxSet": {
"shopMoney": {
"amount": "0.0",
"currencyCode": "USD"
}
},
"paymentTerms": null,
"customer": {
"id": "gid://shopify/Customer/1234567890123",
"email": "example@email.com",
"createdAt": "2022-01-01T10:00:00Z",
"updatedAt": "2024-12-31T07:30:33Z",
"firstName": "John",
"lastName": "Doe",
"numberOfOrders": "5",
"state": "ENABLED",
"amountSpent": {
"amount": "500.00",
"currencyCode": "USD"
},
"lastOrder": {
"id": "gid://shopify/Order/8765432109876",
"name": "#5678"
},
"note": null,
"verifiedEmail": true,
"multipassIdentifier": null,
"taxExempt": false,
"tags": [],
"phone": "123-456-7890",
"taxExemptions": [],
"emailMarketingConsent": {
"marketingState": "SUBSCRIBED",
"consentUpdatedAt": null
},
"smsMarketingConsent": null,
"defaultAddress": {
"id": "gid://shopify/MailingAddress/9876543210987",
"firstName": "John",
"lastName": "Doe",
"company": "Example Corp",
"address1": "123 Example St",
"address2": "Apt 101",
"city": "Example City",
"province": "California",
"country": "United States",
"zip": "12345",
"phone": "123-456-7890",
"name": "John Doe",
"provinceCode": "CA",
"countryCodeV2": "US"
}
}
}
}
}
Create Fulfillment Service
Creates a new fulfillment service. | key: createFulfillmentServiceGql
| Input | Notes | Example |
|---|---|---|
| Callback URL | The callback URL that the fulfillment service has registered for request. | https://example.com |
| Fulfillment Service Name | The name of the fulfillment service. | MyFulfillmentService |
| Inventory Management | Whether the fulfillment services tracks product inventory and provides updates to Shopify. | false |
| Connection | The Shopify connection to use. | |
| Tracking Support | Whether the fulfillment service supports tracking numbers for packages. | false |
{
"data": {
"fulfillmentService": {
"id": "gid://shopify/FulfillmentService/1234567890?id=true",
"serviceName": "ExampleFulfillmentService",
"handle": "examplefulfillmentservice",
"location": {
"id": "gid://shopify/Location/0987654321"
},
"callbackUrl": "https://example.com/",
"trackingSupport": false,
"inventoryManagement": false,
"permitsSkuSharing": false
},
"userErrors": []
}
}
Create Order
Creates a new order. | key: createOrderGql
| Input | Notes | Example |
|---|---|---|
| Order Data | JSON data to be sent as the Order payload. | |
| Connection | The Shopify connection to use. |
{
"data": {
"order": {
"id": "gid://shopify/Order/1234567890123",
"name": "#1234",
"app": {
"id": "gid://shopify/App/9876543210987"
},
"clientIp": "0.0.0.0",
"customerAcceptsMarketing": false,
"cancelReason": null,
"cancelledAt": null,
"closedAt": null,
"confirmationNumber": "ABC123XYZ",
"confirmed": true,
"createdAt": "2024-12-08T11:29:38Z",
"currencyCode": "USD",
"currentSubtotalPriceSet": {
"shopMoney": {
"amount": "50.00",
"currencyCode": "USD"
},
"presentmentMoney": {
"amount": "50.00",
"currencyCode": "USD"
}
},
"currentTotalAdditionalFeesSet": null,
"currentTotalDiscountsSet": {
"shopMoney": {
"amount": "5.00",
"currencyCode": "USD"
},
"presentmentMoney": {
"amount": "5.00",
"currencyCode": "USD"
}
},
"currentTotalDutiesSet": null,
"currentTotalPriceSet": {
"shopMoney": {
"amount": "50.00",
"currencyCode": "USD"
},
"presentmentMoney": {
"amount": "50.00",
"currencyCode": "USD"
}
},
"currentTotalTaxSet": {
"shopMoney": {
"amount": "0.00",
"currencyCode": "USD"
},
"presentmentMoney": {
"amount": "0.00",
"currencyCode": "USD"
}
},
"customerLocale": "en",
"discountCodes": [],
"dutiesIncluded": false,
"email": "example@example.com",
"estimatedTaxes": false,
"displayFinancialStatus": "PAID",
"displayFulfillmentStatus": "UNFULFILLED",
"retailLocation": null,
"merchantBusinessEntity": {
"id": "gid://shopify/BusinessEntity/1122334455667"
},
"merchantOfRecordApp": null,
"note": "Example note",
"originalTotalAdditionalFeesSet": null,
"originalTotalDutiesSet": null,
"paymentGatewayNames": [
"manual"
],
"phone": null,
"poNumber": null,
"presentmentCurrencyCode": "USD",
"processedAt": "2024-12-08T11:29:38Z",
"sourceIdentifier": "example-source-id",
"sourceName": "9876543210987",
"registeredSourceUrl": null,
"subtotalPriceSet": {
"shopMoney": {
"amount": "50.00",
"currencyCode": "USD"
},
"presentmentMoney": {
"amount": "50.00",
"currencyCode": "USD"
}
},
"tags": [],
"taxExempt": true,
"taxLines": [],
"taxesIncluded": false,
"test": false,
"totalCashRoundingAdjustment": {
"paymentSet": {
"shopMoney": {
"amount": "0.00",
"currencyCode": "USD"
},
"presentmentMoney": {
"amount": "0.00",
"currencyCode": "USD"
}
},
"refundSet": {
"shopMoney": {
"amount": "0.00",
"currencyCode": "USD"
},
"presentmentMoney": {
"amount": "0.00",
"currencyCode": "USD"
}
}
},
"totalDiscountsSet": {
"shopMoney": {
"amount": "5.00",
"currencyCode": "USD"
},
"presentmentMoney": {
"amount": "5.00",
"currencyCode": "USD"
}
},
"totalOutstandingSet": {
"shopMoney": {
"amount": "0.00",
"currencyCode": "USD"
}
},
"totalPriceSet": {
"shopMoney": {
"amount": "50.00",
"currencyCode": "USD"
},
"presentmentMoney": {
"amount": "50.00",
"currencyCode": "USD"
}
},
"totalShippingPriceSet": {
"shopMoney": {
"amount": "0.00",
"currencyCode": "USD"
},
"presentmentMoney": {
"amount": "0.00",
"currencyCode": "USD"
}
},
"totalTaxSet": {
"shopMoney": {
"amount": "0.00",
"currencyCode": "USD"
},
"presentmentMoney": {
"amount": "0.00",
"currencyCode": "USD"
}
},
"totalTipReceivedSet": {
"shopMoney": {
"amount": "0.00",
"currencyCode": "USD"
}
},
"totalWeight": "5000",
"updatedAt": "2024-12-08T11:29:39Z",
"billingAddress": {
"address1": "123 Example St",
"address2": null,
"name": "John Doe",
"lastName": "Doe",
"company": null,
"phone": null,
"zip": "12345",
"country": "United States",
"countryCodeV2": "US",
"province": "California",
"provinceCode": "CA"
},
"customer": {
"id": "gid://shopify/Customer/4567890123456",
"displayName": "John Doe",
"firstName": "John",
"lastName": "Doe",
"phone": null
},
"lineItems": {
"nodes": [
{
"id": "gid://shopify/LineItem/2345678901234",
"currentQuantity": 3,
"unfulfilledQuantity": 3,
"isGiftCard": false,
"name": "Sample Product",
"originalUnitPriceSet": {
"shopMoney": {
"amount": "16.67",
"currencyCode": "USD"
},
"presentmentMoney": {
"amount": "16.67",
"currencyCode": "USD"
}
},
"product": null,
"quantity": 3,
"requiresShipping": true,
"sku": "EX123",
"taxable": true,
"title": "Sample Product",
"totalDiscountSet": {
"shopMoney": {
"amount": "5.00",
"currencyCode": "USD"
},
"presentmentMoney": {
"amount": "5.00",
"currencyCode": "USD"
}
},
"variant": null,
"vendor": "Example Vendor",
"taxLines": [
{
"channelLiable": false,
"priceSet": {
"shopMoney": {
"amount": "0.00",
"currencyCode": "USD"
},
"presentmentMoney": {
"amount": "0.00",
"currencyCode": "USD"
}
},
"rate": 0.05,
"title": "Example Tax"
}
],
"duties": [],
"discountAllocations": [
{
"allocatedAmountSet": {
"shopMoney": {
"amount": "5.00",
"currencyCode": "USD"
},
"presentmentMoney": {
"amount": "5.00",
"currencyCode": "USD"
}
},
"discountApplication": {
"index": 0
}
}
]
}
]
},
"paymentTerms": null,
"refunds": [],
"shippingAddress": {
"firstName": "John",
"address1": "123 Example St",
"phone": null,
"city": "Example City",
"zip": "12345",
"province": "California",
"country": "United States",
"lastName": "Doe",
"address2": null,
"company": null,
"latitude": null,
"longitude": null,
"name": "John Doe",
"countryCodeV2": "US",
"provinceCode": "CA"
}
},
"userErrors": []
}
}
Create Product
Creates a new product. | key: createProductGql
| Input | Notes | Example |
|---|---|---|
| Additional Fields | Additional fields that might not be covered by the standard inputs. This is a JSON object. | |
| Description HTML | Provide an HTML string for the description of the product. | <p>This is an example product.</p> |
| Image Alt Text | Provide the alt text for the image of the product. | Alt text |
| Image URL | Provide a URL for the image of the product. | https://example.com/image.jpg |
| Product Status | Specify the status of the product. | |
| Product Type | Provide a value for the type of product. | T-shirt |
| Connection | The Shopify connection to use. | |
| Tags | Provide a list of tags for the product. | Style |
| Title | Provide a string value for the title of the product. | Example Product |
| Vendor | Provide a value for the vendor of the product. | Burton inc. |
{
"data": {
"product": {
"id": 1234567890123,
"title": "Example Product",
"body_html": "<p>This is an example product.</p>",
"vendor": "Example Vendor",
"product_type": "Example Category",
"created_at": "2025-01-07T00:00:00Z",
"handle": "example-product-1",
"updated_at": "2025-01-07T00:00:01Z",
"published_at": null,
"template_suffix": null,
"tags": "example-tag",
"status": "active",
"admin_graphql_api_id": "gid://shopify/Product/1234567890123",
"variants": [
{
"id": 9876543210987,
"product_id": 1234567890123,
"title": "Example Variant",
"price": "10.00",
"position": 1,
"inventory_policy": "DENY",
"compare_at_price": null,
"created_at": "2025-01-07T00:00:01Z",
"updated_at": "2025-01-07T00:00:01Z",
"taxable": true,
"barcode": "123456789012",
"requires_shipping": true,
"sku": "EX-001",
"weight": 1,
"weight_unit": "POUNDS",
"inventory_item_id": 11223344556677,
"inventory_quantity": 100,
"admin_graphql_api_id": "gid://shopify/ProductVariant/9876543210987"
}
],
"options": [
{
"id": 99887766554433,
"product_id": 1234567890123,
"name": "Size",
"position": 1,
"values": [
"Small",
"Medium",
"Large"
]
}
],
"images": [
{
"id": 66554433221100,
"alt": "Example Image",
"position": 1,
"product_id": 1234567890123,
"created_at": "2025-01-07T00:00:00Z",
"updated_at": "2025-01-07T00:00:01Z",
"admin_graphql_api_id": "gid://shopify/MediaImage/66554433221100",
"width": null,
"height": null,
"src": null
}
],
"image": {
"id": 66554433221100,
"alt": "Example Image",
"product_id": 1234567890123,
"created_at": "2025-01-07T00:00:00Z",
"updated_at": "2025-01-07T00:00:01Z",
"admin_graphql_api_id": "gid://shopify/MediaImage/66554433221100",
"width": null,
"height": null,
"src": null
}
}
}
}
Create Product Image
Creates a new image for an existing product. | key: createProductImageGql
| Input | Notes | Example |
|---|---|---|
| Image Alt Text | Provide the alt text for the image. | Alt text |
| Image URL | Provide the URL of the image. | https://example.com/image.jpg |
| Product ID | The unique identifier for the product. | 108828309 or gid://shopify/Product/108828309 |
| Connection | The Shopify connection to use. |
{
"data": {
"media": [
{
"id": "gid://shopify/MediaImage/1072273196",
"alt": "Alt text.",
"status": "UPLOADED",
"image": null
}
],
"mediaUserErrors": []
}
}
Create Variant
Creates a new variant for the specified product. | key: createVariantGql
| Input | Notes | Example |
|---|---|---|
| Product ID | The unique identifier for the product. | 108828309 or gid://shopify/Product/108828309 |
| Connection | The Shopify connection to use. | |
| Variant | Provide a JSON object containing the variant data. |
{
"data": {
"productVariants": [
{
"id": "gid://shopify/ProductVariant/1070325177",
"title": "Golden",
"selectedOptions": [
{
"name": "Title",
"value": "Golden"
}
]
}
],
"userErrors": []
}
}
Create Webhook
Creates a webhook for the specified topic. | key: createWebhook
| Input | Notes | Example |
|---|---|---|
| Post URL | The URL where the newly created webhook will post to. Used to configure the Shopify trigger. | https://example.com/webhook |
| Connection | The Shopify connection to use. | |
| Webhook Format | The format for the webhook response. | json |
| Webhook Topic | The event topic for the webhook. See Shopify webhook topics for all available topics. | products/create |
{
"data": {
"webhook": {
"id": 8099884584,
"address": "pubsub://projectName:topicName",
"topic": "customers/update",
"created_at": "2024-03-14T13:45:35-04:00",
"updated_at": "2024-03-14T13:45:35-04:00",
"format": "json",
"fields": [],
"metafield_namespaces": [],
"api_version": "unstable",
"private_metafield_namespaces": []
}
}
}
Delete Collection
Deletes a collection by ID. | key: deleteCollectionGql
| Input | Notes | Example |
|---|---|---|
| Collection ID | The unique identifier for the collection. | gid://shopify/Collection/841564295 |
| Connection | The Shopify connection to use. |
{
"data": {
"deletedCollectionId": "gid://shopify/Collection/123456789012",
"userErrors": []
}
}
Delete Customer
Deletes an existing customer. | key: deleteCustomerGql
| Input | Notes | Example |
|---|---|---|
| Customer | The unique identifier for the customer. | 5940139491234 or gid://shopify/Customer/5940139491234 |
| Connection | The Shopify connection to use. |
{
"data": {}
}
Delete Draft Order
Deletes an existing draft order. | key: deleteDraftOrderGql
| Input | Notes | Example |
|---|---|---|
| Draft Order Id | The unique identifier for the draft order. | 916042021234 or gid://shopify/DraftOrder/916042021234 |
| Connection | The Shopify connection to use. |
{
"data": {
"deletedId": "gid://shopify/DraftOrder/276395349",
"userErrors": []
}
}
Delete Fulfillment Service
Deletes an existing fulfillment service. | key: deleteFulfillmentServiceGql
| Input | Notes | Example |
|---|---|---|
| Fulfillment Service ID | The unique identifier for the fulfillment service. | gid://shopify/FulfillmentService/18961920?id=true |
| Connection | The Shopify connection to use. |
{
"data": {
"deletedId": "gid://shopify/FulfillmentService/198258461",
"userErrors": []
}
}
Delete Instance Webhooks
Deletes all webhooks related to the current instance. | key: deleteInstanceWebhooks
| Input | Notes | Example |
|---|---|---|
| Connection | The Shopify connection to use. |
Delete Inventory Levels
Deletes an inventory level. | key: deleteInventoryLevelsGql
| Input | Notes | Example |
|---|---|---|
| Inventory Level Id | The unique identifier for the inventory level. | gid://shopify/InventoryLevel/820859520?inventory_item_id=826867926 |
| Connection | The Shopify connection to use. |
{
"data": {
"userErrors": []
}
}
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. | key: deleteMetafieldGql
| Input | Notes | Example |
|---|---|---|
| Key | Provide the key of the metafield to delete. | myKey |
| Namespace | Provide the namespace of the metafield to delete. | global |
| Owner ID | Provide the owner ID of the metafield to delete. | gid://shopify/Product/20995642 |
| Connection | The Shopify connection to use. |
{
"data": {
"deletedMetafields": [
{
"key": "today",
"namespace": "inventory",
"ownerId": "gid://shopify/Product/20995642"
}
],
"userErrors": []
}
}
Delete Order
Deletes an existing order by ID. | key: deleteOrderGql
| Input | Notes | Example |
|---|---|---|
| Order ID | The unique identifier for the order. | 10079785100 or gid://shopify/Order/10079785100 |
| Connection | The Shopify connection to use. |
{
"data": {
"deletedId": "gid://shopify/Order/776341364",
"userErrors": []
}
}
Delete Product
Deletes an existing product. | key: deleteProductGql
| Input | Notes | Example |
|---|---|---|
| Product ID | The unique identifier for the product. | 108828309 or gid://shopify/Product/108828309 |
| Connection | The Shopify connection to use. |
{
"data": {
"productDelete": {
"deletedProductId": "gid://shopify/Product/108828309",
"userErrors": []
}
}
}
Delete Product Image
Deletes a product image. | key: deleteProductImageGql
| Input | Notes | Example |
|---|---|---|
| Image ID | The unique identifier for the product image. | gid://shopify/MediaImage/916933471 |
| Product ID | The unique identifier for the product. | 108828309 or gid://shopify/Product/108828309 |
| Connection | The Shopify connection to use. |
{
"data": {
"deletedMediaIds": [
"gid://shopify/MediaImage/730211239"
],
"deletedProductImageIds": [
"gid://shopify/ProductImage/916933471"
],
"mediaUserErrors": []
}
}
Delete Variant
Deletes an existing variant by ID. | key: deleteVariantGql
| Input | Notes | Example |
|---|---|---|
| Product ID | The unique identifier for the product. | 108828309 or gid://shopify/Product/108828309 |
| Connection | The Shopify connection to use. | |
| Variant ID | The unique identifier for the product variant. | gid://shopify/ProductVariant/1070325177 |
{
"data": {
"product": {
"id": "gid://shopify/Product/20995642",
"title": "Element"
},
"userErrors": []
}
}
Delete Webhook
Deletes a webhook by ID. | key: deleteWebhook
| Input | Notes | Example |
|---|---|---|
| Connection | The Shopify connection to use. | |
| Webhook ID | The ID of an existing webhook. | 450789469 |
{
"data": {}
}
Get Collection
Retrieves a collection by ID. | key: getCollectionGql
| Input | Notes | Example |
|---|---|---|
| Collection ID | The unique identifier for the collection. | gid://shopify/Collection/841564295 |
| Connection | The Shopify connection to use. |
{
"data": {
"collection": {
"id": "gid://shopify/Collection/123456789012",
"description": "Example description",
"descriptionHtml": "<p>Example description in HTML</p>",
"handle": "example-collection-handle",
"products": {
"nodes": [
{
"descriptionHtml": "<p>Example product description</p>",
"category": "Example Category",
"createdAt": "2023-01-01T12:00:00Z",
"description": "Example product description",
"featuredMedia": {
"alt": "Example alt text",
"id": "gid://shopify/MediaImage/987654321098",
"preview": {
"image": {
"url": "https://cdn.example.com/images/example.jpg",
"width": 200,
"height": 300,
"id": "gid://shopify/ImageSource/654321987654"
}
},
"status": "READY"
},
"handle": "example-product-handle",
"id": "gid://shopify/Product/1234567890123",
"priceRangeV2": {
"maxVariantPrice": {
"amount": "50.0",
"currencyCode": "USD"
},
"minVariantPrice": {
"amount": "10.0",
"currencyCode": "USD"
}
},
"productType": "Example Type",
"publishedAt": "2023-01-01T12:00:00Z",
"status": "ACTIVE",
"tags": [
"Example Tag 1",
"Example Tag 2"
],
"title": "Example Product Title",
"totalInventory": 100,
"vendor": "Example Vendor Name"
}
]
},
"productsCount": {
"count": 10
},
"sortOrder": "MANUAL",
"title": "Example Collection Title"
}
}
}
Get Customer
Retrieves a customer by ID. | key: getCustomer
| Input | Notes | Example |
|---|---|---|
| Customer | The unique ID of the customer. | 207119551 |
| Connection | The Shopify connection to use. |
{
"data": {
"customer": {
"id": 207119551,
"email": "bob.norman@mail.example.com",
"accepts_marketing": false,
"created_at": "2023-07-11T18:25:37-04:00",
"updated_at": "2023-07-11T18:25:37-04:00",
"first_name": "Bob",
"last_name": "Norman",
"orders_count": 1,
"state": "disabled",
"total_spent": "199.65",
"last_order_id": 450789469,
"note": null,
"verified_email": true,
"multipass_identifier": null,
"tax_exempt": false,
"tags": "Léon, Noël",
"last_order_name": "#1001",
"currency": "USD",
"phone": "+16136120707",
"addresses": [
{
"id": 207119551,
"customer_id": 207119551,
"first_name": null,
"last_name": null,
"company": null,
"address1": "Chestnut Street 92",
"address2": "",
"city": "Louisville",
"province": "Kentucky",
"country": "United States",
"zip": "40202",
"phone": "555-625-1199",
"name": "",
"province_code": "KY",
"country_code": "US",
"country_name": "United States",
"default": true
}
],
"accepts_marketing_updated_at": "2005-06-12T11:57:11-04:00",
"marketing_opt_in_level": null,
"tax_exemptions": [],
"email_marketing_consent": {
"state": "not_subscribed",
"opt_in_level": null,
"consent_updated_at": "2004-06-13T11:57:11-04:00"
},
"sms_marketing_consent": {
"state": "not_subscribed",
"opt_in_level": "single_opt_in",
"consent_updated_at": "2023-07-11T18:25:37-04:00",
"consent_collected_from": "OTHER"
},
"admin_graphql_api_id": "gid://shopify/Customer/207119551",
"default_address": {
"id": 207119551,
"customer_id": 207119551,
"first_name": null,
"last_name": null,
"company": null,
"address1": "Chestnut Street 92",
"address2": "",
"city": "Louisville",
"province": "Kentucky",
"country": "United States",
"zip": "40202",
"phone": "555-625-1199",
"name": "",
"province_code": "KY",
"country_code": "US",
"country_name": "United States",
"default": true
}
}
}
}
Get Draft Order
Retrieves a draft order by ID. | key: getDraftOrderGql
| Input | Notes | Example |
|---|---|---|
| Draft Order Id | The unique identifier for the draft order. | 916042021234 or gid://shopify/DraftOrder/916042021234 |
| Connection | The Shopify connection to use. |
{
"data": {
"draftOrder": {
"id": "gid://shopify/DraftOrder/1234567890123",
"note2": "Sample Note",
"email": "example@email.com",
"taxesIncluded": false,
"currencyCode": "USD",
"invoiceSentAt": null,
"createdAt": "2024-12-31T07:30:32Z",
"updatedAt": "2024-12-31T07:30:33Z",
"taxExempt": true,
"completedAt": "2024-12-31T07:30:33Z",
"name": "#D123",
"status": "COMPLETED",
"lineItems": {
"nodes": [
{
"id": "gid://shopify/DraftOrderLineItem/9876543210987",
"variant": null,
"product": null,
"title": "Example Product",
"variantTitle": null,
"sku": null,
"vendor": null,
"quantity": 3,
"requiresShipping": false,
"taxable": true,
"isGiftCard": false,
"fulfillmentService": {
"type": "MANUAL"
},
"weight": {
"unit": "KILOGRAMS",
"value": 2
},
"taxLines": [
{
"channelLiable": null,
"priceSet": {
"shopMoney": {
"amount": "0.0",
"currencyCode": "USD"
}
},
"rate": 0.05,
"ratePercentage": 5,
"source": "Shopify",
"title": "Example State Tax"
}
],
"appliedDiscount": {
"title": "Promo",
"value": 10,
"valueType": "PERCENTAGE",
"description": "Seasonal Discount",
"amountSet": {
"shopMoney": {
"amount": "5.00",
"currencyCode": "USD"
}
}
},
"name": "Example Product",
"custom": true,
"originalUnitPriceSet": {
"shopMoney": {
"currencyCode": "USD",
"amount": "20.00"
}
}
}
]
},
"shippingAddress": {
"firstName": "John",
"address1": "123 Example St",
"phone": "123-456-7890",
"city": "Example City",
"zip": "12345",
"province": "California",
"country": "United States",
"lastName": "Doe",
"address2": "Apt 101",
"company": "Example Corp",
"latitude": null,
"longitude": null,
"name": "John Doe",
"countryCodeV2": "US",
"provinceCode": "CA"
},
"billingAddress": {
"firstName": "John",
"address1": "123 Example St",
"phone": "123-456-7890",
"city": "Example City",
"zip": "12345",
"province": "California",
"country": "United States",
"lastName": "Doe",
"address2": "Apt 101",
"company": "Example Corp",
"latitude": null,
"longitude": null,
"name": "John Doe",
"countryCodeV2": "US",
"provinceCode": "CA"
},
"invoiceUrl": "https://example-store.myshopify.com/123456/invoices/abcdef123456",
"appliedDiscount": null,
"order": {
"id": "gid://shopify/Order/8765432109876"
},
"shippingLine": null,
"taxLines": [],
"tags": [],
"totalPriceSet": {
"shopMoney": {
"amount": "60.00",
"currencyCode": "USD"
}
},
"subtotalPriceSet": {
"shopMoney": {
"amount": "60.00",
"currencyCode": "USD"
}
},
"totalTaxSet": {
"shopMoney": {
"amount": "0.0",
"currencyCode": "USD"
}
},
"paymentTerms": null,
"customer": {
"id": "gid://shopify/Customer/1234567890123",
"email": "example@email.com",
"createdAt": "2022-01-01T10:00:00Z",
"updatedAt": "2024-12-31T07:30:33Z",
"firstName": "John",
"lastName": "Doe",
"numberOfOrders": "5",
"state": "ENABLED",
"amountSpent": {
"amount": "500.00",
"currencyCode": "USD"
},
"lastOrder": {
"id": "gid://shopify/Order/8765432109876",
"name": "#5678"
},
"note": null,
"verifiedEmail": true,
"multipassIdentifier": null,
"taxExempt": false,
"tags": [],
"phone": "123-456-7890",
"taxExemptions": [],
"emailMarketingConsent": {
"marketingState": "SUBSCRIBED",
"consentUpdatedAt": null
},
"smsMarketingConsent": null,
"defaultAddress": {
"id": "gid://shopify/MailingAddress/9876543210987",
"firstName": "John",
"lastName": "Doe",
"company": "Example Corp",
"address1": "123 Example St",
"address2": "Apt 101",
"city": "Example City",
"province": "California",
"country": "United States",
"zip": "12345",
"phone": "123-456-7890",
"name": "John Doe",
"provinceCode": "CA",
"countryCodeV2": "US"
}
}
}
}
}
Get Fulfillment
Retrieves a fulfillment by ID. | key: getFulfillmentGql
| Input | Notes | Example |
|---|---|---|
| Fulfillment Id | The unique identifier for the fulfillment. | 5154544124321 or gid://shopify/Fulfillment/5154544124321 |
| Connection | The Shopify connection to use. |
{
"data": {
"fulfillment": {
"id": "gid://shopify/Fulfillment/1234567890",
"order": {
"id": "gid://shopify/Order/9876543210"
},
"status": "SUCCESS",
"createdAt": "2024-12-30T12:00:00Z",
"updatedAt": "2024-12-31T08:00:00Z",
"service": {
"type": "MANUAL"
},
"trackingInfo": [
{
"company": "FedEx",
"number": "987654321012",
"url": "https://www.fedex.com/fedextrack/?tracknumbers=987654321012"
}
],
"location": {
"id": "gid://shopify/Location/1122334455"
},
"originAddress": {
"address1": "500 Example Blvd",
"address2": "Suite 400",
"city": "Example City",
"countryCode": "US",
"provinceCode": "CA",
"zip": "90001"
},
"fulfillmentLineItems": {
"nodes": [
{
"id": "gid://shopify/FulfillmentLineItem/5432109876",
"lineItem": {
"title": "Example Product A",
"quantity": 1,
"originalUnitPriceSet": {
"shopMoney": {
"amount": "50.00",
"currencyCode": "USD"
},
"presentmentMoney": {
"amount": "50.00",
"currencyCode": "USD"
}
},
"totalDiscountSet": {
"shopMoney": {
"amount": "5.00",
"currencyCode": "USD"
},
"presentmentMoney": {
"amount": "5.00",
"currencyCode": "USD"
}
},
"discountAllocations": [
{
"allocatedAmountSet": {
"shopMoney": {
"amount": "5.00",
"currencyCode": "USD"
}
},
"discountApplication": {
"index": 1
}
}
],
"duties": [],
"discountedTotalSet": {
"shopMoney": {
"amount": "45.00"
}
},
"variant": {
"title": "Variant A",
"id": "gid://shopify/ProductVariant/11223344",
"price": "50.00",
"product": {
"id": "gid://shopify/Product/55667788"
}
},
"requiresShipping": true,
"vendor": "Example Vendor",
"sku": "EXM-001",
"taxable": true,
"isGiftCard": false,
"name": "Example Product A"
}
},
{
"id": "gid://shopify/FulfillmentLineItem/6543210987",
"lineItem": {
"title": "Example Product B",
"quantity": 2,
"originalUnitPriceSet": {
"shopMoney": {
"amount": "30.00",
"currencyCode": "USD"
},
"presentmentMoney": {
"amount": "30.00",
"currencyCode": "USD"
}
},
"totalDiscountSet": {
"shopMoney": {
"amount": "3.00",
"currencyCode": "USD"
},
"presentmentMoney": {
"amount": "3.00",
"currencyCode": "USD"
}
},
"discountAllocations": [
{
"allocatedAmountSet": {
"shopMoney": {
"amount": "3.00",
"currencyCode": "USD"
}
},
"discountApplication": {
"index": 2
}
}
],
"duties": [],
"discountedTotalSet": {
"shopMoney": {
"amount": "57.00"
}
},
"variant": {
"title": "Variant B",
"id": "gid://shopify/ProductVariant/22334455",
"price": "30.00",
"product": {
"id": "gid://shopify/Product/66778899"
}
},
"requiresShipping": true,
"vendor": "Example Vendor",
"sku": "EXM-002",
"taxable": true,
"isGiftCard": false,
"name": "Example Product B"
}
}
]
},
"name": "F-1001"
}
}
}
Get Fulfillment Order
Retrieves a specific fulfillment order by ID. | key: getFulfillmentOrder
| Input | Notes | Example |
|---|---|---|
| Fulfillment Order ID | The unique identifier for the fulfillment order. | 1046000820 |
| Connection | The Shopify connection to use. |
{
"data": {
"data": {
"fulfillment_order": {
"id": 1046000819,
"shop_id": 548380009,
"order_id": 450789469,
"assigned_location_id": 24826418,
"request_status": "submitted",
"status": "open",
"supported_actions": [
"cancel_fulfillment_order"
],
"destination": {
"id": 1046000803,
"address1": "Chestnut Street 92",
"address2": "",
"city": "Louisville",
"company": null,
"country": "United States",
"email": "bob.norman@mail.example.com",
"first_name": "Bob",
"last_name": "Norman",
"phone": "+1(502)-459-2181",
"province": "Kentucky",
"zip": "40202"
},
"line_items": [
{
"id": 1058737560,
"shop_id": 548380009,
"fulfillment_order_id": 1046000819,
"quantity": 1,
"line_item_id": 518995019,
"inventory_item_id": 49148385,
"fulfillable_quantity": 1,
"variant_id": 49148385
}
],
"international_duties": null,
"fulfill_at": null,
"fulfill_by": null,
"fulfillment_holds": [],
"created_at": "2024-01-02T09:11:20-05:00",
"updated_at": "2024-01-02T09:11:20-05:00",
"delivery_method": null,
"assigned_location": {
"address1": null,
"address2": null,
"city": null,
"country_code": "DE",
"location_id": 24826418,
"name": "Apple Api Shipwire",
"phone": null,
"province": null,
"zip": null
},
"merchant_requests": []
}
}
}
}
Get Fulfillment Service
Retrieves a fulfillment service by ID. | key: getFulfillmentServiceGql
| Input | Notes | Example |
|---|---|---|
| Fulfillment Service ID | The unique identifier for the fulfillment service. | gid://shopify/FulfillmentService/18961920?id=true |
| Connection | The Shopify connection to use. |
{
"data": {
"fulfillmentService": {
"id": "gid://shopify/FulfillmentService/1234567890?id=true",
"serviceName": "ExampleFulfillmentService",
"handle": "examplefulfillmentservice",
"location": {
"id": "gid://shopify/Location/0987654321"
},
"callbackUrl": "https://example.com/",
"trackingSupport": false,
"inventoryManagement": false,
"permitsSkuSharing": false
}
}
}
Get Inventory Item
Retrieves an inventory item by ID. | key: getInventoryItemsGql
| Input | Notes | Example |
|---|---|---|
| Inventory Item Id | The unique identifier for the inventory item. | gid://shopify/InventoryItem/43933612241234 |
| Connection | The Shopify connection to use. |
{
"data": {
"inventoryItem": {
"id": "gid://shopify/InventoryItem/12345678901234",
"sku": "EXAMPLE-SKU",
"createdAt": "2022-01-01T12:00:00Z",
"updatedAt": "2024-12-01T15:30:00Z",
"requiresShipping": true,
"unitCost": {
"amount": "10.0",
"currencyCode": "USD"
},
"countryCodeOfOrigin": null,
"provinceCodeOfOrigin": null,
"harmonizedSystemCode": null,
"tracked": false,
"countryHarmonizedSystemCodes": {
"nodes": []
}
}
}
}
Get Inventory Levels
Retrieves an inventory level by ID. | key: getInventoryLevelsGql
| Input | Notes | Example |
|---|---|---|
| Inventory Level Id | The unique identifier for the inventory level. | gid://shopify/InventoryLevel/100340760123?inventory_item_id=43933612245123 |
| Connection | The Shopify connection to use. |
{
"data": {
"inventoryLevel": {
"id": "gid://shopify/InventoryLevel/523463154?inventory_item_id=43729076",
"item": {
"id": "gid://shopify/InventoryItem/43729076"
},
"location": {
"id": "gid://shopify/Location/346779380"
},
"quantities": [
{
"name": "available",
"quantity": 0
}
],
"updatedAt": "2024-11-07T20:59:45Z"
}
}
}
Get Location
Retrieves a location by ID. | key: getLocationsGql
| Input | Notes | Example |
|---|---|---|
| Location ID | The ID of the location that the inventory level belongs to. | 346779380 or gid://shopify/Location/346779380 |
| Connection | The Shopify connection to use. |
{
"data": {
"location": {
"id": "gid://shopify/Location/12345678901",
"name": "123 Example St Suite 100",
"address": {
"address1": "123 Example St Suite 100",
"address2": null,
"city": "Example City",
"zip": "12345",
"province": "Example State",
"country": "Example Country",
"phone": "",
"countryCode": "EX",
"provinceCode": "ES"
},
"createdAt": "2022-01-01T10:00:00Z",
"updatedAt": "2022-01-01T10:00:00Z",
"isActive": true
}
}
}
Get Order
Retrieves an order by ID. | key: getOrderGql
| Input | Notes | Example |
|---|---|---|
| Order ID | The unique identifier for the order. | 10079785100 or gid://shopify/Order/10079785100 |
| Connection | The Shopify connection to use. |
{
"data": {
"order": {
"id": "gid://shopify/Order/1234567890123",
"name": "#1234",
"app": {
"id": "gid://shopify/App/9876543210987"
},
"clientIp": "0.0.0.0",
"customerAcceptsMarketing": false,
"cancelReason": null,
"cancelledAt": null,
"closedAt": null,
"confirmationNumber": "ABC123XYZ",
"confirmed": true,
"createdAt": "2024-12-08T11:29:38Z",
"currencyCode": "USD",
"currentSubtotalPriceSet": {
"shopMoney": {
"amount": "50.00",
"currencyCode": "USD"
},
"presentmentMoney": {
"amount": "50.00",
"currencyCode": "USD"
}
},
"currentTotalAdditionalFeesSet": null,
"currentTotalDiscountsSet": {
"shopMoney": {
"amount": "5.00",
"currencyCode": "USD"
},
"presentmentMoney": {
"amount": "5.00",
"currencyCode": "USD"
}
},
"currentTotalDutiesSet": null,
"currentTotalPriceSet": {
"shopMoney": {
"amount": "50.00",
"currencyCode": "USD"
},
"presentmentMoney": {
"amount": "50.00",
"currencyCode": "USD"
}
},
"currentTotalTaxSet": {
"shopMoney": {
"amount": "0.00",
"currencyCode": "USD"
},
"presentmentMoney": {
"amount": "0.00",
"currencyCode": "USD"
}
},
"customerLocale": "en",
"discountCodes": [],
"dutiesIncluded": false,
"email": "example@example.com",
"estimatedTaxes": false,
"displayFinancialStatus": "PAID",
"displayFulfillmentStatus": "UNFULFILLED",
"retailLocation": null,
"merchantBusinessEntity": {
"id": "gid://shopify/BusinessEntity/1122334455667"
},
"merchantOfRecordApp": null,
"note": "Example note",
"originalTotalAdditionalFeesSet": null,
"originalTotalDutiesSet": null,
"paymentGatewayNames": [
"manual"
],
"phone": null,
"poNumber": null,
"presentmentCurrencyCode": "USD",
"processedAt": "2024-12-08T11:29:38Z",
"sourceIdentifier": "example-source-id",
"sourceName": "9876543210987",
"registeredSourceUrl": null,
"subtotalPriceSet": {
"shopMoney": {
"amount": "50.00",
"currencyCode": "USD"
},
"presentmentMoney": {
"amount": "50.00",
"currencyCode": "USD"
}
},
"tags": [],
"taxExempt": true,
"taxLines": [],
"taxesIncluded": false,
"test": false,
"totalCashRoundingAdjustment": {
"paymentSet": {
"shopMoney": {
"amount": "0.00",
"currencyCode": "USD"
},
"presentmentMoney": {
"amount": "0.00",
"currencyCode": "USD"
}
},
"refundSet": {
"shopMoney": {
"amount": "0.00",
"currencyCode": "USD"
},
"presentmentMoney": {
"amount": "0.00",
"currencyCode": "USD"
}
}
},
"totalDiscountsSet": {
"shopMoney": {
"amount": "5.00",
"currencyCode": "USD"
},
"presentmentMoney": {
"amount": "5.00",
"currencyCode": "USD"
}
},
"totalOutstandingSet": {
"shopMoney": {
"amount": "0.00",
"currencyCode": "USD"
}
},
"totalPriceSet": {
"shopMoney": {
"amount": "50.00",
"currencyCode": "USD"
},
"presentmentMoney": {
"amount": "50.00",
"currencyCode": "USD"
}
},
"totalShippingPriceSet": {
"shopMoney": {
"amount": "0.00",
"currencyCode": "USD"
},
"presentmentMoney": {
"amount": "0.00",
"currencyCode": "USD"
}
},
"totalTaxSet": {
"shopMoney": {
"amount": "0.00",
"currencyCode": "USD"
},
"presentmentMoney": {
"amount": "0.00",
"currencyCode": "USD"
}
},
"totalTipReceivedSet": {
"shopMoney": {
"amount": "0.00",
"currencyCode": "USD"
}
},
"totalWeight": "5000",
"updatedAt": "2024-12-08T11:29:39Z",
"billingAddress": {
"address1": "123 Example St",
"address2": null,
"name": "John Doe",
"lastName": "Doe",
"company": null,
"phone": null,
"zip": "12345",
"country": "United States",
"countryCodeV2": "US",
"province": "California",
"provinceCode": "CA"
},
"customer": {
"id": "gid://shopify/Customer/4567890123456",
"displayName": "John Doe",
"firstName": "John",
"lastName": "Doe",
"phone": null
},
"lineItems": {
"nodes": [
{
"id": "gid://shopify/LineItem/2345678901234",
"currentQuantity": 3,
"unfulfilledQuantity": 3,
"isGiftCard": false,
"name": "Sample Product",
"originalUnitPriceSet": {
"shopMoney": {
"amount": "16.67",
"currencyCode": "USD"
},
"presentmentMoney": {
"amount": "16.67",
"currencyCode": "USD"
}
},
"product": null,
"quantity": 3,
"requiresShipping": true,
"sku": "EX123",
"taxable": true,
"title": "Sample Product",
"totalDiscountSet": {
"shopMoney": {
"amount": "5.00",
"currencyCode": "USD"
},
"presentmentMoney": {
"amount": "5.00",
"currencyCode": "USD"
}
},
"variant": null,
"vendor": "Example Vendor",
"taxLines": [
{
"channelLiable": false,
"priceSet": {
"shopMoney": {
"amount": "0.00",
"currencyCode": "USD"
},
"presentmentMoney": {
"amount": "0.00",
"currencyCode": "USD"
}
},
"rate": 0.05,
"title": "Example Tax"
}
],
"duties": [],
"discountAllocations": [
{
"allocatedAmountSet": {
"shopMoney": {
"amount": "5.00",
"currencyCode": "USD"
},
"presentmentMoney": {
"amount": "5.00",
"currencyCode": "USD"
}
},
"discountApplication": {
"index": 0
}
}
]
}
]
},
"paymentTerms": null,
"refunds": [],
"shippingAddress": {
"firstName": "John",
"address1": "123 Example St",
"phone": null,
"city": "Example City",
"zip": "12345",
"province": "California",
"country": "United States",
"lastName": "Doe",
"address2": null,
"company": null,
"latitude": null,
"longitude": null,
"name": "John Doe",
"countryCodeV2": "US",
"provinceCode": "CA"
}
}
}
}
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. | key: getOrder
| Input | Notes | Example |
|---|---|---|
| Order ID | The unique ID of the order. | 450789469 |
| Connection | The Shopify connection to use. |
{
"data": {
"order": {
"id": 450789469,
"admin_graphql_api_id": "gid://shopify/Order/450789469",
"app_id": null,
"browser_ip": "0.0.0.0",
"buyer_accepts_marketing": false,
"cancel_reason": null,
"cancelled_at": null,
"cart_token": "68778783ad298f1c80c3bafcddeea02f",
"checkout_id": 901414060,
"checkout_token": "bd5a8aa1ecd019dd3520ff791ee3a24c",
"client_details": {
"accept_language": null,
"browser_height": null,
"browser_ip": "0.0.0.0",
"browser_width": null,
"session_hash": null,
"user_agent": null
},
"closed_at": null,
"confirmation_number": null,
"confirmed": true,
"contact_email": "bob.norman@mail.example.com",
"created_at": "2008-01-10T11:00:00-05:00",
"currency": "USD",
"current_subtotal_price": "195.67",
"current_subtotal_price_set": {
"shop_money": {
"amount": "195.67",
"currency_code": "USD"
},
"presentment_money": {
"amount": "195.67",
"currency_code": "USD"
}
},
"current_total_additional_fees_set": null,
"current_total_discounts": "3.33",
"current_total_discounts_set": {
"shop_money": {
"amount": "3.33",
"currency_code": "USD"
},
"presentment_money": {
"amount": "3.33",
"currency_code": "USD"
}
},
"current_total_duties_set": null,
"current_total_price": "199.65",
"current_total_price_set": {
"shop_money": {
"amount": "199.65",
"currency_code": "USD"
},
"presentment_money": {
"amount": "199.65",
"currency_code": "USD"
}
},
"current_total_tax": "3.98",
"current_total_tax_set": {
"shop_money": {
"amount": "3.98",
"currency_code": "USD"
},
"presentment_money": {
"amount": "3.98",
"currency_code": "USD"
}
},
"customer_locale": null,
"device_id": null,
"discount_codes": [
{
"code": "TENOFF",
"amount": "10.00",
"type": "fixed_amount"
}
],
"duties_included": false,
"email": "bob.norman@mail.example.com",
"estimated_taxes": false,
"financial_status": "partially_refunded",
"fulfillment_status": null,
"landing_site": "http://www.example.com?source=abc",
"landing_site_ref": "abc",
"location_id": null,
"merchant_business_entity_id": "MTU0ODM4MDAwOQ",
"merchant_of_record_app_id": null,
"name": "#1001",
"note": null,
"note_attributes": [
{
"name": "custom engraving",
"value": "Happy Birthday"
},
{
"name": "colour",
"value": "green"
}
],
"number": 1,
"order_number": 1001,
"order_status_url": "https://jsmith.myshopify.com/548380009/orders/b1946ac92492d2347c6235b4d2611184/authenticate?key=imasecretipod",
"original_total_additional_fees_set": null,
"original_total_duties_set": null,
"payment_gateway_names": [
"bogus"
],
"phone": "+557734881234",
"po_number": "ABC123",
"presentment_currency": "USD",
"processed_at": "2008-01-10T11:00:00-05:00",
"reference": "fhwdgads",
"referring_site": "http://www.otherexample.com",
"source_identifier": "fhwdgads",
"source_name": "web",
"source_url": null,
"subtotal_price": "597.00",
"subtotal_price_set": {
"shop_money": {
"amount": "597.00",
"currency_code": "USD"
},
"presentment_money": {
"amount": "597.00",
"currency_code": "USD"
}
},
"tags": "",
"tax_exempt": false,
"tax_lines": [
{
"price": "11.94",
"rate": 0.06,
"title": "State Tax",
"price_set": {
"shop_money": {
"amount": "11.94",
"currency_code": "USD"
},
"presentment_money": {
"amount": "11.94",
"currency_code": "USD"
}
},
"channel_liable": null
}
],
"taxes_included": false,
"test": false,
"token": "b1946ac92492d2347c6235b4d2611184",
"total_cash_rounding_payment_adjustment_set": {
"shop_money": {
"amount": "0.00",
"currency_code": "USD"
},
"presentment_money": {
"amount": "0.00",
"currency_code": "USD"
}
},
"total_cash_rounding_refund_adjustment_set": {
"shop_money": {
"amount": "0.00",
"currency_code": "USD"
},
"presentment_money": {
"amount": "0.00",
"currency_code": "USD"
}
},
"total_discounts": "10.00",
"total_discounts_set": {
"shop_money": {
"amount": "10.00",
"currency_code": "USD"
},
"presentment_money": {
"amount": "10.00",
"currency_code": "USD"
}
},
"total_line_items_price": "597.00",
"total_line_items_price_set": {
"shop_money": {
"amount": "597.00",
"currency_code": "USD"
},
"presentment_money": {
"amount": "597.00",
"currency_code": "USD"
}
},
"total_outstanding": "0.00",
"total_price": "598.94",
"total_price_set": {
"shop_money": {
"amount": "598.94",
"currency_code": "USD"
},
"presentment_money": {
"amount": "598.94",
"currency_code": "USD"
}
},
"total_shipping_price_set": {
"shop_money": {
"amount": "0.00",
"currency_code": "USD"
},
"presentment_money": {
"amount": "0.00",
"currency_code": "USD"
}
},
"total_tax": "11.94",
"total_tax_set": {
"shop_money": {
"amount": "11.94",
"currency_code": "USD"
},
"presentment_money": {
"amount": "11.94",
"currency_code": "USD"
}
},
"total_tip_received": "0.00",
"total_weight": 0,
"updated_at": "2008-01-10T11:00:00-05:00",
"user_id": null,
"billing_address": {
"first_name": "Bob",
"address1": "Chestnut Street 92",
"phone": "+1(502)-459-2181",
"city": "Louisville",
"zip": "40202",
"province": "Kentucky",
"country": "United States",
"last_name": "Norman",
"address2": "",
"company": null,
"latitude": 45.41634,
"longitude": -75.6868,
"name": "Bob Norman",
"country_code": "US",
"province_code": "KY"
},
"customer": {
"id": 207119551,
"email": "bob.norman@mail.example.com",
"created_at": "2025-01-02T11:29:59-05:00",
"updated_at": "2025-01-02T11:29:59-05:00",
"first_name": "Bob",
"last_name": "Norman",
"state": "disabled",
"note": null,
"verified_email": true,
"multipass_identifier": null,
"tax_exempt": false,
"phone": "+16136120707",
"email_marketing_consent": {
"state": "not_subscribed",
"opt_in_level": null,
"consent_updated_at": "2004-06-13T11:57:11-04:00"
},
"sms_marketing_consent": {
"state": "not_subscribed",
"opt_in_level": "single_opt_in",
"consent_updated_at": "2024-01-01T07:00:00-05:00",
"consent_collected_from": "OTHER"
},
"tags": "Léon, Noël",
"currency": "USD",
"tax_exemptions": [],
"admin_graphql_api_id": "gid://shopify/Customer/207119551",
"default_address": {
"id": 207119551,
"customer_id": 207119551,
"first_name": null,
"last_name": null,
"company": null,
"address1": "Chestnut Street 92",
"address2": "",
"city": "Louisville",
"province": "Kentucky",
"country": "United States",
"zip": "40202",
"phone": "555-625-1199",
"name": "",
"province_code": "KY",
"country_code": "US",
"country_name": "United States",
"default": true
}
},
"discount_applications": [
{
"target_type": "line_item",
"type": "discount_code",
"value": "10.0",
"value_type": "fixed_amount",
"allocation_method": "across",
"target_selection": "all",
"code": "TENOFF"
}
],
"fulfillments": [
{
"id": 255858046,
"admin_graphql_api_id": "gid://shopify/Fulfillment/255858046",
"created_at": "2025-01-02T11:29:59-05:00",
"location_id": 655441491,
"name": "#1001.0",
"order_id": 450789469,
"origin_address": {},
"receipt": {
"testcase": true,
"authorization": "123456"
},
"service": "manual",
"shipment_status": null,
"status": "failure",
"tracking_company": "USPS",
"tracking_number": "1Z1234512345123456",
"tracking_numbers": [
"1Z1234512345123456"
],
"tracking_url": "https://tools.usps.com/go/TrackConfirmAction_input?qtc_tLabels1=1Z1234512345123456",
"tracking_urls": [
"https://tools.usps.com/go/TrackConfirmAction_input?qtc_tLabels1=1Z1234512345123456"
],
"updated_at": "2025-01-02T11:29:59-05:00",
"line_items": [
{
"id": 466157049,
"admin_graphql_api_id": "gid://shopify/LineItem/466157049",
"attributed_staffs": [],
"current_quantity": 0,
"fulfillable_quantity": 0,
"fulfillment_service": "manual",
"fulfillment_status": null,
"gift_card": false,
"grams": 200,
"name": "IPod Nano - 8gb - green",
"price": "199.00",
"price_set": {
"shop_money": {
"amount": "199.00",
"currency_code": "USD"
},
"presentment_money": {
"amount": "199.00",
"currency_code": "USD"
}
},
"product_exists": true,
"product_id": 632910392,
"properties": [
{
"name": "Custom Engraving Front",
"value": "Happy Birthday"
},
{
"name": "Custom Engraving Back",
"value": "Merry Christmas"
}
],
"quantity": 1,
"requires_shipping": true,
"sku": "IPOD2008GREEN",
"taxable": true,
"title": "IPod Nano - 8gb",
"total_discount": "0.00",
"total_discount_set": {
"shop_money": {
"amount": "0.00",
"currency_code": "USD"
},
"presentment_money": {
"amount": "0.00",
"currency_code": "USD"
}
},
"variant_id": 39072856,
"variant_inventory_management": "shopify",
"variant_title": "green",
"vendor": null,
"tax_lines": [
{
"channel_liable": null,
"price": "3.98",
"price_set": {
"shop_money": {
"amount": "3.98",
"currency_code": "USD"
},
"presentment_money": {
"amount": "3.98",
"currency_code": "USD"
}
},
"rate": 0.06,
"title": "State Tax"
}
],
"duties": [],
"discount_allocations": [
{
"amount": "3.34",
"amount_set": {
"shop_money": {
"amount": "3.34",
"currency_code": "USD"
},
"presentment_money": {
"amount": "3.34",
"currency_code": "USD"
}
},
"discount_application_index": 0
}
]
}
]
}
],
"line_items": [
{
"id": 466157049,
"admin_graphql_api_id": "gid://shopify/LineItem/466157049",
"attributed_staffs": [],
"current_quantity": 0,
"fulfillable_quantity": 0,
"fulfillment_service": "manual",
"fulfillment_status": null,
"gift_card": false,
"grams": 200,
"name": "IPod Nano - 8gb - green",
"price": "199.00",
"price_set": {
"shop_money": {
"amount": "199.00",
"currency_code": "USD"
},
"presentment_money": {
"amount": "199.00",
"currency_code": "USD"
}
},
"product_exists": true,
"product_id": 632910392,
"properties": [
{
"name": "Custom Engraving Front",
"value": "Happy Birthday"
},
{
"name": "Custom Engraving Back",
"value": "Merry Christmas"
}
],
"quantity": 1,
"requires_shipping": true,
"sku": "IPOD2008GREEN",
"taxable": true,
"title": "IPod Nano - 8gb",
"total_discount": "0.00",
"total_discount_set": {
"shop_money": {
"amount": "0.00",
"currency_code": "USD"
},
"presentment_money": {
"amount": "0.00",
"currency_code": "USD"
}
},
"variant_id": 39072856,
"variant_inventory_management": "shopify",
"variant_title": "green",
"vendor": null,
"tax_lines": [
{
"channel_liable": null,
"price": "3.98",
"price_set": {
"shop_money": {
"amount": "3.98",
"currency_code": "USD"
},
"presentment_money": {
"amount": "3.98",
"currency_code": "USD"
}
},
"rate": 0.06,
"title": "State Tax"
}
],
"duties": [],
"discount_allocations": [
{
"amount": "3.34",
"amount_set": {
"shop_money": {
"amount": "3.34",
"currency_code": "USD"
},
"presentment_money": {
"amount": "3.34",
"currency_code": "USD"
}
},
"discount_application_index": 0
}
]
},
{
"id": 518995019,
"admin_graphql_api_id": "gid://shopify/LineItem/518995019",
"attributed_staffs": [],
"current_quantity": 1,
"fulfillable_quantity": 1,
"fulfillment_service": "manual",
"fulfillment_status": null,
"gift_card": false,
"grams": 200,
"name": "IPod Nano - 8gb - red",
"price": "199.00",
"price_set": {
"shop_money": {
"amount": "199.00",
"currency_code": "USD"
},
"presentment_money": {
"amount": "199.00",
"currency_code": "USD"
}
},
"product_exists": true,
"product_id": 632910392,
"properties": [],
"quantity": 1,
"requires_shipping": true,
"sku": "IPOD2008RED",
"taxable": true,
"title": "IPod Nano - 8gb",
"total_discount": "0.00",
"total_discount_set": {
"shop_money": {
"amount": "0.00",
"currency_code": "USD"
},
"presentment_money": {
"amount": "0.00",
"currency_code": "USD"
}
},
"variant_id": 49148385,
"variant_inventory_management": "shopify",
"variant_title": "red",
"vendor": null,
"tax_lines": [
{
"channel_liable": null,
"price": "3.98",
"price_set": {
"shop_money": {
"amount": "3.98",
"currency_code": "USD"
},
"presentment_money": {
"amount": "3.98",
"currency_code": "USD"
}
},
"rate": 0.06,
"title": "State Tax"
}
],
"duties": [],
"discount_allocations": [
{
"amount": "3.33",
"amount_set": {
"shop_money": {
"amount": "3.33",
"currency_code": "USD"
},
"presentment_money": {
"amount": "3.33",
"currency_code": "USD"
}
},
"discount_application_index": 0
}
]
},
{
"id": 703073504,
"admin_graphql_api_id": "gid://shopify/LineItem/703073504",
"attributed_staffs": [],
"current_quantity": 0,
"fulfillable_quantity": 0,
"fulfillment_service": "manual",
"fulfillment_status": null,
"gift_card": false,
"grams": 200,
"name": "IPod Nano - 8gb - black",
"price": "199.00",
"price_set": {
"shop_money": {
"amount": "199.00",
"currency_code": "USD"
},
"presentment_money": {
"amount": "199.00",
"currency_code": "USD"
}
},
"product_exists": true,
"product_id": 632910392,
"properties": [],
"quantity": 1,
"requires_shipping": true,
"sku": "IPOD2008BLACK",
"taxable": true,
"title": "IPod Nano - 8gb",
"total_discount": "0.00",
"total_discount_set": {
"shop_money": {
"amount": "0.00",
"currency_code": "USD"
},
"presentment_money": {
"amount": "0.00",
"currency_code": "USD"
}
},
"variant_id": 457924702,
"variant_inventory_management": "shopify",
"variant_title": "black",
"vendor": null,
"tax_lines": [
{
"channel_liable": null,
"price": "3.98",
"price_set": {
"shop_money": {
"amount": "3.98",
"currency_code": "USD"
},
"presentment_money": {
"amount": "3.98",
"currency_code": "USD"
}
},
"rate": 0.06,
"title": "State Tax"
}
],
"duties": [],
"discount_allocations": [
{
"amount": "3.33",
"amount_set": {
"shop_money": {
"amount": "3.33",
"currency_code": "USD"
},
"presentment_money": {
"amount": "3.33",
"currency_code": "USD"
}
},
"discount_application_index": 0
}
]
}
],
"payment_terms": null,
"refunds": [
{
"id": 509562969,
"admin_graphql_api_id": "gid://shopify/Refund/509562969",
"created_at": "2025-01-02T11:29:59-05:00",
"note": "it broke during shipping",
"order_id": 450789469,
"processed_at": "2025-01-02T11:29:59-05:00",
"restock": true,
"total_additional_fees_set": {
"shop_money": {
"amount": "0.00",
"currency_code": "USD"
},
"presentment_money": {
"amount": "0.00",
"currency_code": "USD"
}
},
"total_duties_set": {
"shop_money": {
"amount": "0.00",
"currency_code": "USD"
},
"presentment_money": {
"amount": "0.00",
"currency_code": "USD"
}
},
"user_id": 548380009,
"order_adjustments": [],
"transactions": [
{
"id": 179259969,
"admin_graphql_api_id": "gid://shopify/OrderTransaction/179259969",
"amount": "209.00",
"authorization": "authorization-key",
"created_at": "2005-08-05T12:59:12-04:00",
"currency": "USD",
"device_id": null,
"error_code": null,
"gateway": "bogus",
"kind": "refund",
"location_id": null,
"message": null,
"order_id": 450789469,
"parent_id": 801038806,
"payment_id": "#1001.3",
"processed_at": "2005-08-05T12:59:12-04:00",
"receipt": {},
"source_name": "web",
"status": "success",
"test": false,
"user_id": null
}
],
"refund_line_items": [
{
"id": 104689539,
"line_item_id": 703073504,
"location_id": 487838322,
"quantity": 1,
"restock_type": "legacy_restock",
"subtotal": 195.66,
"subtotal_set": {
"shop_money": {
"amount": "195.66",
"currency_code": "USD"
},
"presentment_money": {
"amount": "195.66",
"currency_code": "USD"
}
},
"total_tax": 3.98,
"total_tax_set": {
"shop_money": {
"amount": "3.98",
"currency_code": "USD"
},
"presentment_money": {
"amount": "3.98",
"currency_code": "USD"
}
},
"line_item": {
"id": 703073504,
"admin_graphql_api_id": "gid://shopify/LineItem/703073504",
"attributed_staffs": [],
"current_quantity": 0,
"fulfillable_quantity": 0,
"fulfillment_service": "manual",
"fulfillment_status": null,
"gift_card": false,
"grams": 200,
"name": "IPod Nano - 8gb - black",
"price": "199.00",
"price_set": {
"shop_money": {
"amount": "199.00",
"currency_code": "USD"
},
"presentment_money": {
"amount": "199.00",
"currency_code": "USD"
}
},
"product_exists": true,
"product_id": 632910392,
"properties": [],
"quantity": 1,
"requires_shipping": true,
"sku": "IPOD2008BLACK",
"taxable": true,
"title": "IPod Nano - 8gb",
"total_discount": "0.00",
"total_discount_set": {
"shop_money": {
"amount": "0.00",
"currency_code": "USD"
},
"presentment_money": {
"amount": "0.00",
"currency_code": "USD"
}
},
"variant_id": 457924702,
"variant_inventory_management": "shopify",
"variant_title": "black",
"vendor": null,
"tax_lines": [
{
"channel_liable": null,
"price": "3.98",
"price_set": {
"shop_money": {
"amount": "3.98",
"currency_code": "USD"
},
"presentment_money": {
"amount": "3.98",
"currency_code": "USD"
}
},
"rate": 0.06,
"title": "State Tax"
}
],
"duties": [],
"discount_allocations": [
{
"amount": "3.33",
"amount_set": {
"shop_money": {
"amount": "3.33",
"currency_code": "USD"
},
"presentment_money": {
"amount": "3.33",
"currency_code": "USD"
}
},
"discount_application_index": 0
}
]
}
},
{
"id": 709875399,
"line_item_id": 466157049,
"location_id": 487838322,
"quantity": 1,
"restock_type": "legacy_restock",
"subtotal": 195.67,
"subtotal_set": {
"shop_money": {
"amount": "195.67",
"currency_code": "USD"
},
"presentment_money": {
"amount": "195.67",
"currency_code": "USD"
}
},
"total_tax": 3.98,
"total_tax_set": {
"shop_money": {
"amount": "3.98",
"currency_code": "USD"
},
"presentment_money": {
"amount": "3.98",
"currency_code": "USD"
}
},
"line_item": {
"id": 466157049,
"admin_graphql_api_id": "gid://shopify/LineItem/466157049",
"attributed_staffs": [],
"current_quantity": 0,
"fulfillable_quantity": 0,
"fulfillment_service": "manual",
"fulfillment_status": null,
"gift_card": false,
"grams": 200,
"name": "IPod Nano - 8gb - green",
"price": "199.00",
"price_set": {
"shop_money": {
"amount": "199.00",
"currency_code": "USD"
},
"presentment_money": {
"amount": "199.00",
"currency_code": "USD"
}
},
"product_exists": true,
"product_id": 632910392,
"properties": [
{
"name": "Custom Engraving Front",
"value": "Happy Birthday"
},
{
"name": "Custom Engraving Back",
"value": "Merry Christmas"
}
],
"quantity": 1,
"requires_shipping": true,
"sku": "IPOD2008GREEN",
"taxable": true,
"title": "IPod Nano - 8gb",
"total_discount": "0.00",
"total_discount_set": {
"shop_money": {
"amount": "0.00",
"currency_code": "USD"
},
"presentment_money": {
"amount": "0.00",
"currency_code": "USD"
}
},
"variant_id": 39072856,
"variant_inventory_management": "shopify",
"variant_title": "green",
"vendor": null,
"tax_lines": [
{
"channel_liable": null,
"price": "3.98",
"price_set": {
"shop_money": {
"amount": "3.98",
"currency_code": "USD"
},
"presentment_money": {
"amount": "3.98",
"currency_code": "USD"
}
},
"rate": 0.06,
"title": "State Tax"
}
],
"duties": [],
"discount_allocations": [
{
"amount": "3.34",
"amount_set": {
"shop_money": {
"amount": "3.34",
"currency_code": "USD"
},
"presentment_money": {
"amount": "3.34",
"currency_code": "USD"
}
},
"discount_application_index": 0
}
]
}
}
],
"duties": [],
"additional_fees": []
}
],
"shipping_address": {
"first_name": "Bob",
"address1": "Chestnut Street 92",
"phone": "+1(502)-459-2181",
"city": "Louisville",
"zip": "40202",
"province": "Kentucky",
"country": "United States",
"last_name": "Norman",
"address2": "",
"company": null,
"latitude": 45.41634,
"longitude": -75.6868,
"name": "Bob Norman",
"country_code": "US",
"province_code": "KY"
},
"shipping_lines": [
{
"id": 369256396,
"carrier_identifier": null,
"code": "Free Shipping",
"discounted_price": "0.00",
"discounted_price_set": {
"shop_money": {
"amount": "0.00",
"currency_code": "USD"
},
"presentment_money": {
"amount": "0.00",
"currency_code": "USD"
}
},
"is_removed": false,
"phone": null,
"price": "0.00",
"price_set": {
"shop_money": {
"amount": "0.00",
"currency_code": "USD"
},
"presentment_money": {
"amount": "0.00",
"currency_code": "USD"
}
},
"requested_fulfillment_service_id": null,
"source": "shopify",
"title": "Free Shipping",
"tax_lines": [],
"discount_allocations": []
}
]
}
}
}
Get Product
Retrieves a product by ID. | key: getProduct
| Input | Notes | Example |
|---|---|---|
| Product ID | The unique ID of the product. | 74020090 |
| Connection | The Shopify connection to use. |
{
"data": {
"product": {
"id": 632910392,
"title": "IPod Nano - 8GB",
"body_html": "<p>It's the small iPod with one very big idea: Video. Now the world's most popular music player, available in 4GB and 8GB models, lets you enjoy TV shows, movies, video podcasts, and more. The larger, brighter display means amazing picture quality. In six eye-catching colors, iPod nano is stunning all around. And with models starting at just $149, little speaks volumes.</p>",
"vendor": "Apple",
"product_type": "Cult Products",
"created_at": "2023-07-11T17:47:36-04:00",
"handle": "ipod-nano",
"updated_at": "2023-07-11T17:47:36-04:00",
"published_at": "2007-12-31T19:00:00-05:00",
"template_suffix": null,
"status": "active",
"published_scope": "web",
"tags": "Emotive, Flash Memory, MP3, Music",
"admin_graphql_api_id": "gid://shopify/Product/632910392",
"variants": [
{
"id": 808950810,
"product_id": 632910392,
"title": "Pink",
"price": "199.00",
"sku": "IPOD2008PINK",
"position": 1,
"inventory_policy": "continue",
"compare_at_price": null,
"fulfillment_service": "manual",
"inventory_management": "shopify",
"option1": "Pink",
"option2": null,
"option3": null,
"created_at": "2023-07-11T17:47:36-04:00",
"updated_at": "2023-07-11T17:47:36-04:00",
"taxable": true,
"barcode": "1234_pink",
"grams": 567,
"image_id": 562641783,
"weight": 1.25,
"weight_unit": "lb",
"inventory_item_id": 808950810,
"inventory_quantity": 10,
"old_inventory_quantity": 10,
"presentment_prices": [
{
"price": {
"amount": "199.00",
"currency_code": "USD"
},
"compare_at_price": null
}
],
"requires_shipping": true,
"admin_graphql_api_id": "gid://shopify/ProductVariant/808950810"
}
],
"options": [
{
"id": 594680422,
"product_id": 632910392,
"name": "Color",
"position": 1,
"values": [
"Pink",
"Red",
"Green",
"Black"
]
}
],
"images": [
{
"id": 850703190,
"product_id": 632910392,
"position": 1,
"created_at": "2023-07-11T17:47:36-04:00",
"updated_at": "2023-07-11T17:47:36-04:00",
"alt": null,
"width": 123,
"height": 456,
"src": "https://cdn.shopify.com/s/files/1/0005/4838/0009/products/ipod-nano.png?v=1689112056",
"variant_ids": [],
"admin_graphql_api_id": "gid://shopify/ProductImage/850703190"
}
],
"image": {
"id": 850703190,
"product_id": 632910392,
"position": 1,
"created_at": "2023-07-11T17:47:36-04:00",
"updated_at": "2023-07-11T17:47:36-04:00",
"alt": null,
"width": 123,
"height": 456,
"src": "https://cdn.shopify.com/s/files/1/0005/4838/0009/products/ipod-nano.png?v=1689112056",
"variant_ids": [],
"admin_graphql_api_id": "gid://shopify/ProductImage/850703190"
}
}
}
}
Get Product Image
Retrieves a product image by ID. | key: getProductImageGql
| Input | Notes | Example |
|---|---|---|
| Image ID | Provide a unique ID of a product image. Use only the ID number. | 916933471 |
| Product ID | The unique identifier for the product. | 108828309 or gid://shopify/Product/108828309 |
| Connection | The Shopify connection to use. |
{
"data": {
"image": {
"alt": "image",
"id": "gid://shopify/MediaImage/32285801283737",
"mediaContentType": "IMAGE",
"status": "READY",
"preview": {
"image": {
"altText": "image",
"height": 300,
"id": "gid://shopify/ImageSource/32307802603673",
"originalSrc": "https://cdn.shopify.com/s/files/1/0606/2820/5721/files/300.jpg?v=123456",
"url": "https://cdn.shopify.com/s/files/1/0606/2820/5721/files/300.jpg?v=123456",
"width": 200,
"src": "https://cdn.shopify.com/s/files/1/0606/2820/5721/files/300.jpg?v=123456"
},
"status": "READY"
}
}
}
}
Get Shop Configuration
Retrieves the shop configuration. | key: getShopConfig
| Input | Notes | Example |
|---|---|---|
| Connection | The Shopify connection to use. |
{
"data": {
"data": {
"shop": {
"id": 548380009,
"name": "John Smith Test Store",
"email": "j.smith@example.com",
"domain": "shop.apple.com",
"province": "California",
"country": "US",
"address1": "1 Infinite Loop",
"zip": "95014",
"city": "Cupertino",
"source": null,
"phone": "1231231234",
"latitude": 45.45,
"longitude": -75.43,
"primary_locale": "en",
"address2": "Suite 100",
"created_at": "2007-12-31T19:00:00-05:00",
"updated_at": "2024-02-14T10:58:03-05:00",
"country_code": "US",
"country_name": "United States",
"currency": "USD",
"customer_email": "customers@apple.com",
"timezone": "(GMT-05:00) Eastern Time (US & Canada)",
"iana_timezone": "America/New_York",
"shop_owner": "John Smith",
"money_format": "${{amount}}",
"money_with_currency_format": "${{amount}} USD",
"weight_unit": "lb",
"province_code": "CA",
"taxes_included": null,
"auto_configure_tax_inclusivity": null,
"tax_shipping": null,
"county_taxes": true,
"plan_display_name": "Shopify Plus",
"plan_name": "enterprise",
"has_discounts": true,
"has_gift_cards": true,
"myshopify_domain": "jsmith.myshopify.com",
"google_apps_domain": null,
"google_apps_login_enabled": null,
"money_in_emails_format": "${{amount}}",
"money_with_currency_in_emails_format": "${{amount}} USD",
"eligible_for_payments": true,
"requires_extra_payments_agreement": false,
"password_enabled": false,
"has_storefront": true,
"finances": true,
"primary_location_id": 655441491,
"checkout_api_supported": true,
"multi_location_enabled": true,
"setup_required": false,
"pre_launch_enabled": false,
"enabled_presentment_currencies": [
"USD"
],
"transactional_sms_disabled": false,
"marketing_sms_consent_enabled_at_checkout": false
}
}
}
}
Get Variant
Retrieves a product variant by ID. | key: getVariantGql
| Input | Notes | Example |
|---|---|---|
| Connection | The Shopify connection to use. | |
| Variant ID | The unique identifier for the product variant. | gid://shopify/ProductVariant/1070325177 |
{
"data": {
"productVariant": {
"id": "gid://shopify/ProductVariant/43729076",
"title": "151cm",
"availableForSale": true,
"barcode": "12345678",
"compareAtPrice": "20.00",
"createdAt": "2024-11-12T15:54:57Z"
}
}
}
List Collections
Lists all collections. | key: listCollectionsGql
| Input | Notes | Example |
|---|---|---|
| Page Offset Cursor | Cursor for pagination. Use the value from the previous response to retrieve the next page of results. | eyJkaXJlY3Rpb24iOiJwcmV2IiwibGFzdF9pZCI6OTAyOTk2ODAwMzM1NCwibGFzdF92YWx1ZSI6IlRoZSBDb2xsZWN0aW9uIFNub3dib2FyZDogTGlxdWlkIn0 |
| Fetch All | When true, automatically fetches all pages of results using pagination. The API is limited to 250 records per page max. | false |
| Limit | The maximum number of results to return per page. Maximum: 250. | 20 |
| Connection | The Shopify connection to use. |
{
"data": {
"collections": [
{
"id": "gid://shopify/Collection/123456789012",
"description": "Example description",
"descriptionHtml": "<p>Example description in HTML</p>",
"handle": "example-collection-handle",
"products": {
"nodes": [
{
"descriptionHtml": "<p>Example product description</p>",
"category": "Example Category",
"createdAt": "2023-01-01T12:00:00Z",
"description": "Example product description",
"featuredMedia": {
"alt": "Example alt text",
"id": "gid://shopify/MediaImage/987654321098",
"preview": {
"image": {
"url": "https://cdn.example.com/images/example.jpg",
"width": 200,
"height": 300,
"id": "gid://shopify/ImageSource/654321987654"
}
},
"status": "READY"
},
"handle": "example-product-handle",
"id": "gid://shopify/Product/1234567890123",
"priceRangeV2": {
"maxVariantPrice": {
"amount": "50.0",
"currencyCode": "USD"
},
"minVariantPrice": {
"amount": "10.0",
"currencyCode": "USD"
}
},
"productType": "Example Type",
"publishedAt": "2023-01-01T12:00:00Z",
"status": "ACTIVE",
"tags": [
"Example Tag 1",
"Example Tag 2"
],
"title": "Example Product Title",
"totalInventory": 100,
"vendor": "Example Vendor Name"
}
]
},
"productsCount": {
"count": 10
},
"sortOrder": "MANUAL",
"title": "Example Collection Title"
}
],
"pageInfo": {
"hasNextPage": false,
"endCursor": "YXJyYXljb25uZWN0aW9uOjA="
}
}
}
List Currencies
Lists all enabled currencies. | key: listCurrenciesGql
| Input | Notes | Example |
|---|---|---|
| Page Offset Cursor | Cursor for pagination. Use the value from the previous response to retrieve the next page of results. | eyJkaXJlY3Rpb24iOiJwcmV2IiwibGFzdF9pZCI6OTAyOTk2ODAwMzM1NCwibGFzdF92YWx1ZSI6IlRoZSBDb2xsZWN0aW9uIFNub3dib2FyZDogTGlxdWlkIn0 |
| Fetch All | When true, automatically fetches all pages of results using pagination. The API is limited to 250 records per page max. | false |
| Limit | The maximum number of results to return per page. Maximum: 250. | 20 |
| Connection | The Shopify connection to use. |
{
"data": {
"currencies": [
{
"currencyCode": "CAD",
"rateUpdatedAt": "2018-01-24T00:01:01Z",
"enabled": false
}
],
"pageInfo": {
"hasNextPage": false,
"endCursor": "YXJyYXljb25uZWN0aW9uOjA="
}
}
}
List Customers
Lists all customers. | key: listCustomers
| Input | Notes | Example |
|---|---|---|
| Get All Data | When 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 |
| Limit | The maximum number of results to return per page. Maximum: 250. | 20 |
| Page Offset Token | Cursor for pagination. Use the value from the previous response to retrieve the next page of results. | eyJkaXJlY3Rpb24iOiJwcmV2IiwibGFzdF9pZCI6OTAyOTk2ODAwMzM1NCwibGFzdF92YWx1ZSI6IlRoZSBDb2xsZWN0aW9uIFNub3dib2FyZDogTGlxdWlkIn0 |
| Connection | The Shopify connection to use. |
{
"data": {
"data": {
"customers": [
{
"id": 8000000000000,
"email": "example@example.com",
"created_at": "2025-01-07T09:32:23Z",
"updated_at": "2025-01-07T09:32:23Z",
"first_name": "John",
"last_name": "Doe",
"state": "DISABLED",
"last_order_id": null,
"note": null,
"verified_email": true,
"multipass_identifier": null,
"tax_exempt": false,
"tags": "",
"last_order_name": null,
"phone": "+18000000000",
"addresses": [
{
"id": null,
"customer_id": 8000000000000,
"first_name": "Jane",
"last_name": "Smith",
"company": "Example Corp",
"address1": "456 Oak Avenue",
"address2": "Suite 12",
"city": "Metropolis",
"province": "California",
"country": "United States",
"zip": "90210",
"phone": "555-000-0000",
"name": "Jane Smith",
"province_code": "CA",
"country_code": "US",
"country_name": "United States"
}
],
"tax_exemptions": [],
"email_marketing_consent": {
"state": "NOT_SUBSCRIBED",
"opt_in_level": "SINGLE_OPT_IN",
"consent_updated_at": null
},
"sms_marketing_consent": {
"state": "NOT_SUBSCRIBED",
"opt_in_level": "SINGLE_OPT_IN",
"consent_updated_at": null,
"consent_collected_from": "OTHER"
},
"admin_graphql_api_id": "gid://shopify/Customer/8000000000000",
"default_address": {
"id": null,
"customer_id": 8000000000000,
"first_name": "Jane",
"last_name": "Smith",
"company": "Example Corp",
"address1": "456 Oak Avenue",
"address2": "Suite 12",
"city": "Metropolis",
"province": "California",
"country": "United States",
"zip": "90210",
"phone": "555-000-0000",
"name": "Jane Smith",
"province_code": "CA",
"country_code": "US",
"country_name": "United States"
}
}
]
},
"pagination": {
"next": {
"page_info": "YXJyYXljb25uZWN0aW9uOjA=",
"rel": "next"
}
},
"pageInfo": "YXJyYXljb25uZWN0aW9uOjA=",
"rel": "rel=\"next\""
}
}
List Draft Orders
Lists all draft orders. | key: listDraftOrders
| Input | Notes | Example |
|---|---|---|
| Get All Data | When 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 |
| Limit | The maximum number of results to return per page. Maximum: 250. | 20 |
| Page Offset Token | Cursor for pagination. Use the value from the previous response to retrieve the next page of results. | eyJkaXJlY3Rpb24iOiJwcmV2IiwibGFzdF9pZCI6OTAyOTk2ODAwMzM1NCwibGFzdF92YWx1ZSI6IlRoZSBDb2xsZWN0aW9uIFNub3dib2FyZDogTGlxdWlkIn0 |
| Connection | The Shopify connection to use. |
{
"data": {
"data": {
"draft_orders": [
{
"id": 1234567890,
"note": null,
"email": "example@example.com",
"taxes_included": false,
"currency": "USD",
"invoice_sent_at": null,
"created_at": "2022-02-16T18:49:34Z",
"updated_at": "2022-02-16T18:49:34Z",
"tax_exempt": false,
"completed_at": null,
"name": "#D1",
"status": "OPEN",
"line_items": [
{
"id": 9876543210,
"variant_id": null,
"product_id": null,
"title": "Example Product",
"variant_title": null,
"sku": "EXAMPLE-SKU",
"vendor": "Example Vendor",
"quantity": 1,
"requires_shipping": true,
"taxable": true,
"gift_card": false,
"fulfillment_service": "MANUAL",
"tax_lines": [
{
"channel_liable": null,
"rate": 0.045,
"title": "Example State Tax",
"price_set": {
"shop_money": {
"amount": "0.54",
"currency_code": "USD"
}
},
"price": "0.54"
}
],
"applied_discount": null,
"name": "Example Line Item",
"custom": true,
"original_unit_price": "12.0",
"admin_graphql_api_id": "gid://shopify/DraftOrderLineItem/9876543210"
}
],
"shipping_address": {
"first_name": "John",
"last_name": "Doe",
"address1": "123 Example St",
"address2": null,
"city": "Example City",
"province": "Example Province",
"country": "Example Country",
"zip": "12345",
"phone": "123-456-7890"
},
"billing_address": {
"first_name": "Jane",
"last_name": "Smith",
"address1": "456 Example Ave",
"address2": null,
"city": "Example City",
"province": "Example Province",
"country": "Example Country",
"zip": "67890",
"phone": "987-654-3210"
},
"invoice_url": "https://example-store.myshopify.com/invoices/exampleInvoiceId",
"applied_discount": null,
"order_id": null,
"shipping_line": null,
"tax_lines": [
{
"rate": 0.045,
"rate_percentage": 4.5,
"source": null,
"price_set": {
"shop_money": {
"amount": "0.54",
"currency_code": "USD"
}
},
"price": "0.54",
"channel_liable": null,
"title": "Example State Tax"
}
],
"tags": "",
"total_price": "12.78",
"subtotal_price": "12.0",
"total_tax": "0.78",
"payment_terms": null,
"customer": {
"id": 1122334455,
"email": "customer@example.com",
"first_name": "Alice",
"last_name": "Johnson",
"phone": "111-222-3333"
},
"admin_graphql_api_id": "gid://shopify/DraftOrder/1234567890"
}
]
},
"pagination": {
"next": {
"page_info": "YXJyYXljb25uZWN0aW9uOjA=",
"rel": "next"
}
},
"pageInfo": "YXJyYXljb25uZWN0aW9uOjA=",
"rel": "rel=\"next\""
}
}
List Fulfillment Orders
Lists all fulfillment orders for a specific order. | key: listFulfillmentOrders
| Input | Notes | Example |
|---|---|---|
| Order ID | The unique ID of the order. | 450789469 |
| Connection | The Shopify connection to use. |
{
"data": {
"data": {
"fulfillment_orders": [
{
"id": 1234567890123,
"order_id": 1234567890123,
"request_status": "UNSUBMITTED",
"status": "OPEN",
"supported_actions": [
"HOLD",
"SPLIT"
],
"destination": {
"id": 1234567890123,
"address1": null,
"address2": null,
"city": null,
"company": null,
"country": null,
"email": "test@example.com",
"first_name": null,
"last_name": null,
"phone": null,
"province": null,
"zip": null
},
"line_items": [
{
"id": 1234567890123,
"quantity": 1,
"line_item_id": 1234567890123,
"inventory_item_id": 1234567890123,
"variant_id": 1234567890123
}
],
"international_duties": null,
"fulfill_at": "2024-11-13T16:00:00Z",
"fulfill_by": null,
"fulfillment_holds": [],
"created_at": "2024-11-13T16:57:40Z",
"updated_at": "2024-11-13T16:57:40Z",
"delivery_method": {
"id": 1234567890123,
"method_type": "SHIPPING",
"min_delivery_date_time": null,
"max_delivery_date_time": null,
"additional_information": {
"instructions": null,
"phone": null
},
"service_code": "custom",
"source_reference": null,
"branded_promise": null,
"presented_name": "Shipping"
},
"assigned_location": {
"address1": "REDACTED",
"address2": null,
"city": "Sioux Falls",
"country_code": "US",
"location_id": 1234567890123,
"name": "REDACTED",
"phone": "",
"province": "South Dakota",
"zip": "57108"
},
"merchant_requests": []
}
]
},
"pagination": {
"next": {
"page_info": "YXJyYXljb25uZWN0aW9uOjA=",
"rel": "next"
}
},
"pageInfo": "YXJyYXljb25uZWN0aW9uOjA=",
"rel": "rel=\"next\""
}
}
List Fulfillment Services
Lists all fulfillment services. | key: listFulfillmentServicesGql
| Input | Notes | Example |
|---|---|---|
| Connection | The Shopify connection to use. |
{
"data": {
"fulfillmentServices": [
{
"id": "gid://shopify/FulfillmentService/1234567890?id=true",
"serviceName": "ExampleFulfillmentService",
"handle": "examplefulfillmentservice",
"location": {
"id": "gid://shopify/Location/0987654321"
},
"callbackUrl": "https://example.com/",
"trackingSupport": false,
"inventoryManagement": false,
"permitsSkuSharing": false
}
]
}
}
List Fulfillments
Lists all fulfillments for a specified order. | key: listFulfillments
| Input | Notes | Example |
|---|---|---|
| Get All Data | When 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 |
| Limit | The maximum number of results to return per page. Maximum: 250. | 20 |
| Order ID | The unique ID of the order. | 450789469 |
| Page Offset Token | Cursor for pagination. Use the value from the previous response to retrieve the next page of results. | eyJkaXJlY3Rpb24iOiJwcmV2IiwibGFzdF9pZCI6OTAyOTk2ODAwMzM1NCwibGFzdF92YWx1ZSI6IlRoZSBDb2xsZWN0aW9uIFNub3dib2FyZDogTGlxdWlkIn0 |
| Connection | The Shopify connection to use. |
{
"data": {
"data": {
"fulfillments": [
{
"id": 1234567890123,
"order_id": 9876543210987,
"status": "SUCCESS",
"created_at": "2025-01-14T22:03:11Z",
"service": "MANUAL",
"updated_at": "2025-01-14T22:03:11Z",
"tracking_company": null,
"location_id": 123456789012,
"origin_address": null,
"line_items": [
{
"id": 2345678901234,
"variant_id": null,
"title": "Sample product",
"quantity": 2,
"sku": null,
"variant_title": null,
"vendor": "",
"product_id": null,
"requires_shipping": false,
"taxable": true,
"gift_card": false,
"name": "Sample product",
"price": {
"amount": "19.99",
"currencyCode": "USD"
},
"total_discount": {
"amount": "5.00",
"currencyCode": "USD"
},
"fulfillment_status": "fulfilled",
"price_set": {
"shop_money": {
"amount": "19.99",
"currency_code": "USD"
},
"presentment_money": {
"amount": "19.99",
"currency_code": "USD"
}
},
"total_discount_set": {
"shop_money": {
"amount": "5.00",
"currency_code": "USD"
},
"presentment_money": {
"amount": "5.00",
"currency_code": "USD"
}
},
"discount_allocations": [
{
"amount": "5.00",
"discount_application_index": 0,
"amount_set": {
"shop_money": {
"amount": "5.00",
"currency_code": "USD"
},
"presentment_money": {
"amount": "5.00",
"currency_code": "USD"
}
}
}
],
"duties": [],
"admin_graphql_api_id": "gid://shopify/FulfillmentLineItem/2345678901234"
}
],
"tracking_number": null,
"tracking_numbers": [],
"tracking_url": null,
"tracking_urls": [],
"name": "#9999-F1",
"admin_graphql_api_id": "gid://shopify/Fulfillment/1234567890123"
}
]
}
}
}
List Inventory Items
Lists all inventory items. | key: listInventoryItemsGql
| Input | Notes | Example |
|---|---|---|
| Page Offset Cursor | Cursor for pagination. Use the value from the previous response to retrieve the next page of results. | eyJkaXJlY3Rpb24iOiJwcmV2IiwibGFzdF9pZCI6OTAyOTk2ODAwMzM1NCwibGFzdF92YWx1ZSI6IlRoZSBDb2xsZWN0aW9uIFNub3dib2FyZDogTGlxdWlkIn0 |
| Fetch All | When true, automatically fetches all pages of results using pagination. The API is limited to 250 records per page max. | false |
| Limit | The maximum number of results to return per page. Maximum: 250. | 20 |
| Query | The query to filter the inventory items. | id:>=30322695 |
| Connection | The Shopify connection to use. |
{
"data": {
"inventoryItems": [
{
"id": "gid://shopify/InventoryItem/12345678901234",
"sku": "EXAMPLE-SKU",
"createdAt": "2022-01-01T12:00:00Z",
"updatedAt": "2024-12-01T15:30:00Z",
"requiresShipping": true,
"unitCost": {
"amount": "10.0",
"currencyCode": "USD"
},
"countryCodeOfOrigin": null,
"provinceCodeOfOrigin": null,
"harmonizedSystemCode": null,
"tracked": false,
"countryHarmonizedSystemCodes": {
"nodes": []
}
}
],
"pageInfo": {
"hasNextPage": false,
"endCursor": "YXJyYXljb25uZWN0aW9uOjA="
}
}
}
List Inventory Levels At Location
Lists all inventory levels at a specified location. | key: listInventoryLevelsGql
| Input | Notes | Example |
|---|---|---|
| Page Offset Cursor | Cursor for pagination. Use the value from the previous response to retrieve the next page of results. | eyJkaXJlY3Rpb24iOiJwcmV2IiwibGFzdF9pZCI6OTAyOTk2ODAwMzM1NCwibGFzdF92YWx1ZSI6IlRoZSBDb2xsZWN0aW9uIFNub3dib2FyZDogTGlxdWlkIn0 |
| Fetch All | When true, automatically fetches all pages of results using pagination. The API is limited to 250 records per page max. | false |
| Limit | The maximum number of results to return per page. Maximum: 250. | 20 |
| Location ID | The ID of the location that the inventory level belongs to. | 346779380 or gid://shopify/Location/346779380 |
| Connection | The Shopify connection to use. |
{
"data": {
"inventoryLevels": [
{
"id": "gid://shopify/InventoryLevel/523463154?inventory_item_id=43729076",
"item": {
"id": "gid://shopify/InventoryItem/43729076"
},
"location": {
"id": "gid://shopify/Location/346779380"
},
"quantities": [
{
"name": "available",
"quantity": 0
}
],
"updatedAt": "2024-11-07T20:59:45Z"
}
],
"pageInfo": {
"hasNextPage": false,
"endCursor": "YXJyYXljb25uZWN0aW9uOjA="
}
}
}
List Locations
Lists all locations. | key: listLocationsGql
| Input | Notes | Example |
|---|---|---|
| Page Offset Cursor | Cursor for pagination. Use the value from the previous response to retrieve the next page of results. | eyJkaXJlY3Rpb24iOiJwcmV2IiwibGFzdF9pZCI6OTAyOTk2ODAwMzM1NCwibGFzdF92YWx1ZSI6IlRoZSBDb2xsZWN0aW9uIFNub3dib2FyZDogTGlxdWlkIn0 |
| Fetch All | When true, automatically fetches all pages of results using pagination. The API is limited to 250 records per page max. | false |
| Limit | The maximum number of results to return per page. Maximum: 250. | 20 |
| Connection | The Shopify connection to use. |
{
"data": {
"locations": [
{
"id": "gid://shopify/Location/12345678901",
"name": "123 Example St Suite 100",
"address": {
"address1": "123 Example St Suite 100",
"address2": null,
"city": "Example City",
"zip": "12345",
"province": "Example State",
"country": "Example Country",
"phone": "",
"countryCode": "EX",
"provinceCode": "ES"
},
"createdAt": "2022-01-01T10:00:00Z",
"updatedAt": "2022-01-01T10:00:00Z",
"isActive": true
}
],
"pageInfo": {
"hasNextPage": false,
"endCursor": "YXJyYXljb25uZWN0aW9uOjA="
}
}
}
List Metafields
Lists resource metafields. Note: This action currently utilizes an unstable version of the Shopify Admin GraphQL API and is subject to change. | key: listMetafieldsGql
| Input | Notes | Example |
|---|---|---|
| Page Offset Cursor | Cursor for pagination. Use the value from the previous response to retrieve the next page of results. | eyJkaXJlY3Rpb24iOiJwcmV2IiwibGFzdF9pZCI6OTAyOTk2ODAwMzM1NCwibGFzdF92YWx1ZSI6IlRoZSBDb2xsZWN0aW9uIFNub3dib2FyZDogTGlxdWlkIn0 |
| Fetch All | When true, automatically fetches all pages of results using pagination. The API is limited to 250 records per page max. | false |
| Limit | The maximum number of results to return per page. Maximum: 250. | 20 |
| Resource | The unique identifier for the resource. | gid://shopify/Product/20995642 |
| Connection | The Shopify connection to use. |
{
"data": {
"metafields": [
{
"key": "myKey",
"value": "myValue",
"type": "single_line_text_field",
"namespace": "app--1234567",
"productId": "gid://shopify/Product/20995642",
"description": null,
"jsonValue": "myValue",
"createdAt": "2025-01-28T20:52:51Z",
"updatedAt": "2025-01-28T20:52:51Z"
}
],
"pageInfo": {
"hasNextPage": false,
"endCursor": "YXJyYXljb25uZWN0aW9uOjA="
}
}
}
List Orders
Lists all orders. | key: listOrdersGql
| Input | Notes | Example |
|---|---|---|
| Page Offset Cursor | Cursor for pagination. Use the value from the previous response to retrieve the next page of results. | eyJkaXJlY3Rpb24iOiJwcmV2IiwibGFzdF9pZCI6OTAyOTk2ODAwMzM1NCwibGFzdF92YWx1ZSI6IlRoZSBDb2xsZWN0aW9uIFNub3dib2FyZDogTGlxdWlkIn0 |
| Fetch All | When true, automatically fetches all pages of results using pagination. The API is limited to 250 records per page max. | false |
| Limit | The maximum number of results to return per page. Maximum: 250. | 20 |
| Query | The query to filter the orders. | updated_at:>2019-12-01 |
| Connection | The Shopify connection to use. |
{
"data": {
"orders": [
{
"id": "gid://shopify/Order/1234567890123",
"name": "#1234",
"app": {
"id": "gid://shopify/App/9876543210987"
},
"clientIp": "0.0.0.0",
"customerAcceptsMarketing": false,
"cancelReason": null,
"cancelledAt": null,
"closedAt": null,
"confirmationNumber": "ABC123XYZ",
"confirmed": true,
"createdAt": "2024-12-08T11:29:38Z",
"currencyCode": "USD",
"currentSubtotalPriceSet": {
"shopMoney": {
"amount": "50.00",
"currencyCode": "USD"
},
"presentmentMoney": {
"amount": "50.00",
"currencyCode": "USD"
}
},
"currentTotalAdditionalFeesSet": null,
"currentTotalDiscountsSet": {
"shopMoney": {
"amount": "5.00",
"currencyCode": "USD"
},
"presentmentMoney": {
"amount": "5.00",
"currencyCode": "USD"
}
},
"currentTotalDutiesSet": null,
"currentTotalPriceSet": {
"shopMoney": {
"amount": "50.00",
"currencyCode": "USD"
},
"presentmentMoney": {
"amount": "50.00",
"currencyCode": "USD"
}
},
"currentTotalTaxSet": {
"shopMoney": {
"amount": "0.00",
"currencyCode": "USD"
},
"presentmentMoney": {
"amount": "0.00",
"currencyCode": "USD"
}
},
"customerLocale": "en",
"discountCodes": [],
"dutiesIncluded": false,
"email": "example@example.com",
"estimatedTaxes": false,
"displayFinancialStatus": "PAID",
"displayFulfillmentStatus": "UNFULFILLED",
"retailLocation": null,
"merchantBusinessEntity": {
"id": "gid://shopify/BusinessEntity/1122334455667"
},
"merchantOfRecordApp": null,
"note": "Example note",
"originalTotalAdditionalFeesSet": null,
"originalTotalDutiesSet": null,
"paymentGatewayNames": [
"manual"
],
"phone": null,
"poNumber": null,
"presentmentCurrencyCode": "USD",
"processedAt": "2024-12-08T11:29:38Z",
"sourceIdentifier": "example-source-id",
"sourceName": "9876543210987",
"registeredSourceUrl": null,
"subtotalPriceSet": {
"shopMoney": {
"amount": "50.00",
"currencyCode": "USD"
},
"presentmentMoney": {
"amount": "50.00",
"currencyCode": "USD"
}
},
"tags": [],
"taxExempt": true,
"taxLines": [],
"taxesIncluded": false,
"test": false,
"totalCashRoundingAdjustment": {
"paymentSet": {
"shopMoney": {
"amount": "0.00",
"currencyCode": "USD"
},
"presentmentMoney": {
"amount": "0.00",
"currencyCode": "USD"
}
},
"refundSet": {
"shopMoney": {
"amount": "0.00",
"currencyCode": "USD"
},
"presentmentMoney": {
"amount": "0.00",
"currencyCode": "USD"
}
}
},
"totalDiscountsSet": {
"shopMoney": {
"amount": "5.00",
"currencyCode": "USD"
},
"presentmentMoney": {
"amount": "5.00",
"currencyCode": "USD"
}
},
"totalOutstandingSet": {
"shopMoney": {
"amount": "0.00",
"currencyCode": "USD"
}
},
"totalPriceSet": {
"shopMoney": {
"amount": "50.00",
"currencyCode": "USD"
},
"presentmentMoney": {
"amount": "50.00",
"currencyCode": "USD"
}
},
"totalShippingPriceSet": {
"shopMoney": {
"amount": "0.00",
"currencyCode": "USD"
},
"presentmentMoney": {
"amount": "0.00",
"currencyCode": "USD"
}
},
"totalTaxSet": {
"shopMoney": {
"amount": "0.00",
"currencyCode": "USD"
},
"presentmentMoney": {
"amount": "0.00",
"currencyCode": "USD"
}
},
"totalTipReceivedSet": {
"shopMoney": {
"amount": "0.00",
"currencyCode": "USD"
}
},
"totalWeight": "5000",
"updatedAt": "2024-12-08T11:29:39Z",
"billingAddress": {
"address1": "123 Example St",
"address2": null,
"name": "John Doe",
"lastName": "Doe",
"company": null,
"phone": null,
"zip": "12345",
"country": "United States",
"countryCodeV2": "US",
"province": "California",
"provinceCode": "CA"
},
"customer": {
"id": "gid://shopify/Customer/4567890123456",
"displayName": "John Doe",
"firstName": "John",
"lastName": "Doe",
"phone": null
},
"lineItems": {
"nodes": [
{
"id": "gid://shopify/LineItem/2345678901234",
"currentQuantity": 3,
"unfulfilledQuantity": 3,
"isGiftCard": false,
"name": "Sample Product",
"originalUnitPriceSet": {
"shopMoney": {
"amount": "16.67",
"currencyCode": "USD"
},
"presentmentMoney": {
"amount": "16.67",
"currencyCode": "USD"
}
},
"product": null,
"quantity": 3,
"requiresShipping": true,
"sku": "EX123",
"taxable": true,
"title": "Sample Product",
"totalDiscountSet": {
"shopMoney": {
"amount": "5.00",
"currencyCode": "USD"
},
"presentmentMoney": {
"amount": "5.00",
"currencyCode": "USD"
}
},
"variant": null,
"vendor": "Example Vendor",
"taxLines": [
{
"channelLiable": false,
"priceSet": {
"shopMoney": {
"amount": "0.00",
"currencyCode": "USD"
},
"presentmentMoney": {
"amount": "0.00",
"currencyCode": "USD"
}
},
"rate": 0.05,
"title": "Example Tax"
}
],
"duties": [],
"discountAllocations": [
{
"allocatedAmountSet": {
"shopMoney": {
"amount": "5.00",
"currencyCode": "USD"
},
"presentmentMoney": {
"amount": "5.00",
"currencyCode": "USD"
}
},
"discountApplication": {
"index": 0
}
}
]
}
]
},
"paymentTerms": null,
"refunds": [],
"shippingAddress": {
"firstName": "John",
"address1": "123 Example St",
"phone": null,
"city": "Example City",
"zip": "12345",
"province": "California",
"country": "United States",
"lastName": "Doe",
"address2": null,
"company": null,
"latitude": null,
"longitude": null,
"name": "John Doe",
"countryCodeV2": "US",
"provinceCode": "CA"
}
}
],
"pageInfo": {
"hasNextPage": false,
"endCursor": "YXJyYXljb25uZWN0aW9uOjA="
}
}
}
List Orders (Deprecated)
List all orders. This version of the action is being deprecated. Please replace action with List Orders. | key: listOrders
| Input | Notes | Example |
|---|---|---|
| Attribution App ID | Show orders attributed to a certain app, specified by the app ID. | current |
| IDs | Retrieve only orders specified by a comma-separated list of order IDs. | 450789469,39072856 |
| Created At Min | Show orders created at or after this date. Use ISO 8601 format (YYYY-MM-DD or YYYY-MM-DDTHH:mm:ss-HH:mm). | 2021-10-01 |
| Created At Max | Show orders created at or before date. ISO 8601 format like 2021-10-01 or 2021-10-01T00:00:00-04:00 for exact time. | 2021-10-01 |
| Fields | Retrieve only certain fields, specified by a comma-separated list of fields names. | id,currency |
| Financial Status | Filter orders by their financial status. | authorized |
| Fulfillment Status | Filter orders by their fulfillment status. | shipped |
| Get All Data | When 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 |
| Limit | The maximum number of results to return per page. Maximum: 250. | 20 |
| Status | Filter orders by their status. | open |
| Page Offset Token | Cursor for pagination. Use the value from the previous response to retrieve the next page of results. | eyJkaXJlY3Rpb24iOiJwcmV2IiwibGFzdF9pZCI6OTAyOTk2ODAwMzM1NCwibGFzdF92YWx1ZSI6IlRoZSBDb2xsZWN0aW9uIFNub3dib2FyZDogTGlxdWlkIn0 |
| Processed At Max | Show orders imported at or before date. ISO 8601 format like 2021-10-01 or 2021-10-01T00:00:00-04:00 for exact time. | 2021-10-01 |
| Processed At Min | Show orders imported at or after date. ISO 8601 format like 2021-10-01 or 2021-10-01T00:00:00-04:00 for exact time. | 2021-10-01 |
| Connection | The Shopify connection to use. | |
| Since ID | Show orders after the specified ID. | 450789469 |
| Updated At Max | Show 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. | 2021-10-01 |
| Updated At Min | Show 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. | 2021-10-01 |
{
"data": {
"data": {
"orders": [
{
"id": 12345678912345,
"admin_graphql_api_id": "gid://shopify/Order/12345678912345",
"app_id": 123456,
"browser_ip": "192.168.0.1",
"buyer_accepts_marketing": false,
"cancel_reason": null,
"cancelled_at": null,
"cart_token": null,
"checkout_id": 30873867714713,
"checkout_token": "c0a38ddd2c577019041f04b17fe53761",
"client_details": {
"accept_language": null,
"browser_height": null,
"browser_ip": "192.168.0.1",
"browser_width": null,
"session_hash": null,
"user_agent": "Mozilla/5.0 (Windows NT 10.0; Win64; x64) AppleWebKit/537.36 (KHTML, like Gecko) Chrome/122.0.0.0 Safari/537.36"
},
"closed_at": null,
"company": null,
"confirmed": true,
"contact_email": null,
"created_at": "2024-03-06T14:31:14-07:00",
"currency": "USD",
"current_subtotal_price": "0.00",
"current_subtotal_price_set": {
"shop_money": {
"amount": "0.00",
"currency_code": "USD"
},
"presentment_money": {
"amount": "0.00",
"currency_code": "USD"
}
},
"current_total_additional_fees_set": null,
"current_total_discounts": "0.00",
"current_total_discounts_set": {
"shop_money": {
"amount": "0.00",
"currency_code": "USD"
},
"presentment_money": {
"amount": "0.00",
"currency_code": "USD"
}
},
"current_total_duties_set": null,
"current_total_price": "0.00",
"current_total_price_set": {
"shop_money": {
"amount": "0.00",
"currency_code": "USD"
},
"presentment_money": {
"amount": "0.00",
"currency_code": "USD"
}
},
"current_total_tax": "0.00",
"current_total_tax_set": {
"shop_money": {
"amount": "0.00",
"currency_code": "USD"
},
"presentment_money": {
"amount": "0.00",
"currency_code": "USD"
}
},
"customer_locale": "en",
"device_id": null,
"discount_codes": [],
"email": "",
"estimated_taxes": false,
"financial_status": "paid",
"fulfillment_status": null,
"landing_site": null,
"landing_site_ref": null,
"location_id": 65947994123,
"merchant_of_record_app_id": null,
"name": "#1157",
"note": null,
"note_attributes": [],
"number": 157,
"order_number": 1157,
"order_status_url": "https://test-store.myshopify.com/60628201234/orders/abcdef12345/authenticate?key=e79e76cb7634bee51d1d70fd8fbf2840",
"original_total_additional_fees_set": null,
"original_total_duties_set": null,
"payment_gateway_names": [],
"phone": null,
"presentment_currency": "USD",
"processed_at": "2024-03-06T14:31:13-07:00",
"reference": "6b89108234e53714356e05091234567",
"referring_site": null,
"source_identifier": "6b89108234e53714356e05091234567",
"source_name": "shopify_draft_order",
"source_url": null,
"subtotal_price": "0.00",
"subtotal_price_set": {
"shop_money": {
"amount": "0.00",
"currency_code": "USD"
},
"presentment_money": {
"amount": "0.00",
"currency_code": "USD"
}
},
"tags": "",
"tax_lines": [],
"taxes_included": false,
"test": false,
"token": "abcdef12345",
"total_discounts": "0.00",
"total_discounts_set": {
"shop_money": {
"amount": "0.00",
"currency_code": "USD"
},
"presentment_money": {
"amount": "0.00",
"currency_code": "USD"
}
},
"total_line_items_price": "0.00",
"total_line_items_price_set": {
"shop_money": {
"amount": "0.00",
"currency_code": "USD"
},
"presentment_money": {
"amount": "0.00",
"currency_code": "USD"
}
},
"total_outstanding": "0.00",
"total_price": "0.00",
"total_price_set": {
"shop_money": {
"amount": "0.00",
"currency_code": "USD"
},
"presentment_money": {
"amount": "0.00",
"currency_code": "USD"
}
},
"total_shipping_price_set": {
"shop_money": {
"amount": "0.00",
"currency_code": "USD"
},
"presentment_money": {
"amount": "0.00",
"currency_code": "USD"
}
},
"total_tax": "0.00",
"total_tax_set": {
"shop_money": {
"amount": "0.00",
"currency_code": "USD"
},
"presentment_money": {
"amount": "0.00",
"currency_code": "USD"
}
},
"total_tip_received": "0.00",
"total_weight": 0,
"updated_at": "2024-03-06T14:31:15-07:00",
"user_id": 987654321,
"billing_address": null,
"customer": null,
"discount_applications": [],
"fulfillments": [],
"line_items": [
{
"id": 456789123,
"admin_graphql_api_id": "gid://shopify/LineItem/456789123",
"fulfillable_quantity": 1,
"fulfillment_service": "manual",
"fulfillment_status": null,
"gift_card": false,
"grams": 0,
"name": "Shirt - Blue / Small",
"price": "0.00",
"price_set": {
"shop_money": {
"amount": "0.00",
"currency_code": "USD"
},
"presentment_money": {
"amount": "0.00",
"currency_code": "USD"
}
},
"product_exists": true,
"product_id": 7733213712345,
"properties": [],
"quantity": 1,
"requires_shipping": true,
"sku": "",
"taxable": true,
"title": "Shirt",
"total_discount": "0.00",
"total_discount_set": {
"shop_money": {
"amount": "0.00",
"currency_code": "USD"
},
"presentment_money": {
"amount": "0.00",
"currency_code": "USD"
}
},
"variant_id": 43449939394713,
"variant_inventory_management": null,
"variant_title": "Blue / Small",
"vendor": "Acme",
"tax_lines": [],
"duties": [],
"discount_allocations": []
},
{
"id": 13397695332505,
"admin_graphql_api_id": "gid://shopify/LineItem/13397695332505",
"fulfillable_quantity": 1,
"fulfillment_service": "manual",
"fulfillment_status": null,
"gift_card": false,
"grams": 0,
"name": "Shirt - Black / Small",
"price": "0.00",
"price_set": {
"shop_money": {
"amount": "0.00",
"currency_code": "USD"
},
"presentment_money": {
"amount": "0.00",
"currency_code": "USD"
}
},
"product_exists": true,
"product_id": 7733213712345,
"properties": [],
"quantity": 1,
"requires_shipping": true,
"sku": "",
"taxable": true,
"title": "Shirt",
"total_discount": "0.00",
"total_discount_set": {
"shop_money": {
"amount": "0.00",
"currency_code": "USD"
},
"presentment_money": {
"amount": "0.00",
"currency_code": "USD"
}
},
"variant_id": 43449939427481,
"variant_inventory_management": null,
"variant_title": "Black / Small",
"vendor": "Acme",
"tax_lines": [],
"duties": [],
"discount_allocations": []
}
],
"payment_terms": null,
"refunds": [],
"shipping_address": null,
"shipping_lines": []
}
]
},
"pagination": {
"previous": {
"limit": "2",
"page_info": "eyJkaXJlY3Rpb24iOiJwcmV2IiwibGFzdF9pZCI6NTMyNjQwNDQ4NTI3MywibGFzdF92YWx1ZSI6IjIwMjQtMDMtMDYgMjE6MzE6MTQuNDMxO123456",
"rel": "previous",
"url": "https://test-store.myshopify.com/admin/api/2023-04/resource?limit=2&page_info=eyJkaXJlY3Rpb24iOiJwcmV2IiwibGFzdF9pZCI6NTMyNjQwNDQ4NTI3MywibGFzdF92YWx1ZSI6IjIwMjQtMDMtMDYgMjE6MzE6MTQuNDMxO123456"
},
"next": {
"limit": "2",
"page_info": "eyJkaXJlY3Rpb24iOiJuZXh0IiwibGFzdF9pZCI6NTMyNjQwNDMyMTQzMywibGFzdF92YWx1ZSI6IjIwMjQtMDMtMDYgMjE6MzA6NTYuOTY1NDYabcd",
"rel": "next",
"url": "https://test-store.myshopify.com/admin/api/2023-04/resource?limit=2&page_info=eyJkaXJlY3Rpb24iOiJuZXh0IiwibGFzdF9pZCI6NTMyNjQwNDMyMTQzMywibGFzdF92YWx1ZSI6IjIwMjQtMDMtMDYgMjE6MzA6NTYuOTY1NDYabcd"
}
},
"pageInfo": "eyJkaXJlY3Rpb24iOiJuZXh0IiwibGFzdF9pZCI6NTMyNjQwNDMyMTQzMywibGFzdF92YWx1ZSI6IjIwMjQtMDMtMDYgMjE6MzA6NTYuOTY1NDYabcd",
"rel": "rel=\"next\"",
"headers": {
"date": "Tue, 26 Mar 2024 23:31:56 GMT",
"content-type": "application/json; charset=utf-8",
"transfer-encoding": "chunked",
"connection": "close",
"x-sorting-hat-podid": "152",
"x-sorting-hat-shopid": "60628201234",
"vary": "Accept-Encoding, Accept",
"referrer-policy": "origin-when-cross-origin",
"x-frame-options": "DENY",
"x-shopid": "60628201234",
"x-shardid": "152",
"x-stats-userid": "",
"x-stats-apiclientid": "6511233",
"x-stats-apipermissionid": "429538012345",
"x-shopify-api-version": "2023-04",
"x-shopify-api-version-warning": "https://shopify.dev/concepts/about-apis/versioning",
"http_x_shopify_shop_api_call_limit": "1/40",
"x-shopify-shop-api-call-limit": "1/40",
"link": "<https://test-store.myshopify.com/admin/api/2023-04/resource?limit=2&page_info=eyJkaXJlY3Rpb24iOiJwcmV2IiwibGFzdF9pZCI6NTMyNjQwNDQ4NTI3MywibGFzdF92YWx1ZSI6IjIwMjQtMDMtMDYgMjE6MzE6MTQuNDMxO123456>; rel=\"previous\", <https://test-store.myshopify.com/admin/api/2023-04/resource?limit=2&page_info=eyJkaXJlY3Rpb24iOiJuZXh0IiwibGFzdF9pZCI6NTMyNjQwNDMyMTQzMywibGFzdF92YWx1ZSI6IjIwMjQtMDMtMDYgMjE6MzA6NTYuOTY1NDYabcd>; rel=\"next\"",
"strict-transport-security": "max-age=7889238",
"x-request-id": "da004e10-b646-4c9a-b340-74537e4a066b-12346",
"server-timing": "processing;dur=78, cfRequestDuration;dur=137.999773",
"x-shopify-stage": "production",
"content-security-policy": "default-src 'self' data: blob: 'unsafe-inline' 'unsafe-eval' https://* shopify-pos://*; block-all-mixed-content; child-src 'self' https://* shopify-pos://*; connect-src 'self' wss://* https://*; frame-ancestors 'none'; img-src 'self' data: blob: https:; script-src https://cdn.shopify.com https://cdn.shopifycdn.net https://checkout.shopifycs.com https://api.stripe.com https://mpsnare.iesnare.com https://appcenter.intuit.com https://www.paypal.com https://js.braintreegateway.com https://c.paypal.com https://maps.googleapis.com https://www.google-analytics.com https://v.shopify.com 'self' 'unsafe-inline' 'unsafe-eval'; upgrade-insecure-requests; report-uri /csp-report?source%5Baction%5D=index&source%5Bapp%5D=Shopify&source%5Bcontroller%5D=admin%2Forders&source%5Bsection%5D=admin_api&source%5Buuid%5D=da004e10-b646-4c9a-b340-74537e4a066b-12346",
"x-content-type-options": "nosniff",
"x-download-options": "noopen",
"x-permitted-cross-domain-policies": "none",
"x-xss-protection": "1; mode=block; report=/xss-report?source%5Baction%5D=index&source%5Bapp%5D=Shopify&source%5Bcontroller%5D=admin%2Forders&source%5Bsection%5D=admin_api&source%5Buuid%5D=da004e10-b646-4c9a-b340-74537e4a066b-12346",
"x-envoy-upstream-service-time": "81",
"x-dc": "gcp-us-central1,gcp-us-central1",
"cf-cache-status": "DYNAMIC",
"report-to": "{\"endpoints\":[{\"url\":\"https:\\/\\/a.nel.cloudflare.com\\/report\\/v4?s=uu1FyX%2B%2BP%2FEeJ6ZHU0JrkwDut31f4GbXULyxPQ8i1mdykz%2BFk%2FwIDraEoru0w7h173cXMiZLoz3pdLbFSkF0j5TnUkEXI94jinI0gmj3dMjX9LzrXPnEJ%2Bb1HqTUMc41db0xG72h%2FmGe%2F3W8OPrtdVF7\"}],\"group\":\"cf-nel\",\"max_age\":604800}",
"nel": "{\"success_fraction\":0.01,\"report_to\":\"cf-nel\",\"max_age\":604800}",
"server": "cloudflare",
"cf-ray": "86aaefe76d1710b6-ORD",
"alt-svc": "h3=\":443\"; ma=86400"
}
}
}
List Product Images
Lists all product images for the specified product. | key: listProductImages
| Input | Notes | Example |
|---|---|---|
| Product ID | The unique ID of the product. | 74020090 |
| Connection | The Shopify connection to use. |
{
"data": {
"data": {
"images": [
{
"id": 12345678901234,
"alt": "sample alt text",
"position": 0,
"product_id": 9876543210987,
"created_at": "2025-01-01T00:00:00Z",
"updated_at": "2025-01-01T00:00:01Z",
"admin_graphql_api_id": "gid://shopify/MediaImage/12345678901234",
"width": 100,
"height": 150,
"src": "https://example.com/images/sample.jpg"
}
]
}
}
}
List Products
Lists all products. | key: listProducts
| Input | Notes | Example |
|---|---|---|
| Get All Data | When 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 |
| Limit | The maximum number of results to return per page. Maximum: 250. | 20 |
| Page Offset Token | Cursor for pagination. Use the value from the previous response to retrieve the next page of results. | eyJkaXJlY3Rpb24iOiJwcmV2IiwibGFzdF9pZCI6OTAyOTk2ODAwMzM1NCwibGFzdF92YWx1ZSI6IlRoZSBDb2xsZWN0aW9uIFNub3dib2FyZDogTGlxdWlkIn0 |
| Connection | The Shopify connection to use. |
{
"data": {
"data": {
"products": [
{
"id": 632910392,
"title": "IPod Nano - 8GB",
"body_html": "<p>It's the small iPod with one very big idea: Video. Now the world's most popular music player, available in 4GB and 8GB models, lets you enjoy TV shows, movies, video podcasts, and more. The larger, brighter display means amazing picture quality. In six eye-catching colors, iPod nano is stunning all around. And with models starting at just $149, little speaks volumes.</p>",
"vendor": "Apple",
"product_type": "Cult Products",
"created_at": "2023-07-11T17:47:36-04:00",
"handle": "ipod-nano",
"updated_at": "2023-07-11T17:47:36-04:00",
"published_at": "2007-12-31T19:00:00-05:00",
"template_suffix": null,
"status": "active",
"published_scope": "web",
"tags": "Emotive, Flash Memory, MP3, Music",
"admin_graphql_api_id": "gid://shopify/Product/632910392",
"variants": [
{
"id": 808950810,
"product_id": 632910392,
"title": "Pink",
"price": "199.00",
"sku": "IPOD2008PINK",
"position": 1,
"inventory_policy": "continue",
"compare_at_price": null,
"fulfillment_service": "manual",
"inventory_management": "shopify",
"option1": "Pink",
"option2": null,
"option3": null,
"created_at": "2023-07-11T17:47:36-04:00",
"updated_at": "2023-07-11T17:47:36-04:00",
"taxable": true,
"barcode": "1234_pink",
"grams": 567,
"image_id": 562641783,
"weight": 1.25,
"weight_unit": "lb",
"inventory_item_id": 808950810,
"inventory_quantity": 10,
"old_inventory_quantity": 10,
"presentment_prices": [
{
"price": {
"amount": "199.00",
"currency_code": "USD"
},
"compare_at_price": null
}
],
"requires_shipping": true,
"admin_graphql_api_id": "gid://shopify/ProductVariant/808950810"
}
],
"options": [
{
"id": 594680422,
"product_id": 632910392,
"name": "Color",
"position": 1,
"values": [
"Pink",
"Red",
"Green",
"Black"
]
}
],
"images": [
{
"id": 850703190,
"product_id": 632910392,
"position": 1,
"created_at": "2023-07-11T17:47:36-04:00",
"updated_at": "2023-07-11T17:47:36-04:00",
"alt": null,
"width": 123,
"height": 456,
"src": "https://cdn.shopify.com/s/files/1/0005/4838/0009/products/ipod-nano.png?v=1689112056",
"variant_ids": [],
"admin_graphql_api_id": "gid://shopify/ProductImage/850703190"
}
],
"image": {
"id": 850703190,
"product_id": 632910392,
"position": 1,
"created_at": "2023-07-11T17:47:36-04:00",
"updated_at": "2023-07-11T17:47:36-04:00",
"alt": null,
"width": 123,
"height": 456,
"src": "https://cdn.shopify.com/s/files/1/0005/4838/0009/products/ipod-nano.png?v=1689112056",
"variant_ids": [],
"admin_graphql_api_id": "gid://shopify/ProductImage/850703190"
}
}
]
},
"pagination": {
"previous": {
"limit": "2",
"page_info": "eyJkaXJlY3Rpb24iOiJwcmV2IiwibGFzdF9pZCI6NTMyNjQwNDQ4NTI3MywibGFzdF92YWx1ZSI6IjIwMjQtMDMtMDYgMjE6MzE6MTQuNDMxO123456",
"rel": "previous",
"url": "https://test-store.myshopify.com/admin/api/2023-04/resource?limit=2&page_info=eyJkaXJlY3Rpb24iOiJwcmV2IiwibGFzdF9pZCI6NTMyNjQwNDQ4NTI3MywibGFzdF92YWx1ZSI6IjIwMjQtMDMtMDYgMjE6MzE6MTQuNDMxO123456"
},
"next": {
"limit": "2",
"page_info": "eyJkaXJlY3Rpb24iOiJuZXh0IiwibGFzdF9pZCI6NTMyNjQwNDMyMTQzMywibGFzdF92YWx1ZSI6IjIwMjQtMDMtMDYgMjE6MzA6NTYuOTY1NDYabcd",
"rel": "next",
"url": "https://test-store.myshopify.com/admin/api/2023-04/resource?limit=2&page_info=eyJkaXJlY3Rpb24iOiJuZXh0IiwibGFzdF9pZCI6NTMyNjQwNDMyMTQzMywibGFzdF92YWx1ZSI6IjIwMjQtMDMtMDYgMjE6MzA6NTYuOTY1NDYabcd"
}
},
"pageInfo": "eyJkaXJlY3Rpb24iOiJuZXh0IiwibGFzdF9pZCI6NTMyNjQwNDMyMTQzMywibGFzdF92YWx1ZSI6IjIwMjQtMDMtMDYgMjE6MzA6NTYuOTY1NDYabcd",
"rel": "rel=\"next\"",
"headers": {
"date": "Tue, 26 Mar 2024 23:31:56 GMT",
"content-type": "application/json; charset=utf-8",
"transfer-encoding": "chunked",
"connection": "close",
"x-sorting-hat-podid": "152",
"x-sorting-hat-shopid": "60628201234",
"vary": "Accept-Encoding, Accept",
"referrer-policy": "origin-when-cross-origin",
"x-frame-options": "DENY",
"x-shopid": "60628201234",
"x-shardid": "152",
"x-stats-userid": "",
"x-stats-apiclientid": "6511233",
"x-stats-apipermissionid": "429538012345",
"x-shopify-api-version": "2023-04",
"x-shopify-api-version-warning": "https://shopify.dev/concepts/about-apis/versioning",
"http_x_shopify_shop_api_call_limit": "1/40",
"x-shopify-shop-api-call-limit": "1/40",
"link": "<https://test-store.myshopify.com/admin/api/2023-04/resource?limit=2&page_info=eyJkaXJlY3Rpb24iOiJwcmV2IiwibGFzdF9pZCI6NTMyNjQwNDQ4NTI3MywibGFzdF92YWx1ZSI6IjIwMjQtMDMtMDYgMjE6MzE6MTQuNDMxO123456>; rel=\"previous\", <https://test-store.myshopify.com/admin/api/2023-04/resource?limit=2&page_info=eyJkaXJlY3Rpb24iOiJuZXh0IiwibGFzdF9pZCI6NTMyNjQwNDMyMTQzMywibGFzdF92YWx1ZSI6IjIwMjQtMDMtMDYgMjE6MzA6NTYuOTY1NDYabcd>; rel=\"next\"",
"strict-transport-security": "max-age=7889238",
"x-request-id": "da004e10-b646-4c9a-b340-74537e4a066b-12346",
"server-timing": "processing;dur=78, cfRequestDuration;dur=137.999773",
"x-shopify-stage": "production",
"content-security-policy": "default-src 'self' data: blob: 'unsafe-inline' 'unsafe-eval' https://* shopify-pos://*; block-all-mixed-content; child-src 'self' https://* shopify-pos://*; connect-src 'self' wss://* https://*; frame-ancestors 'none'; img-src 'self' data: blob: https:; script-src https://cdn.shopify.com https://cdn.shopifycdn.net https://checkout.shopifycs.com https://api.stripe.com https://mpsnare.iesnare.com https://appcenter.intuit.com https://www.paypal.com https://js.braintreegateway.com https://c.paypal.com https://maps.googleapis.com https://www.google-analytics.com https://v.shopify.com 'self' 'unsafe-inline' 'unsafe-eval'; upgrade-insecure-requests; report-uri /csp-report?source%5Baction%5D=index&source%5Bapp%5D=Shopify&source%5Bcontroller%5D=admin%2Forders&source%5Bsection%5D=admin_api&source%5Buuid%5D=da004e10-b646-4c9a-b340-74537e4a066b-12346",
"x-content-type-options": "nosniff",
"x-download-options": "noopen",
"x-permitted-cross-domain-policies": "none",
"x-xss-protection": "1; mode=block; report=/xss-report?source%5Baction%5D=index&source%5Bapp%5D=Shopify&source%5Bcontroller%5D=admin%2Forders&source%5Bsection%5D=admin_api&source%5Buuid%5D=da004e10-b646-4c9a-b340-74537e4a066b-12346",
"x-envoy-upstream-service-time": "81",
"x-dc": "gcp-us-central1,gcp-us-central1",
"cf-cache-status": "DYNAMIC",
"report-to": "{\"endpoints\":[{\"url\":\"https:\\/\\/a.nel.cloudflare.com\\/report\\/v4?s=uu1FyX%2B%2BP%2FEeJ6ZHU0JrkwDut31f4GbXULyxPQ8i1mdykz%2BFk%2FwIDraEoru0w7h173cXMiZLoz3pdLbFSkF0j5TnUkEXI94jinI0gmj3dMjX9LzrXPnEJ%2Bb1HqTUMc41db0xG72h%2FmGe%2F3W8OPrtdVF7\"}],\"group\":\"cf-nel\",\"max_age\":604800}",
"nel": "{\"success_fraction\":0.01,\"report_to\":\"cf-nel\",\"max_age\":604800}",
"server": "cloudflare",
"cf-ray": "86aaefe76d1710b6-ORD",
"alt-svc": "h3=\":443\"; ma=86400"
}
}
}
List Variants
Lists all variants for the specified product. | key: listVariantsGql
| Input | Notes | Example |
|---|---|---|
| Page Offset Cursor | Cursor for pagination. Use the value from the previous response to retrieve the next page of results. | eyJkaXJlY3Rpb24iOiJwcmV2IiwibGFzdF9pZCI6OTAyOTk2ODAwMzM1NCwibGFzdF92YWx1ZSI6IlRoZSBDb2xsZWN0aW9uIFNub3dib2FyZDogTGlxdWlkIn0 |
| Fetch All | When true, automatically fetches all pages of results using pagination. The API is limited to 250 records per page max. | false |
| Limit | The maximum number of results to return per page. Maximum: 250. | 20 |
| Product ID | The unique identifier for the product. | 108828309 |
| Connection | The Shopify connection to use. |
{
"data": {
"productVariants": [
{
"id": "gid://shopify/ProductVariant/30322695",
"title": "151cm"
}
],
"pageInfo": {
"hasNextPage": false,
"endCursor": "YXJyYXljb25uZWN0aW9uOjA="
}
}
}
List Webhooks
Lists all webhooks or webhooks for the current instance. | key: listWebhooks
| Input | Notes | Example |
|---|---|---|
| Connection | The Shopify connection to use. | |
| Show Only Instance Webhooks | When true, only webhooks that point to this instance are returned. | true |
{
"data": [
{
"id": 4759306,
"address": "https://apple.com",
"topic": "orders/create",
"created_at": "2024-03-14T13:44:21-04:00",
"updated_at": "2024-03-14T13:44:21-04:00",
"format": "json",
"fields": [],
"metafield_namespaces": [],
"api_version": "unstable",
"private_metafield_namespaces": []
}
]
}
Raw Request
Sends a raw GraphQL request to Shopify. | key: graphQlRawRequest
| Input | Notes | Example |
|---|---|---|
| API Version | Shopify versions its API. See Shopify API release notes for a list of available versions. | 2026-01 |
| Connection | The Shopify connection to use. | |
| Query or Mutation | GraphQL query or mutation. See Shopify's GraphQL API documentation for examples. Ex: { shop { name } } | |
| Variables | Variables to pass to the query or mutation. | key1: value1, key2: value2 |
| Variables Object | Variables 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. | key: rawRequest
| Input | Notes | Example |
|---|---|---|
| API Version | Shopify versions its API. See Shopify API release notes for a list of available versions. | 2026-01 |
| Connection | The Shopify connection to use. | |
| Data | The HTTP body payload to send to the URL. | {"exampleKey": "Example Data"} |
| Debug Request | Enabling this flag will log out the current request. | false |
| File Data | File Data to be sent as a multipart form upload. | [{key: "example.txt", value: "My File Contents"}] |
| File Data File Names | File names to apply to the file data inputs. Keys must match the file data keys above. | |
| Form Data | The Form Data to be sent as a multipart form upload. | [{"key": "Example Key", "value": new Buffer("Hello World")}] |
| Header | A list of headers to send with the request. | User-Agent: curl/7.64.1 |
| Max Retry Count | The maximum number of retries to attempt. Specify 0 for no retries. | 0 |
| Method | The HTTP method to use. | |
| Query Parameter | A 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. | |
| Response Type | The type of data you expect in the response. You can request json, text, or binary data. | json |
| Retry On All Errors | If 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 |
| Retry Delay (ms) | The delay in milliseconds between retries. This is used when 'Use Exponential Backoff' is disabled. | 0 |
| Return Headers | When true, response headers will be included in the output object. | false |
| Timeout | The maximum time that a client will await a response to its request | 2000 |
| URL | Input 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. | /users/current.json |
| Use Exponential Backoff | Specifies whether to use a pre-defined exponential backoff strategy for retries. When enabled, 'Retry Delay (ms)' is ignored. | 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. | key: setMetafieldGql
| Input | Notes | Example |
|---|---|---|
| Key | The key for the metafield. | myKey |
| Namespace | The namespace for the metafield. | global |
| Owner ID | The unique ID of the owner of the metafield. | gid://shopify/Product/20995642 |
| Connection | The Shopify connection to use. | |
| Type | Provide a type for the metafield. Required when there is no corresponding definition for the given namespace, key, and owner resource type. | single_line_text_field |
| Value | The value for the metafield. | myValue |
{
"data": {
"metafields": [
{
"key": "myKey",
"value": "myValue",
"type": "single_line_text_field",
"namespace": "app--1234567",
"productId": "gid://shopify/Product/20995642",
"description": null,
"jsonValue": "myValue",
"createdAt": "2025-01-28T20:52:51Z",
"updatedAt": "2025-01-28T20:52:51Z"
}
],
"userErrors": []
}
}
Update Customer
Updates an existing customer by ID. | key: updateCustomerGql
| Input | Notes | Example |
|---|---|---|
| Additional Fields | Additional fields that might not be covered by the standard inputs. This is a JSON object. | |
| Address List | Provide a JSON array containing address objects. | |
| Customer | The unique identifier for the customer. | 5940139491234 or gid://shopify/Customer/5940139491234 |
The email address of the customer. | someone@example.com | |
| First Name | The first name of the customer. | John |
| Last Name | The last name of the customer. | Doe |
| Metafields | Provide a JSON array containing metadata objects. | |
| Notes | A note about the customer. | This is an example note. |
| Phone | The phone number of the customer. | +18005555454 |
| Connection | The Shopify connection to use. | |
| Tags | For each list item, provide a string you would like to tag the product with. | Style |
| Tax Exempt | Determines if the customer is tax exempt. |
{
"data": {
"userErrors": [],
"customer": {
"id": "gid://shopify/Customer/8000000000000",
"email": "example@example.com",
"createdAt": "2025-01-07T09:32:23Z",
"updatedAt": "2025-01-07T09:32:23Z",
"firstName": "John",
"lastName": "Doe",
"state": "DISABLED",
"lastOrder": null,
"note": null,
"verifiedEmail": true,
"multipassIdentifier": null,
"taxExempt": false,
"tags": [],
"phone": "+18000000000",
"addresses": [
{
"id": "gid://shopify/MailingAddress/9000000000000?model_name=CustomerAddress",
"firstName": "Jane",
"lastName": "Smith",
"company": "Example Corp",
"address1": "456 Oak Avenue",
"address2": "Suite 12",
"city": "Metropolis",
"province": "California",
"country": "United States",
"zip": "90210",
"phone": "555-000-0000",
"name": "Jane Smith",
"provinceCode": "CA",
"countryCodeV2": "US"
}
],
"taxExemptions": [],
"emailMarketingConsent": {
"marketingState": "NOT_SUBSCRIBED",
"marketingOptInLevel": "SINGLE_OPT_IN",
"consentUpdatedAt": null
},
"smsMarketingConsent": {
"marketingState": "NOT_SUBSCRIBED",
"marketingOptInLevel": "SINGLE_OPT_IN",
"consentUpdatedAt": null,
"consentCollectedFrom": "OTHER"
},
"defaultAddress": {
"id": "gid://shopify/MailingAddress/9000000000000?model_name=CustomerAddress",
"firstName": "Jane",
"lastName": "Smith",
"company": "Example Corp",
"address1": "456 Oak Avenue",
"address2": "Suite 12",
"city": "Metropolis",
"province": "California",
"country": "United States",
"zip": "90210",
"phone": "555-000-0000",
"name": "Jane Smith",
"provinceCode": "CA",
"countryCodeV2": "US"
}
}
}
}
Update Fulfillment Service
Updates an existing fulfillment service. | key: updateFulfillmentServiceGql
| Input | Notes | Example |
|---|---|---|
| Callback URL | The callback URL that the fulfillment service has registered for request. | https://example.com |
| Fulfillment Service ID | The unique identifier for the fulfillment service. | gid://shopify/FulfillmentService/18961920?id=true |
| Fulfillment Service Name | The name of the fulfillment service. | MyFulfillmentService |
| Inventory Management | Whether the fulfillment services tracks product inventory and provides updates to Shopify. | |
| Connection | The Shopify connection to use. | |
| Tracking Support | Whether the fulfillment service supports tracking numbers for packages. |
{
"data": {
"fulfillmentService": {
"id": "gid://shopify/FulfillmentService/1234567890?id=true",
"serviceName": "ExampleFulfillmentService",
"handle": "examplefulfillmentservice",
"location": {
"id": "gid://shopify/Location/0987654321"
},
"callbackUrl": "https://example.com/",
"trackingSupport": false,
"inventoryManagement": false,
"permitsSkuSharing": false
},
"userErrors": []
}
}
Update Inventory Item
Updates an existing inventory item. | key: updateInventoryItemsGql
| Input | Notes | Example |
|---|---|---|
| Cost | Unit cost associated with the inventory item, the currency is the shop's default currency. | 1.00 |
| Inventory Item Id | The unique identifier for the inventory item. | gid://shopify/InventoryItem/43933612241234 |
| Connection | The Shopify connection to use. | |
| SKU | The SKU (stock keeping unit) of the inventory item. | 97802837847 |
| Tracked | Whether the inventory item is tracked. |
{
"data": {
"inventoryItem": {
"id": "gid://shopify/InventoryItem/12345678901234",
"sku": "EXAMPLE-SKU",
"createdAt": "2022-01-01T12:00:00Z",
"updatedAt": "2024-12-01T15:30:00Z",
"requiresShipping": true,
"unitCost": {
"amount": "10.0",
"currencyCode": "USD"
},
"countryCodeOfOrigin": null,
"provinceCodeOfOrigin": null,
"harmonizedSystemCode": null,
"tracked": false,
"countryHarmonizedSystemCodes": {
"nodes": []
}
},
"userErrors": []
}
}
Update Product
Updates an existing product by ID. | key: updateProductGql
| Input | Notes | Example |
|---|---|---|
| Additional Fields | Additional fields that might not be covered by the standard inputs. This is a JSON object. | |
| Description HTML | Provide an HTML string for the description of the product. | <p>This is an example product.</p> |
| Image Alt Text | Provide the alt text for the image of the product. | Alt text |
| Image URL | Provide a URL for the image of the product. | https://example.com/image.jpg |
| Product ID | The unique identifier for the product. | 108828309 or gid://shopify/Product/108828309 |
| Product Status | Specify the status of the product. | |
| Product Type | Provide a value for the type of product. | T-shirt |
| Connection | The Shopify connection to use. | |
| Tags | For each list item, provide a string you would like to tag the product with. | Style |
| Title | Provide a string value for the title of the product. | Example Product |
| Vendor | Provide a value for the vendor of the product. | Burton inc. |
{
"data": {
"product": {
"id": "gid://shopify/Product/912855135",
"title": "Helmet Nova",
"media": {
"nodes": [
{
"alt": "Gray helmet for bikers",
"mediaContentType": "IMAGE",
"preview": {
"status": "UPLOADED"
}
}
]
}
},
"userErrors": []
}
}
Update Variant
Updates an existing product variant by ID. | key: updateVariantGql
| Input | Notes | Example |
|---|---|---|
| Product ID | The unique identifier for the product. | 108828309 or gid://shopify/Product/108828309 |
| Connection | The Shopify connection to use. | |
| Update Variant | Provide a JSON object containing the variant data to update. |
{
"data": {
"product": {
"id": "gid://shopify/Product/20995642"
},
"productVariants": null,
"userErrors": [
{
"field": [
"variants",
"0",
"id"
],
"message": "Product variant does not exist"
}
]
}
}
Changelog
2026-03-31
Various modernizations and documentation updates
2026-03-05
Added inline data sources for draft orders, collections, and fulfillment services to enable dynamic dropdown selection
2026-02-26
Added inline data sources for variants, product images, and inventory items to enhance data selection capabilities
2026-01-27
Added New and Updated Customers, New and Updated Orders, and New and Updated Products polling triggers.
2025-10-17
Enhanced webhook lifecycle management with improved event topic webhook handling and automated cleanup
2025-05-05
Added inline datasources and global debug to all actions for improved integration capabilities