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. Create offers for the prices you sell​

An offer tells Order Management System which physical goods to ship when a specific price is purchased. Only payments that contain at least one offer-mapped price create orders.

In the Orders view, go to Shipping > Offers and create an offer for every price that requires shipping. See Offers for details.

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 you mapped to an offer.
  2. In the Orders view, open Orders. The new order appears shortly after the payment succeeds, with one item per matched line item.

If no order appears, check that the payment succeeded, that the offer covers the purchased price, and that the Order Management addon is still enabled in Settings > Addons.

Next steps​