Skip to main content

Order Change Create Ep

POST 
/v1/order/change/create

Create Order Change Request

Creates a request to change an order. This change will need to be accepted or rejected with the /order/change/approve or /reject endpoints.

Required Scopes (ioc.w)

Changes will be in the "waiting_for_approval" status until approved or rejected. If the order already has a pending change, it will be automatically marked as "rejected" before creating the new change.

By default, the endpoint validates that the change would succeed before creating the change request. Set validate=False to skip this validation and create the change request regardless.

update: OrderUpdateRequest
The order update details to be applied if approved. Please refer to the /order/update endpoint for details on the update structure. The order field within the update identifies the order to attach the change request to.

validate: bool = True
When True (default), validates the change would succeed before creating the change request. If validation fails, returns a 422 error with the validation message.

callback_url: str | None = None
URL to send a webhook callback to when the change is later accepted or rejected. If omitted, no callback is sent for the decision.

callback_secret: str | None = None
Shared secret used to sign the callback request so the receiver can verify it originated here.


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.

created_on: datetime
When the change request was created.

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",
  "created_on": "2026-09-25T19:33:18.327Z",
  "change_types": [
    "supply_change"
  ]
}
Loading...