- Retrieve a paginated list of products with filtering by status, vendor, product type, collection, title, published_status (published/unpublished/any), and date ranges (created_at, published_at, updated_at). Returns next_page_info cursor for pagination — pass it as page_info input to fetch subsequent pages
- Retrieve a single product by ID
- Create a new product with optional variants, images, options, metafields, SEO tags, and published_at. Only title is required — all other fields are optional
- Update an existing product by product_id. Supports updating title, description, vendor, tags, status, variants, images, options, metafields, and SEO tags
- Delete a product
- Get total count of products
- Retrieve all variants for a given product_id with pricing, SKU, inventory, and option values. Returns next_page_info cursor for pagination — pass it as page_info input to fetch subsequent pages
- Retrieve a specific product variant
- Add a new variant to a product with pricing, inventory, fulfillment, image, and metafields options. Requires product_id as path parameter
- Update variant pricing, inventory, fulfillment, options, barcode, image, tax code, and metafields by variant_id. All fields optional — only pass fields to change
- Remove a variant from a product
- Get count of variants for a product
- Retrieve all images for a product
- Retrieve a single product image
- Add a new image to a product
- Modify a product image's position, alt text, variant associations, metafields, or replace image content via src URL
- Remove an image from a product
- Retrieve a paginated list of orders with filtering by status, fulfillment state, financial state, date ranges, and app attribution. Supports cursor-based pagination via page_info parameter
- Retrieve a single order by ID
- Create a new order with line items (supporting variant_id, title, price, SKU, quantity, grams, taxable, requires_shipping, product_id, vendor, gift_card, fulfillment_service, total_discount, properties, tax_lines, discount_allocations, duties, attributed_staffs), customer, billing/shipping addresses, tax lines, discount codes, fulfillment status, fulfillments, currency, inventory behaviour, shipping lines, transactions, note, tags, note_attributes, and metafields
- Update an existing order's properties including note, tags, email, phone, marketing preferences, note_attributes, and metafields
- Cancel an order
- Get total count of orders matching filter criteria for reporting and dashboards
- Close an order
- Reopen a closed order
- Retrieve a paginated list of customers. Supports cursor-based pagination via page_info parameter
- Retrieve a single customer by ID
- Create a new customer with name, email, phone, addresses, tags, verified_email, send_email_welcome, and metafields options
- Update an existing customer by customer_id. Supports updating name, email, phone, addresses, tags, note, tax_exempt, verified_email, and metafields
- Get total count of customers
- Search customers by criteria with cursor-based pagination
- Retrieve all addresses for a customer. Supports cursor-based pagination via page_info parameter
- Retrieve a specific customer address
- Add a new shipping or billing address to a customer by customer_id. All address fields (address1, city, country, etc.) are optional — only customer_id is required
- Update an existing address
- Remove an address from customer (cannot delete default address)
- Retrieve inventory items by IDs (required on first request, max 100). Returns next_page_info cursor for pagination — pass it as page_info to fetch subsequent pages (omit ids when using page_info)
- Retrieve inventory levels across locations
- Adjust inventory quantity at a location (requires inventory tracking enabled)
- Set absolute inventory quantity at a location
- Connect an inventory item to a location
- Update an inventory item's SKU, tracking status, shipping requirement, harmonized system code, and country/province of origin by inventory_item_id
- Retrieve all store locations with cursor-based pagination
- Retrieve a specific location
- Retrieve fulfillments for an order. Supports cursor-based pagination via page_info parameter
- Create a fulfillment for fulfillment orders
- Retrieve all custom collections with cursor-based pagination
- Create a new custom collection with title, description, image, sort order, collects (to include products), and metafields
- Update an existing custom collection by collection_id. Supports updating title, description, image, sort order, published status, collects (to add products), and metafields
- Permanently delete a custom collection
- Retrieve product-collection associations with cursor-based pagination
- Add a product to a collection
- Remove a product from a collection
- Retrieve all registered webhooks. Supports cursor-based pagination via page_info parameter
- Register a new webhook subscription with topic, address, format, fields, and metafield namespaces
- Modify an existing webhook subscription
- Unregister a webhook subscription
- Retrieve all draft orders. Supports cursor-based pagination via page_info parameter
- Retrieve a single draft order by ID
- Create a new draft order with line items (supporting variant_id, title, price, quantity, sku, grams, taxable, requires_shipping, gift_card, applied_discount, properties), billing/shipping addresses, order-level applied discount, and customer
- Convert draft order to regular order
- Modify an existing draft order
- Permanently delete a draft order
- Retrieve payment transactions for an order
- Create a payment transaction (requires existing authorization)
- Retrieve all refunds for a specific order_id, including line items, transactions, and adjustments. Returns next_page_info cursor for pagination — pass it as page_info to fetch subsequent pages
- Retrieve a specific refund by ID
- Create a refund for order items (requires captured payment)
- Calculate refund amounts before processing with line items, restock type, location, already_stocked flag, and shipping
- Retrieve metafields for a product
- Retrieve metafields for a customer
- Retrieve metafields for an order
- Create a metafield for a product
- Create a metafield for a customer
- Create a metafield for an order
- Retrieve a specific metafield attached to a product by product_id and metafield_id. Use the fields query param to return only specific fields (e.g., id,namespace,key,value,type)
- Update a product metafield's value or type
- Delete a metafield from a product
- Delete a metafield from a customer
- Delete a metafield from an order
- Update a customer metafield's value or type by customer_id and metafield_id. Only the value and type fields can be changed on an existing 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 an existing metafield
- Retrieve all price rules
- Retrieve a single price rule by ID
- Retrieve abandoned checkouts with filtering by status (open or closed), date ranges, and cursor-based pagination. Returns checkout details including customer info, line items, totals, and recovery URLs
No matching actions