Skip to main content
Delegate
Docs

OmniCart

Connect your OmniCart store to manage orders, products, customers, collections, and draft orders — all from the WebOS desktop.

#What's included

  • Orders — list, search, view details, cancel, complete, and archive orders
  • Products — browse your product catalog with variants, options, and pricing
  • Customers — view customer profiles, addresses, and order history
  • Collections — manage product collections and their associated products
  • Draft Orders — create and manage draft orders, convert them to live orders
  • Store Overview — real-time metrics for order count, revenue, customers, and products
  • Store Settings — view store configuration, currencies, and region info

#About OmniCart

OmniCart is a headless commerce platform. Unlike traditional ecommerce platforms, it separates the storefront from the backend — giving you full control over your customer-facing experience while Delegate provides the admin panel.

The OmniCart integration connects directly to your store’s Admin API, so you can manage your entire commerce operation from the Delegate WebOS desktop alongside your other business tools. OmniCart does not use OAuth — you connect with an Admin API Secret Key (recommended) or admin email and password.

#Prerequisites

  • A running OmniCart store (self-hosted or cloud)
  • An Admin API Secret Key (recommended), or an admin user account with email and password
  • The base URL of your OmniCart store (e.g. https://api.my-store.com)
ℹ️Note
OmniCart requires the Marketing & Commerce bundle in your workspace subscription. Check Settings → Billing to verify your plan includes this bundle.

#Connecting OmniCart

1

Open the OmniCart app in WebOS

Launch WebOS and find OmniCart in the app launcher under the E-Commerce category. You can also press Cmd+K and type "OmniCart".
2

Choose an authentication method

OmniCart connects via its Admin API. Pick the method that fits your setup:
  • API Secret Key (recommended) — a durable server-to-server credential. In your OmniCart admin go to Settings › Developer › Secret API Keys and copy the sk_… key.
  • Email & Password — your OmniCart admin email and password.
3

Enter your store details

Fill in the connection form with:
  • Base URL — your OmniCart store URL (e.g. https://api.my-store.com). Do not include /admin at the end.
  • Admin API Secret Key (sk_…) — or, if using the other method, your Admin Email and Admin Password.
  • Account Label (optional) — a friendly name like "Production Store" or "Staging"
4

Click Connect OmniCart

Delegate validates your credentials by authenticating with your store and fetching store info. If successful, you’ll see the OmniCart dashboard.
💡Tip
You can connect multiple OmniCart accounts (e.g. production and staging). Use the account selector in the sidebar to switch between them.

#Managing orders

The Orders panel shows all orders from your OmniCart store. Use the search bar to find orders by ID or email, and filter by status (Pending, Completed, Cancelled).

Click any order to view its full details including:

  • Line items with quantities and pricing
  • Payment and fulfillment status
  • Shipping address
  • Order timeline

Available actions on an order:

  • Complete — mark the order as completed
  • Cancel — cancel the order (with optional reason)
  • Archive — archive the order to hide it from the default view
⚠️Warning
Cancelling an order cannot be undone. Make sure to process any necessary refunds through your payment provider before cancelling.

#Browsing products

The Products panel displays your product catalog. Each product shows its title, status (Published, Draft, Proposed), and thumbnail.

Click a product to see:

  • Product variants with SKU, pricing, and inventory counts
  • Product options (Size, Color, etc.)
  • Associated collection

#Customer management

The Customers panel lists all customers with their email, name, and registration status. Click a customer to view their saved addresses and order history.

Customers are labeled as Registered (have an account) or Guest (checkout-only).

#Draft orders

Draft orders let you create orders on behalf of customers before processing payment. Use the Convert to Order button to turn a draft into a live order.

ℹ️Note
Draft order creation is done through your OmniCart admin or storefront. Delegate provides viewing, management, and conversion capabilities.

#Demo mode

Don't have an OmniCart store yet? Click Try Demo Mode on the connect screen to explore all panels with sample data. Demo mode is read-only and doesn't connect to any real store.

#How authentication works

OmniCart connects through its Admin API — there is no OAuth flow. Delegate supports two credential types:

  • API Secret Key (recommended) — the sk_… key is sent over HTTP Basic auth (username = the key, empty password). It’s a durable server-to-server credential that doesn’t expire on a session timer.
  • Email & Password — Delegate authenticates with your store to obtain a short-lived JWT, cached for 55 minutes and automatically refreshed when it expires.

Credentials are encrypted at rest using AES-256.

⚠️Warning
Your credentials are stored encrypted in Delegate’s database. For maximum security, prefer a dedicated Admin API Secret Key scoped to only the permissions you need.

#Disconnecting

To disconnect an OmniCart account, click the account selector in the app sidebar and select Remove. This deletes the stored credentials from Delegate. Your OmniCart store is unaffected.

#Troubleshooting

  • Connection failed (422) — double-check your base URL and credentials (API Secret Key, or email and password). Make sure the URL doesn't end with /admin.
  • Access denied (403) — verify your workspace has the Marketing & Commerce bundle enabled.
  • Orders not loading — confirm your OmniCart store is running and accessible from the internet. Self-hosted instances behind a firewall may not be reachable.
  • Stale data — click the refresh button in the sidebar to re-fetch data from your store.