OrderEx Developers
OrderEx holds the facts of every order line after checkout, so that the money follows the goods. Your systems report those facts and read them back through the tenant API.
These guides are for developers who connect a shop, an ERP, a warehouse system, a carrier or a payment provider to OrderEx. They take you from your first call to production, and every example uses the same invented order as the reference.
The guides, in reading order
- Getting started: get an API key, and create and read back your first order.
- Core concepts: facts, ids, amounts, VAT, times, and order status versus line status.
- The order lifecycle: report cancellations, shipments, deliveries and returns, and void a shipment.
- Payment facts: record authorizations, captures, refunds and releases, and see where the money does not add up.
- A reliable integration: retry safely, handle facts that arrive out of order, and load your history.
- Reading data: find orders, read the timeline and shipments, and page through lists.
- Errors: read a problem response and know what to do about it.
- Webhooks: let OrderEx call you when an order changes, and verify each call.
- Going live: the checklist before production.
Reference
- API reference: every endpoint of the tenant API, its requests, responses and problem types.
- Change list: every change to the API on its own dated page, newest first.
- Versioning: how the API changes, and how you are told before a change can break your integration.