Skip to main content

​
Shopify Integration

​
Overview

Shopify is the simplest integration method supported by ORBEXA. Merchants only need to complete OAuth authorization — no code required — and ORBEXA automatically syncs product data and deploys all protocol endpoints.

​
OAuth Authorization Flow

ORBEXA uses the standard Shopify OAuth flow for authorization:
  1. Merchant initiates authorization — Click “Connect Shopify” in the ORBEXA console
  2. Redirect to Shopify — Redirected to the Shopify authorization page where the merchant confirms the permission scope
  3. Callback handling — Shopify calls back to ORBEXA, and the platform obtains an Access Token
  4. Automatic sync — All product data is immediately pulled from Shopify
  5. Endpoint deployment — UCP/ACP/MCP endpoints are automatically deployed for the merchant
The entire process is implemented through shopifyOAuth.ts, including complete OAuth state verification and token management.

​
Automatic Product Sync

After authorization is complete, ORBEXA automatically syncs the following data from Shopify:
  • Product basics (name, description, price, images)
  • Product variants (size, color, specifications)
  • Inventory quantities
  • Product status (published/unpublished)
  • Product categories and tags
After sync, product data enters the AI Refinery Pipeline for automatic cleaning and standardization (see Chapter 7), then is exposed through all protocol endpoints.

​
Webhook Event Handling

ORBEXA registers the following Shopify Webhooks to ensure real-time data synchronization:
Webhook EventTrigger ConditionORBEXA Action
Product UpdateProduct information changesAutomatically updates product data, regenerates protocol endpoint content
Product DeleteProduct removedRemoves the product from all protocol endpoints
Inventory UpdateInventory level changesUpdates inventory in real time, reflected across UCP/ACP/MCP
Order CreateNew order placedRecords order information
Order UpdateOrder status changesUpdates order status
Order FulfilledOrder shippedMarks the order as complete
App UninstalledMerchant uninstalls the appCleans up authorization data, deactivates protocol endpoints

​
Event Handling Mechanism

All Webhook events are handled automatically by ORBEXA:
  • Product changes: When a product is updated or deleted, the platform immediately syncs the change to the local database, and all protocol endpoints automatically reflect the latest state
  • Inventory changes: Inventory quantity changes are synced in real time, so AI agents always query accurate inventory
  • Order events: Order creation, updates, and fulfillment status are automatically recorded and synced
  • App uninstall: When a merchant uninstalls the ORBEXA app from the Shopify admin, the platform automatically cleans up associated data and authorization

​
Platform-Side Rate Limiting

To comply with Shopify API limits, ORBEXA limits calls to the Shopify platform to 2 requests/second. This is a platform-side rate limit and does not affect the rate at which AI agents access ORBEXA endpoints.

​
Zero-Code Integration

Shopify merchants do not need to:
  • Write any code
  • Configure any Webhooks
  • Manage API keys
  • Understand UCP/ACP/MCP protocols
Simply complete the OAuth authorization in the ORBEXA console, and everything else is automated.

​
Summary

Shopify integration is the most lightweight integration method in ORBEXA: after OAuth authorization, products sync automatically, 7 Webhook event types are handled automatically, and all protocol endpoints become available immediately. Merchants never need to touch any technical details.
Next chapter: WooCommerce Integration — Plugin installation, API connection, three-way product/order/inventory sync