Ordexs API v1 Get an API key

Get started

Build on Ordexs

Read and change an Ordexs store from your own software: products and stock, cash-on-delivery orders, customers, delivery prices, and webhooks for everything that happens.

Your first request in two minutes

  1. In the Ordexs dashboard, open Settings → Developers and create a test key. Test keys work on a separate test store, so nothing you do reaches a real customer or courier.
  2. Put the key in an environment variable, never in your code:
export ORDEXS_API_KEY="ordx_test_…"
  1. Ask the API who you are:
curl https://api.ordexs.com/v1/store \
  -H "Authorization: Bearer $ORDEXS_API_KEY"

You get the store's name, country, currency and languages back as JSON. The quickstart goes on from here to create a product and a first order.

What you can build

  • Order intake. A chatbot, a call-centre tool or another sales channel creates orders that land in the merchant's Orders page, priced by the store itself: offers, discount codes and delivery included.
  • Stock and catalogue sync. Keep products and stock in step with a warehouse, an ERP or another shop.
  • Live dashboards and automations. Webhooks tell you the moment an order is confirmed, shipped, delivered or returned.
  • Customer tools. Look customers up by phone, see their delivery history, add notes to orders.

The API at a glance

The rules everything follows

  • One base URL: https://api.ordexs.com/v1. JSON in, JSON out, HTTPS only.
  • Money is a string with the currency's exact decimals: {"amount": "2500.00", "currency": "DZD"}. See Money and currencies.
  • IDs carry a prefix that says what they are: ord_, prod_, var_, cus_, evt_.
  • Lists use cursors, never page numbers. See Pagination and syncing.
  • Every error has one shape with a stable code and a sentence you can act on. See Errors.
  • Retries are safe with an Idempotency-Key. See Idempotency.
  • Additive only. v1 gains fields and endpoints, never loses them. See Versioning.