Integration Cancel Order Request

POST 
/v1/order_request/cancel

Cancel Order Request

Cancels a pending order request by its order number. Used when the originating partner cancels before this tenant has accepted/rejected. No webhook callback is fired — the partner initiated this cancellation.

Required Scopes (io.w)

Request

order_number: int
The number of the pending order request to cancel.

---

reason_code: str | None = None
Optional reason code recorded against the canceled.

---

note: str | None = None
Optional free-text note recorded against the canceled.

Response

status: str
The resulting status, canceled.

---

order_number: int
The number of the order request that was canceled.

Responses

200

Successful Response

422

Validation Error

application/json

Example (from schema)

{
  "detail": [
    {
      "loc": [
        "string",
        0
      ],
      "msg": "string",
      "type": "string"
    }
  ]
}

Loading...