curl --request PATCH \
--url https://{companyName}.api.joinluminous.com/external/api/v1/purchase-orders/{purchaseOrderId}/items/{lineItemId}/closed \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--data '
{
"closed": true,
"reason": "Supplier discontinued the item; remaining units will not ship."
}
'{
"data": {
"id": 78001,
"purchase_order_id": 9001,
"closed": true,
"closed_at": "2026-10-02T14:30:00+00:00",
"close_reason": "Supplier discontinued the item; remaining units will not ship.",
"open_quantity": 0,
"remaining_to_receive": 40,
"quantity": 100,
"quantity_received": 60
}
}{
"message": "<string>"
}{
"message": "<string>"
}{
"message": "<string>"
}Close or reopen a purchase-order line
Close a single purchase-order line short — mark the rest of it as no longer expected — or reopen a previously closed line. Ordered and received quantities are not rewritten, so the purchase order keeps an accurate record of what was ordered versus what actually arrived.
- Close — send
closed: truewith areason. The line’sopen_quantityandavailable_to_allocatedrop to0, incoming stock is recounted, and any open allocation pegs against the undelivered remainder are shrunk. A reason is required when closing, and a line with nothing left to receive cannot be closed. - Reopen — send
closed: false. The close timestamp and reason are cleared and incoming stock is recounted. Allocation pegs removed on close are not restored.
While a line is closed, POST /receiving-reports refuses any receipt that references it with
400; reopen the line first.
Both operations are idempotent: closing an already-closed line or reopening an open one returns the line’s current state unchanged.
remaining_to_receive is unaffected by closing; read open_quantity for what is still expected.
The full-replace PUT /purchase-orders/{id} does not accept a closed flag, so resubmitting a line
there can never close or reopen it by accident.
curl --request PATCH \
--url https://{companyName}.api.joinluminous.com/external/api/v1/purchase-orders/{purchaseOrderId}/items/{lineItemId}/closed \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--data '
{
"closed": true,
"reason": "Supplier discontinued the item; remaining units will not ship."
}
'{
"data": {
"id": 78001,
"purchase_order_id": 9001,
"closed": true,
"closed_at": "2026-10-02T14:30:00+00:00",
"close_reason": "Supplier discontinued the item; remaining units will not ship.",
"open_quantity": 0,
"remaining_to_receive": 40,
"quantity": 100,
"quantity_received": 60
}
}{
"message": "<string>"
}{
"message": "<string>"
}{
"message": "<string>"
}Authorizations
Authenticate using a bearer token. To create a token, navigate to /settings/api-tokens and click Create API Token.
Path Parameters
ID of the purchase order the line item belongs to
ID of the purchase-order line item to close or reopen
Body
Response
Line closed or reopened (or already in the requested state)
Show child attributes
Show child attributes