Shopify

Use Shopify to manage products, orders, customers, inventory, and fulfillments. The reference below covers location and collection lookups as well as store mutations.

Connection guides: Admin API tokens.

OAuth scopes

Sim requests these scopes when someone connects a Shopify account. For a self-hosted deployment, register your own app with the provider using the settings below. See Integrations and OAuth for setup.

Use the block

Manage Shopify products and variants, orders, customers, inventory, collections, and merchant-managed fulfillment using Admin GraphQL API 2026-10. Discover fulfillment orders, ship selected items, update tracking, and check cancellation jobs. Continue list and nested results with the returned cursors. Product activation does not publish to sales channels. Orders normally cover the last 60 days; older orders and protected customer fields require Shopify approval and access. Expanded list details are optional and use smaller pages to stay within query-cost limits. Expanded order-update responses are opt-in and require product, protected-address, and fulfillment access.

Actions

Shopify Create Product

Create a new product in your Shopify store

Inputs and outputs

Input

Parameter	Type	Required	Description
handle	string	No	URL-friendly product handle
seo	json	No	SEOInput object with title and description
category	string	No	Product taxonomy category GID
templateSuffix	string	No	Theme template suffix
metafields	array	No	MetafieldInput array: namespace, key, type, value, or id
collectionsToJoin	array	No	Collection GIDs to add the product to
requiresSellingPlan	boolean	No	Whether a selling plan is required to purchase the product
productOptions	array	No	OptionCreateInput array with name and values: [{name: "Size", values: [{name: "Small"}]}]
media	array	No	CreateMediaInput array with originalSource, mediaContentType, and optional alt
shopDomain	string	No	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, UNLISTED)

Output

Parameter	Type	Description
product	object	The created product
↳ templateSuffix	string	Theme template suffix
↳ requiresSellingPlan	boolean	Whether purchasing requires a selling plan
↳ category	object	Product taxonomy category
↳ id	string	Taxonomy category GID
↳ fullName	string	Category path
↳ id	string	Unique product identifier (GID)
↳ title	string	Product title
↳ handle	string	URL-friendly product identifier
↳ seo	object	Search engine listing
↳ title	string	SEO title
↳ description	string	SEO description
↳ onlineStoreUrl	string	Online store URL, null when not published
↳ options	array	Product options
↳ id	string	Option GID
↳ name	string	Option name
↳ position	number	Option position
↳ values	array	Option values
↳ 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, UNLISTED)
↳ createdAt	string	Creation timestamp (ISO 8601)
↳ updatedAt	string	Last modification timestamp (ISO 8601)
↳ variants	object	Product variants page; use Get Product with variantsAfter for subsequent pages
↳ pageInfo	object	Variant pagination
↳ startCursor	string	Cursor at the start of this page
↳ endCursor	string	Cursor to pass as after for the next page
↳ hasNextPage	boolean	Whether there are more results after this page
↳ hasPreviousPage	boolean	Whether there are results before this page
↳ edges	array	Array of variant edges
↳ node	object	Variant node
↳ id	string	Unique variant identifier (GID)
↳ title	string	Variant title
↳ price	string	Variant price
↳ barcode	string	Variant barcode
↳ taxable	boolean	Whether the variant is taxable
↳ inventoryPolicy	string	Inventory policy (DENY or CONTINUE)
↳ inventoryItem	object	Inventory item for stock operations
↳ id	string	Inventory item GID
↳ sku	string	SKU
↳ tracked	boolean	Whether stock is tracked
↳ selectedOptions	array	Selected product options
↳ name	string	Option name
↳ value	string	Selected value
↳ compareAtPrice	string	Compare at price
↳ sku	string	Stock keeping unit
↳ inventoryQuantity	number	Available inventory quantity
↳ images	object	Product images page; use Get Product with imagesAfter for subsequent pages
↳ pageInfo	object	Image pagination
↳ startCursor	string	Cursor at the start of this page
↳ endCursor	string	Cursor to pass as after for the next page
↳ hasNextPage	boolean	Whether there are more results after this page
↳ hasPreviousPage	boolean	Whether there are results before this page
↳ edges	array	Array of image edges
↳ node	object	Image node
↳ id	string	Unique image identifier (GID)
↳ url	string	Image URL
↳ altText	string	Alternative text for accessibility

Shopify Get Product

Get a single product by ID from your Shopify store

Inputs and outputs

Input

Parameter	Type	Required	Description
variantsFirst	number	No	Maximum variants in this page (default 50, max 100)
variantsAfter	string	No	Cursor from variants.pageInfo.endCursor for the next page
imagesFirst	number	No	Maximum images in this page (default 20, max 100)
imagesAfter	string	No	Cursor from images.pageInfo.endCursor for the next page
shopDomain	string	No	Your Shopify store domain (e.g., mystore.myshopify.com)
productId	string	Yes	Product ID (gid://shopify/Product/123456789)

Output

Parameter	Type	Description
product	object	The product details
↳ templateSuffix	string	Theme template suffix
↳ requiresSellingPlan	boolean	Whether purchasing requires a selling plan
↳ category	object	Product taxonomy category
↳ id	string	Taxonomy category GID
↳ fullName	string	Category path
↳ id	string	Unique product identifier (GID)
↳ title	string	Product title
↳ handle	string	URL-friendly product identifier
↳ seo	object	Search engine listing
↳ title	string	SEO title
↳ description	string	SEO description
↳ onlineStoreUrl	string	Online store URL, null when not published
↳ options	array	Product options
↳ id	string	Option GID
↳ name	string	Option name
↳ position	number	Option position
↳ values	array	Option values
↳ 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, UNLISTED)
↳ createdAt	string	Creation timestamp (ISO 8601)
↳ updatedAt	string	Last modification timestamp (ISO 8601)
↳ variants	object	Product variants page; use Get Product with variantsAfter for subsequent pages
↳ pageInfo	object	Variant pagination
↳ startCursor	string	Cursor at the start of this page
↳ endCursor	string	Cursor to pass as after for the next page
↳ hasNextPage	boolean	Whether there are more results after this page
↳ hasPreviousPage	boolean	Whether there are results before this page
↳ edges	array	Array of variant edges
↳ node	object	Variant node
↳ id	string	Unique variant identifier (GID)
↳ title	string	Variant title
↳ price	string	Variant price
↳ barcode	string	Variant barcode
↳ taxable	boolean	Whether the variant is taxable
↳ inventoryPolicy	string	Inventory policy (DENY or CONTINUE)
↳ inventoryItem	object	Inventory item for stock operations
↳ id	string	Inventory item GID
↳ sku	string	SKU
↳ tracked	boolean	Whether stock is tracked
↳ selectedOptions	array	Selected product options
↳ name	string	Option name
↳ value	string	Selected value
↳ compareAtPrice	string	Compare at price
↳ sku	string	Stock keeping unit
↳ inventoryQuantity	number	Available inventory quantity
↳ images	object	Product images page; use Get Product with imagesAfter for subsequent pages
↳ pageInfo	object	Image pagination
↳ startCursor	string	Cursor at the start of this page
↳ endCursor	string	Cursor to pass as after for the next page
↳ hasNextPage	boolean	Whether there are more results after this page
↳ hasPreviousPage	boolean	Whether there are results before this page
↳ edges	array	Array of image edges
↳ node	object	Image node
↳ id	string	Unique image identifier (GID)
↳ url	string	Image URL
↳ altText	string	Alternative text for accessibility

Shopify List Products

List products from your Shopify store with optional filtering

Inputs and outputs

Input

Parameter	Type	Required	Description
includeDetails	boolean	No	Include expanded nested details; uses a smaller page limit to stay within Shopify query costs
reverse	boolean	No	Reverse the result sort order (default false)
sortKey	string	No	Sort results by CREATED_AT, ID, INVENTORY_TOTAL, PRODUCT_TYPE, PUBLISHED_AT, RELEVANCE, TITLE, UPDATED_AT, VENDOR (default Shopify ordering)
shopDomain	string	No	Your Shopify store domain (e.g., mystore.myshopify.com)
after	string	No	Cursor from pageInfo.endCursor to retrieve the next page
first	number	No	Number of products to return (default: 50, max: 250; with includeDetails: default/max 20)
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
↳ templateSuffix	string	Theme template suffix
↳ requiresSellingPlan	boolean	Whether purchasing requires a selling plan
↳ category	object	Product taxonomy category
↳ id	string	Taxonomy category GID
↳ fullName	string	Category path
↳ id	string	Unique product identifier (GID)
↳ title	string	Product title
↳ handle	string	URL-friendly product identifier
↳ seo	object	Search engine listing
↳ title	string	SEO title
↳ description	string	SEO description
↳ onlineStoreUrl	string	Online store URL, null when not published
↳ options	array	Product options
↳ id	string	Option GID
↳ name	string	Option name
↳ position	number	Option position
↳ values	array	Option values
↳ 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, UNLISTED)
↳ createdAt	string	Creation timestamp (ISO 8601)
↳ updatedAt	string	Last modification timestamp (ISO 8601)
↳ variants	object	Product variants page; use Get Product with variantsAfter for subsequent pages
↳ pageInfo	object	Variant pagination
↳ startCursor	string	Cursor at the start of this page
↳ endCursor	string	Cursor to pass as after for the next page
↳ hasNextPage	boolean	Whether there are more results after this page
↳ hasPreviousPage	boolean	Whether there are results before this page
↳ edges	array	Array of variant edges
↳ node	object	Variant node
↳ id	string	Unique variant identifier (GID)
↳ title	string	Variant title
↳ price	string	Variant price
↳ barcode	string	Variant barcode
↳ taxable	boolean	Whether the variant is taxable
↳ inventoryPolicy	string	Inventory policy (DENY or CONTINUE)
↳ inventoryItem	object	Inventory item for stock operations
↳ id	string	Inventory item GID
↳ sku	string	SKU
↳ tracked	boolean	Whether stock is tracked
↳ selectedOptions	array	Selected product options
↳ name	string	Option name
↳ value	string	Selected value
↳ compareAtPrice	string	Compare at price
↳ sku	string	Stock keeping unit
↳ inventoryQuantity	number	Available inventory quantity
↳ images	object	Product images page; use Get Product with imagesAfter for subsequent pages
↳ pageInfo	object	Image pagination
↳ startCursor	string	Cursor at the start of this page
↳ endCursor	string	Cursor to pass as after for the next page
↳ hasNextPage	boolean	Whether there are more results after this page
↳ hasPreviousPage	boolean	Whether there are results before this page
↳ edges	array	Array of image edges
↳ node	object	Image node
↳ id	string	Unique image identifier (GID)
↳ url	string	Image URL
↳ altText	string	Alternative text for accessibility
pageInfo	object	Pagination information
↳ startCursor	string	Cursor at the start of this page
↳ endCursor	string	Cursor to pass as after for the next page
↳ hasNextPage	boolean	Whether there are more results after this page
↳ hasPreviousPage	boolean	Whether there are results before this page

Shopify Update Product

Update an existing product in your Shopify store

Inputs and outputs

Input

Parameter	Type	Required	Description
handle	string	No	URL-friendly product handle
seo	json	No	SEOInput object with title and description
category	string	No	Product taxonomy category GID
templateSuffix	string	No	Theme template suffix
metafields	array	No	MetafieldInput array: namespace, key, type, value, or id
collectionsToJoin	array	No	Collection GIDs to add the product to
requiresSellingPlan	boolean	No	Whether a selling plan is required to purchase the product
collectionsToLeave	array	No	Collection GIDs to remove the product from
redirectNewHandle	boolean	No	Create a redirect when changing the handle
media	array	No	CreateMediaInput array with originalSource, mediaContentType, and optional alt
shopDomain	string	No	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, UNLISTED)

Output

Parameter	Type	Description
product	object	The updated product
↳ templateSuffix	string	Theme template suffix
↳ requiresSellingPlan	boolean	Whether purchasing requires a selling plan
↳ category	object	Product taxonomy category
↳ id	string	Taxonomy category GID
↳ fullName	string	Category path
↳ id	string	Unique product identifier (GID)
↳ title	string	Product title
↳ handle	string	URL-friendly product identifier
↳ seo	object	Search engine listing
↳ title	string	SEO title
↳ description	string	SEO description
↳ onlineStoreUrl	string	Online store URL, null when not published
↳ options	array	Product options
↳ id	string	Option GID
↳ name	string	Option name
↳ position	number	Option position
↳ values	array	Option values
↳ 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, UNLISTED)
↳ createdAt	string	Creation timestamp (ISO 8601)
↳ updatedAt	string	Last modification timestamp (ISO 8601)
↳ variants	object	Product variants page; use Get Product with variantsAfter for subsequent pages
↳ pageInfo	object	Variant pagination
↳ startCursor	string	Cursor at the start of this page
↳ endCursor	string	Cursor to pass as after for the next page
↳ hasNextPage	boolean	Whether there are more results after this page
↳ hasPreviousPage	boolean	Whether there are results before this page
↳ edges	array	Array of variant edges
↳ node	object	Variant node
↳ id	string	Unique variant identifier (GID)
↳ title	string	Variant title
↳ price	string	Variant price
↳ barcode	string	Variant barcode
↳ taxable	boolean	Whether the variant is taxable
↳ inventoryPolicy	string	Inventory policy (DENY or CONTINUE)
↳ inventoryItem	object	Inventory item for stock operations
↳ id	string	Inventory item GID
↳ sku	string	SKU
↳ tracked	boolean	Whether stock is tracked
↳ selectedOptions	array	Selected product options
↳ name	string	Option name
↳ value	string	Selected value
↳ compareAtPrice	string	Compare at price
↳ sku	string	Stock keeping unit
↳ inventoryQuantity	number	Available inventory quantity
↳ images	object	Product images page; use Get Product with imagesAfter for subsequent pages
↳ pageInfo	object	Image pagination
↳ startCursor	string	Cursor at the start of this page
↳ endCursor	string	Cursor to pass as after for the next page
↳ hasNextPage	boolean	Whether there are more results after this page
↳ hasPreviousPage	boolean	Whether there are results before this page
↳ edges	array	Array of image edges
↳ node	object	Image node
↳ id	string	Unique image identifier (GID)
↳ url	string	Image URL
↳ altText	string	Alternative text for accessibility

Shopify Delete Product

Delete a product from your Shopify store

Inputs and outputs

Input

Parameter	Type	Required	Description
shopDomain	string	No	Your Shopify store domain (e.g., mystore.myshopify.com)
productId	string	Yes	Product ID to delete (gid://shopify/Product/123456789)

Output

Parameter	Type	Description
deletedId	string	The ID of the deleted product

Shopify Get Order

Get a single order by ID from your Shopify store

Inputs and outputs

Input

Parameter	Type	Required	Description
lineItemsFirst	number	No	Maximum lineItems in this page (default 50, max 50)
lineItemsAfter	string	No	Cursor from lineItems.pageInfo.endCursor for the next page
shopDomain	string	No	Your Shopify store domain (e.g., mystore.myshopify.com)
orderId	string	Yes	Order ID (gid://shopify/Order/123456789)

Output

Parameter	Type	Description
order	object	The order details
↳ poNumber	string	Purchase order number
↳ customAttributes	array	Order attributes
↳ key	string	Attribute key
↳ value	string	Attribute value
↳ 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
↳ shopMoney	object	Amount in shop currency
↳ amount	string	Decimal money amount
↳ currencyCode	string	Currency code (ISO 4217)
↳ presentmentMoney	object	Amount in presentment currency
↳ amount	string	Decimal money amount
↳ currencyCode	string	Currency code (ISO 4217)
↳ subtotalPriceSet	object	Order subtotal (before shipping and taxes)
↳ shopMoney	object	Amount in shop currency
↳ amount	string	Decimal money amount
↳ currencyCode	string	Currency code (ISO 4217)
↳ presentmentMoney	object	Amount in presentment currency
↳ amount	string	Decimal money amount
↳ currencyCode	string	Currency code (ISO 4217)
↳ totalTaxSet	object	Total tax amount
↳ shopMoney	object	Amount in shop currency
↳ amount	string	Decimal money amount
↳ currencyCode	string	Currency code (ISO 4217)
↳ presentmentMoney	object	Amount in presentment currency
↳ amount	string	Decimal money amount
↳ currencyCode	string	Currency code (ISO 4217)
↳ totalShippingPriceSet	object	Total shipping price
↳ shopMoney	object	Amount in shop currency
↳ amount	string	Decimal money amount
↳ currencyCode	string	Currency code (ISO 4217)
↳ presentmentMoney	object	Amount in presentment currency
↳ amount	string	Decimal money amount
↳ currencyCode	string	Currency code (ISO 4217)
↳ note	string	Order note
↳ tags	array	Order tags
↳ customer	object	Customer who placed the order
↳ 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
↳ lineItems	object	Order line items page; use Get Order with lineItemsAfter for subsequent pages
↳ pageInfo	object	Line item pagination
↳ startCursor	string	Cursor at the start of this page
↳ endCursor	string	Cursor to pass as after for the next page
↳ hasNextPage	boolean	Whether there are more results after this page
↳ hasPreviousPage	boolean	Whether there are results before this page
↳ edges	array	Array of line item edges
↳ node	object	Line item node
↳ id	string	Unique line item identifier (GID)
↳ title	string	Product title
↳ quantity	number	Quantity ordered
↳ variant	object	Associated product variant
↳ id	string	Unique variant identifier (GID)
↳ title	string	Variant title
↳ price	string	Variant price
↳ barcode	string	Variant barcode
↳ taxable	boolean	Whether the variant is taxable
↳ inventoryPolicy	string	Inventory policy (DENY or CONTINUE)
↳ inventoryItem	object	Inventory item for stock operations
↳ id	string	Inventory item GID
↳ sku	string	SKU
↳ tracked	boolean	Whether stock is tracked
↳ selectedOptions	array	Selected product options
↳ name	string	Option name
↳ value	string	Selected value
↳ compareAtPrice	string	Compare at price
↳ sku	string	Stock keeping unit
↳ inventoryQuantity	number	Available inventory quantity
↳ originalTotalSet	object	Original total price before discounts
↳ shopMoney	object	Amount in shop currency
↳ amount	string	Decimal money amount
↳ currencyCode	string	Currency code (ISO 4217)
↳ presentmentMoney	object	Amount in presentment currency
↳ amount	string	Decimal money amount
↳ currencyCode	string	Currency code (ISO 4217)
↳ discountedTotalSet	object	Total price after discounts
↳ shopMoney	object	Amount in shop currency
↳ amount	string	Decimal money amount
↳ currencyCode	string	Currency code (ISO 4217)
↳ presentmentMoney	object	Amount in presentment currency
↳ amount	string	Decimal money amount
↳ currencyCode	string	Currency code (ISO 4217)
↳ shippingAddress	object	Shipping address
↳ firstName	string	First name
↳ lastName	string	Last name
↳ address1	string	Street address line 1
↳ address2	string	Street address line 2
↳ city	string	City
↳ province	string	Province or state name
↳ provinceCode	string	Province or state code
↳ country	string	Country name
↳ countryCode	string	Country code (ISO 3166-1 alpha-2)
↳ zip	string	Postal or ZIP code
↳ phone	string	Phone number
↳ billingAddress	object	Billing address
↳ firstName	string	First name
↳ lastName	string	Last name
↳ address1	string	Street address line 1
↳ address2	string	Street address line 2
↳ city	string	City
↳ province	string	Province or state name
↳ provinceCode	string	Province or state code
↳ country	string	Country name
↳ countryCode	string	Country code (ISO 3166-1 alpha-2)
↳ zip	string	Postal or ZIP code
↳ phone	string	Phone number
↳ fulfillments	array	Order fulfillments
↳ 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
↳ company	string	Shipping carrier name
↳ number	string	Tracking number
↳ url	string	Tracking URL

Shopify List Orders

List orders from your Shopify store with optional filtering

Inputs and outputs

Input

Parameter	Type	Required	Description
includeDetails	boolean	No	Include expanded nested details; uses a smaller page limit to stay within Shopify query costs
reverse	boolean	No	Reverse the result sort order (default false)
sortKey	string	No	Sort results by CREATED_AT, CURRENT_TOTAL_PRICE, CUSTOMER_NAME, DESTINATION, FINANCIAL_STATUS, FULFILLMENT_STATUS, ID, ORDER_NUMBER, PO_NUMBER, PROCESSED_AT, RELEVANCE, TOTAL_ITEMS_QUANTITY, TOTAL_PRICE, UPDATED_AT (default Shopify ordering)
shopDomain	string	No	Your Shopify store domain (e.g., mystore.myshopify.com)
after	string	No	Cursor from pageInfo.endCursor to retrieve the next page
first	number	No	Number of orders to return (default: 50, max: 250; with includeDetails: default/max 10)
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

Parameter	Type	Description
orders	array	List of orders
↳ poNumber	string	Purchase order number
↳ customAttributes	array	Order attributes
↳ key	string	Attribute key
↳ value	string	Attribute value
↳ 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
↳ shopMoney	object	Amount in shop currency
↳ amount	string	Decimal money amount
↳ currencyCode	string	Currency code (ISO 4217)
↳ presentmentMoney	object	Amount in presentment currency
↳ amount	string	Decimal money amount
↳ currencyCode	string	Currency code (ISO 4217)
↳ subtotalPriceSet	object	Order subtotal (before shipping and taxes)
↳ shopMoney	object	Amount in shop currency
↳ amount	string	Decimal money amount
↳ currencyCode	string	Currency code (ISO 4217)
↳ presentmentMoney	object	Amount in presentment currency
↳ amount	string	Decimal money amount
↳ currencyCode	string	Currency code (ISO 4217)
↳ totalTaxSet	object	Total tax amount
↳ shopMoney	object	Amount in shop currency
↳ amount	string	Decimal money amount
↳ currencyCode	string	Currency code (ISO 4217)
↳ presentmentMoney	object	Amount in presentment currency
↳ amount	string	Decimal money amount
↳ currencyCode	string	Currency code (ISO 4217)
↳ totalShippingPriceSet	object	Total shipping price
↳ shopMoney	object	Amount in shop currency
↳ amount	string	Decimal money amount
↳ currencyCode	string	Currency code (ISO 4217)
↳ presentmentMoney	object	Amount in presentment currency
↳ amount	string	Decimal money amount
↳ currencyCode	string	Currency code (ISO 4217)
↳ note	string	Order note
↳ tags	array	Order tags
↳ customer	object	Customer who placed the order
↳ 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
↳ lineItems	object	Order line items page; use Get Order with lineItemsAfter for subsequent pages
↳ pageInfo	object	Line item pagination
↳ startCursor	string	Cursor at the start of this page
↳ endCursor	string	Cursor to pass as after for the next page
↳ hasNextPage	boolean	Whether there are more results after this page
↳ hasPreviousPage	boolean	Whether there are results before this page
↳ edges	array	Array of line item edges
↳ node	object	Line item node
↳ id	string	Unique line item identifier (GID)
↳ title	string	Product title
↳ quantity	number	Quantity ordered
↳ variant	object	Associated product variant
↳ id	string	Unique variant identifier (GID)
↳ title	string	Variant title
↳ price	string	Variant price
↳ barcode	string	Variant barcode
↳ taxable	boolean	Whether the variant is taxable
↳ inventoryPolicy	string	Inventory policy (DENY or CONTINUE)
↳ inventoryItem	object	Inventory item for stock operations
↳ id	string	Inventory item GID
↳ sku	string	SKU
↳ tracked	boolean	Whether stock is tracked
↳ selectedOptions	array	Selected product options
↳ name	string	Option name
↳ value	string	Selected value
↳ compareAtPrice	string	Compare at price
↳ sku	string	Stock keeping unit
↳ inventoryQuantity	number	Available inventory quantity
↳ originalTotalSet	object	Original total price before discounts
↳ shopMoney	object	Amount in shop currency
↳ amount	string	Decimal money amount
↳ currencyCode	string	Currency code (ISO 4217)
↳ presentmentMoney	object	Amount in presentment currency
↳ amount	string	Decimal money amount
↳ currencyCode	string	Currency code (ISO 4217)
↳ discountedTotalSet	object	Total price after discounts
↳ shopMoney	object	Amount in shop currency
↳ amount	string	Decimal money amount
↳ currencyCode	string	Currency code (ISO 4217)
↳ presentmentMoney	object	Amount in presentment currency
↳ amount	string	Decimal money amount
↳ currencyCode	string	Currency code (ISO 4217)
↳ shippingAddress	object	Shipping address
↳ firstName	string	First name
↳ lastName	string	Last name
↳ address1	string	Street address line 1
↳ address2	string	Street address line 2
↳ city	string	City
↳ province	string	Province or state name
↳ provinceCode	string	Province or state code
↳ country	string	Country name
↳ countryCode	string	Country code (ISO 3166-1 alpha-2)
↳ zip	string	Postal or ZIP code
↳ phone	string	Phone number
↳ billingAddress	object	Billing address
↳ firstName	string	First name
↳ lastName	string	Last name
↳ address1	string	Street address line 1
↳ address2	string	Street address line 2
↳ city	string	City
↳ province	string	Province or state name
↳ provinceCode	string	Province or state code
↳ country	string	Country name
↳ countryCode	string	Country code (ISO 3166-1 alpha-2)
↳ zip	string	Postal or ZIP code
↳ phone	string	Phone number
↳ fulfillments	array	Order fulfillments
↳ 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
↳ company	string	Shipping carrier name
↳ number	string	Tracking number
↳ url	string	Tracking URL
pageInfo	object	Pagination information
↳ startCursor	string	Cursor at the start of this page
↳ endCursor	string	Cursor to pass as after for the next page
↳ hasNextPage	boolean	Whether there are more results after this page
↳ hasPreviousPage	boolean	Whether there are results before this page

Shopify Update Order

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

Inputs and outputs

Input

Parameter	Type	Required	Description
phone	string	No	Customer phone number for the order
shippingAddress	json	No	MailingAddressInput object with firstName, lastName, address1, address2, city, provinceCode, countryCode, zip, and phone
customAttributes	array	No	Order attributes as an array of {key, value} objects
metafields	array	No	MetafieldInput array: namespace, key, type, value, or id
poNumber	string	No	Purchase order number
includeDetails	boolean	No	Include product variants, addresses, and fulfillments; requires read_products, protected-address access, and a scope accepted by Fulfillment
shopDomain	string	No	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

Parameter	Type	Description
order	object	The updated order
↳ poNumber	string	Purchase order number
↳ customAttributes	array	Order attributes
↳ key	string	Attribute key
↳ value	string	Attribute value
↳ 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
↳ shopMoney	object	Amount in shop currency
↳ amount	string	Decimal money amount
↳ currencyCode	string	Currency code (ISO 4217)
↳ presentmentMoney	object	Amount in presentment currency
↳ amount	string	Decimal money amount
↳ currencyCode	string	Currency code (ISO 4217)
↳ subtotalPriceSet	object	Order subtotal (before shipping and taxes)
↳ shopMoney	object	Amount in shop currency
↳ amount	string	Decimal money amount
↳ currencyCode	string	Currency code (ISO 4217)
↳ presentmentMoney	object	Amount in presentment currency
↳ amount	string	Decimal money amount
↳ currencyCode	string	Currency code (ISO 4217)
↳ totalTaxSet	object	Total tax amount
↳ shopMoney	object	Amount in shop currency
↳ amount	string	Decimal money amount
↳ currencyCode	string	Currency code (ISO 4217)
↳ presentmentMoney	object	Amount in presentment currency
↳ amount	string	Decimal money amount
↳ currencyCode	string	Currency code (ISO 4217)
↳ totalShippingPriceSet	object	Total shipping price
↳ shopMoney	object	Amount in shop currency
↳ amount	string	Decimal money amount
↳ currencyCode	string	Currency code (ISO 4217)
↳ presentmentMoney	object	Amount in presentment currency
↳ amount	string	Decimal money amount
↳ currencyCode	string	Currency code (ISO 4217)
↳ note	string	Order note
↳ tags	array	Order tags
↳ customer	object	Customer who placed the order
↳ 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
↳ lineItems	object	Order line items page; use Get Order with lineItemsAfter for subsequent pages
↳ pageInfo	object	Line item pagination
↳ startCursor	string	Cursor at the start of this page
↳ endCursor	string	Cursor to pass as after for the next page
↳ hasNextPage	boolean	Whether there are more results after this page
↳ hasPreviousPage	boolean	Whether there are results before this page
↳ edges	array	Array of line item edges
↳ node	object	Line item node
↳ id	string	Unique line item identifier (GID)
↳ title	string	Product title
↳ quantity	number	Quantity ordered
↳ variant	object	Associated product variant
↳ id	string	Unique variant identifier (GID)
↳ title	string	Variant title
↳ price	string	Variant price
↳ barcode	string	Variant barcode
↳ taxable	boolean	Whether the variant is taxable
↳ inventoryPolicy	string	Inventory policy (DENY or CONTINUE)
↳ inventoryItem	object	Inventory item for stock operations
↳ id	string	Inventory item GID
↳ sku	string	SKU
↳ tracked	boolean	Whether stock is tracked
↳ selectedOptions	array	Selected product options
↳ name	string	Option name
↳ value	string	Selected value
↳ compareAtPrice	string	Compare at price
↳ sku	string	Stock keeping unit
↳ inventoryQuantity	number	Available inventory quantity
↳ originalTotalSet	object	Original total price before discounts
↳ shopMoney	object	Amount in shop currency
↳ amount	string	Decimal money amount
↳ currencyCode	string	Currency code (ISO 4217)
↳ presentmentMoney	object	Amount in presentment currency
↳ amount	string	Decimal money amount
↳ currencyCode	string	Currency code (ISO 4217)
↳ discountedTotalSet	object	Total price after discounts
↳ shopMoney	object	Amount in shop currency
↳ amount	string	Decimal money amount
↳ currencyCode	string	Currency code (ISO 4217)
↳ presentmentMoney	object	Amount in presentment currency
↳ amount	string	Decimal money amount
↳ currencyCode	string	Currency code (ISO 4217)
↳ shippingAddress	object	Shipping address
↳ firstName	string	First name
↳ lastName	string	Last name
↳ address1	string	Street address line 1
↳ address2	string	Street address line 2
↳ city	string	City
↳ province	string	Province or state name
↳ provinceCode	string	Province or state code
↳ country	string	Country name
↳ countryCode	string	Country code (ISO 3166-1 alpha-2)
↳ zip	string	Postal or ZIP code
↳ phone	string	Phone number
↳ billingAddress	object	Billing address
↳ firstName	string	First name
↳ lastName	string	Last name
↳ address1	string	Street address line 1
↳ address2	string	Street address line 2
↳ city	string	City
↳ province	string	Province or state name
↳ provinceCode	string	Province or state code
↳ country	string	Country name
↳ countryCode	string	Country code (ISO 3166-1 alpha-2)
↳ zip	string	Postal or ZIP code
↳ phone	string	Phone number
↳ fulfillments	array	Order fulfillments
↳ 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
↳ company	string	Shipping carrier name
↳ number	string	Tracking number
↳ url	string	Tracking URL

Shopify Cancel Order

Cancel an order in your Shopify store

Inputs and outputs

Input

Parameter	Type	Required	Description
shopDomain	string	No	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
restock	boolean	Yes	Whether to restock the inventory committed to the order
refundMethod	json	No	Optional refund method object, for example {"originalPaymentMethodsRefund": true}
staffNote	string	No	A note about the cancellation for staff reference

Output

Parameter	Type	Description
jobResult	object	Cancellation outcome; pass its ID to Get Job until done, then inspect status and errors
↳ id	string	Cancellation result GID; pass to Get Job
↳ done	boolean	Whether the request has finished processing; inspect status and errors for the outcome
↳ status	string	Current cancellation status
↳ errors	array	Asynchronous cancellation errors
↳ field	array	Input field path
↳ message	string	Error message
↳ code	string	Cancellation error code
↳ order	object	Associated order
↳ id	string	Order GID
↳ cancelledAt	string	Cancellation timestamp, null until cancelled
job	object	Legacy job progress; use jobResult to verify cancellation outcome
↳ id	string	Job ID
↳ done	boolean	Whether processing ran; this alone does not prove cancellation succeeded
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

Create a new customer in your Shopify store

Inputs and outputs

Input

Parameter	Type	Required	Description
locale	string	No	Customer locale, such as en
taxExempt	boolean	No	Whether the customer is exempt from taxes
metafields	array	No	MetafieldInput array: namespace, key, type, value, or id
emailMarketingConsent	json	No	CustomerEmailMarketingConsentInput with marketingState, marketingOptInLevel, consentUpdatedAt
smsMarketingConsent	json	No	CustomerSmsMarketingConsentInput with marketingState, marketingOptInLevel, consentUpdatedAt
shopDomain	string	No	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

Parameter	Type	Description
customer	object	The created customer
↳ emailMarketingConsent	object	Email marketing consent
↳ marketingState	string	Consent state
↳ marketingOptInLevel	string	Opt-in level
↳ consentUpdatedAt	string	Consent update timestamp
↳ smsMarketingConsent	object	SMS marketing consent
↳ marketingState	string	Consent state
↳ marketingOptInLevel	string	Opt-in level
↳ consentUpdatedAt	string	Consent update timestamp
↳ 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
↳ numberOfOrders	string	Lifetime order count as an unsigned integer string
↳ locale	string	Customer locale
↳ taxExempt	boolean	Whether the customer is tax exempt
↳ amountSpent	object	Total amount spent by customer
↳ amount	string	Decimal money amount
↳ currencyCode	string	Currency code (ISO 4217)
↳ defaultAddress	object	Customer default address
↳ firstName	string	First name
↳ lastName	string	Last name
↳ address1	string	Street address line 1
↳ address2	string	Street address line 2
↳ city	string	City
↳ province	string	Province or state name
↳ provinceCode	string	Province or state code
↳ country	string	Country name
↳ countryCode	string	Country code (ISO 3166-1 alpha-2)
↳ zip	string	Postal or ZIP code
↳ phone	string	Phone number
↳ addresses	array	Customer addresses
↳ firstName	string	First name
↳ lastName	string	Last name
↳ address1	string	Street address line 1
↳ address2	string	Street address line 2
↳ city	string	City
↳ province	string	Province or state name
↳ provinceCode	string	Province or state code
↳ country	string	Country name
↳ countryCode	string	Country code (ISO 3166-1 alpha-2)
↳ zip	string	Postal or ZIP code
↳ phone	string	Phone number

Shopify Get Customer

Get a single customer by ID from your Shopify store

Inputs and outputs

Input

Parameter	Type	Required	Description
shopDomain	string	No	Your Shopify store domain (e.g., mystore.myshopify.com)
customerId	string	Yes	Customer ID (gid://shopify/Customer/123456789)

Output

Parameter	Type	Description
customer	object	The customer details
↳ emailMarketingConsent	object	Email marketing consent
↳ marketingState	string	Consent state
↳ marketingOptInLevel	string	Opt-in level
↳ consentUpdatedAt	string	Consent update timestamp
↳ smsMarketingConsent	object	SMS marketing consent
↳ marketingState	string	Consent state
↳ marketingOptInLevel	string	Opt-in level
↳ consentUpdatedAt	string	Consent update timestamp
↳ 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
↳ numberOfOrders	string	Lifetime order count as an unsigned integer string
↳ locale	string	Customer locale
↳ taxExempt	boolean	Whether the customer is tax exempt
↳ amountSpent	object	Total amount spent by customer
↳ amount	string	Decimal money amount
↳ currencyCode	string	Currency code (ISO 4217)
↳ defaultAddress	object	Customer default address
↳ firstName	string	First name
↳ lastName	string	Last name
↳ address1	string	Street address line 1
↳ address2	string	Street address line 2
↳ city	string	City
↳ province	string	Province or state name
↳ provinceCode	string	Province or state code
↳ country	string	Country name
↳ countryCode	string	Country code (ISO 3166-1 alpha-2)
↳ zip	string	Postal or ZIP code
↳ phone	string	Phone number
↳ addresses	array	Customer addresses
↳ firstName	string	First name
↳ lastName	string	Last name
↳ address1	string	Street address line 1
↳ address2	string	Street address line 2
↳ city	string	City
↳ province	string	Province or state name
↳ provinceCode	string	Province or state code
↳ country	string	Country name
↳ countryCode	string	Country code (ISO 3166-1 alpha-2)
↳ zip	string	Postal or ZIP code
↳ phone	string	Phone number

Shopify List Customers

List customers from your Shopify store with optional filtering

Inputs and outputs

Input

Parameter	Type	Required	Description
reverse	boolean	No	Reverse the result sort order (default false)
sortKey	string	No	Sort results by CREATED_AT, ID, LOCATION, NAME, RELEVANCE, UPDATED_AT (default Shopify ordering)
shopDomain	string	No	Your Shopify store domain (e.g., mystore.myshopify.com)
after	string	No	Cursor from pageInfo.endCursor to retrieve the next page
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

Parameter	Type	Description
customers	array	List of customers
↳ emailMarketingConsent	object	Email marketing consent
↳ marketingState	string	Consent state
↳ marketingOptInLevel	string	Opt-in level
↳ consentUpdatedAt	string	Consent update timestamp
↳ smsMarketingConsent	object	SMS marketing consent
↳ marketingState	string	Consent state
↳ marketingOptInLevel	string	Opt-in level
↳ consentUpdatedAt	string	Consent update timestamp
↳ 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
↳ numberOfOrders	string	Lifetime order count as an unsigned integer string
↳ locale	string	Customer locale
↳ taxExempt	boolean	Whether the customer is tax exempt
↳ amountSpent	object	Total amount spent by customer
↳ amount	string	Decimal money amount
↳ currencyCode	string	Currency code (ISO 4217)
↳ defaultAddress	object	Customer default address
↳ firstName	string	First name
↳ lastName	string	Last name
↳ address1	string	Street address line 1
↳ address2	string	Street address line 2
↳ city	string	City
↳ province	string	Province or state name
↳ provinceCode	string	Province or state code
↳ country	string	Country name
↳ countryCode	string	Country code (ISO 3166-1 alpha-2)
↳ zip	string	Postal or ZIP code
↳ phone	string	Phone number
pageInfo	object	Pagination information
↳ startCursor	string	Cursor at the start of this page
↳ endCursor	string	Cursor to pass as after for the next page
↳ hasNextPage	boolean	Whether there are more results after this page
↳ hasPreviousPage	boolean	Whether there are results before this page

Shopify Update Customer

Update an existing customer in your Shopify store

Inputs and outputs

Input

Parameter	Type	Required	Description
addresses	array	No	MailingAddressInput array; replacing addresses is deprecated by Shopify
locale	string	No	Customer locale, such as en
taxExempt	boolean	No	Whether the customer is exempt from taxes
metafields	array	No	MetafieldInput array: namespace, key, type, value, or id
emailMarketingConsent	json	No	CustomerEmailMarketingConsentInput with marketingState, marketingOptInLevel, consentUpdatedAt
smsMarketingConsent	json	No	CustomerSmsMarketingConsentInput with marketingState, marketingOptInLevel, consentUpdatedAt
shopDomain	string	No	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

Parameter	Type	Description
customer	object	The updated customer
↳ emailMarketingConsent	object	Email marketing consent
↳ marketingState	string	Consent state
↳ marketingOptInLevel	string	Opt-in level
↳ consentUpdatedAt	string	Consent update timestamp
↳ smsMarketingConsent	object	SMS marketing consent
↳ marketingState	string	Consent state
↳ marketingOptInLevel	string	Opt-in level
↳ consentUpdatedAt	string	Consent update timestamp
↳ 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
↳ numberOfOrders	string	Lifetime order count as an unsigned integer string
↳ locale	string	Customer locale
↳ taxExempt	boolean	Whether the customer is tax exempt
↳ amountSpent	object	Total amount spent by customer
↳ amount	string	Decimal money amount
↳ currencyCode	string	Currency code (ISO 4217)
↳ defaultAddress	object	Customer default address
↳ firstName	string	First name
↳ lastName	string	Last name
↳ address1	string	Street address line 1
↳ address2	string	Street address line 2
↳ city	string	City
↳ province	string	Province or state name
↳ provinceCode	string	Province or state code
↳ country	string	Country name
↳ countryCode	string	Country code (ISO 3166-1 alpha-2)
↳ zip	string	Postal or ZIP code
↳ phone	string	Phone number
↳ addresses	array	Customer addresses
↳ firstName	string	First name
↳ lastName	string	Last name
↳ address1	string	Street address line 1
↳ address2	string	Street address line 2
↳ city	string	City
↳ province	string	Province or state name
↳ provinceCode	string	Province or state code
↳ country	string	Country name
↳ countryCode	string	Country code (ISO 3166-1 alpha-2)
↳ zip	string	Postal or ZIP code
↳ phone	string	Phone number

Shopify Delete Customer

Delete a customer from your Shopify store

Inputs and outputs

Input

Parameter	Type	Required	Description
shopDomain	string	No	Your Shopify store domain (e.g., mystore.myshopify.com)
customerId	string	Yes	Customer ID to delete (gid://shopify/Customer/123456789)

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.

Inputs and outputs

Input

Parameter	Type	Required	Description
reverse	boolean	No	Reverse the result sort order (default false)
shopDomain	string	No	Your Shopify store domain (e.g., mystore.myshopify.com)
after	string	No	Cursor from pageInfo.endCursor to retrieve the next page
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

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
↳ inventoryLevelsPageInfo	object	Pagination for location summary; use Get Inventory Level for subsequent pages
↳ startCursor	string	Cursor at the start of this page
↳ endCursor	string	Cursor to pass as after for the next page
↳ hasNextPage	boolean	Whether there are more results after this page
↳ hasPreviousPage	boolean	Whether there are results before this page
↳ inventoryLevels	array	Inventory levels at different locations
↳ id	string	Inventory level identifier (GID)
↳ available	number	Available quantity
↳ onHand	number	On-hand quantity
↳ location	object	Location for this inventory level
↳ id	string	Location identifier (GID)
↳ name	string	Location name
pageInfo	object	Pagination information
↳ startCursor	string	Cursor at the start of this page
↳ endCursor	string	Cursor to pass as after for the next page
↳ hasNextPage	boolean	Whether there are more results after this page
↳ hasPreviousPage	boolean	Whether there are results before this page

Shopify Get Inventory Level

Get inventory level for a product variant at a specific location

Inputs and outputs

Input

Parameter	Type	Required	Description
first	number	No	Locations per page when locationId is omitted (default 50, max 250)
after	string	No	Cursor from inventoryLevel.pageInfo.endCursor
shopDomain	string	No	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

Parameter	Type	Description
inventoryLevel	object	The inventory level details
↳ pageInfo	object	Location pagination when no locationId is supplied
↳ startCursor	string	Cursor at the start of this page
↳ endCursor	string	Cursor to pass as after for the next page
↳ hasNextPage	boolean	Whether there are more results after this page
↳ hasPreviousPage	boolean	Whether there are results before this page
↳ 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

Adjust inventory quantity for a product variant at a specific location

Inputs and outputs

Input

Parameter	Type	Required	Description
idempotencyKey	string	No	Unique key for this adjustment; reuse the same key when retrying the same change
reason	string	No	Inventory reason, e.g. correction, received, damaged, or promotion (default correction)
name	string	No	Inventory quantity to adjust: available or on_hand (default available)
referenceDocumentUri	string	No	URI identifying the source document for this adjustment
changeFromQuantity	number	No	Expected current quantity; prevents applying an adjustment to stale stock
ledgerDocumentUri	string	No	Ledger entry URI; required when adjusting on_hand
shopDomain	string	No	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

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
↳ referenceDocumentUri	string	Source document URI
↳ changes	array	Inventory changes applied
↳ name	string	Quantity name (e.g., available)
↳ delta	number	Quantity change amount
↳ quantityAfterChange	number	Quantity after adjustment, when available
↳ 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.

Inputs and outputs

Input

Parameter	Type	Required	Description
reverse	boolean	No	Reverse the result sort order (default false)
sortKey	string	No	Sort results by ID, NAME, RELEVANCE (default Shopify ordering)
query	string	No	Shopify location search query, e.g. name:Warehouse
includeLegacy	boolean	No	Include legacy fulfillment-service locations (default false)
shopDomain	string	No	Your Shopify store domain (e.g., mystore.myshopify.com)
after	string	No	Cursor from pageInfo.endCursor to retrieve the next page
first	number	No	Number of locations to return (default: 50, max: 250)
includeInactive	boolean	No	Whether to include deactivated locations (default: false)

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
↳ address1	string	Street address line 1
↳ address2	string	Street address line 2
↳ city	string	City
↳ province	string	Province or state name
↳ provinceCode	string	Province or state code
↳ country	string	Country name
↳ countryCode	string	Country code (ISO 3166-1 alpha-2)
↳ zip	string	Postal or ZIP code
↳ phone	string	Phone number
pageInfo	object	Pagination information
↳ startCursor	string	Cursor at the start of this page
↳ endCursor	string	Cursor to pass as after for the next page
↳ 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 (use List Fulfillment Orders to find it).

Inputs and outputs

Input

Parameter	Type	Required	Description
fulfillmentOrderLineItems	array	No	Partial fulfillment items as [{id: "gid://shopify/FulfillmentOrderLineItem/123", quantity: 1}]; omit to fulfill all remaining items
message	string	No	Message associated with the fulfillment
originAddress	json	No	FulfillmentOriginAddressInput with address1, address2, city, countryCode, provinceCode, zip
trackingNumbers	array	No	Multiple tracking numbers as a JSON string array
trackingUrls	array	No	Multiple tracking URLs as a JSON string array
shopDomain	string	No	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

Parameter	Type	Description
fulfillment	object	The created fulfillment with tracking info and fulfilled items
↳ lineItemsPageInfo	object	Fulfillment item pagination; use Get Fulfillment for subsequent pages
↳ startCursor	string	Cursor at the start of this page
↳ endCursor	string	Cursor to pass as after for the next page
↳ hasNextPage	boolean	Whether there are more results after this page
↳ hasPreviousPage	boolean	Whether there are results before this page
↳ 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
↳ company	string	Shipping carrier name
↳ number	string	Tracking number
↳ url	string	Tracking URL
↳ 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.

Inputs and outputs

Input

Parameter	Type	Required	Description
reverse	boolean	No	Reverse the result sort order (default false)
sortKey	string	No	Sort results by ID, RELEVANCE, TITLE, UPDATED_AT (default Shopify ordering)
shopDomain	string	No	Your Shopify store domain (e.g., mystore.myshopify.com)
after	string	No	Cursor from pageInfo.endCursor to retrieve the next page
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

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
↳ id	string	Unique image identifier (GID)
↳ url	string	Image URL
↳ altText	string	Alternative text for accessibility
pageInfo	object	Pagination information
↳ startCursor	string	Cursor at the start of this page
↳ endCursor	string	Cursor to pass as after for the next page
↳ hasNextPage	boolean	Whether there are more results after this page
↳ hasPreviousPage	boolean	Whether there are results before this page

Shopify List Fulfillment Orders

Find fulfillment order IDs and remaining items for an order at merchant-managed locations

Inputs and outputs

Input

Parameter	Type	Required	Description
shopDomain	string	No	Shop domain supplied by the connected credential (store.myshopify.com)
orderId	string	Yes	Order GID to retrieve fulfillment orders for
first	number	No	Results per page (default 20, max 20)
after	string	No	Cursor from pageInfo.endCursor to continue

Output

Parameter	Type	Description
fulfillmentOrders	array	Fulfillment orders visible to the connected app
↳ id	string	Fulfillment order GID to pass to Create Fulfillment
↳ orderId	string	Associated order GID
↳ status	string	Fulfillment order status
↳ requestStatus	string	Fulfillment request status
↳ createdAt	string	Creation timestamp
↳ updatedAt	string	Last update timestamp
↳ fulfillAt	string	Earliest fulfillment timestamp
↳ fulfillBy	string	Fulfillment deadline
↳ assignedLocation	object	Assigned fulfillment location
↳ name	string	Assigned location name
↳ location	object	Current location
↳ id	string	Location GID
↳ name	string	Location name
↳ supportedActions	array	Actions permitted for this fulfillment order
↳ action	string	Permitted action
↳ externalUrl	string	External fulfillment URL when applicable
↳ lineItems	object	Fulfillment order item page; use Get Fulfillment Order to continue
↳ pageInfo	object	Line item pagination
↳ startCursor	string	Cursor at the start of this page
↳ endCursor	string	Cursor to pass as after for the next page
↳ hasNextPage	boolean	Whether there are more results after this page
↳ hasPreviousPage	boolean	Whether there are results before this page
↳ edges	array	Fulfillment order item edges
↳ node	object	Fulfillment order line item
↳ id	string	Fulfillment order line item GID for partial fulfillment
↳ totalQuantity	number	Total quantity assigned
↳ remainingQuantity	number	Quantity still to fulfill
↳ inventoryItemId	string	Inventory item GID
↳ productTitle	string	Product title
↳ variantTitle	string	Variant title
↳ sku	string	SKU
↳ lineItem	object	Original order line item
↳ id	string	Order line item GID
pageInfo	object	Fulfillment order pagination
↳ startCursor	string	Cursor at the start of this page
↳ endCursor	string	Cursor to pass as after for the next page
↳ hasNextPage	boolean	Whether there are more results after this page
↳ hasPreviousPage	boolean	Whether there are results before this page

Shopify Get Fulfillment Order

Read a fulfillment order and one page of line items for partial fulfillment

Inputs and outputs

Input

Parameter	Type	Required	Description
shopDomain	string	No	Shop domain supplied by the connected credential (store.myshopify.com)
fulfillmentOrderId	string	Yes	Fulfillment order GID
first	number	No	Results per page (default 50, max 250)
after	string	No	Cursor from pageInfo.endCursor to continue

Output

Parameter	Type	Description
fulfillmentOrder	object	Fulfillment order with remaining quantities and item pagination
↳ id	string	Fulfillment order GID to pass to Create Fulfillment
↳ orderId	string	Associated order GID
↳ status	string	Fulfillment order status
↳ requestStatus	string	Fulfillment request status
↳ createdAt	string	Creation timestamp
↳ updatedAt	string	Last update timestamp
↳ fulfillAt	string	Earliest fulfillment timestamp
↳ fulfillBy	string	Fulfillment deadline
↳ assignedLocation	object	Assigned fulfillment location
↳ name	string	Assigned location name
↳ location	object	Current location
↳ id	string	Location GID
↳ name	string	Location name
↳ supportedActions	array	Actions permitted for this fulfillment order
↳ action	string	Permitted action
↳ externalUrl	string	External fulfillment URL when applicable
↳ lineItems	object	Fulfillment order item page; use Get Fulfillment Order to continue
↳ pageInfo	object	Line item pagination
↳ startCursor	string	Cursor at the start of this page
↳ endCursor	string	Cursor to pass as after for the next page
↳ hasNextPage	boolean	Whether there are more results after this page
↳ hasPreviousPage	boolean	Whether there are results before this page
↳ edges	array	Fulfillment order item edges
↳ node	object	Fulfillment order line item
↳ id	string	Fulfillment order line item GID for partial fulfillment
↳ totalQuantity	number	Total quantity assigned
↳ remainingQuantity	number	Quantity still to fulfill
↳ inventoryItemId	string	Inventory item GID
↳ productTitle	string	Product title
↳ variantTitle	string	Variant title
↳ sku	string	SKU
↳ lineItem	object	Original order line item
↳ id	string	Order line item GID

Shopify Get Job

Read Shopify job progress or the outcome and errors of an order cancellation

Inputs and outputs

Input

Parameter	Type	Required	Description
shopDomain	string	No	Shop domain supplied by the connected credential (store.myshopify.com)
jobId	string	Yes	jobResult.id (OrderCancelJobResult GID) for cancellation outcome, or a legacy Job GID

Output

Parameter	Type	Description
jobResult	object	Cancellation outcome when using an OrderCancelJobResult ID
↳ id	string	Cancellation result GID; pass to Get Job
↳ done	boolean	Whether the request has finished processing; inspect status and errors for the outcome
↳ status	string	Current cancellation status
↳ errors	array	Asynchronous cancellation errors
↳ field	array	Input field path
↳ message	string	Error message
↳ code	string	Cancellation error code
↳ order	object	Associated order
↳ id	string	Order GID
↳ cancelledAt	string	Cancellation timestamp, null until cancelled
job	object	Asynchronous job status
↳ id	string	Job GID
↳ done	boolean	Whether processing ran; inspect cancellation result for success

Shopify Create Product Variants

Create product variants with pricing, options, inventory attributes, and metafields

Inputs and outputs

Input

Parameter	Type	Required	Description
shopDomain	string	No	Shop domain supplied by the connected credential (store.myshopify.com)
productId	string	Yes	Product GID
variants	array	Yes	ProductVariantsBulkInput array (1-250): optionValues for creation, price, compareAtPrice, inventoryItem, taxable, inventoryPolicy, metafields
strategy	string	No	DEFAULT, REMOVE_STANDALONE_VARIANT, or PRESERVE_STANDALONE_VARIANT
media	array	No	CreateMediaInput array with originalSource, mediaContentType, and alt

Output

Parameter	Type	Description
productVariants	array	Variants successfully created or updated
↳ id	string	Unique variant identifier (GID)
↳ title	string	Variant title
↳ price	string	Variant price
↳ barcode	string	Variant barcode
↳ taxable	boolean	Whether the variant is taxable
↳ inventoryPolicy	string	Inventory policy (DENY or CONTINUE)
↳ inventoryItem	object	Inventory item for stock operations
↳ id	string	Inventory item GID
↳ sku	string	SKU
↳ tracked	boolean	Whether stock is tracked
↳ selectedOptions	array	Selected product options
↳ name	string	Option name
↳ value	string	Selected value
↳ compareAtPrice	string	Compare at price
↳ sku	string	Stock keeping unit
↳ inventoryQuantity	number	Available inventory quantity
userErrors	array	Validation errors, including partial update failures
↳ field	array	Input field path
↳ message	string	Validation error

Shopify Update Product Variants

Update product variants with pricing, options, inventory attributes, and metafields

Inputs and outputs

Input

Parameter	Type	Required	Description
shopDomain	string	No	Shop domain supplied by the connected credential (store.myshopify.com)
productId	string	Yes	Product GID
variants	array	Yes	ProductVariantsBulkInput array (1-250): id for updates, price, compareAtPrice, inventoryItem, optionValues, taxable, inventoryPolicy, metafields
allowPartialUpdates	boolean	No	Allow valid variants to update even if other variants fail
media	array	No	CreateMediaInput array with originalSource, mediaContentType, and alt

Output

Parameter	Type	Description
productVariants	array	Variants successfully created or updated
↳ id	string	Unique variant identifier (GID)
↳ title	string	Variant title
↳ price	string	Variant price
↳ barcode	string	Variant barcode
↳ taxable	boolean	Whether the variant is taxable
↳ inventoryPolicy	string	Inventory policy (DENY or CONTINUE)
↳ inventoryItem	object	Inventory item for stock operations
↳ id	string	Inventory item GID
↳ sku	string	SKU
↳ tracked	boolean	Whether stock is tracked
↳ selectedOptions	array	Selected product options
↳ name	string	Option name
↳ value	string	Selected value
↳ compareAtPrice	string	Compare at price
↳ sku	string	Stock keeping unit
↳ inventoryQuantity	number	Available inventory quantity
userErrors	array	Validation errors, including partial update failures
↳ field	array	Input field path
↳ message	string	Validation error

Shopify Get Fulfillment

Read shipment tracking and one page of fulfilled line items

Inputs and outputs

Input

Parameter	Type	Required	Description
shopDomain	string	No	Shop domain supplied by the connected credential (store.myshopify.com)
fulfillmentId	string	Yes	Fulfillment GID
first	number	No	Results per page (default 50, max 250)
after	string	No	Cursor from pageInfo.endCursor to continue

Output

Parameter	Type	Description
fulfillment	object	Shipment tracking and line item page
↳ lineItemsPageInfo	object	Fulfillment item pagination; use Get Fulfillment for subsequent pages
↳ startCursor	string	Cursor at the start of this page
↳ endCursor	string	Cursor to pass as after for the next page
↳ hasNextPage	boolean	Whether there are more results after this page
↳ hasPreviousPage	boolean	Whether there are results before this page
↳ 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
↳ company	string	Shipping carrier name
↳ number	string	Tracking number
↳ url	string	Tracking URL
↳ 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 Update Fulfillment Tracking

Update tracking numbers, URLs, or carrier for an existing fulfillment

Inputs and outputs

Input

Parameter	Type	Required	Description
shopDomain	string	No	Shop domain supplied by the connected credential (store.myshopify.com)
fulfillmentId	string	Yes	Fulfillment GID
trackingInfo	json	Yes	FulfillmentTrackingInput object: company, number, url, or numbers and urls arrays
notifyCustomer	boolean	No	Send the customer an updated shipment notification

Output

Parameter	Type	Description
fulfillment	object	Updated shipment tracking and line item page
↳ lineItemsPageInfo	object	Fulfillment item pagination; use Get Fulfillment for subsequent pages
↳ startCursor	string	Cursor at the start of this page
↳ endCursor	string	Cursor to pass as after for the next page
↳ hasNextPage	boolean	Whether there are more results after this page
↳ hasPreviousPage	boolean	Whether there are results before this page
↳ 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
↳ company	string	Shipping carrier name
↳ number	string	Tracking number
↳ url	string	Tracking URL
↳ 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 Get Collection

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

Inputs and outputs

Input

Parameter	Type	Required	Description
productsAfter	string	No	Cursor from products.pageInfo.endCursor for the next page
shopDomain	string	No	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

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
↳ id	string	Unique image identifier (GID)
↳ url	string	Image URL
↳ altText	string	Alternative text for accessibility
↳ productsPageInfo	object	Pagination for collection products; use productsAfter
↳ startCursor	string	Cursor at the start of this page
↳ endCursor	string	Cursor to pass as after for the next page
↳ hasNextPage	boolean	Whether there are more results after this page
↳ hasPreviousPage	boolean	Whether there are results before this page
↳ products	array	Products in the collection
↳ id	string	Unique product identifier (GID)
↳ title	string	Product title
↳ handle	string	URL-friendly product identifier
↳ status	string	Product status (ACTIVE, DRAFT, ARCHIVED, UNLISTED)
↳ vendor	string	Product vendor
↳ productType	string	Product type classification
↳ totalInventory	number	Total inventory across all variants
↳ featuredImage	object	Featured product image
↳ url	string	Featured image URL
↳ altText	string	Alternative text for accessibility