The APIs currently available in IP1 are listed below. These APIs have their specific request parameters depending on the operation and the mode of the API.
Some APIs return a long list of data as response (e.g. ip1Customers.get, ip1Items.get). The list can be very long, covering many pages. With these APIs, we need to have control over how multiple records are retrieved and displayed from the database. This is achieved by adding scan words, paging, filtering, and sorting fields to the APIs. It allows us to limit the number of records per request and provide means of paginating the returned response in a sorted order.
See Paging parameters (parameters that control returned results)
See Example of API input and output data using parameters described above.
| Click to view APIs for | Description |
| Basic | Retrieves basic details for a customer/item, and customer item price, stock quantity/value and AR balance. |
| Customers | Customer listing based on the input parameters and live search. |
| Items | Item listing based on the input parameters and live search. |
| Orders | Retrieves orders by a specific customer or across customers and customer/item o/s purchase orders. |
