How to use the order API

Packages let you create accounts and subscriptions in Smile. This process explains how to use the order endpoint of the API to order a package.

  1. Configure the package for API ordering.
    Packages cannot be ordered in the API by default. You must complete additional steps in Smile before you can use the API to order a package.
  2. Retrieve the order form.
    The order form lists the fields that must be included in an API order.
  3. Place an order for the package.
  4. Approve the order, if the package specifies that approval is required. If an order requires approval, you may need to complete the following steps:
    1. Retrieve order information.
      This lets you display the order to an approver.
    2. Update the order to provide additional information.
      For example, you may need to enter additional information such as a SIM card number or an approver may wish to change the order details. You cannot update an order after it is approved.
    3. Approve the order.
    The order is now complete. Smile automatically approves and completes any orders that do not require approval.
    Note: You can also use the Service order approvals report to approve orders in Smile.
To ensure that other applications take necessary actions after an order is complete, write an application that listens for SmileOrder messages.