Skip to navigation
API ReferenceInbound

Upload an inbound PO document

Attaches a file, such as a packing list, to the PO. Allowed types are .csv, .txt, .pdf, .xls, and .xlsx, up to 25 MB. To change a file that is already attached, use PUT /inbound/documents.

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.

Request

This endpoint expects an object.
poRefstringRequired
The PO reference number.
fileNamestringRequired

Must end in .csv, .txt, .pdf, .xls, or .xlsx.

contentstringRequiredformat: "byte"

The file, base64-encoded. A data:<type>;base64, prefix is accepted. Up to 25 MB, and the content must match the file extension.

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

Response

Uploaded.
SuccessbooleanOptional
Errorstring or nullOptional
Why the request failed. Null on success.
Messagestring or nullOptional

Same as Error.

DocumentobjectOptional

Errors

400
Bad Request Error
404
Not Found Error
409
Conflict Error