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
- 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.
- Put the key in an environment variable, never in your code:
export ORDEXS_API_KEY="ordx_test_…"- 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
StoreThe store the API key belongs to.OrdersOrders, their notes and history.Abandoned checkoutsShoppers who left their details at checkout without ordering.ShippingSending orders to the courier, tracking and labels.Delivery setupDelivery prices and settings, courier accounts, the default courier and routing rules.ReturnsParcels coming back, and checking them in to stock.MoneyCash on delivery owed by couriers, and their payouts.ProductsProducts, their variants and stock.InventoryStock levels, adjustments with a reason, the stock history, deliveries and stock counts.CollectionsCollections (hand-picked or automated) and the categories products use.ReviewsProduct reviews and their moderation.OffersOffers (bundles, quantity packs, cross-sells) and discounts (codes and automatic).CustomersThe people who ordered from the store.AnalyticsRead-only reports, computed by the same code as the dashboard.ContentThe store's pages, policies and order form.MarketingMarketing pixels.BulkBackground jobs for thousands of lines, and exports.GeographyCountries, regions, cities and the store's delivery prices.WebhooksEndpoints that receive events, and the event log.
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
codeand a sentence you can act on. See Errors. - Retries are safe with an
Idempotency-Key. See Idempotency. - Additive only.
v1gains fields and endpoints, never loses them. See Versioning.
