API reference
Ordexs API
The Ordexs API lets your software read and change an Ordexs store: products, stock, orders, customers and delivery prices, plus webhooks for everything that happens in it.
Every request goes to the base URL below, over HTTPS, with your key in the Authorization header. Bodies and responses are JSON. The full contract is also published as an OpenAPI 3.1 file: import it into Postman, Insomnia or a code generator.
https://api.ordexs.com/v1New here? Start with the quickstart, then read authentication and errors.
Store
The store the API key belongs to.
Orders
Orders, their notes and history.
- GETList orders
/orders - GETList team members
/team_members - GETRetrieve an order
/orders/{order_id} - POSTCreate an order
/orders - POSTArchive orders
/orders/archive - POSTAssign orders
/orders/assign - POSTPreview an order
/orders/preview - PATCHUpdate an order
/orders/{order_id} - PATCHRecord a call's outcome
/orders/{order_id}/contacts/{contact_id} - POSTCancel an order
/orders/{order_id}/cancel - POSTLog a contact
/orders/{order_id}/contacts - POSTAdd a note to an order
/orders/{order_id}/notes - POSTChange an order's status
/orders/{order_id}/status - GETList contacts with the customer
/orders/{order_id}/contacts - GETList an order's history
/orders/{order_id}/history - GETList an order's notes
/orders/{order_id}/notes - DELDelete a note
/orders/{order_id}/notes/{note_id}
Abandoned checkouts
Shoppers who left their details at checkout without ordering.
- GETList abandoned checkouts
/abandoned_checkouts - GETRetrieve an abandoned checkout
/abandoned_checkouts/{checkout_id} - POSTAssign abandoned checkouts
/abandoned_checkouts/assign - PATCHUpdate an abandoned checkout
/abandoned_checkouts/{checkout_id} - POSTConfirm an abandoned checkout
/abandoned_checkouts/{checkout_id}/confirm - DELDelete an abandoned checkout
/abandoned_checkouts/{checkout_id}
Shipping
Sending orders to the courier, tracking and labels.
- GETList shipments
/shipments - GETRetrieve a shipment
/shipments/{shipment_id} - POSTSend an order to the courier
/orders/{order_id}/ship - POSTSet a tracking number by hand
/orders/{order_id}/tracking - POSTCancel a shipment
/shipments/{shipment_id}/cancel - POSTMark a parcel packed
/shipments/{shipment_id}/pack - POSTRefresh a parcel's status now
/shipments/{shipment_id}/refresh - POSTValidate a parcel with the courier
/shipments/{shipment_id}/validate - POSTAdvance a test shipment
/test_helpers/shipments/{shipment_id}/advance - GETDownload the label
/shipments/{shipment_id}/label
Delivery setup
Delivery prices and settings, courier accounts, the default courier and routing rules.
- GETList courier accounts
/couriers - GETList delivery prices
/delivery/prices - GETList routing rules
/delivery/routing_rules - GETRetrieve delivery settings
/delivery/settings - POSTAdd a routing rule
/delivery/routing_rules - PATCHUpdate delivery prices
/delivery/prices - PATCHUpdate a routing rule
/delivery/routing_rules/{rule_id} - PATCHUpdate delivery settings
/delivery/settings - DELDelete a routing rule
/delivery/routing_rules/{rule_id}
Returns
Parcels coming back, and checking them in to stock.
- GETList returns
/returns - GETRetrieve a return
/returns/{order_id} - POSTCheck returns in
/returns/check_in - POSTMark a return as arrived
/returns/{order_id}/receive
Money
Cash on delivery owed by couriers, and their payouts.
- GETList cash-on-delivery balances
/cod_balances - GETList orders awaiting payment
/cod_orders - GETList payouts
/payouts - GETRetrieve a payout
/payouts/{payout_id} - POSTRecord a payout
/payouts - GETList a payout's orders
/payouts/{payout_id}/orders - DELDelete a payout
/payouts/{payout_id}
Products
Products, their variants and stock.
- GETList the media library
/media - GETList products
/products - GETRetrieve a media file
/media/{media_id} - GETRetrieve a product
/products/{product_id} - GETRetrieve a variant
/variants/{variant_id} - POSTCreate a product
/products - POSTCreate an image upload slot
/uploads - PATCHUpdate a product
/products/{product_id} - PATCHUpdate a product image
/products/{product_id}/images/{image_id} - PATCHUpdate a variant
/variants/{variant_id} - POSTAdd a product image
/products/{product_id}/images - POSTAdd a variant
/products/{product_id}/variants - DELArchive a product
/products/{product_id} - DELRemove a product image
/products/{product_id}/images/{image_id} - DELDelete a variant
/variants/{variant_id}
Inventory
Stock levels, adjustments with a reason, the stock history, deliveries and stock counts.
- GETList inventory levels
/inventory - GETList stock movements
/inventory_movements - GETRetrieve inventory settings
/inventory_settings - GETList stock counts
/stock_counts - GETRetrieve an inventory level
/inventory/{variant_id} - GETRetrieve a stock count
/stock_counts/{stock_count_id} - POSTAdjust stock
/inventory/adjustments - POSTStart a stock count
/stock_counts - PATCHUpdate inventory settings
/inventory_settings - POSTApply a stock count
/stock_counts/{stock_count_id}/apply - POSTDiscard a stock count
/stock_counts/{stock_count_id}/discard - POSTRecord counted quantities
/stock_counts/{stock_count_id}/lines - POSTReceive an incoming delivery
/variants/{variant_id}/receive_incoming
Collections
Collections (hand-picked or automated) and the categories products use.
- GETList categories
/categories - GETList collections
/collections - GETRetrieve a collection
/collections/{collection_id} - POSTCreate a collection
/collections - POSTPreview automated conditions
/collections/preview - POSTReorder collections
/collections/reorder - PATCHUpdate a collection
/collections/{collection_id} - POSTDuplicate a collection
/collections/{collection_id}/duplicate - GETList a collection's products
/collections/{collection_id}/products - DELDelete a collection
/collections/{collection_id}
Reviews
Product reviews and their moderation.
- GETRetrieve review settings
/review_settings - GETList reviews
/reviews - POSTAdd a review
/reviews - PATCHUpdate review settings
/review_settings - PATCHPublish or hide a review
/reviews/{review_id} - DELDelete a review
/reviews/{review_id}
Offers
Offers (bundles, quantity packs, cross-sells) and discounts (codes and automatic).
- GETList discounts
/discounts - GETList offers
/offers - GETRetrieve a discount
/discounts/{discount_id} - GETRetrieve an offer
/offers/{offer_id} - POSTCreate a discount
/discounts - POSTCheck a discount code
/discounts/preview - POSTCreate an offer
/offers - PATCHUpdate a discount
/discounts/{discount_id} - PATCHUpdate an offer
/offers/{offer_id} - GETRetrieve an offer's results
/offers/{offer_id}/performance - DELDelete a discount
/discounts/{discount_id} - DELDelete an offer
/offers/{offer_id}
Customers
The people who ordered from the store.
- GETList customer segments
/customer_segments - GETList customers
/customers - GETRetrieve a customer
/customers/{customer_id} - POSTCreate a customer
/customers - PATCHUpdate a customer
/customers/{customer_id} - GETList a segment's customers
/customer_segments/{segment_id}/customers
Analytics
Read-only reports, computed by the same code as the dashboard.
- GETRetrieve customer insights
/analytics/customers - GETRetrieve the overview
/analytics/overview - GETRetrieve team performance
/analytics/team
Content
The store's pages, policies and order form.
- GETRetrieve the order form
/order_form - GETList pages
/pages - GETList policies
/policies - GETRetrieve a page
/pages/{page_id} - GETRetrieve a policy
/policies/{kind} - POSTCreate a content page
/pages - PATCHUpdate the order form
/order_form - PATCHUpdate a page
/pages/{page_id} - POSTDuplicate a page
/pages/{page_id}/duplicate - PUTSet a policy
/policies/{kind} - DELDelete a page
/pages/{page_id} - DELDelete a policy
/policies/{kind}
Marketing
Marketing pixels.
- GETList pixels
/pixels - GETRetrieve a pixel
/pixels/{pixel_id} - POSTAdd a pixel
/pixels - PATCHUpdate a pixel
/pixels/{pixel_id} - DELRemove a pixel
/pixels/{pixel_id}
Bulk
Background jobs for thousands of lines, and exports.
- GETList bulk jobs
/bulk_jobs - GETExport orders
/orders/export - GETRetrieve a bulk job
/bulk_jobs/{job_id} - POSTQueue a bulk job
/bulk_jobs - POSTCreate a bulk file slot
/bulk_uploads - POSTCancel a bulk job
/bulk_jobs/{job_id}/cancel - GETList a bulk job's results
/bulk_jobs/{job_id}/results
Geography
Countries, regions, cities and the store's delivery prices.
- GETList a region's cities
/cities - GETList supported countries
/countries - GETList delivery rates for a destination
/delivery/rates - GETList a country's regions
/regions
Webhooks
Endpoints that receive events, and the event log.
- GETList events
/events - GETList webhook endpoints
/webhook_endpoints - GETRetrieve an event
/events/{event_id} - GETRetrieve a webhook endpoint
/webhook_endpoints/{webhook_endpoint_id} - POSTCreate a webhook endpoint
/webhook_endpoints - PATCHUpdate a webhook endpoint
/webhook_endpoints/{webhook_endpoint_id} - POSTRotate the signing secret
/webhook_endpoints/{webhook_endpoint_id}/rotate_secret - POSTSend a test event
/webhook_endpoints/{webhook_endpoint_id}/test - DELDelete a webhook endpoint
/webhook_endpoints/{webhook_endpoint_id}
