v1

latestOpenAPI 3.1.02026-07-2422707.0 MB

Retrieve the stock quantities of products

This API fetches the stock quantities of all products in the specified center.

You must specify appropriate details for the center_id and inventory_date parameters. Optionally, you can provide the necessary details for the search_string and product_type parameters.

get/v1/inventory/stock?center_id={center_id}&inventory_date={inventory_date}&search_string={seach_string}&product_type={product_type}

Query parameters

center_idstring required

Mandatory Unique 32-character identifier of the center.

inventory_datestring date required

Mandatory Date for which the stock details are to be retrieved. Date format: yyyy-mm-dd. Time format: hh:mm:ss for a 24-hour clock.

search_stringstring

Optional Specify the products that you want to search. Default value: null.

product_type'3'

Optional Indicates the type of products that are to be retrieved: Retail - 1, Consumable - 2, and All - 3. Default value: 3.

Response

200