Get basic information about the authenticated store including name, plan, configuration, and available features.

List available payment providers configured in the store (extracted from /store).

List available shipping providers configured in the store (extracted from /store).

Get extended store settings including languages, design, features and domains (from /store).

List all products in the store with optional filtering, pagination, and sorting. Supports filtering by category, stock levels, dates, and various other criteria.

List all variants for a given product, including price, stock and SKU.

Get a specific variant of a product by ID.

Create a new variant for a product (price, stock, sku, etc.)

Update an existing variant for a product.

List all images for a product.

Create/add a new image to a product.

Update product image properties (src, position, alt).

Get detailed information about a specific product by ID, including variants, images, categories, and all metadata.

Create a new product in the store. At minimum requires name and price. Supports multiple languages, variants, images, categories, and extensive metadata.

Update an existing product. All fields are optional except product_id. Only provided fields will be updated.

Search for products using a text query. Supports pagination and filtering by category and publication status.

📋 LIST ALL ORDERS - Retrieve a paginated list of store orders with comprehensive filtering capabilities. Use this for order management, analytics, and finding specific orders. Supports filtering by status, payment state, shipping status, date ranges, total values, customer IDs, and text search. Returns order details including customer info, products, totals, and fulfillment data.

GET ORDER CUSTOM FIELDS - Retrieve all custom fields for a specific order.

UPDATE ORDER CUSTOM FIELDS - Replace or set custom fields for an order.

🔍 GET SPECIFIC ORDER - Retrieve complete details for a single order by its unique ID. Use this when you need comprehensive information about a specific order including customer data, product line items, pricing, shipping address, payment details, fulfillment status, tracking info, and order history. Essential for order processing, customer service, and detailed analysis.

➕ CREATE NEW ORDER - Create a new order programmatically with complete customer and product information. Use this for manual order creation, bulk imports, external integrations, or processing orders from other channels. Requires customer details (name, email), product variants with quantities, and billing address. Supports custom pricing, shipping options, payment gateway selection, and inventory management.

✏️ UPDATE ORDER - Modify specific fields of an existing order. Use this to update order status (open/closed/cancelled) or add internal owner notes for order management. Limited to certain fields after order creation to maintain data integrity. Commonly used for order state management and adding administrative comments.

❌ CANCEL ORDER - Cancel an existing order and optionally specify the cancellation reason. Use this for order cancellations due to customer requests, fraud detection, inventory issues, or other business reasons. Sets order status to 'cancelled' and may trigger automatic refund processes depending on payment status. Important for order management and customer service.

📦 GET ORDER FULFILLMENT - Retrieve detailed fulfillment and shipping information for a specific order. Use this to track order fulfillment status, shipping details, carrier information, tracking numbers, delivery dates, and fulfillment order line items. Essential for logistics management, customer support, and shipping status updates.

MARK ORDER AS PAID - Mark an order as paid.

LIST DRAFT ORDERS - Retrieve paginated draft orders (quotes) with optional date filters.

GET DRAFT ORDER - Retrieve a single draft order by ID.

CREATE DRAFT ORDER - Create a new draft order (quote) with customer and product information.

CONFIRM DRAFT ORDER - Confirm a draft order and convert it to a regular order.

DELETE DRAFT ORDER - Delete a specific draft order.

GET FULFILLMENT ORDER - Retrieve a fulfillment order by its ID.

LIST ORDER TRANSACTIONS - Retrieve transactions for a given order.

GET ORDER TRANSACTION - Retrieve a single transaction by order and transaction IDs.

CLOSE ORDER - Close (archive) an order.

REOPEN ORDER - Reopen a previously closed order.

CREATE INVOICE - Create an invoice for an order.

GET INVOICE - Retrieve an invoice for an order.

GET ORDER VALUE HISTORY - Get a history of an order's total value changes.

GET ORDER EDIT HISTORY - Retrieve a log of all changes made to an order.

👥 LIST ALL CUSTOMERS - Retrieve a paginated list of store customers with filtering and search capabilities. Use this for customer management, analytics, segmentation, and finding specific customers. Supports filtering by creation/update dates, text search by name/email/identification, and pagination for large customer bases. Returns customer profiles with contact info, spending totals, and order history.

🔍 GET SPECIFIC CUSTOMER - Retrieve complete details for a single customer by their unique ID. Use this when you need comprehensive customer information including personal details, contact info, billing/shipping addresses, total spent, last order, account status, and custom extra fields. Essential for customer service, account management, and personalized marketing.

➕ CREATE NEW CUSTOMER - Create a new customer account with complete profile information. Use this for customer registration, manual account creation, bulk imports, or integrating with external systems. Requires name and email as minimum fields. Supports phone, identification documents, addresses, notes, passwords, and email invitation sending. Ideal for onboarding and customer management.

✏️ UPDATE CUSTOMER - Modify existing customer information including personal details, contact information, and internal notes. Use this for customer profile updates, data corrections, preference changes, and maintaining accurate customer records. All fields are optional except customer_id - only provided fields will be updated, preserving existing data.

🔎 SEARCH CUSTOMERS - Find customers using text search across names, emails, and identification numbers. Use this for quick customer lookup, support queries, order assignment, and customer service scenarios. Supports pagination for large result sets. More flexible than listing with specific filters when you need fuzzy matching or don't know exact customer details.

📂 LIST ALL CATEGORIES - Retrieve a hierarchical list of product categories with filtering and localization support. Use this for catalog management, navigation setup, category analytics, and organizing products. Supports filtering by parent category, text search, date ranges, and multi-language content. Returns category tree structure with names, descriptions, and product counts.

GET CATEGORY CUSTOM FIELDS - Retrieve all custom fields for a category.

UPDATE CATEGORY CUSTOM FIELDS - Replace or set custom fields for a category.

🔍 GET SPECIFIC CATEGORY - Retrieve complete details for a single product category by its unique ID. Use this when you need comprehensive category information including localized names, descriptions, SEO metadata, parent-child relationships, subcategories, and product associations. Essential for category management, SEO optimization, and catalog organization.

➕ CREATE NEW CATEGORY - Create a new product category with multi-language support and hierarchical organization. Use this for expanding catalog structure, organizing products, improving navigation, and setting up category-based promotions. Supports parent-child relationships for subcategories, localized names/descriptions, and Google Shopping integration for enhanced marketing.

✏️ UPDATE CATEGORY - Modify existing category information including names, descriptions, and hierarchy relationships. Use this for category management, localization updates, SEO improvements, and reorganizing catalog structure. Supports multi-language content updates and parent category changes. Only provided fields will be updated, preserving existing data.

🗑️ DELETE CATEGORY - Permanently remove a product category from the store catalog. ⚠️ WARNING: Products in this category will be automatically moved to the parent category or become uncategorized. Use this for catalog cleanup, removing obsolete categories, or restructuring product organization. Consider the impact on navigation and product findability before deletion.

🎫 LIST ALL COUPONS - Retrieve a comprehensive list of discount coupons with advanced filtering options. Use this for promotional campaign management, coupon analytics, expired coupon cleanup, and marketing strategy analysis. Supports filtering by code, discount type (percentage/fixed), validity status, date ranges, and usage statistics. Essential for e-commerce marketing and sales optimization.

🔍 GET SPECIFIC COUPON - Retrieve complete details for a single discount coupon by its unique ID. Use this when you need comprehensive coupon information including discount value, type, usage statistics, validity period, restrictions, and performance metrics. Essential for coupon management, customer support queries, and promotional analysis.

➕ CREATE NEW COUPON - Create promotional discount coupons for marketing campaigns and customer incentives. Use this for launching sales, customer retention, first-time buyer discounts, and seasonal promotions. Supports percentage or fixed amount discounts, usage limits, validity periods, minimum order values, and product/category restrictions. Powerful tool for driving sales and customer engagement.

✏️ UPDATE COUPON - Modify existing discount coupon settings including discount value, validity period, usage limits, and restrictions. Use this for adjusting promotional campaigns, extending coupon validity, changing discount amounts, updating usage limits, and managing coupon lifecycle. Essential for dynamic marketing strategies and campaign optimization.

🗑️ DELETE COUPON - Permanently remove a discount coupon from the store. ⚠️ WARNING: This action is irreversible and will immediately invalidate the coupon for all customers, including those who may already have it saved. Use this for cleaning up expired promotions, removing unused coupons, or terminating problematic discount codes. Consider deactivating instead of deleting if usage tracking is important.

🔗 LIST ALL WEBHOOKS - Retrieve all configured webhook endpoints for real-time event notifications. Use this for integration management, webhook monitoring, debugging connectivity issues, and auditing external system integrations. Supports filtering by URL, event type, and date ranges. Essential for maintaining API integrations and event-driven architectures.

🔍 GET SPECIFIC WEBHOOK - Retrieve complete details for a single webhook configuration by its unique ID. Use this when you need comprehensive webhook information including endpoint URL, event type, authentication settings, delivery status, and error logs. Essential for webhook troubleshooting, configuration verification, and integration maintenance.

➕ CREATE NEW WEBHOOK - Set up real-time event notifications for external system integrations. Use this to establish automated workflows, sync data with external platforms, trigger business processes, and maintain real-time system connectivity. Supports all major store events including orders, customers, products, and categories. Requires HTTPS endpoints for security compliance.

✏️ UPDATE WEBHOOK - Modify existing webhook configuration including endpoint URL and event type. Use this for changing integration endpoints, updating event subscriptions, fixing broken webhook URLs, and adapting to system changes. Essential for maintaining active integrations and ensuring continuous data flow between systems.

LIST SCRIPT TAGS - Retrieve all script tags registered by the app.

GET SCRIPT TAG - Retrieve a single script tag by ID.

CREATE SCRIPT TAG - Register a new script tag (HTTPS URL only).

UPDATE SCRIPT TAG - Update the URL or event of a script tag.

DELETE SCRIPT TAG - Remove a script tag.

LIST LOCATIONS - Retrieve store locations with pagination and date filters.

GET LOCATION - Retrieve a single location by ID.

LIST PAYMENT PROVIDERS - Dedicated endpoint for payment providers.

GET PAYMENT PROVIDER - Retrieve a provider by ID.

LIST PAYMENT OPTIONS - Dedicated endpoint for payment options.

GET PAYMENT OPTION - Retrieve a payment option by ID.

LIST METAFIELDS - List metafields, optionally filtered by owner_resource and owner_id.

GET METAFIELD - Retrieve a single metafield by ID.

CREATE METAFIELD - Create a metafield for a given owner resource/id.

UPDATE METAFIELD - Update a metafield value by ID.

DELETE METAFIELD - Delete a metafield by ID.

LIST SHIPPING CARRIERS - Retrieve shipping carriers configured for the store.

GET SHIPPING CARRIER - Retrieve a single carrier by ID.

LIST DISCOUNTS - Retrieve store discounts (read-only).

GET DISCOUNT - Retrieve a discount by ID.

GET CART - Retrieve a shopping cart by numeric id or token. Returns items, totals and metadata.

ADD CART ITEM - Add a variant to the cart (by id or token) with the desired quantity.

REMOVE CART ITEM - Remove an item from the cart by item_id or variant_id (we'll resolve the item id when needed).

UPDATE CART ITEM QTY - Update line item quantity by item_id or variant_id (fallback removes+adds).

CLEAR CART - Remove all items from the cart.

APPLY CART COUPON - Apply a discount coupon code to the cart.

GET CHECKOUT - Retrieve checkout by ID, including items, customer, totals and status.

Generate a Checkout SDK integration template (script tag + skeleton code and guidance).

🧾 LIST ABANDONED CHECKOUTS - Retrieve paginated abandoned checkouts with filters. Use to analyze recovery opportunities, filter by dates or email, and export leads.

🔎 GET ABANDONED CHECKOUT - Retrieve a single abandoned checkout by ID, including customer, items and totals. Omit fields (or set to all/*) to return everything.

📧 SEND RECOVERY EMAIL - Trigger the recovery email for an abandoned checkout (if supported by API/version). Falls back gracefully if unsupported.

➕ ADD COUPON TO ABANDONED CHECKOUT - Add a discount coupon to an abandoned checkout.

List all product custom fields with pagination support

Get details of a specific product custom field by ID

Create a new product custom field

Update an existing product custom field

Delete a product custom field (only custom fields created by current app)

List products associated with a specific custom field

Associate or disassociate custom field values with a specific product

List all product variant custom fields with pagination support