Receive purchase order

POST/api/v1/purchase-orders/{id}/receive

Transition PO to 'received', flip linked Bill from forecasted to received, mark linked transfer as received, write cost snapshots, and post received quantities to on-hand inventory at ship_to_location_id (skipped when a received shipment is already associated with the PO, since that path writes inventory itself).

Operation ID: receive_order_api_v1_purchase_orders__id__receive_post·View as markdown·OpenAPI slice

Authentication

Bearer token authentication. Pass your DayZero API token in the Authorization header and the target business UUID in x-business-id.

Parameters

Path

idstring · uuidrequired

Responses

201Successful Response

Schema: app__core__success__SuccessEnvelope_OrderResponse___2

successboolean
messagestring
codestring
dataapp__api__v1__schemas__inventory__inventory__OrderResponse

400Bad Request - Invalid input

401Unauthorized - Authentication required

403Forbidden - Insufficient permissions

404Not Found - Resource does not exist

422Validation Error

Schema: HTTPValidationError

detailarray · ValidationErrorValidationError

5 fields

locarray · string | integerrequired
msgstringrequired
typestringrequired
inputobject
ctxobject

Code samples

POST/api/v1/purchase-orders/{id}/receive

bash

curl -X POST 'https://api.ondayzero.com/api/v1/purchase-orders/{id}/receive' \
  -H 'Authorization: Bearer dz_your_token' \
  -H 'x-business-id: YOUR_BUSINESS_ID'