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

post/service-order-cancellations

This endpoint is called to request cancellation of an existing inflight order to provision, modify or cease a service.

The gateway will validate the request and generate a unique ID which is returned. If the order cancellation is rejected immediately then a 400 code will be returned with reason(s) for the rejection in the response.

The order cancellation will then be sent to the supplier for processing and further updates will be sent via KCIs - this could include a rejection if the cancellation does not meet supplier validation/processing rules.

Securityoauth2
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

Request Body schema: application/json
supplier
string^\w{1,20}$

System identifier for a supplier on the gateway that is associated with this order

orderId
required
number >= 1

Unique reference identifying the service order to be cancelled

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

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
text
string [ 1 .. 1000 ] characters

Textual reason for cancellation - provides more context as applicable

Responses
201

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

Unexpected Fibre Gateway error

503

Fibre Gateway is temporarily unavailable

Request samples
application/json
{
  • "supplier": "DUMMY_SUPPLIER",
  • "orderId": 123,
  • "reasonCode": "CUSTOMER_CHANGED_MIND",
  • "text": "Delivery too long"
}
Response samples
application/json
{
  • "id": 234,
  • "supplierReference": "A123X-1",
  • "status": "REJECTED",
  • "supplier": "DUMMY_SUPPLIER",
  • "orderId": 123,
  • "reasonCode": "CUSTOMER_CHANGED_MIND",
  • "text": "Delivery too long"
}