The Avenue APIs are a set of web APIs that define a set of http request messages, along with a definition of the structure of response messages, which are in the form of JSON or XML. The Avenue APIs provide you with the ability to manage your eCommerce stores by providing calls for working with resources such as customers, categories, products, and sales orders. It also allows you to manage shopping carts and inventory. In addition to the core Avenue APIs, you can define custom resources and manage them through the APIs.With Avenue APIs you can:
Avenue uses a suite of APIs, including the eCommerce set, to allow developers to build custom applications such as eCommerce websites which rely on product information and order transactions within Pronto Xi.
The API calls are http-based and are available online, so web transactions can continue if Pronto Xi is unavailable. Transaction data is seamlessly synchronised between the cloud and Pronto Xi within two minutes.
Both B2B and B2C are supported as Avenue's inbuilt pricing engine stays fully synchronised with Pronto Xi.
Here's a sample of what you can do the Avenue APIs:
Once you post information to Avenue, you can use the Transaction API to request order information, including order status, any order submission errors or warning. When when the transaction is received by Pronto Xi, the result information is provided. In the case of order submission, this will include a URL containing the order number.
For more information about the API see transaction.get.
Using the Pronto Avenue APIs, developers don't need to be 4GL or Pronto Xi specialists to work with and access the Pronto Xi data and business logic.
Avenue is hosted by Pronto Software and the APIs are written, installed, and supported by Pronto Software so there is no need for developers to create custom, unsupported interfaces or to obtain additional licences to develop their applications.
You will need to perform a few setups in Avenue before you can start using the Avenue APIs.
Before you can work with Pronto Avenue APIs you must first create a user role, or modify an existing user role that allows API access. Once you have done this, then you can assign yourself and other users to the role.
The User Roles screen is displayed.
The User Role Editor is displayed.
Now you can assign users to the role.
The Users screen is displayed.
The Editing User screen is displayed.
Pronto Xi will typically have a cash or casual debtor set up. You can use this in Avenue to display pricing, availability and so on for B2C users.
In order for this to work you must set up Avenue to recognise the debtor code that is to be used for this purpose.
The Site Settings screen is displayed.
Once you start typing, you can select from the displayed Pronto Xi database matches.
The following APIs are available: