Orders approval via API

Introduction

This article explains how to use AppXite's order approval API functionality to gain full control over orders before they are processed. This self-service feature allows Sellers to approve or reject Customer orders through the AppXite Public API, helping manage risk when placing orders without upfront payment.

In this article:

• What is order approval via API used for
• How to get access to order approval functionality
• How order approval works on the Platform
• Public API for order approval

What is order approval via API used for

If Sellers want to limit their risks when placing orders without payment, they can use AppXite's order approval functionality through the Public API. This allows Sellers to review and approve or reject Customer orders before they are processed and provisioned.

To have full control over the orders, AppXite offers to its customers order approval API functionality as a part of self-service.

How to get access to the "Order Approval" functionality?

First, you need to sign up for the Developers portal here.
Here is an article on how to do it.

After getting access to the platform, you will be able to get APIs.

Orders Approval APIs can be found under the section "Orders".

AppXite can provide you with the test environment to have the opportunity to test APIs and implement integration before going live on production.

How order approval works on the Platform

After successful testing and implementation of the sandbox environment, you should notify AppXite that you are ready to go live, and AppXite will turn on this functionality in production.

In this case, each created order is moving to the "Pending approval" status.

Upon the settings of the application, it calls AppXite Public API to get all orders that are waiting for approval. 

Public API for order approval

There are five types of APIs for order approval:

1. Get the list of all orders
2. Retrieve an order
3. Create an order 
4. Approve an order 
5. Reject an order

Each order in the REST response contains order information, information about the customer, the order's price information, the order approve link, and the order reject link. 

• After that, the application calls our Public API to approve or reject the status of each order.
• If the order was approved, order provisioning starts.
• If the order was rejected, it is shown on the UI that the order was rejected by the reseller.
• If a customer makes an order - it can't be edited after. Customers can suspend the subscription or order a new one with a separate order.

Summary

AppXite's order approval API functionality enables Sellers to control order processing by reviewing and approving or rejecting Customer orders before provisioning. Access is provided through the AppXite Developers portal, with a test environment available for integration testing. Once enabled in production, all orders move to Pending approval status and await approval through the Public API. The API provides five endpoints for managing orders, and approved orders proceed to provisioning while rejected orders are marked accordingly in the UI. Orders cannot be edited once placed, but Customers can suspend Subscriptions or create new orders as needed.