This B2Bservice allows you to request the cancellation of an inflight order and any associated site visit appointments.
Related Business Process
Related Product
This service is available for fibre products.
The data elements and attributes that may be used by this service are described below
The order elements contain Order header information. The following table describes the Order elements.
| NAME | CARDINALITY | INPUT/OUTPUT | DESCRIPTION |
|---|---|---|---|
| id | Mandatory | I/O | Order identifier. |
| Reason | Mandatory | I/O | Describes why you are requesting the order cancellation. |
> Order - Reason Elements
| NAME | CARDINALITY | INPUT/OUTPUT | DESCRIPTION |
|---|---|---|---|
| code | Mandatory | I/O | Order cancellation code. |
| description | Mandatory | I/O | Description of the order cancellation reason. |
-- Order - Reason - description
The following table describes the new values provided by the code and description elements released on the 14th February 2018.
| CODE | DESCRIPTION |
|---|---|
| CUSTOMER_CANCEL_16 | Order Acceptance - Duplicate order removed |
| CUSTOMER_CANCEL_18 | Order Acceptance - Incorrect Address – New order submitted |
| CUSTOMER_CANCEL_17 | OrderAcceptance-IncorrectAddress–Nonewordersubmitted |
| CUSTOMER_CANCEL_14 | Order Acceptance - Incorrect pre-qual information |
| CUSTOMER_CANCEL_15 | OrderAcceptance - Missing orderinformation |
| CUSTOMER_CANCEL_13 | OrderAcceptance -Primary fibre service already on site (an primary requested) |
| CUSTOMER_CANCEL_26 | Customer Cancelled - AccessDenied |
| CUSTOMER_CANCEL_29 | Customer Cancelled - Customer did not accept contribution cost |
| CUSTOMER_CANCEL_19 | Customer Cancelled - Excessive delay for RFS |
| CUSTOMER_CANCEL_21 | Customer Cancelled - Fibre not requested |
| CUSTOMER_CANCEL_25 | Customer Cancelled - Landlord declined permission |
| CUSTOMER_CANCEL_22 | Customer Cancelled - Now moving address |
| CUSTOMER_CANCEL_20 | Customer Cancelled - Premise not ready for fibre installation |
| CUSTOMER_CANCEL_28 | CustomerCancelled -Unhappy with external scoping options (installation) |
| CUSTOMER_CANCEL_27 | Customer Cancelled - Unhappy with internal scoping options (installation) |
| CUSTOMER_CANCEL_32 | RSP Cancelled - Feasibility/Quote rejected by customer |
| CUSTOMER_CANCEL_30 | RSP Cancelled - Incorrect Details |
| CUSTOMER_CANCEL_31 | RSP Cancelled - Submitted in Error |
| CUSTOMER_CANCEL_33 | Customer Cancelled - Competitive offer taken up by customer (same RSP) |
| CUSTOMER_CANCEL_34 | Customer Cancelled - Health and Safety |
| CHORUS_CANCEL_55 | Customer Cancelled - Competitive offer taken up by customer (same RSP) |
| CHORUS_CANCEL_56 | Customer Cancelled - Health and Safety |
-- Service Name
CancelOrderRequest
-- Service Inputs
The following fields are mandatory for requesting this service:
-- Message Handling Specifications
| NAME | DESCRIPTION |
|---|---|
| MEP | Synchronous call with Acknowledgement. |
| Inputs | The order must be in a state that allows cancellation. |
| Outputs | Synchronous Acknowledgement. |
| Non-repudiation | Yes. |
| Description | Initiates a transaction to cancel an order. |
CancelOrderResponse
-- Service Outputs
If valid input was provided and the order state allows for cancellation, your order will be changed to the state and substate of In Progress/Intent to Cancel.
We will review your request and send our response using an AmendOrderNotification.
-- Message Handling Specifications
| NAME | DESCRIPTION |
|---|---|
| MEP | Synchronous call with Acknowledgement. |
| Inputs | Response to your cancel order request. |
| Outputs | Synchronous Acknowledgement. |
| Non-repudiation | Yes |