Skip to navigation
API ReferenceInbound

List inbound POs

Returns every active inbound PO that matches all of the filters supplied. Results are not paged. Cancelled POs are not included.

Authentication

AuthorizationBasic

Basic authentication of the form Basic <base64(username:password)>.

Headers

RushOrderMomCodestringRequired
All requests require the header to contain RushOrderMomCode, a 3 character string that represents the client internally in Rush Order. This should be given to you by Rush Order.

Query parameters

PoRefstringOptional
Returns POs whose reference contains this text.
BolstringOptional
Returns POs whose bill of lading contains this text.
LocationstringOptional
The receiving warehouse, by location code or warehouse code.
Statuseslist of enumsOptional

Returns POs in any of these statuses. Repeat the parameter for more than one. Case-insensitive.

Allowed values:
ExpectedDeliveryDateStartdatetimeOptional
Earliest expected delivery date.
ExpectedDeliveryDateEnddatetimeOptional
Latest expected delivery date.

Response

Success
IdintegerOptional

Rush Order’s ID for the inbound PO. Use it with GET /inbound/id/{poId}.

CreatedDatedatetimeOptional
ExpectedDeliveryDatedatetimeOptional
AppointmentDatedatetime or nullOptional
AppointmentTimeSlotinteger or nullOptional

0 is 8–10 AM, 1 is 10 AM–12 PM, 2 is 12–2 PM, and 3 is 2–4 PM.

ReceivedDatedatetime or nullOptional
POReferenceNumberstringOptional
BillOfLadingstringOptional
An empty string when the PO has none.
StatusenumOptional

Announced: no delivery appointment yet. Accepted: an appointment is booked or the delivery arrived, but receiving has not started. Processing: receiving is under way. Completed: every receiver is finished.

Allowed values:
ContainerLoadstringOptional
HazardTypestringOptional
LocationstringOptional
The receiving warehouse code.
LocationDisplaystringOptional
The receiving warehouse's display name.
ProjectTypeIdinteger or nullOptional
Projectstring or nullOptional
EmailstringOptional
NotesstringOptional
Itemslist of objectsOptional