shopify
Shopify is a leading e-commerce platform designed to help merchants build, run, and grow their online stores. Shopify makes it easy to manage every aspect of your store, from products and inventory to orders and customers.
With Shopify in Agent Forge, your agents can:
Create and manage products: Add new products, update product details, and remove products from your store.
List and retrieve orders: Get information about customer orders, including filtering and order management.
Manage customers: Access and update customer details, or add new customers to your store.
Adjust inventory levels: Programmatically change product stock levels to keep your inventory accurate.
Use Agent Forge's Shopify integration to automate common store management workflows—such as syncing inventory, fulfilling orders, or managing listings—directly from your automations. Empower your agents to access, update, and organize all your store data using simple, programmatic tools.
Usage Instructions
Integrate Shopify into your workflow. Manage products, orders, customers, and inventory. Create, read, update, and delete products. List and manage orders. Handle customer data and adjust inventory levels.
Tools
shopify_create_product
Create a new product in your Shopify store
Input
shopDomain
string
Yes
Your Shopify store domain (e.g., mystore.myshopify.com)
title
string
Yes
Product title
descriptionHtml
string
No
Product description (HTML)
vendor
string
No
Product vendor/brand
productType
string
No
Product type/category
tags
array
No
Product tags
status
string
No
Product status (ACTIVE, DRAFT, ARCHIVED)
Output
product
object
The created product
shopify_get_product
Get a single product by ID from your Shopify store
Input
shopDomain
string
Yes
Your Shopify store domain (e.g., mystore.myshopify.com)
productId
string
Yes
Product ID (gid://shopify/Product/123456789)
Output
product
object
The product details
shopify_list_products
List products from your Shopify store with optional filtering
Input
shopDomain
string
Yes
Your Shopify store domain (e.g., mystore.myshopify.com)
first
number
No
Number of products to return (default: 50, max: 250)
query
string
No
Search query to filter products (e.g., "title:shirt" or "vendor:Nike" or "status:active")
Output
products
array
List of products
pageInfo
object
Pagination information
shopify_update_product
Update an existing product in your Shopify store
Input
shopDomain
string
Yes
Your Shopify store domain (e.g., mystore.myshopify.com)
productId
string
Yes
Product ID to update (gid://shopify/Product/123456789)
title
string
No
New product title
descriptionHtml
string
No
New product description (HTML)
vendor
string
No
New product vendor/brand
productType
string
No
New product type/category
tags
array
No
New product tags
status
string
No
New product status (ACTIVE, DRAFT, ARCHIVED)
Output
product
object
The updated product
shopify_delete_product
Delete a product from your Shopify store
Input
shopDomain
string
Yes
Your Shopify store domain (e.g., mystore.myshopify.com)
productId
string
Yes
Product ID to delete (gid://shopify/Product/123456789)
Output
deletedId
string
The ID of the deleted product
shopify_get_order
Get a single order by ID from your Shopify store
Input
shopDomain
string
Yes
Your Shopify store domain (e.g., mystore.myshopify.com)
orderId
string
Yes
Order ID (gid://shopify/Order/123456789)
Output
order
object
The order details
shopify_list_orders
List orders from your Shopify store with optional filtering
Input
shopDomain
string
Yes
Your Shopify store domain (e.g., mystore.myshopify.com)
first
number
No
Number of orders to return (default: 50, max: 250)
status
string
No
Filter by order status (open, closed, cancelled, any)
query
string
No
Search query to filter orders (e.g., "financial_status:paid" or "fulfillment_status:unfulfilled" or "email:customer@example.com")
Output
orders
array
List of orders
pageInfo
object
Pagination information
shopify_update_order
Update an existing order in your Shopify store (note, tags, email)
Input
shopDomain
string
Yes
Your Shopify store domain (e.g., mystore.myshopify.com)
orderId
string
Yes
Order ID to update (gid://shopify/Order/123456789)
note
string
No
New order note
tags
array
No
New order tags
email
string
No
New customer email for the order
Output
order
object
The updated order
shopify_cancel_order
Cancel an order in your Shopify store
Input
shopDomain
string
Yes
Your Shopify store domain (e.g., mystore.myshopify.com)
orderId
string
Yes
Order ID to cancel (gid://shopify/Order/123456789)
reason
string
Yes
Cancellation reason (CUSTOMER, DECLINED, FRAUD, INVENTORY, STAFF, OTHER)
notifyCustomer
boolean
No
Whether to notify the customer about the cancellation
refund
boolean
No
Whether to refund the order
restock
boolean
No
Whether to restock the inventory
staffNote
string
No
A note about the cancellation for staff reference
Output
order
object
The cancellation result
shopify_create_customer
Create a new customer in your Shopify store
Input
shopDomain
string
Yes
Your Shopify store domain (e.g., mystore.myshopify.com)
email
string
No
Customer email address
firstName
string
No
Customer first name
lastName
string
No
Customer last name
phone
string
No
Customer phone number
note
string
No
Note about the customer
tags
array
No
Customer tags
addresses
array
No
Customer addresses
Output
customer
object
The created customer
shopify_get_customer
Get a single customer by ID from your Shopify store
Input
shopDomain
string
Yes
Your Shopify store domain (e.g., mystore.myshopify.com)
customerId
string
Yes
Customer ID (gid://shopify/Customer/123456789)
Output
customer
object
The customer details
shopify_list_customers
List customers from your Shopify store with optional filtering
Input
shopDomain
string
Yes
Your Shopify store domain (e.g., mystore.myshopify.com)
first
number
No
Number of customers to return (default: 50, max: 250)
query
string
No
Search query to filter customers (e.g., "first_name:John" or "last_name:Smith" or "email:*@gmail.com" or "tag:vip")
Output
customers
array
List of customers
pageInfo
object
Pagination information
shopify_update_customer
Update an existing customer in your Shopify store
Input
shopDomain
string
Yes
Your Shopify store domain (e.g., mystore.myshopify.com)
customerId
string
Yes
Customer ID to update (gid://shopify/Customer/123456789)
email
string
No
New customer email address
firstName
string
No
New customer first name
lastName
string
No
New customer last name
phone
string
No
New customer phone number
note
string
No
New note about the customer
tags
array
No
New customer tags
Output
customer
object
The updated customer
shopify_delete_customer
Delete a customer from your Shopify store
Input
shopDomain
string
Yes
Your Shopify store domain (e.g., mystore.myshopify.com)
customerId
string
Yes
Customer ID to delete (gid://shopify/Customer/123456789)
Output
deletedId
string
The ID of the deleted customer
shopify_list_inventory_items
List inventory items from your Shopify store. Use this to find inventory item IDs by SKU.
Input
shopDomain
string
Yes
Your Shopify store domain (e.g., mystore.myshopify.com)
first
number
No
Number of inventory items to return (default: 50, max: 250)
query
string
No
Search query to filter inventory items (e.g., "sku:ABC123")
Output
inventoryItems
array
List of inventory items with their IDs, SKUs, and stock levels
pageInfo
object
Pagination information
shopify_get_inventory_level
Get inventory level for a product variant at a specific location
Input
shopDomain
string
Yes
Your Shopify store domain (e.g., mystore.myshopify.com)
inventoryItemId
string
Yes
Inventory item ID (gid://shopify/InventoryItem/123456789)
locationId
string
No
Location ID to filter by (optional)
Output
inventoryLevel
object
The inventory level details
shopify_adjust_inventory
Adjust inventory quantity for a product variant at a specific location
Input
shopDomain
string
Yes
Your Shopify store domain (e.g., mystore.myshopify.com)
inventoryItemId
string
Yes
Inventory item ID (gid://shopify/InventoryItem/123456789)
locationId
string
Yes
Location ID (gid://shopify/Location/123456789)
delta
number
Yes
Amount to adjust (positive to increase, negative to decrease)
Output
inventoryLevel
object
The inventory adjustment result
shopify_list_locations
List inventory locations from your Shopify store. Use this to find location IDs needed for inventory operations.
Input
shopDomain
string
Yes
Your Shopify store domain (e.g., mystore.myshopify.com)
first
number
No
Number of locations to return (default: 50, max: 250)
includeInactive
boolean
No
Whether to include deactivated locations (default: false)
Output
locations
array
List of locations with their IDs, names, and addresses
pageInfo
object
Pagination information
shopify_create_fulfillment
Create a fulfillment to mark order items as shipped. Requires a fulfillment order ID (get this from the order details).
Input
shopDomain
string
Yes
Your Shopify store domain (e.g., mystore.myshopify.com)
fulfillmentOrderId
string
Yes
The fulfillment order ID (e.g., gid://shopify/FulfillmentOrder/123456789)
trackingNumber
string
No
Tracking number for the shipment
trackingCompany
string
No
Shipping carrier name (e.g., UPS, FedEx, USPS, DHL)
trackingUrl
string
No
URL to track the shipment
notifyCustomer
boolean
No
Whether to send a shipping confirmation email to the customer (default: true)
Output
fulfillment
object
The created fulfillment with tracking info and fulfilled items
shopify_list_collections
List product collections from your Shopify store. Filter by title, type (custom/smart), or handle.
Input
shopDomain
string
Yes
Your Shopify store domain (e.g., mystore.myshopify.com)
first
number
No
Number of collections to return (default: 50, max: 250)
query
string
No
Search query to filter collections (e.g., "title:Summer" or "collection_type:smart")
Output
collections
array
List of collections with their IDs, titles, and product counts
pageInfo
object
Pagination information
shopify_get_collection
Get a specific collection by ID, including its products. Use this to retrieve products within a collection.
Input
shopDomain
string
Yes
Your Shopify store domain (e.g., mystore.myshopify.com)
collectionId
string
Yes
The collection ID (e.g., gid://shopify/Collection/123456789)
productsFirst
number
No
Number of products to return from this collection (default: 50, max: 250)
Output
collection
object
The collection details including its products
Notes
Category:
toolsType:
shopify
Was this helpful?