API ReferencePurchase Orders

Update Purchase Order Item

Updates the quantity, price, or note of an existing line item. Only fields included in the request body are modified.

Requires scope: purchase_orders:write

Authentication

API_KEYstring
API Key authentication via header

Path parameters

idUUIDRequired
Purchase order ID.
itemIdUUIDRequired
Line item ID.

Request

This endpoint expects an object.
quantitydoubleOptional
Updated ordered quantity. Must be greater than zero if provided.
pricedoubleOptional
Updated cost per unit in USD. Must be greater than or equal to zero if provided.
notestringOptional

Updated note for this line item. Pass null to clear.

Response

This endpoint returns an object.
idUUID
Unique identifier for this line item.
quantitydouble
Ordered quantity.
pricedouble
Cost per unit in USD.
materialobject
Reference to the material being ordered.
variationobject
Reference to the material variation, if applicable.
notestring
Optional note for this line item.
createdAtdatetime
ISO 8601 timestamp when the item was created.
updatedAtdatetime
ISO 8601 timestamp when the item was last updated.

Errors

400
Bad Request Error
401
Unauthorized Error
403
Forbidden Error
404
Not Found Error