Ordexs API v1 Get an API key

Get started

Test mode

Test keys work on a separate test store, so you can build and break things without touching a real order, a real courier or a real customer.

How it works

Every store can have a test store next to it. A test key (ordx_test_…) talks to that test store; a live key (ordx_live_…) talks to the real one. The endpoints, fields and rules are identical: switching an integration from test to live means changing the key and nothing else.

Every object you get back carries livemode: true from a live key, false from a test key.

What is kept apart

Test modeLive mode
Orders, products, customersOnly in the test storeThe real store
StockThe test store's ownReal stock
CouriersSimulated: TEST-… tracking, never a real parcelThe merchant's couriers
Messages to customersNever sentSent as the store is set up
Merchant's stats, order limits, billNot countedCounted
WebhooksSent to test endpoints onlySent to live endpoints only
Rate limit60 requests a minute (120 on Scale)120, 300 or 900 a minute by plan

What it starts with

The test store starts with a copy of the real store's delivery and checkout settings, so delivery prices and order rules come out the same as in the real store. It has no products: create the ones you need with POST /v1/products. Test orders don't appear in the merchant's Orders page.

Clearing test data

The merchant can wipe the test store under Settings → Developers → Test data → Clear test data. Orders, products and customers are deleted; test keys and test webhook endpoints keep working. There is no API call for this.

Testing shipping

Sending a test order to the courier returns a simulated shipment, and POST /v1/test_helpers/shipments/{id}/advance moves it to in transit, delivered or returned as a courier would. See Shipping and tracking.

Testing webhooks

Webhook endpoints have a mode too. Create a test endpoint and it receives the events your test-key calls cause, with livemode: false. You can also send a ping event to any endpoint at any time with POST /v1/webhook_endpoints/{id}/test or the Send test event button in the dashboard.