Skip to navigation
API ReferenceInbound

Get an inbound PO

Returns the inbound PO and its expected items. To include receiving data, use GET /inbound/receiver/{poRef}.

Authentication

AuthorizationBasic

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

Path parameters

poRefstringRequired

The PO reference number. A ! in the PO reference can’t be looked up here; use GET /inbound?PoRef= instead.

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

bolstringOptional
The bill of lading. If the PO was submitted with a bill of lading, include it here, or the PO will not be found.

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

Errors

404
Not Found Error