Stocks API
Overview
Stock API supports the following operations:
- Retrieves stock information. It allows client to receive real-time information about the availability of goods for sale. Returns the quantity of each product in each location (store, warehouse, or other places) (GET /stocks).
- Retrieves the status of the bulk import operation (GET /stock/status-enquiries/{requestId}).
- Retrieves the stock status from the backend system. It allows the client to view information on the current available stock at the location. (POST /stock/state).
- Allows API client to create or update Stock-Inventory Count in a bulk and asynchronous manner (POST /stock/inventoryCount/bulk-load).
- Allows API client to check the status of the dependent backend services such as Counterparties API service, Stock Control API service, MasterData API service, and Bulk Import API service (GET /healthCheck).
Features
Use Stocks API for the following data integration scenarios:
- Obtaining the availability of one or a group of items.
- Obtaining the availability of items at one or in a group of stations.
- Obtaining the availability of items at stations in the specified location (by coordinates and radius).
- Obtaining the availability of the stock status.
Additional Options
- Pagination of retrieved results
- Order results by locations attributes
- Search for stations by partial match
Security
The Stocks API supports OAuth 2.0 for authentication purposes.
The supported protocol for the Stocks API is HTTPS.