Contract order APIs

The listed APIs are included with the developer toolkit and available for preview. A contract order is an agreement between a buyer and seller to create sales orders periodically for a specific tenure.

The contract order outlines the terms and conditions of the agreement. Such as the products and quantity to deliver, recurring delivery dates, billing and shipping addresses. This type of predefined arrangement of contract order lines is relevant in a business-to-business (B2B) order operation. In a B2B scenario, a contract between businesses helps to make sure that both the parties fulfill their obligations and commitments. An effective contract management is critical in B2B relationships as it directly impacts revenue, customer satisfaction, and long-term partnerships.

A pre-negotiated contract order is used to create sales orders that are auto-generated based on the contract delivery timeline or manually created by users when needed.

Sterling™ Order Management System provides APIs to create a contract order between a buyer and seller, and then proceed with the following actions:
  • Record the negotiation progress by changing the contract order status.
  • Record the progress by changing the contract order status, such as reject or approve the changes that are made to the contract order.
  • Cancel a contract order or its lines.
  • Delete a contract order or its lines if the products are no longer needed. You can delete only an unconfirmed contract order or its lines.
  • Confirm a contract order. All draft contract orders and their lines can be confirmed. During the confirmation process, various validations are conducted, including checks on product details, entitlements, and line price.

The following Sterling Order Management System APIs are used to conduct the described actions for a contract order. For more information about contract order APIs, see Javadoc. To access Javadoc, see Accessing development-related documentation.

  • createOrder API
    Create a contract order with or without order lines.
  • changeOrder API
    • Modify a contract order, add contract order lines, or both.
    • Cancel a contract order or its lines.
    • Remove contract order lines or remove a contract order.
  • changeOrderStatus API
    Change the status of a contract order during negotiation, approval, or any further operational phases before you confirm the contract order.
  • deleteOrder API
    Delete an unconfirmed contract order or unconfirmed contract order lines.
  • confirmOrderContract API
    Confirm a contract order.