# Order Management

Create and manage an order to provide, cease or modify a service at a given address.

This follows the concepts in TMF641 - Service Ordering Management API.


## Create an order for provide, cease or modify service.

 - [POST /service-orders](https://docs.thefibrecafe.net/openapi/prod/tenant-api/gen/order-management/handlecreateorder.md): This endpoint can be called to place a order with a supplier to provide, cease
or modify a service.

The Fibre Cafe will validate the request and generate an order number which is
returned. If the order is rejected immediately then a 400 code will be returned
with reason(s) for the rejection in the response.

The order will then be sent to the supplier for processing and further updates
will be sent via KCIs - this could include a rejection if the order does not
meet supplier validation/processing rules. Once the order is acknowledged, the
supplier may assign their own order number which will be returned in the KCI.

## Retrieve current order details including updates (KCIs).

 - [GET /service-orders/{id}](https://docs.thefibrecafe.net/openapi/prod/tenant-api/gen/order-management/handlegetorder.md): This endpoint is called to retrieve the current details (including KCIs) about an inflight service order.

## Request an amendment to an inflight provide, cease or modify order.

 - [POST /service-order-amendments](https://docs.thefibrecafe.net/openapi/prod/tenant-api/gen/order-management/handleamendorder.md): This endpoint is called to request amendment(s) to an existing inflight order to
provision, modify or cease a service.

The Fibre Cafe 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.

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

 - [POST /service-order-cancellations](https://docs.thefibrecafe.net/openapi/prod/tenant-api/gen/order-management/handlecancelorder.md): This endpoint is called to request cancellation of an existing inflight order to
provision, modify or cease a service.

The Fibre Cafe 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.

## Create an order to provide ethernet service.

 - [POST /ethernet/service-orders](https://docs.thefibrecafe.net/openapi/prod/tenant-api/gen/order-management/handlecreateethernetorder.md): This endpoint can be called to place an ethernet order with a supplier - currently only
provide is supported with cease and modify coming soon.

The Fibre Cafe will validate the request and generate an order number which is
returned. If the order is rejected immediately then a 400 code will be returned
with reason(s) for the rejection in the response.

The ethernet order will then be sent to the supplier for processing and further updates
will be sent via KCIs - this could include a rejection if the order does not
meet supplier validation/processing rules. Once the order is acknowledged, the
supplier may assign their own order number which will be returned in the KCI.

## Retrieve current ethernet order details including updates (KCIs).

 - [GET /ethernet/service-orders/{id}](https://docs.thefibrecafe.net/openapi/prod/tenant-api/gen/order-management/handlegetethernetorder.md): This endpoint is called to retrieve the current details (including KCIs) about an inflight ethernet order.