Skip to main content

Order Change Accept Ep

POST 
/v1/order/change/accept

Accept Order Change Request

Accepts a pending order change request and applies the update to the order. An outgoing change that was already applied to the order when it was sent is not applied again; it is only marked as approved. On success, the change is marked as approved. On handled failure (e.g., validation errors), the change is marked as rejected.

Required Scopes (ioc.w)

change_id: str
The ObjectId of the OrderChange to accept.

reason_code: str | None = None
Optional reason code for the acceptance. Sent back to the caller via webhook callback. Max length 100.

trigger_callback: bool = True
Whether to trigger webhook callbacks for the change. If the request originated from a webhook, set to False to avoid loops.

run_async: bool = False
When True, the decision is queued and the endpoint returns immediately with an OrderChangeAsyncResponse instead of waiting for the change to be applied.


Response​

id: str
The unique identifier of the order change.

order_id: str
The internal identifier of the order the change applies to.

order_number: int
The number of the order the change applies to.

status: OrderChangeStatus
The status of the change. One of waiting_for_approval, approved, rejected, failed.

updated_on: datetime
When the change was accepted.

change_types: list[OrderChangeType]
The kinds of change this request carries. Values: supply_change, destination_change, delivery_window_change.

Responses​

Successful Response

{
  "id": "string",
  "order_id": "string",
  "order_number": 0,
  "status": "waiting_for_approval",
  "updated_on": "2026-11-11T17:36:45.931Z",
  "change_types": [
    "supply_change"
  ]
}
Loading...