Skip to main content

Setting Up

Order Management System (OMS) is a first-class addon. Enable it once from your dashboard and every successful payment that contains goods you ship becomes an order automatically — no manual webhook wiring or secrets to copy.

Prerequisites
  • Order Management System is currently available in the sandbox environment only.
  • You need a working payments integration and at least one product with a price.
  • Enabling an addon requires an admin (or owner) role on the account.

1. Enable the Order Management addon​

In the Payments view, go to Settings > Addons and click Enable on Order Management.

Enabling does everything the integration needs in one step:

  • Provisions your Orders workspace for this account.
  • Subscribes Order Management System to the payment events it needs.
  • Configures the shared secret used to verify those events.

When it finishes, an Orders option appears in the view switcher (top of the sidebar). Switch to the Orders view to configure the rest.

note

Disabling the addon later keeps all your Orders data — it only stops new payments from creating orders and hides the Orders view. Re-enabling resumes order creation from that point on; payments received while it was disabled are not backfilled.

2. Mark the products you ship​

A product tells Order Management System what to do when one of its prices is purchased. Only payments that contain at least one shippable product create orders.

In the Payments view, open Products and, for every product you ship:

  • turn on Shippable, and
  • fill in the SKU the warehouse ships it under (add-ons that belong on the order but never ship, such as a warranty, are marked shippable with no SKU).

See What the SKU decides for what each setting changes.

3. Configure order bundling​

In the Orders view, go to Settings > General. The Bundling window (minutes) setting controls whether multiple purchases made by the same customer within a short time are grouped into a single order:

  • 0 — every payment creates its own order.
  • Any other value — follow-up purchases within the window are added to the existing order.

See How orders are created for the exact bundling rules.

4. Verify the setup​

  1. Make a test payment that includes a price of a shippable product.
  2. In the Orders view, open Orders. The new order appears shortly after the payment succeeds, with one item per shippable line item.

If no order appears, check that the payment succeeded, that the purchased product is marked Shippable, and that the Order Management addon is still enabled in Settings > Addons. If all three look right, repair the addon.

Repairing the addon​

Enabling creates two things on the payments side of your account, and both are ordinary objects you can see and edit yourself:

  • a webhook subscriber pointing at Order Management System, in Developer tools > Webhooks, and
  • a secret key noted Order Management System, in Developer tools > Access keys.

If either is archived, deactivated, renamed or has its permissions changed, orders quietly stop being created — the addon can still show as Enabled.

To put both back the way enabling created them, go to Settings > Addons and click Repair on Order Management. Repair is safe to run as often as you like.

note

Repair only touches those two objects and your account's Order Management setup. It does not delete or change any orders, and it does not backfill payments received while the addon was broken.

Repair needs the same admin (or owner) role enabling does, because it manages API keys and webhooks on your behalf. If your account already has the maximum of five active webhook subscribers and Repair needs to create one, archive an unused subscriber in Developer tools > Webhooks first.

Next steps​