> For clean Markdown of any page, append .md to the page URL. > For a complete documentation index, see https://docs.rushorder.com/llms.txt. > For AI client integration (Claude Code, Cursor, etc.), connect to the MCP server at https://docs.rushorder.com/_mcp/server. # Rush Order APIs The Dream API lets your systems submit orders to Rush Order, track their fulfillment, manage returns, and read inventory and inbound receiving data. The API is a REST service returning JSON, secured with HTTP Basic authentication. Full request and response schemas, with an interactive request builder, are in the [API Reference](/api-reference). #### [Orders](https://docs.rushorder.com/api-reference/orders/create) Submit new orders, check import status, retrieve shipment status and tracking, and cancel orders before they are processed. #### [Inventory](https://docs.rushorder.com/api-reference/inventory/list) Read current on-hand quantities for all stock items or a single SKU, overall or by region and warehouse. #### [Returns (RMA)](https://docs.rushorder.com/api-reference/returns/create) Create RMAs with or without a return label, supply your own tracking, and query RMA status. #### [Serial Numbers](https://docs.rushorder.com/api-reference/serials/get) Look up a single serial's shipping, receiving, and returns history, or list shipped, in-inventory, and returned serials. #### [Inbound & Receiving](https://docs.rushorder.com/api-reference/inbound/submit) Submit and manage inbound POs, book delivery appointments, attach documents, and read receiver headers, line items, and serials. #### [Reports](https://docs.rushorder.com/api-reference/reports/get-journal-activity) Retrieve journal activity for a period, and weekly inventory snapshot records. Available to certain clients by request. #### [Webhooks](/webhooks/overview) Receive a signed notification when an order enters the warehouse, is released for picking, or ships. ## Base URL ```text https://dream.rushorder.com/api ``` ## Endpoint summary | Method | Endpoint | Purpose | | -------- | ------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------- | | `POST` | [`/orders`](https://docs.rushorder.com/api-reference/orders/create) | Submit an order for Rush Order to process | | `GET` | [`/orders`](https://docs.rushorder.com/api-reference/orders/get-status) | Shipment status by package id, order number, alt order number, or customer email | | `GET` | [`/orders/batch`](https://docs.rushorder.com/api-reference/orders/get-batch-status) | Shipment status for a batch of orders | | `POST` | [`/orders/cancel`](https://docs.rushorder.com/api-reference/orders/cancel) | Cancel an order prior to processing and invoicing | | `GET` | [`/orders/serialnumbers`](https://docs.rushorder.com/api-reference/orders/get-serial-numbers) | Serial numbers for a shipped order | | `GET` | [`/orders/{confirmationNumber}/status`](https://docs.rushorder.com/api-reference/orders/get-import-status) | Import status of a submitted order | | `GET` | [`/stock`](https://docs.rushorder.com/api-reference/inventory/list) | Current quantity of all stock items | | `GET` | [`/stock/{sku}`](https://docs.rushorder.com/api-reference/inventory/get) | Current quantity of one stock item | | `GET` | [`/regionalinventory`](https://docs.rushorder.com/api-reference/inventory/list-by-region) | Stock quantities by region, warehouse, and disposition | | `POST` | [`/transit/`](https://docs.rushorder.com/api-reference/transit/get-data) | Transit data for an order | | `POST` | [`/rma`](https://docs.rushorder.com/api-reference/returns/create) | Create an RMA | | `POST` | [`/rma/withlabel`](https://docs.rushorder.com/api-reference/returns/create-with-label) | Create an RMA and generate a return label | | `POST` | [`/rma/withtracking`](https://docs.rushorder.com/api-reference/returns/create-with-tracking) | Create an RMA with your own return tracking | | `GET` | [`/rma/status`](https://docs.rushorder.com/api-reference/returns/get-status) | RMA status by RMA or alternate RMA number | | `GET` | [`/rma/status/batch`](https://docs.rushorder.com/api-reference/returns/get-batch-status) | RMA status for a batch of RMAs | | `GET` | [`/serials/{serialNum}`](https://docs.rushorder.com/api-reference/serials/get) | Shipping, receiving, and returns status for a serial | | `GET` | [`/serials/shipped`](https://docs.rushorder.com/api-reference/serials/list-shipped) | Serials for items that have shipped | | `GET` | [`/serials/inventory`](https://docs.rushorder.com/api-reference/serials/list-in-inventory) | Serials for items currently in inventory | | `GET` | [`/serials/returned`](https://docs.rushorder.com/api-reference/serials/list-returned) | Serials for items that have been returned | | `POST` | [`/inbound`](https://docs.rushorder.com/api-reference/inbound/submit) | Submit an advance shipment notice for a PO | | `GET` | [`/inbound`](https://docs.rushorder.com/api-reference/inbound/list) | List inbound POs, with filters | | `GET` | [`/inbound/{poRef}`](https://docs.rushorder.com/api-reference/inbound/get) | One inbound PO by PO reference | | `GET` | [`/inbound/id/{poId}`](https://docs.rushorder.com/api-reference/inbound/get-by-id) | One inbound PO by Rush Order ID | | `GET` | [`/inbound/timeslots`](https://docs.rushorder.com/api-reference/inbound/list-timeslots) | Open delivery time slots on a date | | `PUT` | [`/inbound`](https://docs.rushorder.com/api-reference/inbound/book-appointment) | Book a delivery appointment | | `PUT` | [`/inbound/cancel`](https://docs.rushorder.com/api-reference/inbound/cancel) | Cancel an inbound PO | | `GET` | [`/inbound/documents`](https://docs.rushorder.com/api-reference/inbound/list-documents) | Documents attached to an inbound PO | | `POST` | [`/inbound/documents`](https://docs.rushorder.com/api-reference/inbound/upload-document) | Upload a document to an inbound PO | | `PUT` | [`/inbound/documents`](https://docs.rushorder.com/api-reference/inbound/replace-document) | Replace an attached document | | `GET` | [`/inbound/receiver`](https://docs.rushorder.com/api-reference/inbound/list-receivers) | Deprecated alias of `GET /receiver` | | `GET` | [`/inbound/receiver/{poRef}`](https://docs.rushorder.com/api-reference/inbound/get-po) | Inbound PO with attached receivers | | `GET` | [`/receiver`](https://docs.rushorder.com/api-reference/receivers/list) | Paged list of receiver headers and items | | `GET` | [`/receiver/{poRef}`](https://docs.rushorder.com/api-reference/receivers/get-by-po) | Receiver headers and items for a PO | | `GET` | [`/receiver/{ReceiverNumber}/serials`](https://docs.rushorder.com/api-reference/receivers/list-serials) | Serials for an item on a receiver | | `GET` | [`/jarreport`](https://docs.rushorder.com/api-reference/reports/get-journal-activity) | Journal activity for a period and year (by request) | | `GET` | [`/stocksnapshot`](https://docs.rushorder.com/api-reference/reports/get-stock-snapshot) | Weekly inventory snapshot records (by request) | | `GET` | [`/webhooks/event-types`](https://docs.rushorder.com/api-reference/webhooks/list-event-types) | Webhook event types you can subscribe to (by request) | | `GET` | [`/webhooks/subscriptions`](https://docs.rushorder.com/api-reference/webhooks/list) | Your webhook subscriptions (by request) | | `POST` | [`/webhooks/subscriptions`](https://docs.rushorder.com/api-reference/webhooks/create) | Create a webhook subscription (by request) | | `GET` | [`/webhooks/subscriptions/{id}`](https://docs.rushorder.com/api-reference/webhooks/get) | One webhook subscription (by request) | | `PUT` | [`/webhooks/subscriptions/{id}`](https://docs.rushorder.com/api-reference/webhooks/replace) | Replace a webhook subscription (by request) | | `PATCH` | [`/webhooks/subscriptions/{id}`](https://docs.rushorder.com/api-reference/webhooks/update) | Update some fields of a webhook subscription (by request) | | `DELETE` | [`/webhooks/subscriptions/{id}`](https://docs.rushorder.com/api-reference/webhooks/delete) | Delete a webhook subscription (by request) | | `POST` | [`/webhooks/subscriptions/{id}/secret`](https://docs.rushorder.com/api-reference/webhooks/rotate-secret) | Rotate a signing secret (by request) | | `POST` | [`/webhooks/subscriptions/{id}/test`](https://docs.rushorder.com/api-reference/webhooks/send-test) | Send a test delivery (by request) | | `GET` | [`/webhooks/documentation`](https://docs.rushorder.com/api-reference/webhooks/get-documentation) | Your webhook documentation link (by request) |