Skip to content

Update a PO change order

Procurement module

PATCH/po-change-orders/{id}poChangeOrders.update

A change to an issued purchase order. Updates the fields sent; omitted fields are unchanged. Requires `If-Match` with the current `ETag`: a stale tag returns 412 and a missing tag returns 428.

  • Requires the capability procurement.po.write.
  • OAuth scopes: procurement.
  • Send If-Match with the ETag you read. A stale tag returns 412; a missing tag returns 428.
  • Error statuses: 400, 401, 404, 412, 422, 428, 429. Errors are RFC 9457 problem details.

Path and query parameters

poChangeOrders.update: Path and query parameters
FieldTypeRequiredDescription
idstring (uuid)YesIdentifier of the po change order.

Request body: PoChangeOrderUpdate

poChangeOrders.update: PoChangeOrderUpdate
FieldTypeRequiredDescription
descriptionstringNoWhat changes.Constraints: length 1 to 20000
amount_delta_minorinteger (int64) | nullNoChange amount; null when unpriced. Integer minor units of the resource currency; null means unpriced, never zero.
{
  "description": "Add six deck sections.",
  "amount_delta_minor": 27000
}

Response 200: PoChangeOrder

poChangeOrders.update: PoChangeOrder
FieldTypeRequiredDescription
idstring (uuid)YesIdentifier of the po change order.
org_idstring (uuid)YesIdentifier of the owning organization, derived from the parent row and never accepted from the caller.
created_atstring (date-time)YesWhen the row was created.
created_bystring (uuid) | nullYesIdentifier of the person who created the row; null when a seed, platform or system process created it.
updated_atstring (date-time)YesWhen the row was last updated.
updated_bystring (uuid) | nullYesIdentifier of the person who last updated the row; null when a seed, platform or system process updated it.
purchase_order_idstring (uuid)YesIdentifier of the purchase order.
descriptionstringYesWhat changes.Constraints: length 1 to 20000
amount_delta_minorinteger (int64) | nullYesChange amount; null when unpriced. Integer minor units of the resource currency; null means unpriced, never zero.
po_change_order_state"Proposed" | "Approved" | "Rejected" | "Canceled"YesPO change order state.
{
  "id": "0192f1e2-7c3a-7b4d-9e8f-1a2b3c4d5e6f",
  "org_id": "0192f1e2-7c3a-7b4d-9e8f-1a2b3c4d5e6f",
  "created_at": "2026-10-08T14:30:00Z",
  "created_by": "0192f1e2-7c3a-7b4d-9e8f-1a2b3c4d5e6f",
  "updated_at": "2026-10-08T14:30:00Z",
  "updated_by": "0192f1e2-7c3a-7b4d-9e8f-1a2b3c4d5e6f",
  "purchase_order_id": "0192f1e2-7c3a-7b4d-9e8f-1a2b3c4d5e6f",
  "description": "Add six deck sections.",
  "amount_delta_minor": 27000,
  "po_change_order_state": "Proposed"
}

Code samples

curl -X PATCH "$XOS_BASE_URL/po-change-orders/0192f1e2-7c3a-7b4d-9e8f-1a2b3c4d5e6f" \
  -H "Authorization: Bearer $XOS_API_KEY" \
  -H 'If-Match: W/"etag-from-your-last-read"' \
  -H "Content-Type: application/json" \
  -d '{"description":"Add six deck sections.","amount_delta_minor":27000}'
const { data, etag } = await xos.poChangeOrders.update("0192f1e2-7c3a-7b4d-9e8f-1a2b3c4d5e6f", {
    "description": "Add six deck sections.",
    "amount_delta_minor": 27000
  }, { ifMatch: etag });
response = xos.po_change_orders.update("0192f1e2-7c3a-7b4d-9e8f-1a2b3c4d5e6f", {"description": "Add six deck sections.", "amount_delta_minor": 27000}, if_match=etag)
xos po-change-orders update 0192f1e2-7c3a-7b4d-9e8f-1a2b3c4d5e6f --data '{"description":"Add six deck sections.","amount_delta_minor":27000}' --if-match auto