Request to cancel an inflight provide, cease or modify order.

This endpoint is called to request cancellation of an existing inflight order to provision/modify/cease a service or for a cancellation other (unsolicited cease).

The supplier should validate the cancellation request. If the request is invalid or not possible then a 422 code should be returned with reason(s) for the rejection in the response.

The supplier may return a 202 accepted response without confirming the cancellation if further validation/processing is required. In this scenario, the supplier must then send an order update (KCI) to later confirm the order was cancelled or if rejected.

Alternatively, the supplier can confirm the cancellation immediately by returning a 201 created response.

SecuritybearerAuth
Request
header Parameters
X-Request-ID
required
string

Unique identifier to identify request and response events across the gateway

X-Conversation-ID
required
string

Identifier to track message journey across the gateway

Tenant
required
string

The tenant that has placed the request on the gateway

Example: TENANT1
Request Body schema: application/json
id
required
number >= 1

Unique identifier for this order cancellation request (generated by the gateway)

orderId
required
number >= 1

Unique id identifying the service order to be amended

reasonCode
required
string (CancellationReasonCode) ^[A-Z_]{1,30}

Codes representing reason for cancellation:

  • CUSTOMER_CHANGED_MIND
  • INSTALL_FAILED
  • NETWORK_ISSUE
  • NO_LONGER_REQUIRED
  • OTHER

Reason codes for cancellation other (unsolicited cease):

  • NO_AUTHORISATION
  • CUSTOMER_NOT_AWARE
  • DELIBERATE_MISLEAD
  • PURCHASED_DIFFERENT_PRODUCT
  • END_USER_NOT_MOVING
Responses
201

Order cancellation request was successful and the order has been cancelled.

202

Order cancellation request has been received and will be confirmed or rejected later by a KCI

400

Bad request - supplied request was malformed or missing mandatory parameters

401

Unauthorised access

403

The client is not permitted to access this resource.

422

Unprocessable entity - invalid data was provided

500

Invalid or failed response from the supplier

503

Supplier API is temporarily unavailable

post/service-order-cancellations
Request samples
application/json
{
  • "id": 345,
  • "orderId": 123,
  • "reasonCode": "CUSTOMER_CHANGED_MIND"
}
Response samples
application/json
{
  • "supplierReference": "A123-1",
  • "id": 345,
  • "orderId": 123,
  • "reasonCode": "CUSTOMER_CHANGED_MIND"
}