Actions

85 actions

Action

Description

List Products

Retrieve a paginated list of products with filtering by status, vendor, product type, collection, title, published\_statu...

Get Product

Retrieve a single product by ID, returning full details including each variant's inventory\_item\_id. After finding a prod...

Create Product

Create a new product with optional variants, images, options, metafields, SEO tags, and published\_at. Only title is requ...

Update Product

Update an existing product by product\_id. Supports updating title, description, vendor, tags, status, variants, images,...

Delete Product

Delete a product

Count Products

Get total count of products

List Product Variants

Retrieve all variants for a given product\_id with pricing, SKU, inventory, and option values. Returns next\_page\_info cur...

Get Product Variant

Retrieve a specific product variant

Create Product Variant

Add a new variant to a product with pricing, inventory, fulfillment, image, and metafields options. Requires product\_id...

Update Product Variant

Update variant pricing, inventory, fulfillment, options, barcode, image, tax code, and metafields by variant\_id. All fie...

Delete Product Variant

Remove a variant from a product

Count Product Variants

Get count of variants for a product

List Product Images

Retrieve all images for a product

Get Product Image

Retrieve a single product image

Create Product Image

Add a new image to a product

Update Product Image

Modify a product image's position, alt text, variant associations, metafields, or replace image content via src URL

Delete Product Image

Remove an image from a product

List Orders

Retrieve a paginated list of orders with filtering by status, fulfillment state, financial state, date ranges, and app a...

Get Order

Retrieve a single order by ID

Create Order

Create a new order with line items (supporting variant\_id, title, price, SKU, quantity, grams, taxable, requires\_shippin...

Update Order

Update an existing order's properties including note, tags, email, phone, marketing preferences, note\_attributes, and me...

Cancel Order

Cancel an order

Count Orders

Get total count of orders matching filter criteria for reporting and dashboards

Close Order

Close an order

Open Order

Reopen a closed order

List Customers

Retrieve a paginated list of customers. Supports cursor-based pagination via page\_info parameter

Get Customer

Retrieve a single customer by ID

Create Customer

Create a new customer with name, email, phone, addresses, tags, verified\_email, send\_email\_welcome, and metafields optio...

Update Customer

Update an existing customer by customer\_id. Supports updating name, email, phone, addresses, tags, note, tax\_exempt, ver...

Count Customers

Get total count of customers

Search Customers

Search customers by query criteria such as email, name, phone, or tag with cursor-based pagination, or retrieve all cust...

List Customer Addresses

Retrieve all addresses for a customer. Supports cursor-based pagination via page\_info parameter

Get Customer Address

Retrieve a specific customer address

Create Customer Address

Add a new shipping or billing address to a customer by customer\_id. All address fields (address1, city, country, etc.) a...

Update Customer Address

Update an existing address

Delete Customer Address

Remove an address from customer (cannot delete default address)

List Inventory Items

Retrieve inventory items by IDs (required on first request, max 100). Returns next\_page\_info cursor for pagination — pas...

List Inventory Levels

Retrieve inventory levels across locations

Adjust Inventory Level

Adjust inventory quantity at a location (requires inventory tracking enabled)

Set Inventory Level

Set absolute inventory quantity at a location

Connect Inventory To Location

Connect an inventory item to a location

Update Inventory Item

Update an inventory item's SKU, tracking status, shipping requirement, harmonized system code, and country/province of o...

List Locations

Retrieve all store locations (warehouses, retail stores, and fulfillment centers) with cursor-based pagination extracted...

Get Location

Retrieve a specific location

List Fulfillments

Retrieve fulfillments for an order. Supports cursor-based pagination via page\_info parameter

Create Fulfillment

Create a fulfillment for fulfillment orders

List Custom Collections

Retrieve all custom collections with cursor-based pagination

Create Custom Collection

Create a new custom collection with title, description, image, sort order, collects (to include products), and metafield...

Update Custom Collection

Update an existing custom collection by collection\_id. Supports updating title, description, image, sort order, publishe...

Delete Custom Collection

Permanently delete a custom collection

List Collects

Retrieve product-collection associations with cursor-based pagination

Create Collect

Add a product to a collection

Delete Collect

Remove a product from a collection

List Webhooks

Retrieve all registered webhooks. Supports cursor-based pagination via page\_info parameter

Create Webhook

Update Webhook

Modify an existing webhook subscription

Delete Webhook

Unregister a webhook subscription

List Draft Orders

Retrieve all draft orders. Supports cursor-based pagination via page\_info parameter

Get Draft Order

Retrieve a single draft order by ID

Create Draft Order

Create a new draft order with line items (supporting variant\_id, title, price, quantity, sku, grams, taxable, requires\_s...

Complete Draft Order

Convert draft order to regular order

Update Draft Order

Modify an existing draft order's line items, customer, shipping address, discounts, note, email, or tags via PUT /admin/...

Delete Draft Order

Permanently delete a draft order

List Transactions

Retrieve payment transactions for an order

Create Transaction

Create a payment transaction (requires existing authorization)

List Refunds

Retrieve all refunds for a specific order\_id, including line items, transactions, and adjustments. Returns next\_page\_inf...

Get Refund

Retrieve a specific refund by ID

Create Refund

Create a refund for order items (requires captured payment)

Calculate Refund

Calculate refund amounts before processing with line items, restock type, location, already\_stocked flag, and shipping

List Product Metafields

Retrieve metafields for a product

List Customer Metafields

Retrieve metafields for a customer

List Order Metafields

Retrieve metafields for an order

Create Product Metafield

Create a metafield for a product

Create Customer Metafield

Create a metafield for a customer

Create Order Metafield

Create a metafield on an order to store custom metadata or flags (e.g. is\_gift). Use this to reliably add an order metaf...

Get Product Metafield

Retrieve a specific metafield attached to a product by product\_id and metafield\_id. Use the fields query param to return...

Update Product Metafield

Update a product metafield's value or type

Delete Product Metafield

Delete a metafield from a product

Delete Customer Metafield

Delete a metafield from a customer

Delete Order Metafield

Delete a metafield from an order

Update Customer Metafield

Update a customer metafield's value or type by customer\_id and metafield\_id. Only the value and type fields can be chang...

Update Order Metafield

Update an order metafield's value or type by order\_id and metafield\_id. Only the value and type fields can be changed on...

List Price Rules

Retrieve all price rules

Get Price Rule

Retrieve a single price rule by ID

List Abandoned Checkouts

Retrieve abandoned checkouts with filtering by status (open or closed), date ranges, and cursor-based pagination. Return...