API Overview

The Commerce API is structured around a clear hierarchy, guiding you from user creation through organization setup, shop configuration, data population, automation, and analytics.

Core Foundation

• Users — The root of everything in the API.

Once a user is created, the following foundational resources become available:

• Authentication
• Devices

Organizations & Shops

You can create an Organization, an Entity and a Shop separately, or create a Shop directly — the system will automatically generate the required Organization and Entity.

• Organizations
• Entities
• Shops

Organization Management

Manage organization-level settings and operations:

• Invitations
• Invoices
• Payment Methods
• Plan & Billing
• Roles
• Usage

Shop Configuration

Configure and customize your shop with these resources:

Content & Structure

• Content Models

Customers

• Customer Groups

Inventory & Logistics

• Inventory Locations
• Inventory Rules
• Packaging

Localization

• Currencies

Payments

• Gateways

Products

• Option Sets
• Options
• Price Lists
• Product Field Sets

Returns

• Return Inspections
• Return Policies
• Return Reasons

Reviews

• Review Dimension Sets
• Review Dimensions
• Survey Questions

Shipping & Taxes

• Shipping Providers
• Shipping Rules
• Tax Rules
• Tax Systems

Shop Settings

• Branding
• Domains
• Notifications
• Sales Channels

Populating Your Shop

Add and manage core data within your shop:

Content

• Content Blocks
• Files
• Menus
• Data Feeds

Customers

• Customers

Inventory

• Inventory
• Purchase Orders
• Suppliers
• Transfers

Orders & Promotions

• Orders
• Buy Links
• Coupons
• Promotions

Products

• Brands
• Categories
• Products
• Product Variants

Returns & Reviews

• Returns
• Product Questions
• Product Reviews

Automation & Integration

• Automation

  • API Keys
  • Tasks
  • Webhooks
  • Workflows

• Integrations

  • QuickBooks
  • Xero

Helper & Advanced APIs

• AI
• Info
• Search
• Addresses

Customer & Order Management

Customers

• Customer Balance
• Customer Inventory

Orders

• Order Fulfillments
• Order Risks
• Scheduled Fulfillments
• Subscriptions

Analytics

• Analytics