How To: Platform Order Management
For information about prerequisites, see Creating Order. Call the Order Config endpoint to add the Attributes to a Platform Order.The following sample request body only defines a couple of custom Attributes such as the name of Order attributes for an Order.
To update the configured Order attributes, call the Update Order Attributes endpoint.
To get the list of all configured Order attributes, call the Get Custom Attributes of an Order endpoint.
To get the configuration of a State Machine for an Order call the Get Order State Machine Configuration endpoint.
Call the Update State Machine Configuration for an Order endpoint to update the State Machine configuration.
Before creating an Order, configure Platform Order Attributes. Once the attributes are configured call Create Order endpoint and pass the payload similar to what is shown below.
To manage an order, utilize the endpoints provided by the Order service. Call the Update Order attributes endpoint for modifications in Order created, while the Get Order details endpoint helps retrieve in-depth details about the orders. Apply the Order Cancellation endpoint for changes in cancellation details and to add or update the WorkOrder, use the Add WorkOrder to the Order endpoint.
Learn more about Custom Code.
To register Custom Code configuration in the Platform Order Management service call register custom code configurations API Endpoint.
Sample payload for adding Custom code configuration is given below:
To update the Custom Code configuration in Platform Order Management, call the update custom code configurations endpoint.
To get the details of configured Custom Code in Platform Order Management, call the GET Custom Code Configuration endpoint.