This endpoint is called to request amendment(s) to an existing inflight order to provision, modify or cease a service.
The gateway will validate the request and generate an amendment reference which is returned. If the order amendment is rejected immediately then a 400 code will be returned with reason(s) for the rejection in the response.
The order amendment will then be sent to the supplier for processing and further updates will be sent via KCIs - this could include a rejection if the amendment does not meet supplier validation/processing rules.
Represents a request to amend an existing inflight service provide order. Any value(s) supplied will replace the existing value(s).
Order amendment request has been received and will be confirmed or rejected later by a KCI
Bad request - supplied request was malformed or missing mandatory parameters
Unauthorised access
The client is not permitted to access this resource.
Unprocessable entity - invalid data was provided
Unexpected Fibre Gateway error
Fibre Gateway is temporarily unavailable
{- "orderId": 123,
- "supplier": "DUMMY_SUPPLIER",
- "serviceCharacteristics": [
- {
- "name": "LINE_PROFILE",
- "value": "1G1G"
}
], - "primaryContact": {
- "name": "John Smith",
- "email": "john@smith.com",
- "phoneNumber": "01234 567890"
}, - "secondaryContact": {
- "name": "John Smith",
- "email": "john@smith.com",
- "phoneNumber": "01234 567890"
}, - "appointmentReservationId": 345,
- "requestedCompletionDate": "2022-01-10",
- "engineerTasks": [
- "TEST_SINGLE_DEVICE"
], - "hazards": "string",
- "onSiteRestrictions": "string",
- "notes": "Lorem ipsum dolor sit amet..."
}
{- "id": 234,
- "supplierReference": "A123X-1",
- "status": "REJECTED",
- "orderId": 123,
- "supplier": "DUMMY_SUPPLIER",
- "serviceCharacteristics": [
- {
- "name": "LINE_PROFILE",
- "value": "1G1G"
}
], - "primaryContact": {
- "name": "John Smith",
- "email": "john@smith.com",
- "phoneNumber": "01234 567890"
}, - "secondaryContact": {
- "name": "John Smith",
- "email": "john@smith.com",
- "phoneNumber": "01234 567890"
}, - "appointmentReservationId": 345,
- "requestedCompletionDate": "2022-01-10",
- "engineerTasks": [
- "TEST_SINGLE_DEVICE"
], - "hazards": "string",
- "onSiteRestrictions": "string",
- "notes": "Lorem ipsum dolor sit amet..."
}