Open Inventory docs
API referencePurchasingPurchase ordersOrderidLinesLineidReceipts

Receive all or part of an ordered line into physical stock

The API runs on your own Open Inventory instance. Session-authenticated requests require a session on that instance.

POST
/purchase-orders/{orderId}/lines/{lineId}/receipts

Authorization

bearerAuth
headerAuthorizationBearer <inv_ token>

Path Parameters

orderId*string
Formatuuid
lineId*string
Formatuuid

Header Parameters

Idempotency-Key*string

UUID identifying this atomic operation; reuse it only to retry the exact same request.

Formatuuid
X-Organization-ID?string

Organization membership selected for this request. User-bound credentials may select any active membership; standalone tokens may only repeat their pinned organization ID.

Formatuuid

Request Body

application/json
  1. body
quantity*integer

Receipt quantity in base stock units.

Range1 <= value <= 1000
purchaseQuantity?integer

Receipt quantity in the purchase unit snapshotted on the order line.

Range1 <= value <= 1000000
receivedAt?string
Formatdate-time
location?|
Lengthlength <= 240
note?string
Lengthlength <= 20000
unitCodes?array<>

Response Body

Replayed the original goods receipt

Example Request
curl -X POST 'https://inventory.example.com/api/v1/purchase-orders/497f6eca-6276-4993-bfeb-53cbbbba6f08/lines/497f6eca-6276-4993-bfeb-53cbbbba6f08/receipts' \  -H 'Idempotency-Key: 497f6eca-6276-4993-bfeb-53cbbbba6f08' \  -H 'Content-Type: application/json' \  -d '{}'
Example Response
Empty

Update or cancel a purchase order PATCH

Previous Page

List inventory items GET

Next Page