# 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.

Endpoint: POST /service-order-cancellations
Version: 1.15
Security: oauth2

## Header parameters:

  - `X-Request-ID` (string, required)
    Unique identifier to identify request and response events across the Fibre Cafe gateway

  - `X-Conversation-ID` (string, required)
    Identifier to track message journey across the Fibre Cafe gateway

  - `Tenant` (string, required)
    The tenant that has placed the request on the Fibre Cafe
    Example: "TENANT1"

## Request fields (application/json):

  - `id` (number, required)
    Unique identifier for this order cancellation request (generated by the Fibre Cafe)
    Example: 345

  - `orderId` (number, required)
    Unique id identifying the service order to be amended
    Example: 123

  - `reasonCode` (string, required)
    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
    Example: "CUSTOMER_CHANGED_MIND"

  - `supplierOrderReference` (string)
    Order reference provided by the supplier
    Example: "A123X"

## Response 201 fields (application/json):

  - `supplierReference` (string)
    Unique reference generated by the supplier for this cancellation request
    Example: "A123-1"

  - `id` (number, required)
    Unique identifier for this order cancellation request (generated by the Fibre Cafe)
    Example: 345

  - `orderId` (number, required)
    Unique id identifying the service order to be amended
    Example: 123

  - `reasonCode` (string, required)
    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
    Example: "CUSTOMER_CHANGED_MIND"

  - `supplierOrderReference` (string)
    Order reference provided by the supplier
    Example: "A123X"

## Response 400 fields (application/json):

  - `uuid` (string, required)
    Unique identifier of this error - for tracing purposes
    Example: "87432dfb-2e47-4532-a1b7-4b113d48867d"

  - `code` (string, required)
    Fibre Cafe error codes
    Enum: "INVALID_REQUEST", "MALFORMED_REQUEST", "NOT_AUTHORISED", "NOT_FOUND", "NOT_IMPLEMENTED", "SUPPLIER_FAULT"

  - `messages` (array, required)
    Message describing the error
    Example: ["e.g. Invalid value for field x - accepted values are y"]

## Response 401 fields (application/json):

  - `uuid` (string, required)
    Unique identifier of this error - for tracing purposes
    Example: "87432dfb-2e47-4532-a1b7-4b113d48867d"

  - `code` (string, required)
    Fibre Cafe error codes
    Enum: "INVALID_REQUEST", "MALFORMED_REQUEST", "NOT_AUTHORISED", "NOT_FOUND", "NOT_IMPLEMENTED", "SUPPLIER_FAULT"

  - `messages` (array, required)
    Message describing the error
    Example: ["e.g. Invalid value for field x - accepted values are y"]

## Response 422 fields (application/json):

  - `uuid` (string, required)
    Unique identifier of this error - for tracing purposes
    Example: "87432dfb-2e47-4532-a1b7-4b113d48867d"

  - `code` (string, required)
    Fibre Cafe error codes
    Enum: "INVALID_REQUEST", "MALFORMED_REQUEST", "NOT_AUTHORISED", "NOT_FOUND", "NOT_IMPLEMENTED", "SUPPLIER_FAULT"

  - `messages` (array, required)
    Message describing the error
    Example: ["e.g. Invalid value for field x - accepted values are y"]

## Response 500 fields (application/json):

  - `uuid` (string, required)
    Unique identifier of this error - for tracing purposes
    Example: "87432dfb-2e47-4532-a1b7-4b113d48867d"

  - `code` (string, required)
    Fibre Cafe error codes
    Enum: "INVALID_REQUEST", "MALFORMED_REQUEST", "NOT_AUTHORISED", "NOT_FOUND", "NOT_IMPLEMENTED", "SUPPLIER_FAULT"

  - `messages` (array, required)
    Message describing the error
    Example: ["e.g. Invalid value for field x - accepted values are y"]


## Response 202 fields

## Response 403 fields

## Response 503 fields