Cancel Order Request

Note: This request is only used in full integration mode.

BRIJ sends this request to cancel an existing order.

Endpoint

POST https://api.yourplatform.com/cancel-order
Content-Type: application/json

Request Body

1
{
2
  "orderId": "order_abc123",
3
  "externalOrderId": "partner_order_12345"
4
}

Request Parameters

Response Body

Success Response

Return an empty JSON object on success:

1
{}

Error Response

Return an error response when the order cannot be canceled:

1
{
2
  "error": {
3
    "reason": "order_already_processed",
4
    "customerFacingReason": "This order has already been completed and cannot be canceled."
5
  }
6
}

Error Fields

HTTP Status Codes