Receive Purchase Order Stock

Records a delivery against an approved (or partially received) purchase order: creates a numbered purchase receive (PR/...), increments stock at the PO's location and updates each line's received quantity. The PO moves to partially-received or closed depending on outstanding quantities. Receiving more than the ordered quantity is rejected unless the company's over-receive setting is enabled. Depending on the company's purchase settings, a supplier invoice number may be required on the PO before receiving (400 otherwise). Requires update-purchase-orders plus the create-stock-receives permission.

Recent Requests
Log in to see full request history
TimeStatusUser Agent
Retrieving recent requests…
LoadingLoading…
Path Params
integer
required

Purchase order id.

Body Params
string
length ≤ 2048

Stored on the created purchase receive.

string

When a line passes sales_price, update that price level instead of the base price.

receives
array of objects
required

One entry per PO line being received: line_id (integer, required — the PO line id), unit_quantity (number, required; entries <= 0 are skipped), unit (string, optional — defaults to pcs), cost_price (number >= 0, required — actual cost per base unit), sales_price (number, optional — updates the variant's sales price when it differs), serials (array of serial number strings — required for serialized products; the received quantity is the number of serials), batches (array of {expiry, count} for batch-tracked products; batch counts must sum to the line quantity), taxes (array of {id}, optional).

receives*
Headers
string
required

The merchant install this request acts on (install.store_id from the app.installed webhook).

Response

Language
Credentials
Bearer
LoadingLoading…
Response
Click Try It! to start a request and see the response here! Or choose an example:
application/json