AptlyStar

Shopify

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

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 Aptlystar, 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 Aptlystar'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

ParameterTypeRequiredDescription
shopDomainstringYesYour Shopify store domain (e.g., mystore.myshopify.com)
titlestringYesProduct title
descriptionHtmlstringNoProduct description (HTML)
vendorstringNoProduct vendor/brand
productTypestringNoProduct type/category
tagsarrayNoProduct tags
statusstringNoProduct status (ACTIVE, DRAFT, ARCHIVED)

Output

ParameterTypeDescription
productobjectThe created product
↳ idstringUnique product identifier (GID)
↳ titlestringProduct title
↳ handlestringURL-friendly product identifier
↳ descriptionHtmlstringProduct description in HTML format
↳ vendorstringProduct vendor or manufacturer
↳ productTypestringProduct type classification
↳ tagsarrayProduct tags for categorization
↳ statusstringProduct status (ACTIVE, DRAFT, ARCHIVED)
↳ createdAtstringCreation timestamp (ISO 8601)
↳ updatedAtstringLast modification timestamp (ISO 8601)
↳ variantsobjectProduct variants with edges/nodes structure
↳ imagesobjectProduct images with edges/nodes structure

shopify_get_product

Get a single product by ID from your Shopify store

Input

ParameterTypeRequiredDescription
shopDomainstringYesYour Shopify store domain (e.g., mystore.myshopify.com)
productIdstringYesProduct ID (gid://shopify/Product/123456789)

Output

ParameterTypeDescription
productobjectThe product details
↳ idstringUnique product identifier (GID)
↳ titlestringProduct title
↳ handlestringURL-friendly product identifier
↳ descriptionHtmlstringProduct description in HTML format
↳ vendorstringProduct vendor or manufacturer
↳ productTypestringProduct type classification
↳ tagsarrayProduct tags for categorization
↳ statusstringProduct status (ACTIVE, DRAFT, ARCHIVED)
↳ createdAtstringCreation timestamp (ISO 8601)
↳ updatedAtstringLast modification timestamp (ISO 8601)
↳ variantsobjectProduct variants with edges/nodes structure
↳ imagesobjectProduct images with edges/nodes structure

shopify_list_products

List products from your Shopify store with optional filtering

Input

ParameterTypeRequiredDescription
shopDomainstringYesYour Shopify store domain (e.g., mystore.myshopify.com)
firstnumberNoNumber of products to return (default: 50, max: 250)
querystringNoSearch query to filter products (e.g., "title:shirt" or "vendor:Nike" or "status:active")

Output

ParameterTypeDescription
productsarrayList of products
↳ idstringUnique product identifier (GID)
↳ titlestringProduct title
↳ handlestringURL-friendly product identifier
↳ descriptionHtmlstringProduct description in HTML format
↳ vendorstringProduct vendor or manufacturer
↳ productTypestringProduct type classification
↳ tagsarrayProduct tags for categorization
↳ statusstringProduct status (ACTIVE, DRAFT, ARCHIVED)
↳ createdAtstringCreation timestamp (ISO 8601)
↳ updatedAtstringLast modification timestamp (ISO 8601)
↳ variantsobjectProduct variants with edges/nodes structure
↳ imagesobjectProduct images with edges/nodes structure
pageInfoobjectPagination information
↳ hasNextPagebooleanWhether there are more results after this page
↳ hasPreviousPagebooleanWhether there are results before this page

shopify_update_product

Update an existing product in your Shopify store

Input

ParameterTypeRequiredDescription
shopDomainstringYesYour Shopify store domain (e.g., mystore.myshopify.com)
productIdstringYesProduct ID to update (gid://shopify/Product/123456789)
titlestringNoNew product title
descriptionHtmlstringNoNew product description (HTML)
vendorstringNoNew product vendor/brand
productTypestringNoNew product type/category
tagsarrayNoNew product tags
statusstringNoNew product status (ACTIVE, DRAFT, ARCHIVED)

Output

ParameterTypeDescription
productobjectThe updated product
↳ idstringUnique product identifier (GID)
↳ titlestringProduct title
↳ handlestringURL-friendly product identifier
↳ descriptionHtmlstringProduct description in HTML format
↳ vendorstringProduct vendor or manufacturer
↳ productTypestringProduct type classification
↳ tagsarrayProduct tags for categorization
↳ statusstringProduct status (ACTIVE, DRAFT, ARCHIVED)
↳ createdAtstringCreation timestamp (ISO 8601)
↳ updatedAtstringLast modification timestamp (ISO 8601)
↳ variantsobjectProduct variants with edges/nodes structure
↳ imagesobjectProduct images with edges/nodes structure

shopify_delete_product

Delete a product from your Shopify store

Input

ParameterTypeRequiredDescription
shopDomainstringYesYour Shopify store domain (e.g., mystore.myshopify.com)
productIdstringYesProduct ID to delete (gid://shopify/Product/123456789)

Output

ParameterTypeDescription
deletedIdstringThe ID of the deleted product

shopify_get_order

Get a single order by ID from your Shopify store

Input

ParameterTypeRequiredDescription
shopDomainstringYesYour Shopify store domain (e.g., mystore.myshopify.com)
orderIdstringYesOrder ID (gid://shopify/Order/123456789)

Output

ParameterTypeDescription
orderobjectThe order details
↳ idstringUnique order identifier (GID)
↳ namestringOrder name (e.g., #1001)
↳ emailstringCustomer email for the order
↳ phonestringCustomer phone for the order
↳ createdAtstringOrder creation timestamp (ISO 8601)
↳ updatedAtstringLast modification timestamp (ISO 8601)
↳ cancelledAtstringCancellation timestamp (ISO 8601)
↳ closedAtstringClosure timestamp (ISO 8601)
↳ displayFinancialStatusstringFinancial status (PENDING, AUTHORIZED, PARTIALLY_PAID, PAID, PARTIALLY_REFUNDED, REFUNDED, VOIDED)
↳ displayFulfillmentStatusstringFulfillment status (UNFULFILLED, PARTIALLY_FULFILLED, FULFILLED, RESTOCKED, PENDING_FULFILLMENT, OPEN, IN_PROGRESS, ON_HOLD, SCHEDULED)
↳ totalPriceSetobjectTotal order price
↳ subtotalPriceSetobjectOrder subtotal (before shipping and taxes)
↳ totalTaxSetobjectTotal tax amount
↳ totalShippingPriceSetobjectTotal shipping price
↳ notestringOrder note
↳ tagsarrayOrder tags
↳ customerobjectCustomer who placed the order
↳ lineItemsobjectOrder line items with edges/nodes structure
↳ shippingAddressobjectShipping address
↳ billingAddressobjectBilling address
↳ fulfillmentsarrayOrder fulfillments

shopify_list_orders

List orders from your Shopify store with optional filtering

Input

ParameterTypeRequiredDescription
shopDomainstringYesYour Shopify store domain (e.g., mystore.myshopify.com)
firstnumberNoNumber of orders to return (default: 50, max: 250)
statusstringNoFilter by order status (open, closed, cancelled, any)
querystringNoSearch query to filter orders (e.g., "financial_status:paid" or "fulfillment_status:unfulfilled" or "email:customer@example.com")

Output

ParameterTypeDescription
ordersarrayList of orders
↳ idstringUnique order identifier (GID)
↳ namestringOrder name (e.g., #1001)
↳ emailstringCustomer email for the order
↳ phonestringCustomer phone for the order
↳ createdAtstringOrder creation timestamp (ISO 8601)
↳ updatedAtstringLast modification timestamp (ISO 8601)
↳ cancelledAtstringCancellation timestamp (ISO 8601)
↳ closedAtstringClosure timestamp (ISO 8601)
↳ displayFinancialStatusstringFinancial status (PENDING, AUTHORIZED, PARTIALLY_PAID, PAID, PARTIALLY_REFUNDED, REFUNDED, VOIDED)
↳ displayFulfillmentStatusstringFulfillment status (UNFULFILLED, PARTIALLY_FULFILLED, FULFILLED, RESTOCKED, PENDING_FULFILLMENT, OPEN, IN_PROGRESS, ON_HOLD, SCHEDULED)
↳ totalPriceSetobjectTotal order price
↳ subtotalPriceSetobjectOrder subtotal (before shipping and taxes)
↳ totalTaxSetobjectTotal tax amount
↳ totalShippingPriceSetobjectTotal shipping price
↳ notestringOrder note
↳ tagsarrayOrder tags
↳ customerobjectCustomer who placed the order
↳ lineItemsobjectOrder line items with edges/nodes structure
↳ shippingAddressobjectShipping address
↳ billingAddressobjectBilling address
↳ fulfillmentsarrayOrder fulfillments
pageInfoobjectPagination information
↳ hasNextPagebooleanWhether there are more results after this page
↳ hasPreviousPagebooleanWhether there are results before this page

shopify_update_order

Update an existing order in your Shopify store (note, tags, email)

Input

ParameterTypeRequiredDescription
shopDomainstringYesYour Shopify store domain (e.g., mystore.myshopify.com)
orderIdstringYesOrder ID to update (gid://shopify/Order/123456789)
notestringNoNew order note
tagsarrayNoNew order tags
emailstringNoNew customer email for the order

Output

ParameterTypeDescription
orderobjectThe updated order
↳ idstringUnique order identifier (GID)
↳ namestringOrder name (e.g., #1001)
↳ emailstringCustomer email for the order
↳ phonestringCustomer phone for the order
↳ createdAtstringOrder creation timestamp (ISO 8601)
↳ updatedAtstringLast modification timestamp (ISO 8601)
↳ cancelledAtstringCancellation timestamp (ISO 8601)
↳ closedAtstringClosure timestamp (ISO 8601)
↳ displayFinancialStatusstringFinancial status (PENDING, AUTHORIZED, PARTIALLY_PAID, PAID, PARTIALLY_REFUNDED, REFUNDED, VOIDED)
↳ displayFulfillmentStatusstringFulfillment status (UNFULFILLED, PARTIALLY_FULFILLED, FULFILLED, RESTOCKED, PENDING_FULFILLMENT, OPEN, IN_PROGRESS, ON_HOLD, SCHEDULED)
↳ totalPriceSetobjectTotal order price
↳ subtotalPriceSetobjectOrder subtotal (before shipping and taxes)
↳ totalTaxSetobjectTotal tax amount
↳ totalShippingPriceSetobjectTotal shipping price
↳ notestringOrder note
↳ tagsarrayOrder tags
↳ customerobjectCustomer who placed the order
↳ lineItemsobjectOrder line items with edges/nodes structure
↳ shippingAddressobjectShipping address
↳ billingAddressobjectBilling address
↳ fulfillmentsarrayOrder fulfillments

shopify_cancel_order

Cancel an order in your Shopify store

Input

ParameterTypeRequiredDescription
shopDomainstringYesYour Shopify store domain (e.g., mystore.myshopify.com)
orderIdstringYesOrder ID to cancel (gid://shopify/Order/123456789)
reasonstringYesCancellation reason (CUSTOMER, DECLINED, FRAUD, INVENTORY, STAFF, OTHER)
notifyCustomerbooleanNoWhether to notify the customer about the cancellation
restockbooleanYesWhether to restock the inventory committed to the order
refundMethodjsonNoOptional refund method object, for example {"originalPaymentMethodsRefund": true}
staffNotestringNoA note about the cancellation for staff reference

Output

ParameterTypeDescription
orderobjectThe cancellation result
↳ idstringJob identifier for the cancellation
↳ cancelledbooleanWhether the cancellation completed
↳ messagestringStatus message

shopify_create_customer

Create a new customer in your Shopify store

Input

ParameterTypeRequiredDescription
shopDomainstringYesYour Shopify store domain (e.g., mystore.myshopify.com)
emailstringNoCustomer email address
firstNamestringNoCustomer first name
lastNamestringNoCustomer last name
phonestringNoCustomer phone number
notestringNoNote about the customer
tagsarrayNoCustomer tags
addressesarrayNoCustomer addresses

Output

ParameterTypeDescription
customerobjectThe created customer
↳ idstringUnique customer identifier (GID)
↳ emailstringCustomer email address
↳ firstNamestringCustomer first name
↳ lastNamestringCustomer last name
↳ phonestringCustomer phone number
↳ createdAtstringAccount creation timestamp (ISO 8601)
↳ updatedAtstringLast modification timestamp (ISO 8601)
↳ notestringInternal notes about the customer
↳ tagsarrayCustomer tags for categorization
↳ amountSpentobjectTotal amount spent by customer
↳ addressesarrayCustomer addresses
↳ defaultAddressobjectCustomer default address

shopify_get_customer

Get a single customer by ID from your Shopify store

Input

ParameterTypeRequiredDescription
shopDomainstringYesYour Shopify store domain (e.g., mystore.myshopify.com)
customerIdstringYesCustomer ID (gid://shopify/Customer/123456789)

Output

ParameterTypeDescription
customerobjectThe customer details
↳ idstringUnique customer identifier (GID)
↳ emailstringCustomer email address
↳ firstNamestringCustomer first name
↳ lastNamestringCustomer last name
↳ phonestringCustomer phone number
↳ createdAtstringAccount creation timestamp (ISO 8601)
↳ updatedAtstringLast modification timestamp (ISO 8601)
↳ notestringInternal notes about the customer
↳ tagsarrayCustomer tags for categorization
↳ amountSpentobjectTotal amount spent by customer
↳ addressesarrayCustomer addresses
↳ defaultAddressobjectCustomer default address

shopify_list_customers

List customers from your Shopify store with optional filtering

Input

ParameterTypeRequiredDescription
shopDomainstringYesYour Shopify store domain (e.g., mystore.myshopify.com)
firstnumberNoNumber of customers to return (default: 50, max: 250)
querystringNoSearch query to filter customers (e.g., "first_name:John" or "last_name:Smith" or "email:*@gmail.com" or "tag:vip")

Output

ParameterTypeDescription
customersarrayList of customers
↳ idstringUnique customer identifier (GID)
↳ emailstringCustomer email address
↳ firstNamestringCustomer first name
↳ lastNamestringCustomer last name
↳ phonestringCustomer phone number
↳ createdAtstringAccount creation timestamp (ISO 8601)
↳ updatedAtstringLast modification timestamp (ISO 8601)
↳ notestringInternal notes about the customer
↳ tagsarrayCustomer tags for categorization
↳ amountSpentobjectTotal amount spent by customer
↳ addressesarrayCustomer addresses
↳ defaultAddressobjectCustomer default address
pageInfoobjectPagination information
↳ hasNextPagebooleanWhether there are more results after this page
↳ hasPreviousPagebooleanWhether there are results before this page

shopify_update_customer

Update an existing customer in your Shopify store

Input

ParameterTypeRequiredDescription
shopDomainstringYesYour Shopify store domain (e.g., mystore.myshopify.com)
customerIdstringYesCustomer ID to update (gid://shopify/Customer/123456789)
emailstringNoNew customer email address
firstNamestringNoNew customer first name
lastNamestringNoNew customer last name
phonestringNoNew customer phone number
notestringNoNew note about the customer
tagsarrayNoNew customer tags

Output

ParameterTypeDescription
customerobjectThe updated customer
↳ idstringUnique customer identifier (GID)
↳ emailstringCustomer email address
↳ firstNamestringCustomer first name
↳ lastNamestringCustomer last name
↳ phonestringCustomer phone number
↳ createdAtstringAccount creation timestamp (ISO 8601)
↳ updatedAtstringLast modification timestamp (ISO 8601)
↳ notestringInternal notes about the customer
↳ tagsarrayCustomer tags for categorization
↳ amountSpentobjectTotal amount spent by customer
↳ addressesarrayCustomer addresses
↳ defaultAddressobjectCustomer default address

shopify_delete_customer

Delete a customer from your Shopify store

Input

ParameterTypeRequiredDescription
shopDomainstringYesYour Shopify store domain (e.g., mystore.myshopify.com)
customerIdstringYesCustomer ID to delete (gid://shopify/Customer/123456789)

Output

ParameterTypeDescription
deletedIdstringThe 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

ParameterTypeRequiredDescription
shopDomainstringYesYour Shopify store domain (e.g., mystore.myshopify.com)
firstnumberNoNumber of inventory items to return (default: 50, max: 250)
querystringNoSearch query to filter inventory items (e.g., "sku:ABC123")

Output

ParameterTypeDescription
inventoryItemsarrayList of inventory items with their IDs, SKUs, and stock levels
↳ idstringUnique inventory item identifier (GID)
↳ skustringStock keeping unit
↳ trackedbooleanWhether inventory is tracked
↳ createdAtstringCreation timestamp (ISO 8601)
↳ updatedAtstringLast modification timestamp (ISO 8601)
↳ variantobjectAssociated product variant
↳ idstringVariant identifier (GID)
↳ titlestringVariant title
↳ productobjectAssociated product
↳ idstringProduct identifier (GID)
↳ titlestringProduct title
↳ inventoryLevelsarrayInventory levels at different locations
↳ idstringInventory level identifier (GID)
↳ availablenumberAvailable quantity
↳ locationobjectLocation for this inventory level
↳ idstringLocation identifier (GID)
↳ namestringLocation name
pageInfoobjectPagination information
↳ hasNextPagebooleanWhether there are more results after this page
↳ hasPreviousPagebooleanWhether there are results before this page

shopify_get_inventory_level

Get inventory level for a product variant at a specific location

Input

ParameterTypeRequiredDescription
shopDomainstringYesYour Shopify store domain (e.g., mystore.myshopify.com)
inventoryItemIdstringYesInventory item ID (gid://shopify/InventoryItem/123456789)
locationIdstringNoLocation ID to filter by (optional)

Output

ParameterTypeDescription
inventoryLevelobjectThe inventory level details
↳ idstringInventory item identifier (GID)
↳ skustringStock keeping unit
↳ trackedbooleanWhether inventory is tracked
↳ levelsarrayInventory levels at different locations
↳ idstringInventory level identifier (GID)
↳ availablenumberAvailable quantity
↳ onHandnumberOn-hand quantity
↳ committednumberCommitted quantity
↳ incomingnumberIncoming quantity
↳ reservednumberReserved quantity
↳ locationobjectLocation for this inventory level
↳ idstringLocation identifier (GID)
↳ namestringLocation name

shopify_adjust_inventory

Adjust inventory quantity for a product variant at a specific location

Input

ParameterTypeRequiredDescription
shopDomainstringYesYour Shopify store domain (e.g., mystore.myshopify.com)
inventoryItemIdstringYesInventory item ID (gid://shopify/InventoryItem/123456789)
locationIdstringYesLocation ID (gid://shopify/Location/123456789)
deltanumberYesAmount to adjust (positive to increase, negative to decrease)

Output

ParameterTypeDescription
inventoryLevelobjectThe inventory adjustment result
↳ adjustmentGroupobjectInventory adjustment group details
↳ createdAtstringAdjustment timestamp (ISO 8601)
↳ reasonstringAdjustment reason
↳ changesarrayInventory changes applied
↳ namestringQuantity name (e.g., available)
↳ deltanumberQuantity change amount
↳ quantityAfterChangenumberQuantity after adjustment
↳ itemobjectInventory item
↳ idstringInventory item identifier (GID)
↳ skustringStock keeping unit
↳ locationobjectLocation of the adjustment
↳ idstringLocation identifier (GID)
↳ namestringLocation name

shopify_list_locations

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

Input

ParameterTypeRequiredDescription
shopDomainstringYesYour Shopify store domain (e.g., mystore.myshopify.com)
firstnumberNoNumber of locations to return (default: 50, max: 250)
includeInactivebooleanNoWhether to include deactivated locations (default: false)

Output

ParameterTypeDescription
locationsarrayList of locations with their IDs, names, and addresses
↳ idstringUnique location identifier (GID)
↳ namestringLocation name
↳ isActivebooleanWhether the location is active
↳ fulfillsOnlineOrdersbooleanWhether the location fulfills online orders
↳ addressobjectLocation address
pageInfoobjectPagination information
↳ hasNextPagebooleanWhether there are more results after this page
↳ hasPreviousPagebooleanWhether 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

ParameterTypeRequiredDescription
shopDomainstringYesYour Shopify store domain (e.g., mystore.myshopify.com)
fulfillmentOrderIdstringYesThe fulfillment order ID (e.g., gid://shopify/FulfillmentOrder/123456789)
trackingNumberstringNoTracking number for the shipment
trackingCompanystringNoShipping carrier name (e.g., UPS, FedEx, USPS, DHL)
trackingUrlstringNoURL to track the shipment
notifyCustomerbooleanNoWhether to send a shipping confirmation email to the customer (default: true)

Output

ParameterTypeDescription
fulfillmentobjectThe created fulfillment with tracking info and fulfilled items
↳ idstringUnique fulfillment identifier (GID)
↳ statusstringFulfillment status (pending, open, success, cancelled, error, failure)
↳ createdAtstringCreation timestamp (ISO 8601)
↳ updatedAtstringLast modification timestamp (ISO 8601)
↳ trackingInfoarrayTracking information for shipments
↳ fulfillmentLineItemsarrayFulfilled line items
↳ idstringFulfillment line item identifier (GID)
↳ quantitynumberQuantity fulfilled
↳ lineItemobjectAssociated order line item
↳ titlestringProduct title

shopify_list_collections

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

Input

ParameterTypeRequiredDescription
shopDomainstringYesYour Shopify store domain (e.g., mystore.myshopify.com)
firstnumberNoNumber of collections to return (default: 50, max: 250)
querystringNoSearch query to filter collections (e.g., "title:Summer" or "collection_type:smart")

Output

ParameterTypeDescription
collectionsarrayList of collections with their IDs, titles, and product counts
↳ idstringUnique collection identifier (GID)
↳ titlestringCollection title
↳ handlestringURL-friendly collection identifier
↳ descriptionstringPlain text description
↳ descriptionHtmlstringHTML-formatted description
↳ productsCountnumberNumber of products in the collection
↳ sortOrderstringProduct sort order in the collection
↳ updatedAtstringLast modification timestamp (ISO 8601)
↳ imageobjectCollection image
pageInfoobjectPagination information
↳ hasNextPagebooleanWhether there are more results after this page
↳ hasPreviousPagebooleanWhether 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

ParameterTypeRequiredDescription
shopDomainstringYesYour Shopify store domain (e.g., mystore.myshopify.com)
collectionIdstringYesThe collection ID (e.g., gid://shopify/Collection/123456789)
productsFirstnumberNoNumber of products to return from this collection (default: 50, max: 250)

Output

ParameterTypeDescription
collectionobjectThe collection details including its products
↳ idstringUnique collection identifier (GID)
↳ titlestringCollection title
↳ handlestringURL-friendly collection identifier
↳ descriptionstringPlain text description
↳ descriptionHtmlstringHTML-formatted description
↳ productsCountnumberNumber of products in the collection
↳ sortOrderstringProduct sort order in the collection
↳ updatedAtstringLast modification timestamp (ISO 8601)
↳ imageobjectCollection image
↳ productsarrayProducts in the collection

On this page