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.
Submit new orders, check import status, retrieve shipment status and tracking, and cancel orders before they are processed.
Read current on-hand quantities for all stock items or a single SKU, overall or by region and warehouse.
Create RMAs with or without a return label, supply your own tracking, and query RMA status.
Look up a single serial’s shipping, receiving, and returns history, or list shipped, in-inventory, and returned serials.
Submit and manage inbound POs, book delivery appointments, attach documents, and read receiver headers, line items, and serials.
Retrieve journal activity for a period, and weekly inventory snapshot records. Available to certain clients by request.
Receive a signed notification when an order enters the warehouse, is released for picking, or ships.
Base URL
https://dream.rushorder.com/api
Endpoint summary
| Method | Endpoint | Purpose |
|---|---|---|
POST | /orders | Submit an order for Rush Order to process |
GET | /orders | Shipment status by package id, order number, alt order number, or customer email |
GET | /orders/batch | Shipment status for a batch of orders |
POST | /orders/cancel | Cancel an order prior to processing and invoicing |
GET | /orders/serialnumbers | Serial numbers for a shipped order |
GET | /orders/{confirmationNumber}/status | Import status of a submitted order |
GET | /stock | Current quantity of all stock items |
GET | /stock/{sku} | Current quantity of one stock item |
GET | /regionalinventory | Stock quantities by region, warehouse, and disposition |
POST | /transit/ | Transit data for an order |
POST | /rma | Create an RMA |
POST | /rma/withlabel | Create an RMA and generate a return label |
POST | /rma/withtracking | Create an RMA with your own return tracking |
GET | /rma/status | RMA status by RMA or alternate RMA number |
GET | /rma/status/batch | RMA status for a batch of RMAs |
GET | /serials/{serialNum} | Shipping, receiving, and returns status for a serial |
GET | /serials/shipped | Serials for items that have shipped |
GET | /serials/inventory | Serials for items currently in inventory |
GET | /serials/returned | Serials for items that have been returned |
POST | /inbound | Submit an advance shipment notice for a PO |
GET | /inbound | List inbound POs, with filters |
GET | /inbound/{poRef} | One inbound PO by PO reference |
GET | /inbound/id/{poId} | One inbound PO by Rush Order ID |
GET | /inbound/timeslots | Open delivery time slots on a date |
PUT | /inbound | Book a delivery appointment |
PUT | /inbound/cancel | Cancel an inbound PO |
GET | /inbound/documents | Documents attached to an inbound PO |
POST | /inbound/documents | Upload a document to an inbound PO |
PUT | /inbound/documents | Replace an attached document |
GET | /inbound/receiver | Deprecated alias of GET /receiver |
GET | /inbound/receiver/{poRef} | Inbound PO with attached receivers |
GET | /receiver | Paged list of receiver headers and items |
GET | /receiver/{poRef} | Receiver headers and items for a PO |
GET | /receiver/{ReceiverNumber}/serials | Serials for an item on a receiver |
GET | /jarreport | Journal activity for a period and year (by request) |
GET | /stocksnapshot | Weekly inventory snapshot records (by request) |
GET | /webhooks/event-types | Webhook event types you can subscribe to (by request) |
GET | /webhooks/subscriptions | Your webhook subscriptions (by request) |
POST | /webhooks/subscriptions | Create a webhook subscription (by request) |
GET | /webhooks/subscriptions/{id} | One webhook subscription (by request) |
PUT | /webhooks/subscriptions/{id} | Replace a webhook subscription (by request) |
PATCH | /webhooks/subscriptions/{id} | Update some fields of a webhook subscription (by request) |
DELETE | /webhooks/subscriptions/{id} | Delete a webhook subscription (by request) |
POST | /webhooks/subscriptions/{id}/secret | Rotate a signing secret (by request) |
POST | /webhooks/subscriptions/{id}/test | Send a test delivery (by request) |
GET | /webhooks/documentation | Your webhook documentation link (by request) |