Fibre API fixes
Since launching the Fibre APIs, we’ve identified a few inconsistencies, mostly small discrepancies where API behaviour and the API specification and documentation don’t quite align. However, in some cases, these could affect your integration depending on how you have built to the APIs.
We know that many of you are building to the APIs, so we wanted to get this updated to you as quickly as possible to allow time for any necessary adjustments.
We are targeting to have test environments and documentation updated on 24 June 2025. Changes will go live on 25 July 2025.
Please review the upcoming changes and assess any potential impact on your current or finished build.
# | Issue | Issue Details | Fix | Impact |
1 | x-transaction-id is sometimes not specified in error responses | This is an agnostic issue across ALL the Fibre API’s. The platform response payload is not consistent with the API specification regarding x-transaction-id in the error payload. The application will return x-transaction-id (lower case), but sometimes this isn’t specified. | The API specification will be updated to consistently make use of x-transaction-id | Low risk Awareness that the x-transaction-id will be returned exactly as per the API specification. |
2 | Order Charges missing for Manage Order API | As part of the specification for the GET order method, the response payload should always include ‘orderCharges’. Currently, this does not return ‘orderCharges’ when the order is still in a feasibility state. | Update the API to consistently return ‘orderCharges’ even when the value is still empty. | Low risk Manage Order API will consistently return ‘orderCharges’ even when the value is still empty (e.g. during order feasibility) |
3 | The id field is returned in the Place API’s site information response, although it is unspecified | In the Place API, the id field is consistently returned as part of the site information response but this is not included in the API specification. | Update the API to remove id from being returned in the response for site information. | Moderate risk IF you are using field today Validate and update the Place API if you are currently using id. |
4 | Cancellation reason code is not included for the Manage Order API | The Manage Order API specification for the amend order method suggests that where an order is in the process of being cancelled and then subsequently amended the order amended response should include customer cancel code. (e.g. “code”: “CUSTOMER_CANCEL_31”). | Update the API to ensure the customer cancel code is returned for order abandonment. | Low It is unlikely an order amendment will be made for an order that is being cancelled. Be aware that customer cancel code will be returned for order amendments. |
5 | CANCEL notification type is returned but not documented | A notification type (CANCEL) can be returned via the Notification API but is not included in the API documentation. | Update Anypoint API documentation. | Low Documentation will be updated to include this undocumented notification type. |
6 | Unwanted tab characters and inconsistent spacing in API specifications | API specification YAML files include an unnecessary tab character (preceding the OAuth URL), which may cause compliance issues. Also, the spacing convention is inconsistent between files. | Improve API specification files by removing unnecessary tab characters and align them to use the same spacing. | None |
7 | The 'details' structure for the API error payload is not included in the Order Notification API specifications |
The ‘details’ structure is included for the error payload of all APIs except Order Notifications API. This API specification will be updated to reflect its inclusion. | Update the Order Notification API specification. | None |
8 | HTTP headers in API specifications are not all in lower case | The API app code will only ever return HTTP headers in lower case. The API specifications are not consistently using the header names in lowercase and should be updated to reflect this. | Update API specifications. | None |
Contact
If you have any concerns or questions, then please reach out to your friendly Customer Engagement team.