Shopify to Smile.io Integration | MESA
Connect Shopify to Smile.io and automate your tasks
Describe to build
Activity reports
Fully supported
MESA's Shopify to Smile.io integration is the fastest way to sync data between the two — without touching a line of code. Choose which fields to send, how they're formatted, and when the sync happens. Start with a pre-built template, customize it with AI, or build something completely unique in under 10 minutes.
★★★★★ 4.9 rating on Shopify App Store
Start when...
Personalize with built-in tools...
Then, do this...
Trusted by 1,000+ Shopify merchants
Why integrate Shopify with Smile.io
The Shopify to Smile.io integration helps you sync data, automate manual tasks, and keep your stack aligned — without writing code.
Keep customer segments current automatically
As customers shop, MESA updates their tags, fields, and records in real time. Your email lists, loyalty tiers, and CRM stay accurate without anyone touching them manually.
Never miss a low-stock moment again
MESA monitors inventory levels across your catalog and triggers alerts or reorder actions the moment stock drops. Your team knows before customers ever see "sold out."
Connect Shopify data to your business stack
Orders, customers, and products flow automatically to the tools your team already uses — spreadsheets, CRMs, ERPs, and more. Every system stays in sync without manual exports.
Keep loyalty data in sync with your marketing tools
When a customer earns or redeems points in Smile.io, MESA updates their record across your stack — email platform, CRM, Shopify tags. Every tool reflects where each customer stands in your program.
Enroll customers in your loyalty program automatically
When a customer meets a condition in Shopify — first purchase, spend threshold, product type — MESA adds them to Smile.io without any manual steps. Your program grows as your store does.
Trigger rewards at the moments that matter most
When a customer hits a milestone — a birthday, a VIP tier, a win-back window — MESA triggers the right Smile.io action and can notify them through your preferred channel. No manual monitoring required.
Build any Shopify and Smile.io automation
MESA helps you connect apps to automate repetitive tasks. A trigger is an event that starts a workflow, and actions are the steps that occur when it's running.
Abandoned Checkout Created
Starts when an abandoned checkout is created.
Abandoned Checkout URL
Billing Address
Completed At
Created At
Custom Attributes
Customer
Default Cursor
Discount Codes
ID
Name
Note
Shipping Address
Subtotal Price Set
Tax Lines
Taxes Included
Total Discount Set
Total Duties Set
Total Line Items Price Set
Total Price Set
Total Tax Set
Updated At
Collection Created
Starts when a collection is created.
ID
Handle
Title
Body HTML
Published At
Sort Order
Template Suffix
Published Scope
Admin Graphql Api ID
Collection Deleted
Starts when a collection is removed.
- ID
Collection Listing Added
Starts when a collection listing is created.
Collection Listing Removed
Starts when a checkout listing is deleted.
Collection Listing Updated
Starts when a collection listing is updated.
Collection Updated
Starts when a collection is updated.
Body HTML
Handle
Image
ID
Published
Published At
Published Scope
Sort Order
Template Suffix
Title
Updated At
Customer Created
Starts when a customer is created.
Address 1
Address 2
City
Company
Country
Country Code
Country Name
Default
First Name
ID
Last Name
Name
Phone
Province
Province Code
Zip
Customer Deleted
Starts when a customer is removed.
- ID
Customer Disabled
Starts when a customer account is deactivated.
Address 1
Address 2
City
Company
Country
Country Code
Country Name
Default
First Name
ID
Last Name
Name
Phone
Province
Province Code
Zip
Customer Email Marketing Consent Updated
Starts when a customer's email marketing consent is updated.
Customer ID
Email Address
Email Marketing Consent
Customer Enabled
Starts when a customer account is activated.
Address 1
Address 2
City
Company
Country
Country Code
Country Name
Default
First Name
ID
Last Name
Name
Phone
Province
Province Code
Zip
Customer Group Created
Starts when a collection group is created.
ID
Admin Graphql Api ID
Name
Query
Created At
Updated At
Customer Group Deleted
Starts when a collection group is removed.
- ID
Customer Group Updated
Starts when a collection group is updated.
ID
Admin Graphql Api ID
Name
Query
Created At
Updated At
Customer Marketing Consent Updated
Starts when a customer's SMS marketing consent is updated.
ID
Phone
Sms Marketing Consent
Customer Tags Added
Starts when a customer tag is added.
Customer ID
Tags
Occurred At
Customer Tags Removed
Starts when a customer tag is removed.
Customer ID
Tags
Occurred At
Customer Updated
Starts when a customer is updated.
Address 1
Address 2
City
Company
Country
Country Code
Country Name
Default
First Name
ID
Last Name
Name
Phone
Province
Province Code
Zip
Customers Merged
Starts when multiple customers are merged.
Resulting Customer ID
Merged Customer Ids
Merged At
Discount Created
Starts when a discount is created.
Admin Graphql Api ID
Title
Status
Created At
Discount Deleted
Starts when a discount is deleted.
- Admin Graphql Api ID
Discount Updated
Starts when a discount is updated.
Admin Graphql Api ID
Title
Status
Created At
Dispute Created
Starts when a dispute is created.
ID
Order ID
Type
Amount
Currency
Reason
Network Reason Code
Status
Evidence Due By
Evidence Sent On
Finalized On
Initiated At
Dispute Updated
Starts when a dispute is updated.
ID
Order ID
Type
Amount
Currency
Reason
Network Reason Code
Status
Evidence Due By
Evidence Sent On
Finalized On
Initiated At
Draft Order Created
Starts when a draft order is created.
ID
Note
Email
Taxes Included
Currency
Invoice Sent At
Created At
Tax Exempt
Completed At
Name
Allow Discount Codes In Checkout?
B2b?
Status
Line Items
Api Client ID
Shipping Address
Billing Address
Invoice URL
Created On Api Version Handle
Applied Discount
Order ID
Shipping Line
Payment Terms
Note Attributes
Customer
Tags
Tax Lines
Subtotal Price
Total Tax
Total Price
Admin Graphql Api ID
Draft Order Deleted
Starts when a draft order is removed.
- ID
Draft Order Updated
Starts when a draft order is updated.
ID
Order ID
Name
Customer
Shipping Address
Billing Address
Note
Note Attributes
Email
Currency
Invoice Sent At
Invoice URL
Line Items
Payment Terms
Shipping Line
Tags
Tax Exempt
Tax Exemptions
Tax Lines
Applied Discount
Taxes Included
Total Tax
Subtotal Price
Total Price
Completed At
Created At
Updated At
Status
Fulfillment Cancellation Request Accepted
Starts when a 3PL accepts a fulfillment cancellation request.
ID
Status
Fulfillment Cancellation Request Rejected
Starts when a 3PL rejects a fulfillment cancellation request.
ID
Status
Request Status
Fulfillment Cancellation Request Submitted
Starts when a merchant requests a fulfillment request to be cancelled after that request was approved by a 3PL.
ID
Status
Request Status
Fulfillment Cancelled
Starts when a fulfillment is cancelled.
ID
Status
Fulfillment Created
Starts when a fulfillment is created.
ID
Order ID
Name
Status
Tracking Company
Tracking Number
Tracking URL
Shipment Status
Location ID
Notify Customer
Line Items
Fulfillment Event Created
Starts when a fulfillment event is created.
ID
Fulfillment ID
Status
Message
Happened At
Estimated Delivery At
City
Province
Country
Zip
Address 1
Latitude
Longitude
Shop ID
Order ID
Created At
Updated At
Admin Graphql Api ID
Fulfillment Event Deleted
Starts when a fulfillment event is removed.
- ID
Fulfillment Hold Released
Starts when a fulfillment hold is released.
ID
Status
Fulfillment Moved
Starts whenever the location which is assigned to fulfill one or more fulfillment line items is changed.
ID
Status
Assigned Location ID
Fulfillment Order Routing Completed
Starts when an order has finished being routed and its fulfillments are assigned to a fulfillment service's location.
ID
Status
Fulfillment Placed on Hold
Starts when a fulfillment is placed on hold.
ID
Status
Fulfillment Holds
Fulfillment Request Accepted
Starts when a fulfillment service accepts a request to fulfill a fulfillment.
ID
Status
Request Status
Fulfillment Request Rejected
Starts when a 3PL rejects a fulfillment request that was sent by a merchant.
ID
Status
Request Status
Fulfillment Request Submitted
Starts when a merchant submits a fulfillment request to a 3PL.
ID
Status
Request Status
Fulfillment Rescheduled
Starts when a fulfillment is rescheduled.
ID
Status
Fulfill At
Fulfillment Service Failed to Complete Fulfillment
Starts when a fulfillment service intends to close an in progress fulfillment.
ID
Status
Fulfillment Split
Starts when a fulfillment is split into multiple fulfillments.
ID
Quantity
Fulfillment Updated
Starts when a fulfillment is updated.
ID
Order ID
Name
Status
Tracking Company
Tracking Number
Tracking URL
Shipment Status
Location ID
Notify Customer
Line Items
Fulfillment's Line Items Prepared for Local Delivery
Starts when a fulfillment's line items are prepared for local delivery.
ID
Status
Preparable
Delivery Method
Fulfillment's Line Items Prepared for Pickup
Starts when a fulfillment's line items are prepared for pickup.
ID
Status
Preparable
Delivery Method
Fulfillments Merged
Starts when multiple fulfillment are merged into a single fulfillment.
Fulfillment Order ID
Fulfillment Order Line Items
Inventory Item Created
Starts when an inventory item is created.
Cost
Country Code Of Origin
Country Harmonized System Codes
Created At
Harmonized System Code
ID
Province Code Of Origin
Sku
Tracked
Updated At
Requires Shipping
Inventory Item Deleted
Starts when an inventory item is removed.
- ID
Inventory Item Updated
Starts when an inventory item is updated.
Cost
Country Code Of Origin
Country Harmonized System Codes
Created At
Harmonized System Code
ID
Province Code Of Origin
Sku
Tracked
Updated At
Requires Shipping
Inventory Level Connected
Starts when an inventory level is synced.
Available
Inventory Item ID
Location ID
Updated At
Variant
Inventory Level Disconnected
Starts when an inventory item is desynced.
Available
Inventory Item ID
Location ID
Updated At
Variant
Inventory Level Updated
Starts when an inventory level is updated.
Available
Inventory Item ID
Location ID
Updated At
Variant
Locale Created
Starts when a locale is created.
Locale
Name
Primary
Published
Locale Updated
Starts when a locale is updated.
Locale
Name
Primary
Published
Location Created
Starts when a location is created.
Active
Address 1
Address 2
City
Country
Country Code
Country Name
Localized Country Name
Localized Province Name
Created At
ID
Admin Graphql Api ID
Legacy
Name
Phone
Province
Province Code
Updated At
Zip
Location Deleted
Starts when a location is removed.
- ID
Location Updated
Starts when a location is updated.
Active
Address 1
Address 2
City
Country
Country Code
Country Name
Localized Country Name
Localized Province Name
Created At
ID
Admin Graphql Api ID
Legacy
Name
Phone
Province
Province Code
Updated At
Zip
Metaobject Entry Created
Starts when a metaobject entry is created.
ID
Type
Handle
Display Name
Definition ID
Capabilities
Created At
Updated At
Created By App ID
Created By Staff ID
Fields
Metaobject Entry Deleted
Starts when a metaobject entry is deleted.
ID
Type
Handle
Display Name
Definition ID
Capabilities
Created At
Updated At
Created By App ID
Created By Staff ID
Fields
Metaobject Entry Updated
Starts when a metaobject entry is updated.
ID
Type
Handle
Display Name
Definition ID
Capabilities
Created At
Updated At
Created By App ID
Created By Staff ID
Fields
Order Canceled
Starts when an order is canceled.
App ID
Billing Address
Browser Ip
Buyer Accepts Marketing
Cancel Reason
Cancelled At
Client Details
Closed At
Company
Confirmation Number
Created At
Currency
Current Total Additional Fees Set
Current Total Discounts
Current Total Discounts Set
Current Total Duties Set
Current Total Price
Current Total Price Set
Current Subtotal Price
Current Subtotal Price Set
Current Total Tax
Current Total Tax Set
Customer
Customer Locale
Discount Applications
Discount Codes
Email
Estimated Taxes
Financial Status
Fulfillments
Fulfillment Status
ID
Inventory Behaviour
Landing Site
Line Items
Merchant Of Record App ID
Name
Note
Note Attributes
Number
Order Number
Original Total Additional Fees Set
Original Total Duties Set
Payment Terms
Payment Gateway Names
Phone
Po Number
Presentment Currency
Processed At
Referring Site
Refunds
Shipping Address
Shipping Lines
Source Name
Source Identifier
Source URL
Subtotal Price
Subtotal Price Set
Tags
Tax Lines
Taxes Included
Test
Total Discounts
Total Discounts Set
Total Line Items Price
Total Line Items Price Set
Total Outstanding
Total Price
Total Price Set
Total Shipping Price Set
Total Tax
Total Tax Set
Total Tip Received
Total Weight
Updated At
User ID
Order Status URL
Order Created
Starts when an order is created.
App ID
Billing Address
Browser Ip
Buyer Accepts Marketing
Cancel Reason
Cancelled At
Client Details
Closed At
Company
Confirmation Number
Created At
Currency
Current Total Additional Fees Set
Current Total Discounts
Current Total Discounts Set
Current Total Duties Set
Current Total Price
Current Total Price Set
Current Subtotal Price
Current Subtotal Price Set
Current Total Tax
Current Total Tax Set
Customer
Customer Locale
Discount Applications
Discount Codes
Email
Estimated Taxes
Financial Status
Fulfillments
Fulfillment Status
ID
Inventory Behaviour
Landing Site
Line Items
Merchant Of Record App ID
Name
Note
Note Attributes
Number
Order Number
Original Total Additional Fees Set
Original Total Duties Set
Payment Terms
Payment Gateway Names
Phone
Po Number
Presentment Currency
Processed At
Referring Site
Refunds
Shipping Address
Shipping Lines
Source Name
Source Identifier
Source URL
Subtotal Price
Subtotal Price Set
Tags
Tax Lines
Taxes Included
Test
Total Discounts
Total Discounts Set
Total Line Items Price
Total Line Items Price Set
Total Outstanding
Total Price
Total Price Set
Total Shipping Price Set
Total Tax
Total Tax Set
Total Tip Received
Total Weight
Updated At
User ID
Order Status URL
Order Deleted
Starts when an order is removed.
- ID
Order Edited
Starts when an order is edited.
ID
Order ID
Committed At
Created At
App ID
User ID
Line Items
Discounts
Shipping Lines
Notify Customer
Staff Note
Order Fulfilled
Starts when an order is prepared for shipment.
App ID
Billing Address
Browser Ip
Buyer Accepts Marketing
Cancel Reason
Cancelled At
Client Details
Closed At
Company
Confirmation Number
Created At
Currency
Current Total Additional Fees Set
Current Total Discounts
Current Total Discounts Set
Current Total Duties Set
Current Total Price
Current Total Price Set
Current Subtotal Price
Current Subtotal Price Set
Current Total Tax
Current Total Tax Set
Customer
Customer Locale
Discount Applications
Discount Codes
Email
Estimated Taxes
Financial Status
Fulfillments
Fulfillment Status
ID
Inventory Behaviour
Landing Site
Line Items
Merchant Of Record App ID
Name
Note
Note Attributes
Number
Order Number
Original Total Additional Fees Set
Original Total Duties Set
Payment Terms
Payment Gateway Names
Phone
Po Number
Presentment Currency
Processed At
Referring Site
Refunds
Shipping Address
Shipping Lines
Source Name
Source Identifier
Source URL
Subtotal Price
Subtotal Price Set
Tags
Tax Lines
Taxes Included
Test
Total Discounts
Total Discounts Set
Total Line Items Price
Total Line Items Price Set
Total Outstanding
Total Price
Total Price Set
Total Shipping Price Set
Total Tax
Total Tax Set
Total Tip Received
Total Weight
Updated At
User ID
Order Status URL
Order Paid
Starts when an order is processed.
App ID
Billing Address
Browser Ip
Buyer Accepts Marketing
Cancel Reason
Cancelled At
Client Details
Closed At
Company
Confirmation Number
Created At
Currency
Current Total Additional Fees Set
Current Total Discounts
Current Total Discounts Set
Current Total Duties Set
Current Total Price
Current Total Price Set
Current Subtotal Price
Current Subtotal Price Set
Current Total Tax
Current Total Tax Set
Customer
Customer Locale
Discount Applications
Discount Codes
Email
Estimated Taxes
Financial Status
Fulfillments
Fulfillment Status
ID
Inventory Behaviour
Landing Site
Line Items
Merchant Of Record App ID
Name
Note
Note Attributes
Number
Order Number
Original Total Additional Fees Set
Original Total Duties Set
Payment Terms
Payment Gateway Names
Phone
Po Number
Presentment Currency
Processed At
Referring Site
Refunds
Shipping Address
Shipping Lines
Source Name
Source Identifier
Source URL
Subtotal Price
Subtotal Price Set
Tags
Tax Lines
Taxes Included
Test
Total Discounts
Total Discounts Set
Total Line Items Price
Total Line Items Price Set
Total Outstanding
Total Price
Total Price Set
Total Shipping Price Set
Total Tax
Total Tax Set
Total Tip Received
Total Weight
Updated At
User ID
Order Status URL
Order Partially Fulfilled
Starts when a new partial order fulfillment is created.
App ID
Billing Address
Browser Ip
Buyer Accepts Marketing
Cancel Reason
Cancelled At
Client Details
Closed At
Company
Confirmation Number
Created At
Currency
Current Total Additional Fees Set
Current Total Discounts
Current Total Discounts Set
Current Total Duties Set
Current Total Price
Current Total Price Set
Current Subtotal Price
Current Subtotal Price Set
Current Total Tax
Current Total Tax Set
Customer
Customer Locale
Discount Applications
Discount Codes
Email
Estimated Taxes
Financial Status
Fulfillments
Fulfillment Status
ID
Inventory Behaviour
Landing Site
Line Items
Merchant Of Record App ID
Name
Note
Note Attributes
Number
Order Number
Original Total Additional Fees Set
Original Total Duties Set
Payment Terms
Payment Gateway Names
Phone
Po Number
Presentment Currency
Processed At
Referring Site
Refunds
Shipping Address
Shipping Lines
Source Name
Source Identifier
Source URL
Subtotal Price
Subtotal Price Set
Tags
Tax Lines
Taxes Included
Test
Total Discounts
Total Discounts Set
Total Line Items Price
Total Line Items Price Set
Total Outstanding
Total Price
Total Price Set
Total Shipping Price Set
Total Tax
Total Tax Set
Total Tip Received
Total Weight
Updated At
User ID
Order Status URL
Order Transaction Created
Starts when an order transaction is created.
Amount
Authorization
Authorization Expires At
Created At
Currency
Device ID
Error Code
Extended Authorization Attributes
Gateway
ID
Kind
Location ID
Message
Order ID
Payment Details
Parent ID
Payments Refund Attributes
Processed At
Receipt
Source Name
Status
Total Unsettled Set
Test
User ID
Currency Exchange Adjustment
Order Updated
Starts when an order is updated.
App ID
Billing Address
Browser Ip
Buyer Accepts Marketing
Cancel Reason
Cancelled At
Client Details
Closed At
Company
Confirmation Number
Created At
Currency
Current Total Additional Fees Set
Current Total Discounts
Current Total Discounts Set
Current Total Duties Set
Current Total Price
Current Total Price Set
Current Subtotal Price
Current Subtotal Price Set
Current Total Tax
Current Total Tax Set
Customer
Customer Locale
Discount Applications
Discount Codes
Email
Estimated Taxes
Financial Status
Fulfillments
Fulfillment Status
ID
Inventory Behaviour
Landing Site
Line Items
Merchant Of Record App ID
Name
Note
Note Attributes
Number
Order Number
Original Total Additional Fees Set
Original Total Duties Set
Payment Terms
Payment Gateway Names
Phone
Po Number
Presentment Currency
Processed At
Referring Site
Refunds
Shipping Address
Shipping Lines
Source Name
Source Identifier
Source URL
Subtotal Price
Subtotal Price Set
Tags
Tax Lines
Taxes Included
Test
Total Discounts
Total Discounts Set
Total Line Items Price
Total Line Items Price Set
Total Outstanding
Total Price
Total Price Set
Total Shipping Price Set
Total Tax
Total Tax Set
Total Tip Received
Total Weight
Updated At
User ID
Order Status URL
Product Created
Starts when a product is created.
Body HTML
Created At
Handle
ID
Images
Image
Published Scope
Admin Graphql Api ID
Has Variants That Requires Components
Category
Variant Gids
Media
Options
Product Type
Published At
Status
Tags
Template Suffix
Title
Updated At
Variants
Vendor
Product Deleted
Starts when a product is removed.
- ID
Product Updated
Starts when a product is updated.
Body HTML
Created At
Handle
ID
Images
Image
Published Scope
Admin Graphql Api ID
Has Variants That Requires Components
Category
Variant Gids
Media
Options
Product Type
Published At
Status
Tags
Template Suffix
Title
Updated At
Variants
Vendor
Refund Created
Starts when a refund is created.
Created At
Duties
ID
Order ID
Note
Order Adjustments
Processed At
Refund Duties
Refund Line Items
Transactions
User ID
Currency
Notify
Shipping
Return Approved
Starts when a return is approved.
ID
Admin Graphql Api ID
Status
Name
Order
Total Return Line Items
Return Line Items
Return Shipping Fees
Exchange Line Items
Total Exchange Line Items
Return Cancelled
Starts when a return is cancelled.
ID
Admin Graphql Api ID
Order ID
Status
Return Closed
Starts when a return is closed.
ID
Admin Graphql Api ID
Order ID
Status
Return Declined
Starts when a return is declined.
ID
Admin Graphql Api ID
Status
Order
Decline
Return Processed
Starts when a return is processed.
ID
Admin Graphql Api ID
Order ID
Status
Return Reopened
Starts when a return is reopened.
ID
Admin Graphql Api ID
Order ID
Status
Return Requested
Starts when a return is requested.
ID
Admin Graphql Api ID
Status
Order
Total Return Line Items
Name
Return Line Items
Return Shipping Fees
Exchange Line Items
Total Exchange Line Items
Return Updated
Starts when a return is updated.
Admin Graphql Api ID
Return Line Items
Restocking Fees
Return Shipping Fees
Reverse Delivery Deliverable Attached
Starts when a reverse delivery deliverable is attached.
ID
Admin Graphql Api ID
Return
Shipping Deliverable
Reverse Fulfillment Disposed
Starts when a reverse fulfillment order is disposed.
ID
Admin Graphql Api ID
Dispositions
Total Dispositions
Scheduled Fulfillment Ready
Starts when a scheduled fulfillment order is ready.
ID
Status
Shop Updated
Starts when a shop is updated.
ID
Name
Email
Domain
Province
Country
Address 1
Zip
City
Source
Phone
Latitude
Longitude
Primary Locale
Address 2
Created At
Updated At
Country Code
Country Name
Currency
Customer Email
Timezone
Iana Timezone
Shop Owner
Money Format
Money With Currency Format
Weight Unit
Province Code
Taxes Included
Tax Shipping
County Taxes
Plan Display Name
Plan Name
Has Discounts
Has Gift Cards
Myshopify Domain
Google Apps Domain
Google Apps Login Enabled
Money In Emails Format
Money With Currency In Emails Format
Eligible For Payments
Requires Extra Payments Agreement
Password Enabled
Has Storefront
Eligible For Card Reader Giveaway
Finances
Primary Location ID
Cookie Consent Level
Visitor Tracking Consent Preference
Force Ssl
Checkout Api Supported
Multi Location Enabled
Setup Required
Pre Launch Enabled
Enabled Presentment Currencies
Theme Created
Starts when a theme is created.
ID
Admin Graphql Api ID
Name
Role
Theme Store ID
Previewable
Processing
Created At
Updated At
Theme Deleted
Starts when a theme is removed.
- ID
Theme Published
Starts when a theme is published.
ID
Admin Graphql Api ID
Name
Role
Theme Store ID
Previewable
Processing
Created At
Updated At
Theme Updated
Starts when a theme is updated.
ID
Admin Graphql Api ID
Name
Role
Theme Store ID
Previewable
Processing
Created At
Updated At
Variant In Stock
Starts when a variant becomes in stock.
ID
Product ID
Title
Sku
Price
Compare At Price
Position
Option1
Option2
Option3
Inventory Quantity
Old Inventory Quantity
Inventory Policy
Taxable
Barcode
Image ID
Created At
Updated At
Admin Graphql Api ID
Variant Out of Stock
Starts when a variant becomes out of stock.
ID
Product ID
Title
Sku
Price
Compare At Price
Position
Option1
Option2
Option3
Inventory Quantity
Old Inventory Quantity
Inventory Policy
Taxable
Barcode
Image ID
Created At
Updated At
Admin Graphql Api ID
Create Activity
Create an activity.
- Activity
Create Points Transaction
Add or remove points from a customer’s points balance by creating a points transaction.
Get List of Customers
Obtain a list of customers.
ID
First Name
Last Name
Email
Date Of Birth
Points Balance
Referral URL
Vip Tier ID
State
Created At
Updated At
Retrieve Customer
Grab all details about a customer.
ID
First Name
Last Name
Email
Date Of Birth
Points Balance
Referral URL
Vip Tier ID
State
Created At
Updated At
Add Customer Tags
Add tags to a customer.
ID
Display Name
Tags
Add Draft Order Tags
Add tags to a draft order.
ID
Name
Tags
Add Funds to Gift Card
Add a funds to gift card.
Amount
Currency Code
Add Line Item to Draft Order
Add a line item to a draft order.
Draft Order ID
Line Item ID
Add Line Item to Order
Add a line item to an order.
Order ID
Line Item
Add Order Tags
Add tags to an order.
ID
Name
Tags
Add Product Tags
Add tags to a product.
ID
Title
Tags
Add Product to Collection
Add a product to collection.
ID
Title
Handle
Description
Sort Order
Updated At
Products Count
Image
Seo
Rule Set
Add Store Credit to Customer
Add a store credit to customer.
ID
Amount
Balance After Transaction
Created At
Expires At
Account
Add Store Credit to Customer Company Location
Add store credit to a customer company location.
Amount
Currency Code
Account Gid
Account Balance
Account Balance Currency
Adds Product to Custom Collection
Add a product to a custom collection.
Collection ID
Created At
ID
Position
Product ID
Sort Value
Updated At
Adjust Inventory Level
Adjust a product variant's inventory level at a single location.
Location
Inventory Item ID
Available Adjustment
Adjust Inventory Level by Variant
Adjust an inventory level by variant.
ID
Reason
Changes
Adjust Inventory Quantities
Adjust an inventory quantities.
Created At
ID
Reason
Reference Document Uri
Approve Blog Article Comment
Approve a blog article comment.
Author
Blog
Body
Created At
Default Cursor
Handle
ID
Image
Is Published
Published At
Summary
Tags
Template Suffix
Title
Updated At
Approve Comment
Approve a comment.
Approve Return Request
Approve a return request.
Closed At
Created At
Decline
ID
Name
Order
Request Approved At
Return Shipping Fees
Status
Total Quantity
Calculate Order Refund
Sum up refunded transactions based on shipping and line items.
Created At
Duties
ID
Order ID
Note
Order Adjustments
Processed At
Refund Duties
Refund Line Items
Transactions
User ID
Currency
Notify
Shipping
Calculate Order Refund
Calculate a suggested order refund.
ID
Name
Suggested Refund
Calculate Return
Calculate a return.
ID
Return Line Items
Exchange Line Items
Return Shipping Fee
Cancel Fulfillment
Cancel a fulfillment.
ID
Order ID
Name
Status
Tracking Company
Tracking Number
Tracking URL
Shipment Status
Location ID
Notify Customer
Line Items
Cancel Fulfillment
Cancel a fulfillment.
ID
Name
Status
Display Status
Total Quantity
Created At
Updated At
Location
Order
Tracking Info
Cancel Fulfillment Order
Cancel a fulfillment order.
Assigned Location ID
Destination
Delivery Method
Fulfill At
Fulfill By
Fulfillment Holds
ID
International Duties
Line Items
Order ID
Request Status
Shop ID
Status
Supported Actions
Merchant Requests
Assigned Location
Cancel Fulfillment Order
Cancel a fulfillment order.
Address 1
Address 2
City
Country Code
Location
Name
Phone
Province
Zip
Cancel Order
Cancel an existing order.
App ID
Billing Address
Browser Ip
Buyer Accepts Marketing
Cancel Reason
Cancelled At
Client Details
Closed At
Company
Confirmation Number
Created At
Currency
Current Total Additional Fees Set
Current Total Discounts
Current Total Discounts Set
Current Total Duties Set
Current Total Price
Current Total Price Set
Current Subtotal Price
Current Subtotal Price Set
Current Total Tax
Current Total Tax Set
Customer
Customer Locale
Discount Applications
Discount Codes
Email
Estimated Taxes
Financial Status
Fulfillments
Fulfillment Status
ID
Inventory Behaviour
Landing Site
Line Items
Merchant Of Record App ID
Name
Note
Note Attributes
Number
Order Number
Original Total Additional Fees Set
Original Total Duties Set
Payment Terms
Payment Gateway Names
Phone
Po Number
Presentment Currency
Processed At
Referring Site
Refunds
Shipping Address
Shipping Lines
Source Name
Source Identifier
Source URL
Subtotal Price
Subtotal Price Set
Tags
Tax Lines
Taxes Included
Test
Total Discounts
Total Discounts Set
Total Line Items Price
Total Line Items Price Set
Total Outstanding
Total Price
Total Price Set
Total Shipping Price Set
Total Tax
Total Tax Set
Total Tip Received
Total Weight
Updated At
User ID
Order Status URL
Cancel Order
Cancel an order.
- ID
Cancel Return
Cancel a return.
Closed At
Created At
Decline
ID
Name
Order
Request Approved At
Return Shipping Fees
Status
Total Quantity
Close an order
Close an order.
App ID
Billing Address
Browser Ip
Buyer Accepts Marketing
Cancel Reason
Cancelled At
Client Details
Closed At
Company
Confirmation Number
Created At
Currency
Current Total Additional Fees Set
Current Total Discounts
Current Total Discounts Set
Current Total Duties Set
Current Total Price
Current Total Price Set
Current Subtotal Price
Current Subtotal Price Set
Current Total Tax
Current Total Tax Set
Customer
Customer Locale
Discount Applications
Discount Codes
Email
Estimated Taxes
Financial Status
Fulfillments
Fulfillment Status
ID
Inventory Behaviour
Landing Site
Line Items
Merchant Of Record App ID
Name
Note
Note Attributes
Number
Order Number
Original Total Additional Fees Set
Original Total Duties Set
Payment Terms
Payment Gateway Names
Phone
Po Number
Presentment Currency
Processed At
Referring Site
Refunds
Shipping Address
Shipping Lines
Source Name
Source Identifier
Source URL
Subtotal Price
Subtotal Price Set
Tags
Tax Lines
Taxes Included
Test
Total Discounts
Total Discounts Set
Total Line Items Price
Total Line Items Price Set
Total Outstanding
Total Price
Total Price Set
Total Shipping Price Set
Total Tax
Total Tax Set
Total Tip Received
Total Weight
Updated At
User ID
Order Status URL
Close Fulfillment Order
Marks a fulfillment order as incomplete.
Assigned Location ID
Destination
Delivery Method
Fulfill At
Fulfill By
Fulfillment Holds
ID
International Duties
Line Items
Order ID
Request Status
Shop ID
Status
Supported Actions
Merchant Requests
Assigned Location
Close Fulfillment Order
Close a fulfillment order.
Address 1
Address 2
City
Country Code
Location
Name
Phone
Province
Zip
Close Order
Close an order.
ID
Name
Price
Tax Lines
Close Return
Close a return.
Closed At
Created At
Decline
ID
Name
Order
Request Approved At
Return Shipping Fees
Status
Total Quantity
Complete Draft Order
Complete a draft order.
Accept Automatic Discounts
All Variant Prices Overridden
Allow Discount Codes In Checkout
Any Variant Prices Overridden
Applied Discount
Billing Address
Billing Address Matches Shipping Address
Completed At
Created At
Currency Code
Custom Attributes
Customer
Default Cursor
Discount Codes
Email
Has Timeline Comment
ID
Invoice Email Template Subject
Invoice Sent At
Invoice URL
Legacy Resource ID
Line Items Subtotal Price
Name
Note2
Order
Phone
Platform Discounts
Po Number
Presentment Currency Code
Ready
Reserve Inventory Until
Shipping Address
Shipping Line
Status
Subtotal Price Set
Tags
Tax Exempt
Tax Lines
Taxes Included
Total Discounts Set
Total Line Items Price Set
Total Price Set
Total Quantity Of Line Items
Total Shipping Price Set
Total Tax Set
Total Weight
Transformer Fingerprint
Updated At
Visible To Customer
Warnings
Count Blog Article Comments
Count a blog article comments.
ID
Title
Comments Count
Count Blog Articles
Add up blog articles within a blog.
- Count
Count Blog Articles
Count a blog articles.
ID
Title
Articles Count
Count Blogs
Returns the number of blogs on your store.
- Count
Count Blogs
Count a blogs.
- Count
Count Collections
Count a collections.
- Count
Count Collects
Add up all custom collects on your online store.
- Count
Count Comment
Add up comments for all or specific articles.
- Count
Count Custom Collections
Obtain a count of custom collections.
- Count
Count Customers
Add up all customers.
- Count
Count Customers
Count a customers.
- Count
Count Draft Order
Add up all existing draft orders.
- Count
Count Draft Orders
Count a draft orders.
- Count
Count Events
Count an events.
Count
Precision
Count Events
Add up all events or number of events since a specified time.
- Count
Count Gift Cards
Count a gift cards.
- Count
Count Locations
Count a locations.
- Count
Count Locations
Add up all store locations.
- Count
Count Marketing Events
Count a marketing events.
Count
Precision
Count Marketing Events
Add up all marketing events.
- Count
Count Metafields
Count a metafields.
Owner ID
Owner Type
Count
Precision
Count Order Fulfillments
Add up fulfillments for a specific order.
- Count
Count Order Fulfillments
Count an order fulfillments.
ID
Name
Fulfillments Count
Count Order Transactions
Add up existing order transactions.
- Count
Count Order Transactions
Count an order transactions.
ID
Name
Transactions Count
Count Orders
Add up all orders.
- Count
Count Orders
Count an orders.
- Count
Count Pages
Count a pages.
- Count
Count Pages
Add up pages with specific parameters.
- Count
Count Price Rules
Add up price rules.
- Count
Count Product Images
Add up product images for a specific product or after a specified ID.
- Count
Count Product Images
Count a product images.
Product ID
Product Title
Count
Precision
Count Products
Add up all products.
- Count
Count Products
Count a products.
- Count
Count Redirects
Add up redirects with given path or target.
- Count
Count Script Tags
Count a script tags.
Count
Precision
Count Smart Collections
Add up all smart collections on your online store or those that fit a specific criteria.
- Count
Count URL Redirects
Count an url redirects.
- Count
Create a Customer Account Activation URL
Create an account activation URL for a customer that does not currently have an enabled account.
Create a Customer Address
Create a new address for a customer.
Address 1
Address 2
City
Company
Country
Default
First Name
ID
Last Name
Name
Phone
Province
Zip
Create Basic Discount Code
Create a basic discount code.
Applies Once Per Customer
Code
Combines With
Context
Customer Gets
Ends At
Minimum Requirement
Recurring Cycle Limit
Starts At
Tags
Title
Usage Limit
Create Blog
Create a blog for the blog articles.
Create Blog
Create a blog.
Comment Policy
Handle
Metafields
Template Suffix
Title
Create Blog Article
Create a new blog article for a blog.
Title
Handle
Body HTML
Tags
Published
Published At
Author
Template Suffix
Create Blog Article
Create a blog article.
Author
Blog ID
Body
Handle
Image
Is Published
Metafields
Publish Date
Summary
Tags
Template Suffix
Title
Create Carrier Service
Create a carrier service that provides real-time shipping rates.
Name
Callback URL
Service Discovery
Active
Create Collection
Create a collection.
Description HTML
Handle
ID
Image
Metafields
Products
Redirect New Handle
Rule Set
Seo
Sort Order
Template Suffix
Title
Create Comment
Create a comment for a blog article.
Create Comment Spam
Mark a comment as spam.
Create Custom Collection
Create a new custom collection.
Body HTML
Handle
Image
Published
Sort Order
Template Suffix
Title
Create Customer
Create a new customer record.
Addresses
Email
Email Marketing Consent
First Name
Last Name
Note
Phone
Sms Marketing Consent
Tags
Tax Exempt
Tax Exemptions
Create Customer
Create a customer.
Email
Email Marketing Consent
First Name
Last Name
Locale
Metafields
Multipass Identifier
Note
Phone
Sms Marketing Consent
Tags
Tax Exempt
Tax Exemptions
Create Customer Address
Create a customer address.
Address 1
Address 2
City
Company
Country Code
First Name
Last Name
Phone
Province Code
Zip
Customer ID
Set As Default
Create Customer Send Invite
Send an account invite to a specific customer.
To
From
Bcc
Subject
Custom Message
Create Draft Order
Create a draft order.
Customer
Shipping Address
Billing Address
Note
Note Attributes
Email
Line Items
Shipping Line
Tags
Tax Exempt
Tax Exemptions
Applied Discount
Create Draft Order
Create a draft order.
Accept Automatic Discounts
Allow Discount Codes In Checkout
Applied Discount
Billing Address
Custom Attributes
Discount Codes
Email
Line Items
Localized Fields
Metafields
Note
Payment Terms
Phone
Po Number
Presentment Currency Code
Purchasing Entity
Reserve Inventory Until
Session Token
Shipping Address
Shipping Line
Source Name
Tags
Tax Exempt
Transformer Fingerprint
Use Customer Default Address
Visible To Customer
Create Fulfillment
Create a fulfillment. Typically requires creating a fulfillment order first.
Fulfillment Order Line Items
Message
Notify Customer
Origin Address
Tracking Info
Create Fulfillment
Create a fulfillment.
Fulfillment Order ID
Fulfillment Order Line Items
Tracking Number
Tracking Numbers
Tracking URL
Tracking Urls
Tracking Company
Notify Customer
Address 1
Address 2
City
Province Code
Country Code
Zip
Create Fulfillment Event
Create a fulfillment event (tracking event).
Create Fulfillment Event
Create a fulfillment event.
Address 1
City
Country
Estimated Delivery At
Fulfillment ID
Happened At
Latitude
Longitude
Message
Province
Status
Zip
Create Fulfillment Service
Create a fulfillment service.
Callback URL
Inventory Management
Name
Requires Shipping Method
Tracking Support
Create Gift Card
Create a gift card.
Balance
Code
Currency
Customer ID
Disabled At
Expires On
ID
Initial Value
Last Characters
Line Item ID
Note
Order ID
Template Suffix
User ID
Create Gift Card
Create a gift card.
Code
Customer ID
Expires On
Initial Value
Note
Recipient Attributes
Template Suffix
Create Inventory Level
Create an inventory level.
Available
Inventory Item ID
Location ID
On Hand
Stock At Legacy Location
Create Inventory Level Connect
Connect an inventory item to a location by creating an inventory level at that location.
Create Marketing Engagement
Create a marketing engagement.
Channel Handle
Marketing Activity ID
Ad Spend
All Conversions
Clicks Count
Comments Count
Complaints Count
Fails Count
Favorites Count
First Time Customers
Impressions Count
Is Cumulative
Occurred On
Orders
Primary Conversions
Returning Customers
Sales
Sends Count
Sessions Count
Shares Count
Unique Clicks Count
Unique Views Count
Unsubscribes Count
Utc Offset
Views Count
Remote ID
Create Marketing Event
Create a marketing event on the online store.
Create Marketing Event
Create a marketing event.
Marketing Activity Extension ID
Status
Create Marketing Event Engagement
Create a marketing event engagement.
Create Metaobject Definition
Create a metaobject definition.
Access
Capabilities
Description
Display Name Key
Field Definitions
Name
Type
Create Metaobject Entry
Create a metaobject entry.
Create Metaobject Entry
Create a metaobject entry.
Capabilities
Fields
Handle
Type
Create or Update Draft Order Note Attribute
Create or modify an existing draft order note attribute. Appears in the Additional details section of a draft order details page.
Name
Value
Create or Update Order Note Attribute
Create or modify an existing order note attribute. Appears in the Additional details section of an order details page.
Name
Value
Create Order
Create an order.
Billing Address
Buyer Accepts Marketing
Cancel Reason
Company
Currency
Customer
Discount Codes
Email
Financial Status
Fulfillments
Fulfillment Status
Inventory Behaviour
Line Items
Merchant Of Record App ID
Name
Note
Note Attributes
Number
Phone
Po Number
Presentment Currency
Processed At
Referring Site
Shipping Address
Shipping Lines
Source Name
Source Identifier
Source URL
Subtotal Price
Subtotal Price Set
Tags
Tax Lines
Taxes Included
Total Discounts
Total Discounts Set
Total Line Items Price
Total Line Items Price Set
Total Price Set
Total Shipping Price Set
Total Tax
Total Tax Set
Total Weight
User ID
Order Status URL
Create Order
Create an order.
Inventory Behaviour
Send Fulfillment Receipt
Send Receipt
Billing Address
Buyer Accepts Marketing
Closed At
Company Location ID
Currency
Custom Attributes
Customer
Discount Code
Email
Financial Status
Fulfillment
Fulfillment Status
Line Items
Metafields
Name
Note
Phone
Po Number
Presentment Currency
Processed At
Referring Site
Shipping Address
Shipping Lines
Source Identifier
Source Name
Source URL
Tags
Tax Lines
Taxes Included
Test
Transactions
User ID
Create Order Fulfillment
Create an Order Fulfillment and Fulfill the order in a single step.
Tracking Company
Tracking Number
Tracking URL
Location ID
Notify Customer
Line Items
Create Order Refund
Create a refunded order to record the money returned to the customer.
Currency
Discrepancy Reason
Note
Notify
Refund Line Items
Shipping
Transactions
Create Order Risk
Create an order risk displaying a fraud risk with proxy detection.
- Input
Create Order Risk Assessment
Create an order risk assessment.
Facts
Order ID
Risk Level
Create Order Transaction
Create an order transaction that results in an exchange of money.
Currency
Amount
Kind
Parent ID
Create Order Transaction (Capture)
Create an order transaction (capture).
ID
Amount
Parent Transaction ID
Currency
Final Capture
Create Page
Add a new page with static content.
Title
Handle
Body HTML
Author
Template Suffix
Metafields
Create Page
Create a page.
Body
Handle
Is Published
Metafields
Publish Date
Template Suffix
Title
Create Price Rule
Create a price rule with specific entitlements and prerequisites.
Title
Allocation Method
Value
Value Type
Target Type
Customer Selection
Starts At
Once Per Customer
Target Selection
Ends At
Usage Limit
Allocation Limit
Entitled Collection Ids
Entitled Country Ids
Entitled Product Ids
Entitled Variant Ids
Prerequisite Customer Ids
Prerequisite Variant Ids
Prerequisite Product Ids
Prerequisite Saved Search Ids
Prerequisite Collection Ids
Prerequisite Shipping Price Range
Prerequisite Quantity Range
Prerequisite Subtotal Range
Prerequisite To Entitlement Purchase
Prerequisite To Entitlement Quantity Ratio
Created At
Updated At
Create Price Rule Discount Code
Create a price rule discount code with specific entitlements and prerequisites.
Code
ID
Price Rule ID
Usage Count
Create Product
Create a product.
Body HTML
Handle
Images
Options
Product Type
Published At
Status
Tags
Template Suffix
Title
Variants
Vendor
Create Product
Create a product.
Media
Category
Claim Ownership
Collections To Join
Combined Listing Role
Description HTML
Gift Card
Gift Card Template Suffix
Handle
Metafields
Product Options
Product Type
Requires Selling Plan
Seo
Status
Tags
Template Suffix
Title
Vendor
Create Product Image
Create a product image to be added to a Shopify product.
- Image
Create Product Variant
Create a new product variant for a product.
Barcode
Compare At Price
ID
Inventory Policy
Option1
Option2
Option3
Price
Sku
Taxable
Weight
Weight Unit
Create Product Variant
Create a product variant.
Product ID
Strategy
Price
Compare At Price
Sku
Barcode
Taxable
Tax Code
Inventory Policy
Requires Components
Show Unit Price
Cost
Tracked
Requires Shipping
Country Code Of Origin
Province Code Of Origin
Harmonized System Code
Weight
Weight Unit
Shipping Package ID
Option Values
Metafields
Media Src
Media ID
Inventory Quantities
Unit Price Measurement
Create Product Variants
Create a product variants.
Create Redirect
Create a redirect on the online store.
Create Refund
Create a refund.
Allow Over Refunding
Currency
Discrepancy Reason
Note
Notify
Order ID
Processed At
Refund Duties
Refund Line Items
Refund Methods
Shipping
Transactions
Create Report
Create a report with a name and a ShopifyQL.
Create Resource Feedback
Create a resource feedback for a specific product by using its product id.
Create Return
Create a return.
Exchange Line Items
Order ID
Requested At
Return Line Items
Return Shipping Fee
Create Reverse Delivery With Shipping
Create a reverse delivery with shipping.
File URL
Notify Customer
Reverse Delivery Line Items
Reverse Fulfillment Order ID
Number
URL
Create Script Tag
Create a script tag.
Cache
Display Scope
Src
Create Shop Resource Feedback
Create a shop resource feedback.
State
Messages
Feedback Generated At
Channel ID
Create Smart Collection
Create a smart collection using specific rules.
Body HTML
Handle
Image
Published At
Published Scope
Rules
Disjunctive
Sort Order
Template Suffix
Title
Create Theme
Create a theme.
Name
Role
Source
Create URL Redirect
Create an url redirect.
Path
Target
Custom Query
Customer Add Tag
Add one or more new tags to an existing customer.
Customer Remove Tag
Remove one or more tags from an existing customer.
Deactivate Gift Card
Deactivate a gift card.
Amount
Currency Code
Decline Return Request
Decline a return request.
Closed At
Created At
Decline
ID
Name
Order
Request Approved At
Return Shipping Fees
Status
Total Quantity
Deduct Funds from Gift Card
Deduct a funds from gift card.
Amount
Currency Code
Delete Automatic Discount
Remove an automatic discount.
- Deleted Automatic Discount ID
Delete Blog
Remove a blog from the online store.
Delete Blog
Remove a blog.
- Deleted Blog ID
Delete Blog Article
Remove an existing blog article from a blog.
ID
Blog ID
Title
Handle
Body HTML
Tags
Published
Created At
Published At
Updated At
Author
User ID
Template Suffix
Delete Blog Article
Remove a blog article.
- Deleted Article ID
Delete Blog Article Comment
Remove a blog article comment.
- Deleted Comment ID
Delete Carrier Service
Remove a carrier service from the online store.
ID
Name
Callback URL
Service Discovery
Active
Delete Collection
Remove a collection.
- Deleted Collection ID
Delete Collection Metafield
Clear an existing metafield value on a collection.
Delete Custom Collection
Remove a custom collection.
Body HTML
Handle
Image
ID
Published
Published At
Published Scope
Sort Order
Template Suffix
Title
Updated At
Delete Customer
Remove a customer from the online store.
Address 1
Address 2
City
Company
Country
Country Code
Country Name
Default
First Name
ID
Last Name
Name
Phone
Province
Province Code
Zip
Delete Customer
Remove a customer.
- Deleted Customer ID
Delete Customer Address
Remove an address from an existing customer’s address list.
Address 1
Address 2
City
Company
Country
Country Code
Country Name
Default
First Name
ID
Last Name
Name
Phone
Province
Province Code
Zip
Delete Customer Address
Remove a customer address.
- Deleted Address ID
Delete Customer Metafield
Clear an existing metafield value on a customer.
Delete Customer Metafield
Remove a customer metafield.
Owner ID
Namespace
Key
Delete Customer Tags
Remove tags from a customer.
ID
Display Name
Tags
Delete Discount Code
Remove a discount code.
- Deleted Code Discount ID
Delete Draft Order
Remove a draft order from the online store.
ID
Order ID
Name
Customer
Shipping Address
Billing Address
Note
Note Attributes
Email
Currency
Invoice Sent At
Invoice URL
Line Items
Payment Terms
Shipping Line
Tags
Tax Exempt
Tax Exemptions
Tax Lines
Applied Discount
Taxes Included
Total Tax
Subtotal Price
Total Price
Completed At
Created At
Updated At
Status
Delete Draft Order
Remove a draft order.
- Deleted ID
Delete Draft Order Metafield
Clear an existing metafield value on a draft order.
Delete Draft Order Tags
Remove tags from a draft order.
ID
Name
Tags
Delete Fulfillment Event
Remove a fulfillment event from an order.
Delete Fulfillment Service
Remove a fulfillment service.
- Deleted ID
Delete Fulfillment Service
Remove an existing fulfillment service from the online store.
Delete Inventory Level
Remove an inventory level.
Delete Inventory Level
Remove an inventory item's inventory level entirely at a location.
Available
Inventory Item ID
Location ID
Updated At
Variant
Delete Marketing Event
Remove a marketing event from your online store.
Delete Metafields
Remove a metafields.
Key
Namespace
Owner ID
Delete Metaobject Definition
Remove a metaobject definition.
- Deleted ID
Delete Metaobject Entry
Remove a metaobject entry.
- Deleted ID
Delete Order
Remove an order from the online store.
App ID
Billing Address
Browser Ip
Buyer Accepts Marketing
Cancel Reason
Cancelled At
Client Details
Closed At
Company
Confirmation Number
Created At
Currency
Current Total Additional Fees Set
Current Total Discounts
Current Total Discounts Set
Current Total Duties Set
Current Total Price
Current Total Price Set
Current Subtotal Price
Current Subtotal Price Set
Current Total Tax
Current Total Tax Set
Customer
Customer Locale
Discount Applications
Discount Codes
Email
Estimated Taxes
Financial Status
Fulfillments
Fulfillment Status
ID
Inventory Behaviour
Landing Site
Line Items
Merchant Of Record App ID
Name
Note
Note Attributes
Number
Order Number
Original Total Additional Fees Set
Original Total Duties Set
Payment Terms
Payment Gateway Names
Phone
Po Number
Presentment Currency
Processed At
Referring Site
Refunds
Shipping Address
Shipping Lines
Source Name
Source Identifier
Source URL
Subtotal Price
Subtotal Price Set
Tags
Tax Lines
Taxes Included
Test
Total Discounts
Total Discounts Set
Total Line Items Price
Total Line Items Price Set
Total Outstanding
Total Price
Total Price Set
Total Shipping Price Set
Total Tax
Total Tax Set
Total Tip Received
Total Weight
Updated At
User ID
Order Status URL
Delete Order
Remove an order.
- Deleted ID
Delete Order Metafield
Remove an order metafield.
Owner ID
Namespace
Key
Delete Order Metafield
Clear an existing metafield value on an order.
Delete Order Tags
Remove tags from an order.
ID
Name
Tags
Delete Page
Remove a page.
- Deleted Page ID
Delete Page
Remove a page.
ID
Title
Shop ID
Handle
Body HTML
Author
Created At
Updated At
Published At
Template Suffix
Metafields
Admin Graphql Api ID
Delete Price Rule
Remove a price rule from your online store.
Delete Price Rule Discount Code
Remove a price rule discount code from the online store.
Code
Created At
Updated At
ID
Price Rule ID
Usage Count
Delete Product
Remove a product from the online store.
Delete Product
Remove a product.
- Deleted Product ID
Delete Product from Collection
Remove a product from collection.
ID
Done
Delete Product Image
Remove a product image from a specific product.
Delete Product Image
Remove a product image.
- 0
Delete Product Metafield
Clear an existing metafield value on a product.
Delete Product Metafield
Remove a product metafield.
Owner ID
Namespace
Key
Delete Product Tags
Remove tags from a product.
ID
Title
Tags
Delete Product Variant
Remove a product variant from a product.
Delete Product Variant
Remove a product variant.
ID
Title
Variants Count
Delete Product Variant Metafield
Remove a product variant metafield.
Owner ID
Namespace
Key
Delete Product Variant Metafield
Clear an existing metafield value on a product variant.
Delete Product Variants
Remove a product variants.
Delete Redirect
Remove an existing redirect established on the online store.
Delete Report
Remove an existing report from the Shopify Reports page.
Delete Return Item
Remove an item from a return.
Closed At
Created At
Decline
ID
Name
Order
Request Approved At
Return Shipping Fees
Status
Total Quantity
Delete Script Tag
Remove a script tag.
- Deleted Script Tag ID
Delete Smart Collection
Remove a smart collection from your online store.
Body HTML
Handle
ID
Image
Published At
Published Scope
Rules
Disjunctive
Sort Order
Template Suffix
Title
Updated At
Delete Theme
Remove a theme.
- Deleted Theme ID
Delete Theme
Remove a theme from your online store.
Delete Theme Asset
Remove a theme asset from your online store.
Delete URL Redirect
Remove an url redirect.
- Deleted URL Redirect ID
Disable Gift Card
Deactivate a gift card.
Api Client ID
Balance
Code
Created At
Currency
Customer ID
Disabled At
Expires On
ID
Initial Value
Last Characters
Line Item ID
Note
Order ID
Template Suffix
User ID
Updated At
Dispose Reverse Fulfillment Order Items
Dispose reverse fulfillment order line items.
Created At
ID
Location
Quantity
Type
Draft Order Add Tag
Add one or more new tags to an existing draft order.
Draft Order Remove Tag
Add one or more new tags to an existing draft order.
Duplicate Draft Order
Duplicate a draft order.
Accept Automatic Discounts
Allow Discount Codes In Checkout
All Variant Prices Overridden
Any Variant Prices Overridden
Applied Discount
Billing Address
Billing Address Matches Shipping Address
Completed At
Created At
Currency Code
Custom Attributes
Customer
Discount Codes
Email
Has Timeline Comment
ID
Invoice Email Template Subject
Invoice Sent At
Invoice URL
Legacy Resource ID
Line Items
Line Items Subtotal Price
Name
Note2
Order
Phone
Po Number
Presentment Currency Code
Ready
Reserve Inventory Until
Shipping Address
Shipping Line
Status
Subtotal Price Set
Tags
Taxes Included
Tax Exempt
Tax Lines
Total Discounts Set
Total Line Items Price Set
Total Price Set
Total Quantity Of Line Items
Total Shipping Price Set
Total Tax Set
Total Weight
Transformer Fingerprint
Updated At
Visible To Customer
Duplicate Draft Order
Duplicate a draft order.
Accept Automatic Discounts
All Variant Prices Overridden
Allow Discount Codes In Checkout
Any Variant Prices Overridden
Applied Discount
Billing Address
Billing Address Matches Shipping Address
Completed At
Created At
Currency Code
Custom Attributes
Customer
Default Cursor
Discount Codes
Email
Has Timeline Comment
ID
Invoice Email Template Subject
Invoice Sent At
Invoice URL
Legacy Resource ID
Line Items Subtotal Price
Name
Note2
Order
Phone
Platform Discounts
Po Number
Presentment Currency Code
Ready
Reserve Inventory Until
Shipping Address
Shipping Line
Status
Subtotal Price Set
Tags
Tax Exempt
Tax Lines
Taxes Included
Total Discounts Set
Total Line Items Price Set
Total Price Set
Total Quantity Of Line Items
Total Shipping Price Set
Total Tax Set
Total Weight
Transformer Fingerprint
Updated At
Visible To Customer
Warnings
Generate Customer Activation URL
Generate a customer activation url.
- Account Activation URL
Get List of Abandoned Checkouts
Obtain a list of abandoned checkouts. This action will return 50 results by default, with a maximum of 8,000.
Abandoned Checkout URL
Billing Address
Buyer Accepts Marketing
Buyer Accepts Sms Marketing
Cart Token
Closed At
Completed At
Created At
Currency
Customer
Customer Locale
Device ID
Discount Codes
Email
Gateway
ID
Landing Site
Line Items
Location ID
Note
Phone
Presentment Currency
Referring Site
Shipping Address
Sms Marketing Phone
Shipping Lines
Source Name
Subtotal Price
Tax Lines
Taxes Included
Token
Total Discounts
Total Duties
Total Line Items Price
Total Price
Total Tax
Total Weight
Updated At
User ID
Get List of Article Authors
Obtain a list of all article authors. This action will return 50 results by default, with a maximum of 8,000.
Get List of Article Authors
Obtain a list of article authors.
- Name
Get List of Article Tags
Obtain a list of tags for a specific article. This action will return 50 results by default, with a maximum of 8,000.
Get List of Balance Transactions
Obtain a list of existing balance transactions ordered by most recent processing time. This action will return 50 results by default, with a maximum of 8,000.
Get List of Blog Article Comments
Obtain a list of blog article comments.
Article
Author
Body
Body HTML
Created At
ID
Ip
Is Published
Published At
Status
Updated At
User Agent
Get List of Blog Article Tags
Obtain a list of blog article tags.
Tag Count
Tags
Articles Scanned
Get List of Blog Articles
Obtain a list of blog articles from a blog. This action will return 50 results by default, with a maximum of 8,000.
ID
Blog ID
Title
Handle
Body HTML
Tags
Published
Created At
Published At
Updated At
Author
User ID
Template Suffix
Get List of Blog Articles
Obtain a list of blog articles.
Author
Blog
Body
Created At
Default Cursor
Handle
ID
Image
Is Published
Published At
Summary
Tags
Template Suffix
Title
Updated At
Get List of Blogs
Obtain a list of all blogs. This action will return 50 results by default, with a maximum of 8,000.
Get List of Blogs
Obtain a list of blogs.
Comment Policy
Created At
Feed
Handle
ID
Tags
Template Suffix
Title
Updated At
Get List of Carrier Services
Obtain a list of carrier services. This action will return 50 results by default, with a maximum of 8,000.
ID
Name
Callback URL
Service Discovery
Active
Get List of Catalogs
Obtain a list of catalogs.
ID
Price List
Publication
Status
Title
Get List of Catalogs
Obtain a list of catalogs.
Get List of Checkouts
Obtain a list of abandoned checkouts.
Abandoned Checkout URL
Billing Address
Completed At
Created At
Custom Attributes
Customer
Default Cursor
Discount Codes
ID
Name
Note
Shipping Address
Subtotal Price Set
Tax Lines
Taxes Included
Total Discount Set
Total Duties Set
Total Line Items Price Set
Total Price Set
Total Tax Set
Updated At
Get List of Collection Products
Obtain a list of products in a collection.
ID
Title
Handle
Status
Vendor
Product Type
Created At
Updated At
Get List of Collections
Obtain a list of collections.
Active Operations
Available Publications Count
Description HTML
Handle
ID
Image
Legacy Resource ID
Products Count
Rule Set
Seo
Sort Order
Template Suffix
Title
Updated At
Get List of Collections' Products
Obtain a list of products in a collection. This action will return 50 results by default, with a maximum of 8,000.
Body HTML
Created At
Handle
ID
Images
Options
Product Type
Published At
Status
Tags
Template Suffix
Title
Updated At
Variants
Vendor
Get List of Collects
Obtain a list of collects. This action will return 50 results by default, with a maximum of 8,000.
Collection ID
Created At
ID
Position
Product ID
Sort Value
Updated At
Get List of Comments
Obtain a list of comments for all or specific blog articles. This action will return 50 results by default, with a maximum of 8,000.
Get List of Currencies
Obtain a list of currencies.
ID
Shop Name
Base Currency Code
Formats
Currencies
Get List of Currencies
Obtain a list of currencies enabled on the online store. This action will return 50 results by default, with a maximum of 8,000.
Get List of Custom Collections
Obtain a list of custom collections. This action will return 50 results by default, with a maximum of 8,000.
Body HTML
Handle
Image
ID
Published
Published At
Published Scope
Sort Order
Template Suffix
Title
Updated At
Get List of Customer Address
Obtain a list of customer address.
ID
Display Name
Default Address
Addresses
Get List of Customer Addresses
Obtain a list of customer addresses on the online store. This action will return 50 results by default, with a maximum of 8,000.
Address 1
Address 2
City
Company
Country
Country Code
Country Name
Default
First Name
ID
Last Name
Name
Phone
Province
Province Code
Zip
Get List of Customer's Orders
Obtain a list of all customer's orders. This action will return 50 results by default. To get all orders (regardless of status), add "status=any" to the Parameters field.
App ID
Billing Address
Browser Ip
Buyer Accepts Marketing
Cancel Reason
Cancelled At
Client Details
Closed At
Company
Confirmation Number
Created At
Currency
Current Total Additional Fees Set
Current Total Discounts
Current Total Discounts Set
Current Total Duties Set
Current Total Price
Current Total Price Set
Current Subtotal Price
Current Subtotal Price Set
Current Total Tax
Current Total Tax Set
Customer
Customer Locale
Discount Applications
Discount Codes
Email
Estimated Taxes
Financial Status
Fulfillments
Fulfillment Status
ID
Inventory Behaviour
Landing Site
Line Items
Merchant Of Record App ID
Name
Note
Note Attributes
Number
Order Number
Original Total Additional Fees Set
Original Total Duties Set
Payment Terms
Payment Gateway Names
Phone
Po Number
Presentment Currency
Processed At
Referring Site
Refunds
Shipping Address
Shipping Lines
Source Name
Source Identifier
Source URL
Subtotal Price
Subtotal Price Set
Tags
Tax Lines
Taxes Included
Test
Total Discounts
Total Discounts Set
Total Line Items Price
Total Line Items Price Set
Total Outstanding
Total Price
Total Price Set
Total Shipping Price Set
Total Tax
Total Tax Set
Total Tip Received
Total Weight
Updated At
User ID
Order Status URL
Get List of Customers
Obtain a list of existing customers. This action will return 50 results by default, with a maximum of 2,000.
Addresses
Created At
Default Address
Email
Email Marketing Consent
First Name
ID
Last Name
Last Order ID
Last Order Name
Multipass Identifier
Note
Orders Count
Phone
Sms Marketing Consent
State
Tags
Tax Exempt
Tax Exemptions
Total Spent
Updated At
Verified Email
Get List of Customers
Obtain a list of customers.
Amount Spent
Can Delete
Company Contact Profiles
Created At
Data Sale Opt Out
Default Address
Default Email Address
Default Phone Number
Display Name
First Name
ID
Image
Last Name
Last Order
Legacy Resource ID
Lifetime Duration
Locale
Multipass Identifier
Note
Number Of Orders
Product Subscriber Status
State
Statistics
Tags
Tax Exempt
Tax Exemptions
Updated At
Verified Email
Get List of Discount Code Lookups
Obtain a list of searches for a discount code. This action will return 50 results by default, with a maximum of 8,000.
Code
Created At
Updated At
ID
Price Rule ID
Usage Count
Get List of Discount Codes
Obtain a list of discount codes.
ID
Code Discount
Get List of Draft Orders
Obtain a list of existing draft orders. This action will return 50 results by default, with a maximum of 8,000.
ID
Order ID
Name
Customer
Shipping Address
Billing Address
Note
Note Attributes
Email
Currency
Invoice Sent At
Invoice URL
Line Items
Payment Terms
Shipping Line
Tags
Tax Exempt
Tax Exemptions
Tax Lines
Applied Discount
Taxes Included
Total Tax
Subtotal Price
Total Price
Completed At
Created At
Updated At
Status
Get List of Draft Orders
Obtain a list of draft orders.
Accept Automatic Discounts
All Variant Prices Overridden
Allow Discount Codes In Checkout
Any Variant Prices Overridden
Applied Discount
Billing Address
Billing Address Matches Shipping Address
Completed At
Created At
Currency Code
Custom Attributes
Customer
Default Cursor
Discount Codes
Email
Has Timeline Comment
ID
Invoice Email Template Subject
Invoice Sent At
Invoice URL
Legacy Resource ID
Line Items Subtotal Price
Name
Note2
Order
Phone
Platform Discounts
Po Number
Presentment Currency Code
Ready
Reserve Inventory Until
Shipping Address
Shipping Line
Status
Subtotal Price Set
Tags
Tax Exempt
Tax Lines
Taxes Included
Total Discounts Set
Total Line Items Price Set
Total Price Set
Total Quantity Of Line Items
Total Shipping Price Set
Total Tax Set
Total Weight
Transformer Fingerprint
Updated At
Visible To Customer
Warnings
Get List of Events
Obtain a list of events including smart collections, articles, pages, orders, blogs, orders, products and more. This action will return 50 results by default, with a maximum of 8,000.
Get List of Events
Obtain a list of events.
ID
Message
Action
Created At
Critical Alert
Subject ID
Subject Type
App Title
Attribute To App
Attribute To User
Get List of Fulfillment Events
Obtain a list of all fulfillment events that are linked to a specific fulfillment. This action will return 50 results by default, with a maximum of 8,000.
Get List of Fulfillment Orders
Obtain a list of fulfillment orders.
Assigned Location
Channel ID
Created At
Delivery Method
Destination
Fulfill At
Fulfill By
Fulfillment Holds
ID
International Duties
Order
Order ID
Order Name
Order Processed At
Remaining Line Items Weight
Request Status
Status
Supported Actions
Updated At
Get List of Fulfillment Orders for Order
Obtain a list of fulfillment orders for an order.
ID
Name
Fulfillment Orders
Get List of Fulfillment Services
Obtain a list of your app's or all of the shop's fulfillment services. This action will return 50 results by default, with a maximum of 8,000.
Get List of Fulfillment Services
Obtain a list of fulfillment services.
ID
Handle
Service Name
Callback URL
Inventory Management
Permits Sku Sharing
Fulfillment Orders Opt In
Tracking Support
Type
Get List of Gift Cards
Obtain a list of gift cards.
Api Client ID
Balance
Code
Created At
Currency
Customer ID
Disabled At
Expires On
ID
Initial Value
Last Characters
Line Item ID
Note
Order ID
Template Suffix
User ID
Updated At
Get List of Gift Cards
Obtain a list of gift cards.
Balance
Created At
Customer
Deactivated At
Enabled
Expires On
ID
Initial Value
Last Characters
Masked Code
Note
Order
Recipient Attributes
Template Suffix
Updated At
Get List of Inventory Items
Obtain a list of inventory items from a single product. This action will return 50 results by default, with a maximum of 8,000.
Cost
Country Code Of Origin
Country Harmonized System Codes
Created At
Harmonized System Code
ID
Province Code Of Origin
Sku
Tracked
Updated At
Requires Shipping
Get List of Inventory Items
Obtain a list of inventory items.
Country Code Of Origin
Created At
Duplicate Sku Count
Harmonized System Code
ID
Inventory History URL
Legacy Resource ID
Locations Count
Measurement
Province Code Of Origin
Requires Shipping
Sku
Tracked
Tracked Editable
Unit Cost
Updated At
Get List of Inventory Levels
Obtain a list of all inventory levels from an inventory item. This action will return 50 results by default, with a maximum of 8,000.
Available
Inventory Item ID
Location ID
Updated At
Variant
Get List of Inventory Levels
Obtain a list of inventory levels for an inventory item.
ID
Created At
Updated At
Location
Quantities
Get List of Location Inventory Levels
Obtain a list of inventory levels for a location. This action will return 50 results by default, with a maximum of 8,000.
Get List of Location Inventory Levels
Obtain a list of inventory levels at a location.
ID
Created At
Updated At
Item
Quantities
Get List of Locations
Obtain a list of all locations on the online store. This action will return 50 results by default, with a maximum of 8,000.
Active
Address 1
Address 2
City
Country
Country Code
Created At
ID
Legacy
Name
Phone
Province
Province Code
Updated At
Zip
Get List of Locations
Obtain a list of locations.
Activatable
Address
Address Verified
Created At
Deactivatable
Deactivated At
Deletable
Fulfillment Service
Fulfills Online Orders
Has Active Inventory
Has Unfulfilled Orders
ID
Is Active
Is Fulfillment Service
Legacy Resource ID
Local Pickup Settings V2
Name
Ships Inventory
Suggested Addresses
Updated At
Get List of Marketing Events
Obtain a list of marketing events.
Channel Handle
Description
Ended At
ID
Legacy Resource ID
Manage URL
Marketing Channel Type
Preview URL
Remote ID
Scheduled To End At
Source And Medium
Started At
Type
Utm Campaign
Utm Medium
Utm Source
Get List of Marketing Events
Obtain a list of marketing events. This action will return 50 results by default, with a maximum of 8,000.
Get List of Metafields
Obtain a list of metafields. This action will return 50 results by default, with a maximum of 8,000.
Created At
Description
ID
Key
Namespace
Owner ID
Owner Resource
Updated At
Value
Value Type
Get List of Metafields
Obtain a list of metafields.
Owner ID
Owner Type
Metafields
Get List of Metaobject Entries
Obtain a list of metaobject entries.
Capabilities
Created At
Definition
Display Name
Fields
Handle
ID
Thumbnail Field
Type
Updated At
Get List of Order Fulfillment Events
Obtain a list of order fulfillment events.
ID
Status
Events
Get List of Order Fulfillments
Obtain a list of order fulfillments.
ID
Name
Fulfillments
Get List of Order Refunds
Obtain a list of all refunds for an order. This action will return 50 results by default, with a maximum of 8,000.
Created At
Duties
ID
Order ID
Note
Order Adjustments
Processed At
Refund Duties
Refund Line Items
Transactions
User ID
Currency
Notify
Shipping
Get List of Order Refunds
Obtain a list of order refunds.
ID
Name
Refunds
Get List of Order Risk Assessments
Obtain a list of order risk assessments.
ID
Name
Recommendation
Assessments
Get List of Order Transactions
Obtain a list of order transactions on the online store. This action will return 50 results by default, with a maximum of 8,000.
Amount
Authorization
Authorization Expires At
Created At
Currency
Device ID
Error Code
Extended Authorization Attributes
Gateway
ID
Kind
Location ID
Message
Order ID
Payment Details
Parent ID
Payments Refund Attributes
Processed At
Receipt
Source Name
Status
Total Unsettled Set
Test
User ID
Currency Exchange Adjustment
Get List of Order Transactions
Obtain a list of order transactions.
ID
Name
Transactions
Get List of Order's Fulfillments
Obtain a list of order fulfillments. This action will return 50 results by default, with a maximum of 8,000.
ID
Order ID
Name
Status
Tracking Company
Tracking Number
Tracking URL
Shipment Status
Location ID
Notify Customer
Line Items
Get List of Order's Risks
Obtain a list of existing order risks on a single order.
Facts
Provider
Risk Level
Get List of Orders
Obtain a list of orders of any status, including archived orders. This action will return 50 results by default, with a maximum of 1,000.
App ID
Billing Address
Browser Ip
Buyer Accepts Marketing
Cancel Reason
Cancelled At
Client Details
Closed At
Company
Confirmation Number
Created At
Currency
Current Total Additional Fees Set
Current Total Discounts
Current Total Discounts Set
Current Total Duties Set
Current Total Price
Current Total Price Set
Current Subtotal Price
Current Subtotal Price Set
Current Total Tax
Current Total Tax Set
Customer
Customer Locale
Discount Applications
Discount Codes
Email
Estimated Taxes
Financial Status
Fulfillments
Fulfillment Status
ID
Inventory Behaviour
Landing Site
Line Items
Merchant Of Record App ID
Name
Note
Note Attributes
Number
Order Number
Original Total Additional Fees Set
Original Total Duties Set
Payment Terms
Payment Gateway Names
Phone
Po Number
Presentment Currency
Processed At
Referring Site
Refunds
Shipping Address
Shipping Lines
Source Name
Source Identifier
Source URL
Subtotal Price
Subtotal Price Set
Tags
Tax Lines
Taxes Included
Test
Total Discounts
Total Discounts Set
Total Line Items Price
Total Line Items Price Set
Total Outstanding
Total Price
Total Price Set
Total Shipping Price Set
Total Tax
Total Tax Set
Total Tip Received
Total Weight
Updated At
User ID
Order Status URL
Get List of Orders
Obtain a list of orders.
Additional Fees
Alerts
Billing Address
Billing Address Matches Shipping Address
Can Mark As Paid
Can Notify Customer
Cancel Reason
Cancellation
Cancelled At
Capturable
Cart Discount Amount Set
Channel Information
Client Ip
Closed
Closed At
Confirmation Number
Confirmed
Created At
Currency Code
Current Cart Discount Amount Set
Current Shipping Price Set
Current Subtotal Line Items Quantity
Current Subtotal Price Set
Current Tax Lines
Current Total Additional Fees Set
Current Total Discounts Set
Current Total Duties Set
Current Total Price Set
Current Total Tax Set
Current Total Weight
Custom Attributes
Customer
Customer Accepts Marketing
Customer Journey Summary
Customer Locale
Discount Code
Discount Codes
Display Address
Display Financial Status
Display Fulfillment Status
Disputes
Duties Included
Edited
Email
Estimated Taxes
Fulfillable
Fulfillments Count
Fully Paid
Has Timeline Comment
ID
Legacy Resource ID
Line Items
Merchant Business Entity
Merchant Editable
Merchant Editable Errors
Merchant Of Record App
Name
Net Payment Set
Note
Number
Original Total Additional Fees Set
Original Total Duties Set
Original Total Price Set
Payment Gateway Names
Phone
Po Number
Presentment Currency Code
Processed At
Product Network
Publication
Refund Discrepancy Set
Refundable
Registered Source URL
Requires Shipping
Restockable
Retail Location
Return Status
Risk
Shipping Address
Shipping Line
Shopify Protect
Source Identifier
Source Name
Subtotal Line Items Quantity
Subtotal Price Set
Tags
Tax Exempt
Tax Lines
Taxes Included
Test
Total Capturable Set
Total Cash Rounding Adjustment
Total Discounts Set
Total Outstanding Set
Total Price Set
Total Received Set
Total Refunded Set
Total Refunded Shipping Set
Total Shipping Price Set
Total Tax Set
Total Tip Received Set
Total Weight
Transactions Count
Unpaid
Updated At
Get List of Pages
Obtain a list of pages.
Body
Body Summary
Created At
Default Cursor
Handle
ID
Is Published
Published At
Template Suffix
Title
Updated At
Get List of Pages
Obtain a list of all pages on the online store. This action will return 50 results by default, with a maximum of 8,000.
ID
Title
Shop ID
Handle
Body HTML
Author
Created At
Updated At
Published At
Template Suffix
Metafields
Admin Graphql Api ID
Get List of Policies
Obtain a list of shop policies.
ID
Shop Name
Policies
Get List of Policies
Obtain a list of policies that your store has configured for. This action will return 50 results by default, with a maximum of 8,000.
Get List of Price Lists
Obtain a list of price lists.
Currency
Fixed Prices Count
ID
Name
Parent
Get List of Price Lists
Obtain a list of price lists.
Catalog
Currency
Fixed Prices Count
ID
Name
Parent
Get List of Price Rule Discount Codes
Obtain a list of price rule discount codes on the online store. This action will return 50 results by default, with a maximum of 8,000.
Code
Created At
Updated At
ID
Price Rule ID
Usage Count
Get List of Price Rules
Obtain a list of established price rules. This action will return 50 results by default, with a maximum of 8,000.
Title
Allocation Method
Value
Value Type
Target Type
Customer Selection
Starts At
Once Per Customer
Target Selection
Ends At
Usage Limit
Allocation Limit
Entitled Collection Ids
Entitled Country Ids
Entitled Product Ids
Entitled Variant Ids
Prerequisite Customer Ids
Prerequisite Variant Ids
Prerequisite Product Ids
Prerequisite Saved Search Ids
Prerequisite Collection Ids
Prerequisite Shipping Price Range
Prerequisite Quantity Range
Prerequisite Subtotal Range
Prerequisite To Entitlement Purchase
Prerequisite To Entitlement Quantity Ratio
Get List of Product Images
Obtain a list of product images.
ID
URL
Src
Alt Text
Width
Height
Get List of Product Variants
Obtain a list of product variants from an existing product. This action will return 50 results by default, with a maximum of 8,000.
Barcode
Compare At Price
Created At
ID
Inventory Policy
Inventory Quantity
Option1
Option2
Option3
Position
Price
Product ID
Sku
Taxable
Title
Updated At
Weight
Weight Unit
Get List of Product Variants
Obtain a list of product variants.
Available For Sale
Barcode
Compare At Price
Created At
Default Cursor
Delivery Profile
Display Name
ID
Inventory Item
Inventory Policy
Inventory Quantity
Legacy Resource ID
Position
Price
Product
Requires Components
Selected Options
Sellable Online Quantity
Selling Plan Groups Count
Show Unit Price
Sku
Taxable
Title
Unit Price
Unit Price Measurement
Updated At
Get List of Product's Images
Obtain a list of product images from a specific product. This action will return 50 results by default, with a maximum of 8,000.
ID
Alt
Position
Product ID
Variant Ids
Src
Width
Height
Get List of Products
Obtain a list of existing products. This action will return 50 results by default, with a maximum of 8,000.
Body HTML
Created At
Handle
ID
Images
Options
Product Type
Published At
Status
Tags
Template Suffix
Title
Updated At
Variants
Vendor
Get List of Products
Obtain a list of products.
Available Publications Count
Bundle Consolidated Options
Category
Combined Listing Role
Compare At Price Range
Created At
Default Cursor
Description HTML
Gift Card Template Suffix
Handle
Has Only Default Variant
Has Out Of Stock Variants
Has Variants That Requires Components
ID
Is Gift Card
Legacy Resource ID
Media Count
Online Store Preview URL
Online Store URL
Price Range V2
Product Components Count
Product Type
Published At
Requires Selling Plan
Selling Plan Groups Count
Seo
Status
Tags
Template Suffix
Title
Total Inventory
Tracks Inventory
Updated At
Variants Count
Vendor
Get List of Publications
Obtain a list of publications.
Auto Publish
ID
Name
Supports Future Publishing
Get List of Redirects
Obtain a list of URL redirects. This action will return 50 results by default, with a maximum of 8,000.
Get List of Reports
Obtain a list of all reports that are published. This action will return 50 results by default, with a maximum of 8,000.
Get List of Resource Feedbacks
Obtain a list of resource feedbacks for a specific product by using its product id. This action will return 50 results by default, with a maximum of 8,000.
Get List of Returnable Fulfillments
Obtain a list of returnable fulfillments.
ID
Fulfillment
Line Items
Get List of Sales Channels
Obtain a list of sales channels.
Auto Publish
Catalog
ID
Name
Supports Future Publishing
Get List of Script Tags
Obtain a list of script tags.
Cache
Created At
Display Scope
ID
Legacy Resource ID
Src
Updated At
Get List of Shopify Payment Balances
Obtain a list of Shopify account's current balance. This action will return 50 results by default, with a maximum of 8,000.
Get List of Shopify Payment Disputes
Obtain a list of Shopify payment disputes sorted by specific dates or all disputes that have won. This action will return 50 results by default, with a maximum of 8,000.
Get List of Shopify Payment Payouts
Obtain a list of Shopify payment payouts sorted by specific dates. This action will return 50 results by default, with a maximum of 8,000.
ID
Status
Date
Currency
Amount
Get List of Shopify Payments Balance Transactions
Obtain a list of Shopify Payments balance transactions.
ID
Balance Transactions
Get List of Shopify Payments Balances
Obtain a list of Shopify Payments balances.
ID
Activated
Balances
Get List of Shopify Payments Disputes
Obtain a list of Shopify Payments disputes.
ID
Disputes
Get List of Shopify Payments Payouts
Obtain a list of Shopify Payments payouts.
ID
Activated
Payouts
Get List of Smart Collections
Obtain a list of all existing smart collections or those that fit a specific criteria. This action will return 50 results by default, with a maximum of 8,000.
Body HTML
Handle
ID
Image
Published At
Published Scope
Rules
Disjunctive
Sort Order
Template Suffix
Title
Updated At
Get List of Tender Transactions
Obtain a list of existing tender transactions between the Shopify store and a customer. This action will return 50 results by default, with a maximum of 8,000.
Get List of Tender Transactions
Obtain a list of tender transactions.
Amount
ID
Order
Payment Method
Processed At
Remote Reference
Test
Get List of Theme Assets
Obtain a list of all theme assets from a specific theme. This action will return 50 results by default, with a maximum of 8,000.
Get List of Themes
Obtain a list of themes.
Created At
ID
Name
Prefix
Processing
Processing Failed
Role
Theme Store ID
Updated At
Get List of Themes
Obtain a list of all unpublished and current themes. This action will return 50 results by default, with a maximum of 8,000.
Get List of URL Redirects
Obtain a list of url redirects.
ID
Path
Target
Get Product Resource Feedback
Obtain product resource feedback.
Product ID
State
Messages
GraphQL Query
Make a request to the Shopify GraphQL Admin API
Columns
Rows
Hold Fulfillment Order
Applies a fulfillment hold on an open fulfillment order.
Hold Fulfillment Order
Hold a fulfillment order.
Display Reason
Handle
ID
Reason
Reason Notes
List Fulfillments
Retrieve a list of fulfillments.
Look Up Discount Code
Look up a discount code.
ID
Code Discount
Look Up Product Variant by SKU
Look up a product variant by SKU.
Product Variant ID
Product ID
Inventory Item ID
Mark Blog Article Comment as Not Spam
Mark a blog article comment as not spam.
Author
Blog
Body
Created At
Default Cursor
Handle
ID
Image
Is Published
Published At
Summary
Tags
Template Suffix
Title
Updated At
Mark Blog Article Comment as Spam
Mark a blog article comment as spam.
Author
Blog
Body
Created At
Default Cursor
Handle
ID
Image
Is Published
Published At
Summary
Tags
Template Suffix
Title
Updated At
Mark Comment as Not Spam
Mark a comment as not spam after it has been marked as spam.
Mark Order as Paid
Mark an order as paid by recording a payment transaction for the outstanding amount.
ID
Name
Can Mark As Paid
Display Financial Status
Total Price Set
Total Outstanding Set
Transactions
Mark Order as Paid
Mark an order as paid.
ID
Name
Email
Display Financial Status
Fully Paid
Move All Fulfillment Order Items
Move all fulfillment order items to a new location.
ID
Order Name
Status
Request Status
Fulfill By
Created At
Updated At
Assigned Location
Delivery Method
Supported Actions
Move Fulfillment Order
Moves a fulfillment order to a new location.
Assigned Location ID
Destination
Delivery Method
Fulfill At
Fulfill By
Fulfillment Holds
ID
International Duties
Line Items
Order ID
Request Status
Shop ID
Status
Supported Actions
Merchant Requests
Assigned Location
Move Fulfillment Order
Move a fulfillment order.
Address 1
Address 2
City
Country Code
Location
Name
Phone
Province
Zip
Open Fulfillment Order
Marks the fulfillment order as open.
Assigned Location ID
Destination
Delivery Method
Fulfill At
Fulfill By
Fulfillment Holds
ID
International Duties
Line Items
Order ID
Request Status
Shop ID
Status
Supported Actions
Merchant Requests
Assigned Location
Open Fulfillment Order
Open a fulfillment order.
Address 1
Address 2
City
Country Code
Location
Name
Phone
Province
Zip
Order Add Tag
Add one or more new tags to an existing order.
Order Remove Tag
Remove one or more tags from an existing order.
Process Return
Process a return.
Closed At
Created At
Decline
ID
Name
Order
Request Approved At
Return Shipping Fees
Status
Total Quantity
Product Add Tag
Add one or more new tags to an existing product.
Product Remove Tag
Remove one or more tags from an existing product.
Publish Product or Collection
Publish a product or collection to a specific sales channel.
- Count
Publish Resource
Publish a resource.
Action
Description
Publish Theme
Publish a theme.
Created At
ID
Name
Prefix
Processing
Processing Failed
Role
Theme Store ID
Updated At
Query Metafields
Query a metafields.
Owner ID
Owner Type
Metafields
Re-open Closed Order
Re-open a closed order.
App ID
Billing Address
Browser Ip
Buyer Accepts Marketing
Cancel Reason
Cancelled At
Client Details
Closed At
Company
Confirmation Number
Created At
Currency
Current Total Additional Fees Set
Current Total Discounts
Current Total Discounts Set
Current Total Duties Set
Current Total Price
Current Total Price Set
Current Subtotal Price
Current Subtotal Price Set
Current Total Tax
Current Total Tax Set
Customer
Customer Locale
Discount Applications
Discount Codes
Email
Estimated Taxes
Financial Status
Fulfillments
Fulfillment Status
ID
Inventory Behaviour
Landing Site
Line Items
Merchant Of Record App ID
Name
Note
Note Attributes
Number
Order Number
Original Total Additional Fees Set
Original Total Duties Set
Payment Terms
Payment Gateway Names
Phone
Po Number
Presentment Currency
Processed At
Referring Site
Refunds
Shipping Address
Shipping Lines
Source Name
Source Identifier
Source URL
Subtotal Price
Subtotal Price Set
Tags
Tax Lines
Taxes Included
Test
Total Discounts
Total Discounts Set
Total Line Items Price
Total Line Items Price Set
Total Outstanding
Total Price
Total Price Set
Total Shipping Price Set
Total Tax
Total Tax Set
Total Tip Received
Total Weight
Updated At
User ID
Order Status URL
Release Fulfillment Order Hold
Releases the fulfillment hold on a fulfillment order.
Assigned Location ID
Destination
Delivery Method
Fulfill At
Fulfill By
Fulfillment Holds
ID
International Duties
Line Items
Order ID
Request Status
Shop ID
Status
Supported Actions
Merchant Requests
Assigned Location
Release Fulfillment Order Hold
Release a fulfillment order hold.
Address 1
Address 2
City
Country Code
Location
Name
Phone
Province
Zip
Remove Comment
Remove a comment.
Remove Product from Custom Collection
Remove a product from a custom collection.
Collection ID
Created At
ID
Position
Product ID
Sort Value
Updated At
Reopen Order
Reopen an order.
ID
Name
Price
Tax Lines
Reopen Return
Reopen a return.
Closed At
Created At
Decline
ID
Name
Order
Request Approved At
Return Shipping Fees
Status
Total Quantity
Reorder Collection Products
Reorder products in a collection.
Done
ID
Request Return
Request a return.
Closed At
Created At
Decline
ID
Name
Order
Request Approved At
Return Shipping Fees
Status
Total Quantity
Reschedule Fulfillment Order
Reschedules the fulfill at time of a scheduled fulfillment order.
Assigned Location ID
Destination
Delivery Method
Fulfill At
Fulfill By
Fulfillment Holds
ID
International Duties
Line Items
Order ID
Request Status
Shop ID
Status
Supported Actions
Merchant Requests
Assigned Location
Reschedule Fulfillment Order
Reschedule a fulfillment order.
Address 1
Address 2
City
Country Code
Location
Name
Phone
Province
Zip
Restore Comment
Restore a previously removed comment.
Retrieve Blog
Grab all details about a blog.
Comment Policy
Created At
Feed
Handle
ID
Tags
Template Suffix
Title
Updated At
Retrieve Blog Article
Grab all details about the specific blog article.
ID
Blog ID
Title
Handle
Body HTML
Tags
Published
Created At
Published At
Updated At
Author
User ID
Template Suffix
Retrieve Blog Article
Grab all details about a blog article.
- Name
Retrieve Blog Article Comment
Grab all details about a blog article comment.
Author
Blog
Body
Created At
Default Cursor
Handle
ID
Image
Is Published
Published At
Summary
Tags
Template Suffix
Title
Updated At
Retrieve Blogs
Grab all details about the blog.
Retrieve Carrier Service
Grab all details about the carrier service by its id.
ID
Name
Callback URL
Service Discovery
Active
Retrieve Catalog
Grab all details about a catalog.
ID
Price List
Publication
Status
Title
Retrieve Catalog
Grab all details about a catalog.
Retrieve Collect
Grab all details about a specific collect.
Collection ID
Created At
ID
Position
Product ID
Sort Value
Updated At
Retrieve Collection
Grab all details about the collection.
Body HTML
Handle
Image
ID
Published At
Published Scope
Sort Order
Template Suffix
Title
Updated At
Collection Type
Retrieve Collection
Grab all details about a collection.
- Duplicate
Retrieve Collection Metafield
Grab the value of a metafield on a collection.
- Value
Retrieve Collection Metafield
Grab all details about a collection metafield.
ID
Namespace
Key
Value
Type
Description
Created At
Updated At
Owner ID
Owner Title
Retrieve Comment
Grab all details about a specific comment.
Retrieve Company Location
Grab all details about a company location.
Address 1
Address 2
City
Company Name
Country
Country Code
Created At
First Name
Formatted Area
ID
Last Name
Phone
Province
Recipient
Updated At
Zip
Zone Code
Retrieve Count of Gift Cards
Grab a count of gift cards.
- Count
Retrieve Custom Collection
Grab all details about the a custom collection.
Body HTML
Handle
Image
ID
Published
Published At
Published Scope
Sort Order
Template Suffix
Title
Updated At
Retrieve Customer
Grab all details about the customer.
Address 1
Address 2
City
Company
Country
Country Code
Country Name
Default
First Name
ID
Last Name
Name
Phone
Province
Province Code
Zip
Retrieve Customer
Grab all details about a customer.
Amount
Currency Code
Retrieve Customer Address
Grab all details about the customer address.
Address 1
Address 2
City
Company
Country
Country Code
Country Name
Default
First Name
ID
Last Name
Name
Phone
Province
Province Code
Zip
Retrieve Customer Address
Grab all details about a customer address.
ID
Address 1
Address 2
City
Company
Country
Country Code V2
First Name
Last Name
Name
Phone
Province
Province Code
Zip
Customer ID
Customer Display Name
Retrieve Customer Company Location
Grab all details about a customer's company location.
Customer Company Location ID
Customer Company Location Currency
Customer Company Location Name
Retrieve Customer Metafield
Grab the value of a metafield on a customer.
- Value
Retrieve Customer Metafield
Grab all details about a customer metafield.
ID
Namespace
Key
Value
Type
Description
Created At
Updated At
Owner ID
Owner Display Name
Retrieve Discount Code
Grab all details about a discount code.
ID
Code Discount
Retrieve Draft Order
Grab all details about a specific draft order.
ID
Order ID
Name
Customer
Shipping Address
Billing Address
Note
Note Attributes
Email
Currency
Invoice Sent At
Invoice URL
Line Items
Payment Terms
Shipping Line
Tags
Tax Exempt
Tax Exemptions
Tax Lines
Applied Discount
Taxes Included
Total Tax
Subtotal Price
Total Price
Completed At
Created At
Updated At
Status
Retrieve Draft Order
Grab all details about a draft order.
Accept Automatic Discounts
All Variant Prices Overridden
Allow Discount Codes In Checkout
Any Variant Prices Overridden
Applied Discount
Billing Address
Billing Address Matches Shipping Address
Completed At
Created At
Currency Code
Custom Attributes
Customer
Default Cursor
Discount Codes
Email
Has Timeline Comment
ID
Invoice Email Template Subject
Invoice Sent At
Invoice URL
Legacy Resource ID
Line Items Subtotal Price
Name
Note2
Order
Phone
Platform Discounts
Po Number
Presentment Currency Code
Ready
Reserve Inventory Until
Shipping Address
Shipping Line
Status
Subtotal Price Set
Tags
Tax Exempt
Tax Lines
Taxes Included
Total Discounts Set
Total Line Items Price Set
Total Price Set
Total Quantity Of Line Items
Total Shipping Price Set
Total Tax Set
Total Weight
Transformer Fingerprint
Updated At
Visible To Customer
Warnings
Retrieve Draft Order Metafield
Grab the value of a metafield on a draft order.
- Value
Retrieve Draft Order Metafield
Grab all details about a draft order metafield.
ID
Namespace
Key
Value
Type
Description
Created At
Updated At
Owner ID
Owner Name
Retrieve Event
Grab all details about the event by its id.
Retrieve Event
Grab all details about an event.
ID
Action
Message
Created At
Critical Alert
Subject ID
Subject Type
App Title
Attribute To App
Attribute To User
Retrieve Fulfillment
Grab all details about a fulfillment.
Created At
Delivered At
Display Status
Estimated Delivery At
ID
In Transit At
Legacy Resource ID
Location
Name
Order
Origin Address
Requires Shipping
Service
Status
Total Quantity
Updated At
Retrieve Fulfillment Event
Grab all details about the fulfillment event.
Retrieve Fulfillment Order
Retrieve a specific fulfillment order.
Assigned Location ID
Destination
Delivery Method
Fulfill At
Fulfill By
Fulfillment Holds
ID
International Duties
Line Items
Order ID
Request Status
Shop ID
Status
Supported Actions
Merchant Requests
Assigned Location
Retrieve Fulfillment Order
Grab all details about a fulfillment order.
Address 1
Address 2
City
Country Code
Location
Name
Phone
Province
Zip
Retrieve Fulfillment Service
Grab all details about the fulfillment service by its id.
Retrieve Fulfillment Service
Grab all details about a fulfillment service.
Callback URL
Handle
ID
Inventory Management
Location
Requires Shipping Method
Service Name
Tracking Support
Type
Retrieve Gift Card
Grab all details about a gift card.
Api Client ID
Balance
Code
Created At
Currency
Customer ID
Disabled At
Expires On
ID
Initial Value
Last Characters
Line Item ID
Note
Order ID
Template Suffix
User ID
Updated At
Retrieve Gift Card
Grab all details about a gift card.
Amount
Currency Code
Retrieve Inventory Item
Grab all details about the inventory item by id.
Cost
Country Code Of Origin
Country Harmonized System Codes
Created At
Harmonized System Code
ID
Province Code Of Origin
Sku
Tracked
Updated At
Requires Shipping
Retrieve Inventory Item
Grab all details about an inventory item.
Country Code Of Origin
Created At
Duplicate Sku Count
Harmonized System Code
ID
Inventory History URL
Legacy Resource ID
Locations Count
Measurement
Province Code Of Origin
Requires Shipping
Sku
Tracked
Tracked Editable
Unit Cost
Updated At
Variant
Retrieve Inventory Level
Grab all details about an inventory level.
Inventory Item ID
Sku
Tracked
Inventory Level ID
Location
Available
Committed
Incoming
On Hand
Reserved
Created At
Updated At
Retrieve Inventory Levels
Grab all details about inventory levels (includes details about quantities, incoming, available, and location).
Can Deactivate
Created At
Deactivation Alert
ID
Item
Location
Quantities
Updated At
Retrieve Location
Grab all details about a location.
Active
Address 1
Address 2
City
Country
Country Code
Created At
ID
Legacy
Name
Phone
Province
Province Code
Updated At
Zip
Retrieve Location
Grab all details about a location.
Activatable
Address
Address Verified
Created At
Deactivatable
Deactivated At
Deletable
Fulfillment Service
Fulfills Online Orders
Has Active Inventory
Has Unfulfilled Orders
ID
Is Active
Is Fulfillment Service
Legacy Resource ID
Local Pickup Settings V2
Name
Ships Inventory
Suggested Addresses
Updated At
Retrieve Marketing Event
Grab all details about a marketing event.
Channel Handle
Description
Ended At
ID
Legacy Resource ID
Manage URL
Marketing Channel Type
Preview URL
Remote ID
Scheduled To End At
Source And Medium
Started At
Type
Utm Campaign
Utm Medium
Utm Source
Retrieve Marketing Event
Grab all details about the marketing event by its ID.
Retrieve Metafield
Grab all details about a metafield.
Created At
Description
ID
Key
Legacy Resource ID
Namespace
Updated At
Value
Retrieve Metafield
Grab all details about a metafield.
ID
Namespace
Key
Value
Type
Description
Created At
Updated At
Owner Type
Retrieve Metaobject Entry
Grab all details about a metaobject entry.
ID
Handle
Type
Fields
Retrieve Metaobject Entry
Grab all details about a metaobject entry.
Online Store
Publishable
Retrieve Order
Grab all details about the order.
App ID
Billing Address
Browser Ip
Buyer Accepts Marketing
Cancel Reason
Cancelled At
Client Details
Closed At
Company
Confirmation Number
Created At
Currency
Current Total Additional Fees Set
Current Total Discounts
Current Total Discounts Set
Current Total Duties Set
Current Total Price
Current Total Price Set
Current Subtotal Price
Current Subtotal Price Set
Current Total Tax
Current Total Tax Set
Customer
Customer Locale
Discount Applications
Discount Codes
Email
Estimated Taxes
Financial Status
Fulfillments
Fulfillment Status
ID
Inventory Behaviour
Landing Site
Line Items
Merchant Of Record App ID
Name
Note
Note Attributes
Number
Order Number
Original Total Additional Fees Set
Original Total Duties Set
Payment Terms
Payment Gateway Names
Phone
Po Number
Presentment Currency
Processed At
Referring Site
Refunds
Shipping Address
Shipping Lines
Source Name
Source Identifier
Source URL
Subtotal Price
Subtotal Price Set
Tags
Tax Lines
Taxes Included
Test
Total Discounts
Total Discounts Set
Total Line Items Price
Total Line Items Price Set
Total Outstanding
Total Price
Total Price Set
Total Shipping Price Set
Total Tax
Total Tax Set
Total Tip Received
Total Weight
Updated At
User ID
Order Status URL
Retrieve Order
Grab all details about an order.
ID
Name
Price
Tax Lines
Retrieve Order Count
Get the total order count for your store. Filter the results with a custom query.
Count
Precision
Retrieve Order Fulfillment
Grab all details about a specific order fulfillment on an order.
ID
Order ID
Name
Status
Tracking Company
Tracking Number
Tracking URL
Shipment Status
Location ID
Notify Customer
Line Items
Retrieve Order Fulfillment Event
Grab all details about an order fulfillment event.
ID
Status
Message
Happened At
Fulfillment ID
Fulfillment Status
Retrieve Order Metafield
Grab the value of a metafield on an order.
- Value
Retrieve Order Metafield
Grab all details about an order metafield.
ID
Namespace
Key
Value
Type
Description
Created At
Updated At
Owner ID
Owner Name
Retrieve Order Refund
Grab all details about a specific refund.
Created At
Duties
ID
Order ID
Note
Order Adjustments
Processed At
Refund Duties
Refund Line Items
Transactions
User ID
Currency
Notify
Shipping
Retrieve Order Risk Assessment
Grab all details about an order risk assessment.
Risk Level
Facts
Order ID
Order Name
Recommendation
Assessment Index
Retrieve Order Transaction
Grab all details about a specific order transaction.
Currency
Amount
Kind
Parent ID
Error Code
Retrieve Order Transaction
Grab all details about an order transaction.
ID
Kind
Status
Gateway
Formatted Gateway
Account Number
Authorization Code
Created At
Processed At
Test
Error Code
Payment ID
Manually Capturable
Settlement Currency
Parent Transaction
Amount Set
Total Unsettled Set
Payment Details
Order ID
Order Name
Retrieve Order's Fulfillment Orders
Grab fulfillment orders for a specific order.
Assigned Location ID
Destination
Delivery Method
Fulfill At
Fulfill By
Fulfillment Holds
ID
International Duties
Line Items
Order ID
Request Status
Shop ID
Status
Supported Actions
Merchant Requests
Assigned Location
Retrieve Page
Grab all details about the page by its id.
ID
Title
Shop ID
Handle
Body HTML
Author
Created At
Updated At
Published At
Template Suffix
Metafields
Admin Graphql Api ID
Retrieve Page
Grab all details about a page.
Body
Body Summary
Created At
Default Cursor
Handle
ID
Is Published
Published At
Template Suffix
Title
Updated At
Retrieve Price List
Grab all details about a price list.
ID
Name
Currency
Fixed Prices Count
Catalog
Parent
Prices
Retrieve Price List
Grab all details about a price list.
ID
Price List
Publication
Status
Title
Retrieve Price Rule
Grab all details about the price rule.
Title
Allocation Method
Value
Value Type
Target Type
Customer Selection
Starts At
Once Per Customer
Target Selection
Ends At
Usage Limit
Allocation Limit
Entitled Collection Ids
Entitled Country Ids
Entitled Product Ids
Entitled Variant Ids
Prerequisite Customer Ids
Prerequisite Variant Ids
Prerequisite Product Ids
Prerequisite Saved Search Ids
Prerequisite Collection Ids
Prerequisite Shipping Price Range
Prerequisite Quantity Range
Prerequisite Subtotal Range
Prerequisite To Entitlement Purchase
Prerequisite To Entitlement Quantity Ratio
Retrieve Price Rule Discount Code
Grab all details about the price rule discount code.
Code
Created At
Updated At
ID
Price Rule ID
Usage Count
Retrieve Product
Grab all details about the product.
Body HTML
Created At
Handle
ID
Images
Options
Product Type
Published At
Status
Tags
Template Suffix
Title
Updated At
Variants
Vendor
Retrieve Product
Grab all details about a product.
Available Publications Count
Bundle Consolidated Options
Category
Combined Listing Role
Compare At Price Range
Created At
Default Cursor
Description HTML
Gift Card Template Suffix
Handle
Has Only Default Variant
Has Out Of Stock Variants
Has Variants That Requires Components
ID
Is Gift Card
Legacy Resource ID
Media Count
Online Store Preview URL
Online Store URL
Price Range V2
Product Components Count
Product Type
Published At
Requires Selling Plan
Selling Plan Groups Count
Seo
Status
Tags
Template Suffix
Title
Total Inventory
Tracks Inventory
Updated At
Variants Count
Vendor
Retrieve Product Image
Grab all details about the product image.
ID
Alt
Position
Product ID
Variant Ids
Src
Width
Height
Retrieve Product Images
Grab all details about a product images.
ID
Title
Images
Retrieve Product Metafield
Grab the value of a metafield on a product.
- Value
Retrieve Product Metafield
Grab all details about a product metafield.
ID
Namespace
Key
Value
Type
Description
Created At
Updated At
Owner ID
Owner Title
Retrieve Product Variant
Grab all details about specific Shopify product variants from an existing product.
Barcode
Compare At Price
Created At
ID
Inventory Policy
Inventory Quantity
Option1
Option2
Option3
Position
Price
Product ID
Sku
Taxable
Title
Updated At
Weight
Weight Unit
Retrieve Product Variant
Grab all details about a product variant.
Available For Sale
Barcode
Compare At Price
Created At
Default Cursor
Delivery Profile
Display Name
ID
Inventory Item
Inventory Policy
Inventory Quantity
Legacy Resource ID
Position
Price
Product
Requires Components
Selected Options
Sellable Online Quantity
Selling Plan Groups Count
Show Unit Price
Sku
Taxable
Title
Unit Price
Unit Price Measurement
Updated At
Retrieve Product Variant Details from SKU
Returns IDs for the Product, Product Variant and Inventory Item when given a SKU.
Product Variant ID
Product ID
Inventory Item ID
Retrieve Product Variant from Inventory Item
Grab all details about a product variant from an inventory item ID.
Product ID
Product Title
Product Variant ID
Product Variant Title
Inventory Item ID
Retrieve Product Variant Metafield
Grab all details about a product variant metafield.
ID
Namespace
Key
Value
Type
Description
Created At
Updated At
Owner ID
Owner Title
Retrieve Publication
Grab all details about a publication.
Auto Publish
ID
Supports Future Publishing
Retrieve Redirect
Grab all details about a specific redirect by its ID.
Retrieve Refund
Grab all details about a refund.
Created At
Duties
ID
Legacy Resource ID
Note
Order
Processed At
Return
Total Refunded Set
Updated At
Retrieve Report
Grab all details about an existing report.
Retrieve Return
Grab all details about a return.
Closed At
Created At
Decline
ID
Name
Order
Request Approved At
Return Shipping Fees
Status
Total Quantity
Retrieve Return Financial Outcome
Retrieve the suggested financial outcome for a return.
ID
Name
Status
Suggested Financial Outcome
Retrieve Reverse Fulfillment Order
Grab all details about a reverse fulfillment order.
ID
Order
Status
Third Party Confirmation
Retrieve Sales Channel
Grab all details about a sales channel.
Auto Publish
Catalog
ID
Name
Supports Future Publishing
Retrieve Script Tag
Grab all details about a script tag.
Cache
Created At
Display Scope
ID
Legacy Resource ID
Src
Updated At
Retrieve Shop
Grab all details about the shop.
ID
Name
Email
Domain
Province
Country
Address 1
Zip
City
Source
Phone
Latitude
Longitude
Primary Locale
Address 2
Created At
Updated At
Country Code
Country Name
Currency
Customer Email
Timezone
Iana Timezone
Shop Owner
Money Format
Money With Currency Format
Weight Unit
Province Code
Taxes Included
Tax Shipping
County Taxes
Plan Display Name
Plan Name
Has Discounts
Has Gift Cards
Myshopify Domain
Google Apps Domain
Google Apps Login Enabled
Money In Emails Format
Money With Currency In Emails Format
Eligible For Payments
Requires Extra Payments Agreement
Password Enabled
Has Storefront
Eligible For Card Reader Giveaway
Finances
Primary Location ID
Cookie Consent Level
Visitor Tracking Consent Preference
Force Ssl
Checkout Api Supported
Multi Location Enabled
Setup Required
Pre Launch Enabled
Enabled Presentment Currencies
Retrieve Shop
Grab all details about a shop.
Action
Description
Retrieve Shopify Payment Dispute
Grab all details about the Shopify payment dispute by id.
Retrieve Shopify Payment Payout
Grab all details about the Shopify payment payout by id.
ID
Status
Date
Currency
Amount
Retrieve Shopify Payments Dispute
Grab all details about a shopify payments dispute.
ID
Status
Retrieve Shopify Payments Payout
Grab all details about a shopify payments payout.
ID
Status
Issued At
Retrieve Smart Collection
Grab all details about the smart collection.
Body HTML
Handle
ID
Image
Published At
Published Scope
Rules
Disjunctive
Sort Order
Template Suffix
Title
Updated At
Retrieve Theme
Grab all details about a theme.
Created At
ID
Name
Prefix
Processing
Processing Failed
Role
Theme Store ID
Updated At
Retrieve Theme
Grab all details about a specific theme.
Retrieve URL Redirect
Grab all details about an url redirect.
ID
Path
Target
Retrieve Variant Metafield
Grab the value of a metafield on a product variant.
- Value
Run Custom GraphQL Query
Run a custom graphql query.
Run ShopifyQL Query
Run a shopifyql query.
Parse Errors
Table Data
Search Customer by Email
Search for a customer by email address. This action will return 50 results by default, with a maximum of 8,000.
Addresses
Created At
Default Address
Email
Email Marketing Consent
First Name
ID
Last Name
Last Order ID
Last Order Name
Multipass Identifier
Note
Orders Count
Phone
Sms Marketing Consent
State
Tags
Tax Exempt
Tax Exemptions
Total Spent
Updated At
Verified Email
Search Customer by Phone Number
Search for a customer by phone number. This action will return 50 results by default, with a maximum of 8,000.
Addresses
Created At
Default Address
Email
Email Marketing Consent
First Name
ID
Last Name
Last Order ID
Last Order Name
Multipass Identifier
Note
Orders Count
Phone
Sms Marketing Consent
State
Tags
Tax Exempt
Tax Exemptions
Total Spent
Updated At
Verified Email
Search Gift Card
Search for a gift card.
Api Client ID
Balance
Code
Created At
Currency
Customer ID
Disabled At
Expires On
ID
Initial Value
Last Characters
Line Item ID
Note
Order ID
Template Suffix
User ID
Updated At
Send Customer Account Invite
Send a customer account invite.
Amount
Currency Code
Send Draft Order Invoice
Send a draft order invoice.
Accept Automatic Discounts
All Variant Prices Overridden
Allow Discount Codes In Checkout
Any Variant Prices Overridden
Applied Discount
Billing Address
Billing Address Matches Shipping Address
Completed At
Created At
Currency Code
Custom Attributes
Customer
Default Cursor
Discount Codes
Email
Has Timeline Comment
ID
Invoice Email Template Subject
Invoice Sent At
Invoice URL
Legacy Resource ID
Line Items Subtotal Price
Name
Note2
Order
Phone
Platform Discounts
Po Number
Presentment Currency Code
Ready
Reserve Inventory Until
Shipping Address
Shipping Line
Status
Subtotal Price Set
Tags
Tax Exempt
Tax Lines
Taxes Included
Total Discounts Set
Total Line Items Price Set
Total Price Set
Total Quantity Of Line Items
Total Shipping Price Set
Total Tax Set
Total Weight
Transformer Fingerprint
Updated At
Visible To Customer
Warnings
Send Fulfillment Request
Send a fulfillment request for a fulfillment order.
ID
Shop ID
Fulfillment Order ID
Line Item ID
Inventory Item ID
Quantity
Fulfillable Quantity
Variant ID
Send Invoice for Draft Order
Send an invoice for a draft order.
To
From
Bcc
Subject
Custom Message
Send Invoice for Order
Send an invoice for an order that has outstanding balance.
Send Order Invoice
Send an order invoice.
ID
Name
Price
Tax Lines
Set Collection Metafield
Create or update an existing metafield value on a collection.
Set Customer Address
Sets an address for a customer.
Address 1
Address 2
City
Company
Country
Country Code
Country Name
Default
First Name
ID
Last Name
Name
Phone
Province
Province Code
Zip
Set Customer Metafield
Create or update an existing metafield value on a customer.
Set Customer Metafield
Set a customer metafield.
ID
Namespace
Key
Value
Type
Owner Type
Created At
Updated At
Compare Digest
Set Default Address
Set a default address for a customer.
Address 1
Address 2
City
Company
Country
Country Code
Country Name
Default
First Name
ID
Last Name
Name
Phone
Province
Province Code
Zip
Set Draft Order Metafield
Create or update an existing metafield value on a draft order.
Set Draft Order Note Attribute
Set a draft order note attribute.
ID
Name
Custom Attributes
Set Fulfillment Order Deadline
Sets deadline for fulfillment orders.
Assigned Location ID
Destination
Delivery Method
Fulfill At
Fulfill By
Fulfillment Holds
ID
International Duties
Line Items
Order ID
Request Status
Shop ID
Status
Supported Actions
Merchant Requests
Assigned Location
Set Fulfillment Order Deadline
Set a fulfillment order deadline.
- Success
Set Inventory Level
Set a product variant's inventory level at a single location to a specific value (like 0).
Available quantity
Location
Inventory Item ID
Disconnect If Necessary
Set Inventory Level By Variant
Set a product variant's inventory level at a single location to a specific value (like 0).
Available quantity
Location
Inventory Item ID
Disconnect If Necessary
Set Inventory Level by Variant
Set an inventory level by variant.
ID
Reason
Created At
Reference Document Uri
Changes
Set Inventory Quantities
Set an inventory quantities.
Created At
ID
Reason
Reference Document Uri
Set Metafields
Set metafields on a resource.
ID
Namespace
Key
Value
Json Value
Type
Owner Type
Created At
Updated At
Legacy Resource ID
Compare Digest
Definition
Set Metaobject List Metafield
Set a metaobject list metafield.
ID
Namespace
Key
Value
Json Value
Type
Owner Type
Created At
Updated At
Set On-Hand Inventory Quantities
Set on-hand inventory quantities.
Created At
ID
Reason
Reference Document Uri
Set Order Metafield
Create or update an existing metafield value on an order.
Set Order Metafield
Set an order metafield.
ID
Namespace
Key
Value
Type
Owner Type
Created At
Updated At
Compare Digest
Set Order Note Attribute
Set an order note attribute.
ID
Name
Custom Attributes
Set Product Metafield
Create or update an existing metafield value on a product.
Set Product Metafield
Set a product metafield.
ID
Namespace
Key
Value
Type
Owner Type
Created At
Updated At
Compare Digest
Set Product Variant Metafield
Create or update an existing metafield value on a product variant.
Submit Fulfillment Request
Submit a fulfillment request.
Address 1
Address 2
City
Country Code
Location
Name
Phone
Province
Zip
Theme Publish
Publish one of your store's unpublished themes.
Unpublish Product or Collection
Unpublish a product or collection from a specific sales channel.
- Count
Unpublish Resource
Unpublish a resource.
Action
Description
Update Basic Discount Code
Modify a basic discount code.
Applies Once Per Customer
Code
Combines With
Context
Customer Gets
Ends At
Minimum Requirement
Recurring Cycle Limit
Starts At
Tags
Title
Usage Limit
ID
Update Blog
Modify a blog's details.
Update Blog
Modify a blog.
Comment Policy
Handle
Metafields
Redirect Articles
Redirect New Handle
Template Suffix
Title
ID
Update Blog Article
Modify a blog article's content and details.
Title
Handle
Body HTML
Tags
Published
Published At
Author
Template Suffix
Update Blog Article
Modify a blog article.
Author
Blog ID
Body
Handle
Image
Is Published
Metafields
Publish Date
Redirect New Handle
Summary
Tags
Template Suffix
Title
ID
Update Carrier Service
Modify an existing carrier service.
Name
Callback URL
Service Discovery
Active
Update Collection
Modify a collection.
Description HTML
Handle
ID
Image
Metafields
Products
Redirect New Handle
Rule Set
Seo
Sort Order
Template Suffix
Title
Update Comment
Modify comment on an article.
Update Custom Collection
Modify an existing custom collection.
Body HTML
Handle
Image
Published
Sort Order
Template Suffix
Title
Update Customer
Modify a customer's account details.
Addresses
Email
Email Marketing Consent
First Name
Last Name
Note
Phone
Sms Marketing Consent
Tags
Tax Exempt
Tax Exemptions
Update Customer
Modify a customer.
Email
Email Marketing Consent
First Name
ID
Last Name
Locale
Metafields
Multipass Identifier
Note
Phone
Sms Marketing Consent
Tags
Tax Exempt
Tax Exemptions
Update Customer Address
Modify an existing customer's address.
Address 1
Address 2
City
Company
Country
Default
First Name
ID
Last Name
Name
Phone
Province
Zip
Update Customer Address
Modify a customer address.
Customer ID
Address ID
Address 1
Address 2
City
Company
Country Code
First Name
Last Name
Phone
Province Code
Zip
Set As Default
Update Customer Note
Modify a customer's note.
Customer ID
Note
Preserve the existing note
Update Draft Order
Modify an existing draft order.
Customer
Shipping Address
Billing Address
Note
Note Attributes
Email
Line Items
Shipping Line
Tags
Tax Exempt
Tax Exemptions
Applied Discount
Update Draft Order
Modify a draft order.
ID
Accept Automatic Discounts
Allow Discount Codes In Checkout
Applied Discount
Billing Address
Custom Attributes
Discount Codes
Email
Line Items
Localized Fields
Metafields
Note
Payment Terms
Phone
Po Number
Presentment Currency Code
Purchasing Entity
Reserve Inventory Until
Session Token
Shipping Address
Shipping Line
Source Name
Tags
Tax Exempt
Transformer Fingerprint
Use Customer Default Address
Visible To Customer
Update Draft Order Complete
Complete a draft order and mark it as paid or pending.
Payment Gateway ID
Payment Pending
Update Fulfillment Service
Modify a fulfillment service used on the online store.
Update Fulfillment Service
Modify a fulfillment service.
Callback URL
ID
Inventory Management
Name
Requires Shipping Method
Tracking Support
Update Fulfillment Tracking
Update a fulfillment's tracking information.
Tracking Info
Notify Customer
Update Fulfillment Tracking
Modify a fulfillment tracking.
Update Gift Card
Modify an existing's gift card.
Customer ID
Gift Card ID
Expires On
Note
Template Suffix
Update Gift Card
Modify a gift card.
ID
Customer ID
Expires On
Note
Recipient Attributes
Template Suffix
Update Inventory Item
Modify an inventory item's SKU or unit cost.
Cost
Country Code Of Origin
Country Harmonized System Codes
Harmonized System Code
Province Code Of Origin
Sku
Tracked
Requires Shipping
Update Inventory Item
Modify an inventory item.
ID
Cost
Country Code Of Origin
Country Harmonized System Codes
Harmonized System Code
Measurement
Province Code Of Origin
Requires Shipping
Sku
Tracked
Update Marketing Event
Modify a marketing event's remote_id, timestamps, and currency & budget.
Update Marketing Event
Modify a marketing event.
- ID
Update Metaobject Entry
Modify an existing metaobject entry's details.
Update Metaobject Entry
Modify a metaobject entry.
ID
Capabilities
Fields
Handle
Redirect New Handle
Update Order
Modify an order's details.
Name
Email
Phone
Tags
Note
Note Attributes
Line Items
Customer
Shipping Address
Fulfillments
Update Order
Modify an order.
Custom Attributes
Email
ID
Localized Fields
Metafields
Note
Phone
Po Number
Shipping Address
Tags
Update Order Note
Modify an order's note.
Order ID
Note
Preserve the existing note
Update Page
Modify a page's details.
Title
Handle
Body HTML
Author
Template Suffix
Metafields
Update Page
Modify a page.
ID
Body
Handle
Is Published
Metafields
Publish Date
Redirect New Handle
Template Suffix
Title
Update Price Rule
Modify a price rule's title.
Title
Allocation Method
Value
Value Type
Target Type
Customer Selection
Starts At
Once Per Customer
Target Selection
Ends At
Usage Limit
Allocation Limit
Entitled Collection Ids
Entitled Country Ids
Entitled Product Ids
Entitled Variant Ids
Prerequisite Customer Ids
Prerequisite Variant Ids
Prerequisite Product Ids
Prerequisite Saved Search Ids
Prerequisite Collection Ids
Prerequisite Shipping Price Range
Prerequisite Quantity Range
Prerequisite Subtotal Range
Prerequisite To Entitlement Purchase
Prerequisite To Entitlement Quantity Ratio
Created At
Updated At
Update Price Rule Discount Code
Modify an existing price rule discount code.
Code
ID
Price Rule ID
Usage Count
Update Product
Modify a product's details.
Body HTML
Handle
Images
Product Type
Published At
Status
Tags
Template Suffix
Title
Variants
Vendor
Update Product
Modify a product.
Find by Unique Metafield
Handle
ID
Media
Category
Collections To Join
Collections To Leave
Delete Conflicting Constrained Metafields
Description HTML
Gift Card Template Suffix
Metafields
Product Type
Redirect New Handle
Requires Selling Plan
Seo
Status
Tags
Template Suffix
Title
Vendor
Update Product Image
Modify a product image.
Product ID
Media ID
Alt
Preview Image Source
Update Product Variant
Modify specific Shopify product variant's details for an existing product.
Barcode
Compare At Price
ID
Inventory Policy
Option1
Option2
Option3
Price
Sku
Taxable
Weight
Weight Unit
Update Product Variant
Modify a product variant.
Product ID
Variant ID
Price
Compare At Price
Sku
Barcode
Taxable
Tax Code
Inventory Policy
Requires Components
Show Unit Price
Cost
Tracked
Requires Shipping
Country Code Of Origin
Province Code Of Origin
Harmonized System Code
Weight
Weight Unit
Shipping Package ID
Option Values
Metafields
Media Src
Media ID
Unit Price Measurement
Update Product Variants
Modify a product variants.
Update Redirect
Modify a redirect's path and target URIs.
Update Report
Modify a published report's details.
Update Reverse Delivery Shipping
Modify a reverse delivery shipping.
File URL
Notify Customer
Reverse Delivery ID
Number
URL
Update Script Tag
Modify a script tag.
ID
Cache
Display Scope
Src
Update Smart Collection
Modify an existing smart collection's details.
Body HTML
Handle
Image
Published At
Published Scope
Rules
Disjunctive
Sort Order
Template Suffix
Title
Update Smart Collection Order
Modify manually sorted products in an existing smart collection.
Update Theme
Modify a theme.
ID
Name
Update Theme Asset
Modify a theme asset's name and details.
Update URL Redirect
Modify an url redirect.
ID
Path
Target
Not just software—partnership
Expert support included
MESA includes hands-on support from automation experts who know how to get things done.
Free workflow setup
We'll build your first workflow with you live. Most merchants walk away with automation saving 5+ hours/week.
Fast response times
Average first response: Same day. Critical issues: Immediate escalation. Complex builds: 24-48 hours.
Managed services available
Personalized workflow reviews, and quarterly check-ins to identify new opportunities as your business grows.
Real humans, always
Chat with real automation experts (not bots). Email support 9am-5pm PST. Google Meet sessions for complex workflows.
Integrate Shopify with Smile.io today.
Enjoy a 7-day free trial. Get your first workflow in minutes.
MESA AI assistant
+×
Describe your task...
You've known what your store should be doing. Now it can. Describe the task then MESA handles it from there.