Ordexs API v1 Get an API key

Get started

Authentication and keys

Every request carries an API key. A key belongs to one store, works in live or test mode, and can only do what its scopes allow.

Sending the key

Put the key in the Authorization header as a bearer token, on every request:

GET /v1/orders HTTP/1.1
Host: api.ordexs.com
Authorization: Bearer ordx_live_Ab3dEf6hIj9k_…

There is no other way to authenticate: no query-string keys, no cookies, no sessions. A request without a key gets 401 authentication_required; a wrong, revoked or deleted key gets 401 invalid_api_key.

What a key looks like

ordx_live_Ab3dEf6hIj9k_q8Rw2…   a live key
ordx_test_Zx7cVb4nMm1l_t5Yu9…   a test key
  • live keys read and change the merchant's real store.
  • test keys work on a separate test store. See Test mode.
  • The part after the mode is a public prefix the dashboard shows, so the merchant can tell keys apart. The rest is secret and shown once, when the key is created. Ordexs stores only a hash of it and can't show it again.

Who creates keys

The store's owner, or a team member allowed to manage settings, creates keys under Settings → Developers → API keys in the Ordexs dashboard. Keys can't be created or changed through the API itself.

A key belongs to the store, not to the person who made it. It keeps working when that person leaves the team, and their role never widens what it can do. The dashboard shows who created each key and when it was last used.

The number of active keys (live and test together) depends on the plan: 3 on Starter, 10 on Growth, 25 on Scale.

Scopes

A key can only call endpoints whose scope it has. The merchant ticks scopes when creating the key, or picks a preset (Read only, Orders integration, Full access). Calling an endpoint without its scope returns 403 insufficient_scope with the missing scope in details.required_scope.

ScopeLets the key
store:readRead the store’s name, country, currency and languages.
Retrieve the store
products:readRead products, variants, stock and the media library.
List products · Retrieve a product · Retrieve a variant · List collections · Preview automated conditions · Retrieve a collection · List a collection's products · List categories · List reviews · Retrieve review settings · List the media library · Retrieve a media file
products:read_costsAlso see cost prices on variants. Leave it off unless you need margins.
products:writeCreate, change and archive products and variants, set stock, and add product images.
Create a product · Update a product · Archive a product · Update a variant · Delete a variant · Add a variant · Create a collection · Reorder collections · Update a collection · Delete a collection · Duplicate a collection · Add a review · Publish or hide a review · Delete a review · Update review settings · Create an image upload slot · Add a product image · Update a product image · Remove a product image
inventory:readRead stock levels, the stock history and stock counts.
List inventory levels · Retrieve an inventory level · List stock movements · Retrieve inventory settings · List stock counts · Retrieve a stock count · List returns · Retrieve a return
inventory:writeAdjust stock with a reason, receive deliveries, run stock counts and set the low-stock alert level.
Adjust stock · Update inventory settings · Receive an incoming delivery · Start a stock count · Record counted quantities · Apply a stock count · Discard a stock count · Check returns in · Mark a return as arrived
orders:readRead orders, their notes and history.
List orders · Retrieve an order · List an order's notes · List an order's history · List contacts with the customer · List abandoned checkouts · Retrieve an abandoned checkout · Export orders
orders:writeCreate orders, edit them before they ship, change status, cancel and add notes.
Create an order · Update an order · Add a note to an order · Preview an order · Change an order's status · Cancel an order · Archive orders · Log a contact · Record a call's outcome · Delete a note · Update an abandoned checkout · Delete an abandoned checkout · Confirm an abandoned checkout
orders:assignAssign orders to teammates (and unassign them), and list who can be assigned.
List team members · Assign orders · Assign abandoned checkouts
customers:readRead customers.
List customers · Retrieve a customer · List customer segments · List a segment's customers
customers:writeCreate and update customers.
Create a customer · Update a customer
shipping:readRead shipments, their tracking and courier history, and print labels.
List shipments · Retrieve a shipment · Download the label · Refresh a parcel's status now
shipping:writeSend orders to the courier and cancel shipments that haven’t been picked up. Each send is a real parcel at the courier.
Send an order to the courier · Cancel a shipment · Advance a test shipment · Mark a parcel packed · Validate a parcel with the courier · Set a tracking number by hand
offers:readRead offers (bundles, quantity packs, cross-sells) with their results, and discounts; check a discount code.
List offers · Retrieve an offer · Retrieve an offer's results · List discounts · Check a discount code · Retrieve a discount
offers:writeCreate, change, pause and delete offers and discounts.
Create an offer · Update an offer · Delete an offer · Create a discount · Update a discount · Delete a discount
money:readRead the cash-on-delivery balance per courier, the delivered orders not paid for yet, and courier payouts.
List cash-on-delivery balances · List orders awaiting payment · List payouts · Retrieve a payout · List a payout's orders
money:writeRecord courier payouts (the cash a courier hands over) and delete them.
Record a payout · Delete a payout
delivery:readRead delivery settings and prices, the store’s courier accounts and its routing rules.
List courier accounts · Retrieve delivery settings · List delivery prices · List routing rules
delivery:writeChange delivery settings and prices, the default courier and routing rules. Connecting a courier stays in the dashboard.
Update delivery settings · Update delivery prices · Add a routing rule · Update a routing rule · Delete a routing rule
analytics:readRead the store’s analytics: sales and visits over a period, cash, couriers, best sellers, customer insights and team performance. Read only.
Retrieve the overview · Retrieve customer insights · Retrieve team performance
content:readRead the store’s pages, policies and order form.
List policies · Retrieve a policy · List pages · Retrieve a page · Retrieve the order form
content:writeChange the store’s details (name, contact, address, language, timezone, order prefix), its pages, policies and order form.
Set a policy · Delete a policy · Create a content page · Update a page · Delete a page · Duplicate a page · Update the order form · Update the store's details
marketing:readRead the store’s marketing pixels (Meta, TikTok, Google…).
List pixels · Retrieve a pixel
marketing:writeAdd, change and remove marketing pixels. Conversions API tokens are set in the dashboard only.
Add a pixel · Update a pixel · Remove a pixel
webhooks:readList webhook endpoints.
List webhook endpoints · Retrieve a webhook endpoint
webhooks:writeCreate, change, rotate and delete webhook endpoints.
Create a webhook endpoint · Update a webhook endpoint · Delete a webhook endpoint · Rotate the signing secret · Send a test event
events:readRead the event log of the last 30 days.
List events · Retrieve an event

The geography endpoints (countries, regions, cities, delivery rates) need no scope: any valid key can call them.

Revoking and rotating

Revoking a key in the dashboard stops it within 30 seconds, everywhere. There is no undo: create a new key instead.

To rotate a key without downtime: create the new key, deploy it, check it is being used (the dashboard shows Last used), then revoke the old one.

When the store changes plan

The API is part of the Starter, Growth and Scale plans. If the store moves to the Try plan, every request returns 402 plan_required. Keys and webhook endpoints are paused, not deleted, and work again as soon as the store upgrades. Events from the paused period are not sent afterwards.

Keeping keys safe

  • Keep keys on your server. Never ship one in a browser, a mobile app or a desktop app.
  • Read the key from an environment variable or a secrets manager, never from source code.
  • Use a separate key per integration, so revoking one doesn't break the others.
  • If a key leaks, revoke it at once and create a new one.