Ordexs API v1 Get an API key

Changelog

Every change to the Ordexs API, newest first.

Changes inside v1 are always additive: new endpoints, new fields, new event types and new enum values. Your integration should ignore fields and values it doesn't recognise. Anything that would break an existing integration ships as v2, and v1 keeps working.

2026-11-11 — Abandoned checkouts the shopper finished are deleted

  • When a shopper completes their own order, the abandoned checkout is now deleted instead of being kept with status: recovered. Webhook endpoints receive a final abandoned_checkout.updated (status: recovered, with order_id) first; afterwards GET /v1/abandoned_checkouts/{id} answers 404. recovered and confirmed now only describe checkouts the team turned into orders.
  • Any new order with the same phone number within 48 hours clears that number's open checkouts the same way.
  • One open checkout per phone number: a second checkout from the same number updates the existing one.
  • Open checkouts with no activity for 30 days move to status: deleted.

2026-11-10 — Storefront API: single pages

  • GET /pages/{page} now opens every published page. It answered 404 for all of them before.
  • The answer gains kind (page or landing_page), and path points to /lp/{handle} for landing pages. A landing page is built from blocks, so its body_html is usually null.

2026-11-09 — Storefront API

  • New: the Storefront API, a public, read-only API for building a store's front end anywhere — products with search, filters and facets, collections, categories, navigation, pages, policies, reviews, live offers, regions and delivery prices, and POST /cart/price, a server quote that prices a cart exactly as an order would.
  • It lives at https://api.ordexs.com/storefront/v1/<store>/… and needs a public Storefront API token in the X-Ordexs-Storefront-Token header. Stores create tokens under Settings → Developers → Storefront API, and choose which websites may use each one from a browser. The same API answers on the store's own address (https://<store>.myordexs.com/api/storefront/v1/…) without a token.
  • It is separate from this API (/v1): nothing here changed. Its ids are plain UUIDs, and it accepts this API's prod_…, var_… and ofr_… ids for the same rows. Contract: /docs/storefront-api/openapi.json.

2026-11-03 — New files on cdn.myordexs.com

  • Image, video and document URLs for files uploaded from now on start with https://cdn.myordexs.com/ (they were https://cdn.ordexs.com/). Files uploaded before keep their URLs, and both hosts serve every file. Same fields, same meaning; treat both hosts as Ordexs-hosted media.

2026-11-03 — Stores move to myordexs.com

  • A store's free address is now https://<store>.myordexs.com (it was https://<store>.ordexs.com). Every URL the API and webhooks return for a store's public pages uses it: the store's url, a product's url, page and policy urls, and an order's delivery.tracking_url. Same fields, same meaning; only the host changes. Stores with their own domain are unchanged.
  • Old <store>.ordexs.com addresses keep working, and page addresses on them redirect (301) to the same path and query on the new domain. Links you already stored or sent to customers stay valid; there is nothing to migrate.
  • The API itself stays at https://api.ordexs.com/v1.

2026-11-02 — Merged orders

  • A shopper can add items to their own unconfirmed order from the checkout, which sends order.updated for that order instead of order.created for a new one.
  • The merchant's team can merge two open orders of the same customer. The merged order sends order.status_changed and order.cancelled, then is deleted (GET returns 404). See Merged orders.

2026-11-02 — Customer reliability is the delivery score

  • A customer's reliability.tier is now new, reliable, uncertain or risky (it was new, trusted, good, mixed or risky), and reliability.score is the delivery score's percentage: delivered, returned and cancelled orders, with other Ordexs stores at half weight and recent orders weighing more. See Customers.
  • GET /v1/analytics/customers counts customers by the same four tiers in reliability, and top_customers[].reliability uses them too.
  • This changes existing values inside v1, an exception to the additive rule above, made before any integration depended on the old tiers.
  • delivery.tracking_url now stops working 3 days after the order is delivered or returned; the page then shows that the link has expired. A cancelled order has no tracking page. The URL itself doesn't change.
  • Orders: delivery.tracking_url, the customer's tracking page for the order (https://<store>.ordexs.com/track/<code>). null in test mode. See Shipping and tracking.
  • Fixed: since 2026-10-15 orders were missing preorder, assigned_to, type, exchange_of, collect, discount_name and offer_ids, and discount_code held the discount's name instead of its code. They are back as documented.

2026-10-13 — Card payments on orders

  • Stores can now take card payment (CIB / Edahabia through the merchant's own Slick-Pay account), in full or as a deposit with the rest in cash on delivery.
  • Orders: payment.method adds card and card_deposit; payment.status adds pending and partially_paid; new payment.amount_paid and payment.amount_to_collect.
  • order.updated also fires when a card payment lands or the payment method changes.
  • Order form: a new button id, pay_card (GET/PATCH /v1/order_form).
  • payment.card_discount: a store can give a discount for paying by card; it is included in discount and taken off total, and given back if the order switches to cash on delivery.

2026-10-13 — What connected apps need

  • Webhook endpoints created with an OAuth token belong to that connection: the app sees and changes only its own, and they are deleted when the merchant disconnects the app.
  • Products: url is now the product's storefront page (null while unpublished and in test mode); GET /v1/products?handle= finds a product from its storefront address.
  • Orders: shipping_address.region (and GET /v1/delivery/rates?region=) also take an ISO code (DZ-16) or a region name (Alger, الجزائر), up to 60 characters.
  • out_of_stock now carries details.lines: each short line with its available_quantity.

2026-10-13 — OAuth apps

  • Apps can now be connected with an approval instead of a copied key: register an app under Settings → Developers → Your apps, send merchants to https://admin.ordexs.com/oauth/authorize (authorization code + PKCE S256), then POST https://api.ordexs.com/oauth/token (authorization_code, refresh_token) and POST https://api.ordexs.com/oauth/revoke. See OAuth apps.
  • Access tokens look like API keys (ordx_live_… / ordx_test_…) and last one hour; an expired one answers 401 invalid_api_key with a message saying to refresh.

2026-10-13 — Bulk jobs and exports

  • Bulk jobs: POST /v1/bulk_uploads (a slot for the NDJSON file), POST /v1/bulk_jobs (orders.create, orders.update, products.create, products.update, inventory.adjust; up to 10,000 lines), GET /v1/bulk_jobs (+ /{job_id}), GET …/{job_id}/results, POST …/{job_id}/cancel; event bulk_job.completed.
  • GET /v1/orders/export: matching orders as streamed NDJSON, up to 100,000.

2026-10-13 — Marketing pixels

  • GET/POST /v1/pixels, GET/PATCH/DELETE /v1/pixels/{pixel_id} (Meta, TikTok, Google, Snapchat, Pinterest, custom). Conversions API tokens stay in the dashboard.
  • New scopes marketing:read and marketing:write.

2026-10-13 — Store content

  • PATCH /v1/store: name, contact, address, storefront language, timezone, order prefix. GET /v1/store gains language, timezone, order_prefix, contact and address.
  • Policies: GET /v1/policies, GET/PUT/DELETE /v1/policies/{kind}.
  • Pages: GET/POST /v1/pages, GET/PATCH/DELETE /v1/pages/{page_id}, POST …/duplicate.
  • GET/PATCH /v1/order_form: the checkout form's fields, buttons and general settings.
  • New scopes content:read and content:write.

2026-10-13 — Analytics

  • GET /v1/analytics/overview (a period, or a custom range), GET /v1/analytics/customers (customer insights, for everyone or one segment) and GET /v1/analytics/team. Read only, computed by the same code as the dashboard.
  • New scope analytics:read.

2026-10-12 — Editing orders with a courier

  • PATCH /v1/orders/{order_id} now works on an order already with a courier: the change is sent to the courier first and saved only if it accepts it (courier_rejected otherwise), for the details that courier accepts, until the parcel is validated or picked up. It used to be refused with invalid_state_transition as soon as the order had a parcel.

2026-10-12 — Delivery setup

  • GET /v1/couriers: the store's courier accounts.
  • GET/PATCH /v1/delivery/settings (strategy, modes, labels, the couriers whose rates are used, the default courier) and GET/PATCH /v1/delivery/prices (the store's prices per region).
  • Routing rules: GET/POST /v1/delivery/routing_rules, PATCH/DELETE /v1/delivery/routing_rules/{rule_id}.
  • New scopes delivery:read and delivery:write.

2026-10-12 — Product images and media

  • POST /v1/products/{product_id}/images from a url, an upload_id (POST /v1/uploads gives a slot to PUT a file to) or a media_id; PATCH and DELETE /v1/products/{product_id}/images/{image_id}.
  • Product images gain id. PATCH /v1/variants/{variant_id} takes image_id.
  • GET /v1/media and GET /v1/media/{media_id}: the store's media library.
  • products:write now also covers adding files to the media library; products:read reading it.

2026-10-12 — Returns and cash

  • Returns: GET /v1/returns (+ /{order_id}), POST /v1/returns/{order_id}/receive and POST /v1/returns/check_in (back to stock or written off; Ecotrack-family couriers are told).
  • Cash on delivery: GET /v1/cod_balances, GET /v1/cod_orders, and payouts GET/POST /v1/payouts, GET/DELETE /v1/payouts/{id}, GET /v1/payouts/{id}/orders.
  • New scopes money:read and money:write.

2026-10-12 — Offers and discounts

  • Offers: GET/POST /v1/offers, GET/PATCH/DELETE /v1/offers/{id} and GET /v1/offers/{id}/performance, for bundles, upsells (quantity packs) and cross-sells.
  • Discounts: GET/POST /v1/discounts (filter by code, kind, status), GET/PATCH/DELETE /v1/discounts/{id} and POST /v1/discounts/preview (check a code).
  • POST /v1/orders and /v1/orders/preview take offer_ids. Orders gain offer_ids and discount_name.
  • Fixed: an order's discount_code held the discount's name instead of the code. It is now the code, and the name moved to discount_name.
  • New scopes offers:read and offers:write; new error code duplicate_discount_code.

2026-10-12 — Collections, categories and reviews

  • Collections: GET/POST /v1/collections, GET/PATCH/DELETE /v1/collections/{id}, POST …/{id}/duplicate, GET …/{id}/products, POST /v1/collections/reorder, POST /v1/collections/preview. Products gain collection_ids.
  • GET /v1/categories.
  • Reviews: GET/POST /v1/reviews, PATCH/DELETE /v1/reviews/{id}, GET/PATCH /v1/review_settings; event review.created.

2026-10-12 — Customer extras

  • Customers gain reliability (score and tier), whatsapp_opt_in and whatsapp_opt_in_at; PATCH /v1/customers/{id} takes whatsapp_opt_in.
  • GET /v1/orders?customer_id=….
  • GET /v1/customer_segments and GET /v1/customer_segments/{segment_id}/customers.

2026-10-12 — Abandoned checkouts and shipping extras

  • Abandoned checkouts: GET /v1/abandoned_checkouts (+ /{id}), PATCH, DELETE, POST …/{id}/confirm, POST /v1/abandoned_checkouts/assign; events abandoned_checkout.created and abandoned_checkout.updated.
  • Shipments: POST /v1/shipments/{id}/pack, …/validate, …/refresh; POST /v1/orders/{id}/tracking. Shipments gain packed_at and last_checked_at.

2026-10-12 — Working orders

  • POST /v1/orders/assign and GET /v1/team_members (new scope orders:assign); POST /v1/orders/archive.
  • The contact log: GET/POST /v1/orders/{order_id}/contacts, PATCH /v1/orders/{order_id}/contacts/{contact_id}.
  • DELETE /v1/orders/{order_id}/notes/{note_id} (notes the key wrote).
  • PATCH /v1/orders/{order_id} takes scheduled_for and courier. Orders gain assigned_to.

2026-10-12 — Order types and line edits

  • POST /v1/orders takes type (delivery, exchange, pickup, cash_collection) and collect, custom lines (title + unit_price), hand-set unit_price, shipping_fee and total, like the dashboard's Create order. line_items is no longer required for a pickup or a cash collection.
  • PATCH /v1/orders/{order_id} takes line_items, shipping_fee and total.
  • Orders gain type, exchange_of and collect.

2026-10-12 — Inventory

  • Inventory levels: GET /v1/inventory (filters, search, sorts) and GET /v1/inventory/{variant_id}.
  • POST /v1/inventory/adjustments: up to 100 stock changes with a reason, all or nothing.
  • GET /v1/inventory_movements: the stock history, with who made each change.
  • GET/PATCH /v1/inventory_settings (low-stock alert level).
  • Variants gain allow_backorder, incoming_due_at and at_courier; PATCH /v1/variants/{id} sets them and incoming; PATCH /v1/products/{id} sets allow_preorder; POST /v1/variants/{id}/receive_incoming.
  • Stock counts: GET/POST /v1/stock_counts, GET /v1/stock_counts/{id}, POST …/lines, …/apply, …/discard.
  • New scopes inventory:read and inventory:write.

2026-10-12 — Pre-orders and create-and-send

  • POST /v1/orders takes preorder: true (lines may take units from the incoming delivery, like the dashboard's Pre-order switch) and ship: { courier_id? } (send to the courier right after creating; the answer adds shipment or ship_error). Orders gain preorder.

2026-10-12 — Shipping

  • POST /v1/orders/{order_id}/ship sends an order to the store's courier, exactly as the dashboard's Send to courier does. Test keys get a simulated shipment.
  • Shipments: GET /v1/shipments, GET /v1/shipments/{shipment_id}, GET /v1/shipments/{shipment_id}/label (the label file) and POST /v1/shipments/{shipment_id}/cancel.
  • POST /v1/test_helpers/shipments/{shipment_id}/advance moves a test shipment along (test keys only).
  • New scopes shipping:read and shipping:write; new events shipment.created and shipment.updated; new error codes courier_not_configured and courier_rejected.

2026-10-12 — Developer docs

  • The docs at ordexs.com/docs: guides, a reference page for every endpoint with cURL, Node, PHP and Python samples, a page for every webhook event, and search.
  • The OpenAPI 3.1 contract is downloadable at ordexs.com/docs/openapi.json.
  • Corrected the spec's descriptions of source_name, region_label, the order note, previous_attributes and request.api_key_id, which had been cut short. No behaviour changed.

2026-10-11 — Webhooks

  • Webhook endpoints: GET/POST /v1/webhook_endpoints, GET/PATCH/DELETE /v1/webhook_endpoints/{webhook_endpoint_id}, POST …/rotate_secret and POST …/test.
  • Events: order.created, order.updated, order.status_changed, order.cancelled, order.needs_review, order.note_added, product.created, product.updated, product.deleted, inventory.updated, customer.created, customer.updated, and ping.
  • Every delivery is signed: Ordexs-Signature: t=<unix>,v1=<hmac-sha256>. During a secret rotation it carries a second v1 signed with the previous secret.
  • GET /v1/events and GET /v1/events/{event_id}: the last 30 days.
  • Failed deliveries are retried for 3 days. An endpoint that fails for 3 days straight is turned off, and the store owner is told.

2026-10-11 — Write API

  • Orders: POST /v1/orders, POST /v1/orders/preview, PATCH /v1/orders/{order_id}, POST /v1/orders/{order_id}/status, POST /v1/orders/{order_id}/cancel and POST /v1/orders/{order_id}/notes. The store prices every order: line items take a variant_id and a quantity, never a price.
  • Orders gain source_name, external_id, needs_review and metadata, and the list takes external_id, source and needs_review filters. external_id is unique per store and source_name, so a retried create can't make a second order.
  • An order whose city isn't recognised is still created, with needs_review: "city_unmatched". It can't go to a courier until the merchant confirms the address.
  • Products: POST /v1/products, PATCH /v1/products/{product_id}, DELETE /v1/products/{product_id} (archives), POST /v1/products/{product_id}/variants, PATCH /v1/variants/{variant_id} and DELETE /v1/variants/{variant_id}. Setting inventory_quantity is recorded in the store's inventory history.
  • Customers: POST /v1/customers and PATCH /v1/customers/{customer_id}. Customer status gains the value needs_followup.
  • Every POST accepts an Idempotency-Key header (24 hours).
  • New error codes: duplicate_customer.

2026-10-09 — Read API

  • GET /v1/products, GET /v1/products/{product_id} and GET /v1/variants/{variant_id}. A variant's stock or price change moves its product's updated_at, so updated_since catches stock changes.
  • GET /v1/orders, GET /v1/orders/{order_id}, GET /v1/orders/{order_id}/notes and GET /v1/orders/{order_id}/history. Filter orders by status, number, phone, archived, created_since and updated_since.
  • GET /v1/customers and GET /v1/customers/{customer_id}.
  • GET /v1/countries, GET /v1/regions, GET /v1/cities and GET /v1/delivery/rates.
  • Every list uses cursor pagination (limit, cursor, next_cursor).

2026-10-09 — First release

  • API keys (ordx_live_…, ordx_test_…), scopes, test mode and rate limits.
  • GET /v1/store.