Order Amendment

Order Amendment allows the order, which is being fulfilled, to be modified for different parameters such as action, requiredByDate, and User-Defined Fields in the existing order lines. It also allows adding a new order line in the request. The parameters and their reason for change are mentioned as follows:

  • The parameter values passed in the original request were incorrect. The corrected values can be passed by sending an amendment request.
  • The parameter values require a modification as per the change request from the end user. For example, the bandwidth of a product named Internet Bundle is passed as a user-defined field named Bandwidth in the order line. The bandwidth in the original order was 1 Mbps. When the order was being fulfilled, the customer requested the bandwidth to be updated to 2 Mbps. This is done by sending an amendment request by changing the value of the user-defined field named Bandwidth to 2 Mbps.
  • An additional product requires fulfillment when the current one is being fulfilled.

An order can be amended when it is in one of the following states:

FEASIBILITY If the order is amended in these states, then it is called a pre-plan development amendment, because the execution plan has not yet been created. In this scenario, the execution plan generated for the amendment request is considered and run.
OPD
PREQUALIFICATIONFAILED
EXECUTION If the order is amended in these states it is post-plan development amendment, because the execution plan was already created and had begun execution. In this scenario, the existing plan requires modification and merging with the plan that has been generated as per the amendment request. Post-plan development amendment is the most frequently used amendment.
SUSPENDED
ERROR_HANDLER

An order cannot be amended when it is in either of the FINAL states:

  • COMPLETE
  • CANCELLED
  • WITHDRAWN

Delta Amendment

You can request for the required changes only. You do not have to include the existing orderlines or order details in the request for amendment.

Use Case: 1

You have an order, which contains A, B, and C items on line numbers 1, 2, and 3 respectively.

Here is a requirement to add item D on line number 4.

In this case, you do not have to send the entire order in the request. You can send item D in the request with 'add' as the required action.

Use Case: 2

You have an order, which contains A, B, and C items on line numbers 1, 2, and 3 respectively.

Here is a requirement to modify item B on line number 2.

In this case, you do not have to send the entire order in the request. You can send item B in the request with 'modify' as the required action.

Delta amendment is also available for requiredByDate and User-Defined Fields.