Shopify

Manage products, orders, customers, and inventory in your Shopify store

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`

Input

Parameter	Type	Required	Description
`shopDomain`	string	Yes	No description
`title`	string	Yes	No description
`descriptionHtml`	string	No	No description
`vendor`	string	No	No description
`productType`	string	No	No description
`tags`	array	No	No description
`status`	string	No	No description

Output

Parameter	Type	Description
`product`	object	The created product
↳ `id`	string	Unique product identifier (GID)
↳ `title`	string	Product title
↳ `handle`	string	URL-friendly product identifier
↳ `descriptionHtml`	string	Product description in HTML format
↳ `vendor`	string	Product vendor or manufacturer
↳ `productType`	string	Product type classification
↳ `tags`	array	Product tags for categorization
↳ `status`	string	Product status (ACTIVE, DRAFT, ARCHIVED)
↳ `createdAt`	string	Creation timestamp (ISO 8601)
↳ `updatedAt`	string	Last modification timestamp (ISO 8601)
↳ `variants`	object	Product variants with edges/nodes structure
↳ `images`	object	Product images with edges/nodes structure

`shopify_get_product`

Input

Parameter	Type	Required	Description
`shopDomain`	string	Yes	No description
`productId`	string	Yes	No description

Output

Parameter	Type	Description
`product`	object	The product details
↳ `id`	string	Unique product identifier (GID)
↳ `title`	string	Product title
↳ `handle`	string	URL-friendly product identifier
↳ `descriptionHtml`	string	Product description in HTML format
↳ `vendor`	string	Product vendor or manufacturer
↳ `productType`	string	Product type classification
↳ `tags`	array	Product tags for categorization
↳ `status`	string	Product status (ACTIVE, DRAFT, ARCHIVED)
↳ `createdAt`	string	Creation timestamp (ISO 8601)
↳ `updatedAt`	string	Last modification timestamp (ISO 8601)
↳ `variants`	object	Product variants with edges/nodes structure
↳ `images`	object	Product images with edges/nodes structure

`shopify_list_products`

Input

Parameter	Type	Required	Description
`shopDomain`	string	Yes	No description
`first`	number	No	No description
`query`	string	No	Search query to filter products (e.g., "title:shirt" or "vendor:Nike" or "status:active")

Output

Parameter	Type	Description
`products`	array	List of products
↳ `id`	string	Unique product identifier (GID)
↳ `title`	string	Product title
↳ `handle`	string	URL-friendly product identifier
↳ `descriptionHtml`	string	Product description in HTML format
↳ `vendor`	string	Product vendor or manufacturer
↳ `productType`	string	Product type classification
↳ `tags`	array	Product tags for categorization
↳ `status`	string	Product status (ACTIVE, DRAFT, ARCHIVED)
↳ `createdAt`	string	Creation timestamp (ISO 8601)
↳ `updatedAt`	string	Last modification timestamp (ISO 8601)
↳ `variants`	object	Product variants with edges/nodes structure
↳ `images`	object	Product images with edges/nodes structure
`pageInfo`	object	Pagination information
↳ `hasNextPage`	boolean	Whether there are more results after this page
↳ `hasPreviousPage`	boolean	Whether there are results before this page

`shopify_update_product`

Input

Parameter	Type	Required	Description
`shopDomain`	string	Yes	No description
`productId`	string	Yes	No description
`title`	string	No	No description
`descriptionHtml`	string	No	No description
`vendor`	string	No	No description
`productType`	string	No	No description
`tags`	array	No	No description
`status`	string	No	No description

Output

Parameter	Type	Description
`product`	object	The updated product
↳ `id`	string	Unique product identifier (GID)
↳ `title`	string	Product title
↳ `handle`	string	URL-friendly product identifier
↳ `descriptionHtml`	string	Product description in HTML format
↳ `vendor`	string	Product vendor or manufacturer
↳ `productType`	string	Product type classification
↳ `tags`	array	Product tags for categorization
↳ `status`	string	Product status (ACTIVE, DRAFT, ARCHIVED)
↳ `createdAt`	string	Creation timestamp (ISO 8601)
↳ `updatedAt`	string	Last modification timestamp (ISO 8601)
↳ `variants`	object	Product variants with edges/nodes structure
↳ `images`	object	Product images with edges/nodes structure

`shopify_delete_product`

Input

Parameter	Type	Required	Description
`shopDomain`	string	Yes	No description
`productId`	string	Yes	No description

Output

Parameter	Type	Description
`deletedId`	string	The ID of the deleted product

`shopify_get_order`

Input

Parameter	Type	Required	Description
`shopDomain`	string	Yes	No description
`orderId`	string	Yes	No description

Output

Parameter	Type	Description
`order`	object	The order details
↳ `id`	string	Unique order identifier (GID)
↳ `name`	string	Order name (e.g., #1001)
↳ `email`	string	Customer email for the order
↳ `phone`	string	Customer phone for the order
↳ `createdAt`	string	Order creation timestamp (ISO 8601)
↳ `updatedAt`	string	Last modification timestamp (ISO 8601)
↳ `cancelledAt`	string	Cancellation timestamp (ISO 8601)
↳ `closedAt`	string	Closure timestamp (ISO 8601)
↳ `displayFinancialStatus`	string	Financial status (PENDING, AUTHORIZED, PARTIALLY_PAID, PAID, PARTIALLY_REFUNDED, REFUNDED, VOIDED)
↳ `displayFulfillmentStatus`	string	Fulfillment status (UNFULFILLED, PARTIALLY_FULFILLED, FULFILLED, RESTOCKED, PENDING_FULFILLMENT, OPEN, IN_PROGRESS, ON_HOLD, SCHEDULED)
↳ `totalPriceSet`	object	Total order price
↳ `subtotalPriceSet`	object	Order subtotal (before shipping and taxes)
↳ `totalTaxSet`	object	Total tax amount
↳ `totalShippingPriceSet`	object	Total shipping price
↳ `note`	string	Order note
↳ `tags`	array	Order tags
↳ `customer`	object	Customer who placed the order
↳ `lineItems`	object	Order line items with edges/nodes structure
↳ `shippingAddress`	object	Shipping address
↳ `billingAddress`	object	Billing address
↳ `fulfillments`	array	Order fulfillments

`shopify_list_orders`

Input

Parameter	Type	Required	Description
`shopDomain`	string	Yes	No description
`first`	number	No	No description
`status`	string	No	No description
`query`	string	No	Search query to filter orders (e.g., "financial_status:paid" or "fulfillment_status:unfulfilled" or "email:customer@example.com")

Output

Parameter	Type	Description
`orders`	array	List of orders
↳ `id`	string	Unique order identifier (GID)
↳ `name`	string	Order name (e.g., #1001)
↳ `email`	string	Customer email for the order
↳ `phone`	string	Customer phone for the order
↳ `createdAt`	string	Order creation timestamp (ISO 8601)
↳ `updatedAt`	string	Last modification timestamp (ISO 8601)
↳ `cancelledAt`	string	Cancellation timestamp (ISO 8601)
↳ `closedAt`	string	Closure timestamp (ISO 8601)
↳ `displayFinancialStatus`	string	Financial status (PENDING, AUTHORIZED, PARTIALLY_PAID, PAID, PARTIALLY_REFUNDED, REFUNDED, VOIDED)
↳ `displayFulfillmentStatus`	string	Fulfillment status (UNFULFILLED, PARTIALLY_FULFILLED, FULFILLED, RESTOCKED, PENDING_FULFILLMENT, OPEN, IN_PROGRESS, ON_HOLD, SCHEDULED)
↳ `totalPriceSet`	object	Total order price
↳ `subtotalPriceSet`	object	Order subtotal (before shipping and taxes)
↳ `totalTaxSet`	object	Total tax amount
↳ `totalShippingPriceSet`	object	Total shipping price
↳ `note`	string	Order note
↳ `tags`	array	Order tags
↳ `customer`	object	Customer who placed the order
↳ `lineItems`	object	Order line items with edges/nodes structure
↳ `shippingAddress`	object	Shipping address
↳ `billingAddress`	object	Billing address
↳ `fulfillments`	array	Order fulfillments
`pageInfo`	object	Pagination information
↳ `hasNextPage`	boolean	Whether there are more results after this page
↳ `hasPreviousPage`	boolean	Whether there are results before this page

`shopify_update_order`

Input

Parameter	Type	Required	Description
`shopDomain`	string	Yes	No description
`orderId`	string	Yes	No description
`note`	string	No	No description
`tags`	array	No	No description
`email`	string	No	No description

Output

Parameter	Type	Description
`order`	object	The updated order
↳ `id`	string	Unique order identifier (GID)
↳ `name`	string	Order name (e.g., #1001)
↳ `email`	string	Customer email for the order
↳ `phone`	string	Customer phone for the order
↳ `createdAt`	string	Order creation timestamp (ISO 8601)
↳ `updatedAt`	string	Last modification timestamp (ISO 8601)
↳ `cancelledAt`	string	Cancellation timestamp (ISO 8601)
↳ `closedAt`	string	Closure timestamp (ISO 8601)
↳ `displayFinancialStatus`	string	Financial status (PENDING, AUTHORIZED, PARTIALLY_PAID, PAID, PARTIALLY_REFUNDED, REFUNDED, VOIDED)
↳ `displayFulfillmentStatus`	string	Fulfillment status (UNFULFILLED, PARTIALLY_FULFILLED, FULFILLED, RESTOCKED, PENDING_FULFILLMENT, OPEN, IN_PROGRESS, ON_HOLD, SCHEDULED)
↳ `totalPriceSet`	object	Total order price
↳ `subtotalPriceSet`	object	Order subtotal (before shipping and taxes)
↳ `totalTaxSet`	object	Total tax amount
↳ `totalShippingPriceSet`	object	Total shipping price
↳ `note`	string	Order note
↳ `tags`	array	Order tags
↳ `customer`	object	Customer who placed the order
↳ `lineItems`	object	Order line items with edges/nodes structure
↳ `shippingAddress`	object	Shipping address
↳ `billingAddress`	object	Billing address
↳ `fulfillments`	array	Order fulfillments

`shopify_cancel_order`

Input

Parameter	Type	Required	Description
`shopDomain`	string	Yes	No description
`orderId`	string	Yes	No description
`reason`	string	Yes	No description
`notifyCustomer`	boolean	No	No description
`refund`	boolean	No	No description
`restock`	boolean	No	No description
`staffNote`	string	No	No description

Output

Parameter	Type	Description
`order`	object	The cancellation result
↳ `id`	string	Job identifier for the cancellation
↳ `cancelled`	boolean	Whether the cancellation completed
↳ `message`	string	Status message

`shopify_create_customer`

Input

Parameter	Type	Required	Description
`shopDomain`	string	Yes	No description
`email`	string	No	No description
`firstName`	string	No	No description
`lastName`	string	No	No description
`phone`	string	No	No description
`note`	string	No	No description
`tags`	array	No	No description
`addresses`	array	No	No description

Output

Parameter	Type	Description
`customer`	object	The created customer
↳ `id`	string	Unique customer identifier (GID)
↳ `email`	string	Customer email address
↳ `firstName`	string	Customer first name
↳ `lastName`	string	Customer last name
↳ `phone`	string	Customer phone number
↳ `createdAt`	string	Account creation timestamp (ISO 8601)
↳ `updatedAt`	string	Last modification timestamp (ISO 8601)
↳ `note`	string	Internal notes about the customer
↳ `tags`	array	Customer tags for categorization
↳ `amountSpent`	object	Total amount spent by customer
↳ `addresses`	array	Customer addresses
↳ `defaultAddress`	object	Customer default address

`shopify_get_customer`

Input

Parameter	Type	Required	Description
`shopDomain`	string	Yes	No description
`customerId`	string	Yes	No description

Output

Parameter	Type	Description
`customer`	object	The customer details
↳ `id`	string	Unique customer identifier (GID)
↳ `email`	string	Customer email address
↳ `firstName`	string	Customer first name
↳ `lastName`	string	Customer last name
↳ `phone`	string	Customer phone number
↳ `createdAt`	string	Account creation timestamp (ISO 8601)
↳ `updatedAt`	string	Last modification timestamp (ISO 8601)
↳ `note`	string	Internal notes about the customer
↳ `tags`	array	Customer tags for categorization
↳ `amountSpent`	object	Total amount spent by customer
↳ `addresses`	array	Customer addresses
↳ `defaultAddress`	object	Customer default address

`shopify_list_customers`

Input

Parameter	Type	Required	Description
`shopDomain`	string	Yes	No description
`first`	number	No	No description
`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

Parameter	Type	Description
`customers`	array	List of customers
↳ `id`	string	Unique customer identifier (GID)
↳ `email`	string	Customer email address
↳ `firstName`	string	Customer first name
↳ `lastName`	string	Customer last name
↳ `phone`	string	Customer phone number
↳ `createdAt`	string	Account creation timestamp (ISO 8601)
↳ `updatedAt`	string	Last modification timestamp (ISO 8601)
↳ `note`	string	Internal notes about the customer
↳ `tags`	array	Customer tags for categorization
↳ `amountSpent`	object	Total amount spent by customer
↳ `addresses`	array	Customer addresses
↳ `defaultAddress`	object	Customer default address
`pageInfo`	object	Pagination information
↳ `hasNextPage`	boolean	Whether there are more results after this page
↳ `hasPreviousPage`	boolean	Whether there are results before this page

`shopify_update_customer`

Input

Parameter	Type	Required	Description
`shopDomain`	string	Yes	No description
`customerId`	string	Yes	No description
`email`	string	No	No description
`firstName`	string	No	No description
`lastName`	string	No	No description
`phone`	string	No	No description
`note`	string	No	No description
`tags`	array	No	No description

Output

Parameter	Type	Description
`customer`	object	The updated customer
↳ `id`	string	Unique customer identifier (GID)
↳ `email`	string	Customer email address
↳ `firstName`	string	Customer first name
↳ `lastName`	string	Customer last name
↳ `phone`	string	Customer phone number
↳ `createdAt`	string	Account creation timestamp (ISO 8601)
↳ `updatedAt`	string	Last modification timestamp (ISO 8601)
↳ `note`	string	Internal notes about the customer
↳ `tags`	array	Customer tags for categorization
↳ `amountSpent`	object	Total amount spent by customer
↳ `addresses`	array	Customer addresses
↳ `defaultAddress`	object	Customer default address

`shopify_delete_customer`

Input

Parameter	Type	Required	Description
`shopDomain`	string	Yes	No description
`customerId`	string	Yes	No description

Output

Parameter	Type	Description
`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

Parameter	Type	Required	Description
`shopDomain`	string	Yes	No description
`first`	number	No	No description
`query`	string	No	Search query to filter inventory items (e.g., "sku:ABC123")

Output

Parameter	Type	Description
`inventoryItems`	array	List of inventory items with their IDs, SKUs, and stock levels
↳ `id`	string	Unique inventory item identifier (GID)
↳ `sku`	string	Stock keeping unit
↳ `tracked`	boolean	Whether inventory is tracked
↳ `createdAt`	string	Creation timestamp (ISO 8601)
↳ `updatedAt`	string	Last modification timestamp (ISO 8601)
↳ `variant`	object	Associated product variant
↳ `id`	string	Variant identifier (GID)
↳ `title`	string	Variant title
↳ `product`	object	Associated product
↳ `id`	string	Product identifier (GID)
↳ `title`	string	Product title
↳ `inventoryLevels`	array	Inventory levels at different locations
↳ `id`	string	Inventory level identifier (GID)
↳ `available`	number	Available quantity
↳ `location`	object	Location for this inventory level
↳ `id`	string	Location identifier (GID)
↳ `name`	string	Location name
`pageInfo`	object	Pagination information
↳ `hasNextPage`	boolean	Whether there are more results after this page
↳ `hasPreviousPage`	boolean	Whether there are results before this page

`shopify_get_inventory_level`

Input

Parameter	Type	Required	Description
`shopDomain`	string	Yes	No description
`inventoryItemId`	string	Yes	No description
`locationId`	string	No	No description

Output

Parameter	Type	Description
`inventoryLevel`	object	The inventory level details
↳ `id`	string	Inventory item identifier (GID)
↳ `sku`	string	Stock keeping unit
↳ `tracked`	boolean	Whether inventory is tracked
↳ `levels`	array	Inventory levels at different locations
↳ `id`	string	Inventory level identifier (GID)
↳ `available`	number	Available quantity
↳ `onHand`	number	On-hand quantity
↳ `committed`	number	Committed quantity
↳ `incoming`	number	Incoming quantity
↳ `reserved`	number	Reserved quantity
↳ `location`	object	Location for this inventory level
↳ `id`	string	Location identifier (GID)
↳ `name`	string	Location name

`shopify_adjust_inventory`

Input

Parameter	Type	Required	Description
`shopDomain`	string	Yes	No description
`inventoryItemId`	string	Yes	No description
`locationId`	string	Yes	No description
`delta`	number	Yes	No description

Output

Parameter	Type	Description
`inventoryLevel`	object	The inventory adjustment result
↳ `adjustmentGroup`	object	Inventory adjustment group details
↳ `createdAt`	string	Adjustment timestamp (ISO 8601)
↳ `reason`	string	Adjustment reason
↳ `changes`	array	Inventory changes applied
↳ `name`	string	Quantity name (e.g., available)
↳ `delta`	number	Quantity change amount
↳ `quantityAfterChange`	number	Quantity after adjustment
↳ `item`	object	Inventory item
↳ `id`	string	Inventory item identifier (GID)
↳ `sku`	string	Stock keeping unit
↳ `location`	object	Location of the adjustment
↳ `id`	string	Location identifier (GID)
↳ `name`	string	Location name

`shopify_list_locations`

List inventory locations from your Shopify store. Use this to find location IDs needed for inventory operations.

Input

Parameter	Type	Required	Description
`shopDomain`	string	Yes	No description
`first`	number	No	No description
`includeInactive`	boolean	No	No description

Output

Parameter	Type	Description
`locations`	array	List of locations with their IDs, names, and addresses
↳ `id`	string	Unique location identifier (GID)
↳ `name`	string	Location name
↳ `isActive`	boolean	Whether the location is active
↳ `fulfillsOnlineOrders`	boolean	Whether the location fulfills online orders
↳ `address`	object	Location address
`pageInfo`	object	Pagination information
↳ `hasNextPage`	boolean	Whether there are more results after this page
↳ `hasPreviousPage`	boolean	Whether there are results before this page

`shopify_create_fulfillment`

Create a fulfillment to mark order items as shipped. Requires a fulfillment order ID (get this from the order details).

Input

Parameter	Type	Required	Description
`shopDomain`	string	Yes	No description
`fulfillmentOrderId`	string	Yes	No description
`trackingNumber`	string	No	No description
`trackingCompany`	string	No	No description
`trackingUrl`	string	No	No description
`notifyCustomer`	boolean	No	No description

Output

Parameter	Type	Description
`fulfillment`	object	The created fulfillment with tracking info and fulfilled items
↳ `id`	string	Unique fulfillment identifier (GID)
↳ `status`	string	Fulfillment status (pending, open, success, cancelled, error, failure)
↳ `createdAt`	string	Creation timestamp (ISO 8601)
↳ `updatedAt`	string	Last modification timestamp (ISO 8601)
↳ `trackingInfo`	array	Tracking information for shipments
↳ `fulfillmentLineItems`	array	Fulfilled line items
↳ `id`	string	Fulfillment line item identifier (GID)
↳ `quantity`	number	Quantity fulfilled
↳ `lineItem`	object	Associated order line item
↳ `title`	string	Product title

`shopify_list_collections`

List product collections from your Shopify store. Filter by title, type (custom/smart), or handle.

Input

Parameter	Type	Required	Description
`shopDomain`	string	Yes	No description
`first`	number	No	No description
`query`	string	No	Search query to filter collections (e.g., "title:Summer" or "collection_type:smart")

Output

Parameter	Type	Description
`collections`	array	List of collections with their IDs, titles, and product counts
↳ `id`	string	Unique collection identifier (GID)
↳ `title`	string	Collection title
↳ `handle`	string	URL-friendly collection identifier
↳ `description`	string	Plain text description
↳ `descriptionHtml`	string	HTML-formatted description
↳ `productsCount`	number	Number of products in the collection
↳ `sortOrder`	string	Product sort order in the collection
↳ `updatedAt`	string	Last modification timestamp (ISO 8601)
↳ `image`	object	Collection image
`pageInfo`	object	Pagination information
↳ `hasNextPage`	boolean	Whether there are more results after this page
↳ `hasPreviousPage`	boolean	Whether there are results before this page

`shopify_get_collection`

Get a specific collection by ID, including its products. Use this to retrieve products within a collection.

Input

Parameter	Type	Required	Description
`shopDomain`	string	Yes	No description
`collectionId`	string	Yes	No description
`productsFirst`	number	No	No description

Output

Parameter	Type	Description
`collection`	object	The collection details including its products
↳ `id`	string	Unique collection identifier (GID)
↳ `title`	string	Collection title
↳ `handle`	string	URL-friendly collection identifier
↳ `description`	string	Plain text description
↳ `descriptionHtml`	string	HTML-formatted description
↳ `productsCount`	number	Number of products in the collection
↳ `sortOrder`	string	Product sort order in the collection
↳ `updatedAt`	string	Last modification timestamp (ISO 8601)
↳ `image`	object	Collection image
↳ `products`	array	Products in the collection

Sharepoint Similarweb

On this page

Start building today

Trusted by over 100,000 builders.

The SaaS platform to build AI agents and run your agentic workforce.