Inventory Inquiry (Aggregate)
This API allows the user to request the aggregate inventory information of an item or items that belong to a particular manufacturer. This does not separate inventory by location, instead providing the total inventory count across all locations.
Note that unlike other OMS APIs, there are two endpoints that may be used. Each endpoint is associated with a different API key related to a package – either an “Inventory V5” or “Inventory Specific” package. The Inventory Specific package is the preferred endpoint to use, but some implementations may use Inventory V5 depending on their configuration.
Version 5.0 Call – Inventory V5 https://integration.shopatron.com/api/v5/inventory/aggregate Call – Inventory Specific https://integration.shopatron.com/inv/api/v5/inventory/aggregate/ Supported Formats JSON HTTP Method POST
An example use of the Inventory API follows below, or view the sample Postman Collection .
Example
The example case will inquire about an inventory with the following properties:
Inventory of item 212121 At any location of manufacturer 00000
Required Parameters
These parameters are necessary for the Inventory API to return a successful response:
Parameter Type Description manufacturerID integer A unique identifier for a manufacturer. The minimum value is “100”. items array List of items to search on. The minimum length is 1.
The items array is built as an object (/[object] ) with the following parameters. The quantity and any one of the other parameters are required.
Parameter Type Description partNumber string The product part number. The minimum length is 1. upc string The product’s Universal Product Code. The minimum length is 1. sku string The product’s Stock Keeping Unit code. The minimum length is 1. quantity integer The quantity of the product. The minimum value is “0”.
Optional Parameters
Other possible parameters can be provided to specify other details about the product. These variables are:
Parameter Type Description fulfillerID integer A unique identifier for a fulfiller. The minimum value is “0”. catalogID integer A unique identifier for the catalog. The minimum value is “0”. ignoreSafetyStock boolean Whether to ignore the safety stock buffer put in place. The default is “false”. includeNegativeInventory boolean Whether to allow items with negative inventory in the results. The default is “false”. shippingLocation boolean Whether to limit results to locations that are shipping enabled. taxableLocation boolean Filter results by locations that apply tax (true) or don’t (false). restockEnabled boolean Filter results by locations that are restock-enabled (true) or not (false). pickupEnabled boolean Filter results by locations that are pickup-enabled (true) or not (false). finderbotEnabled boolean Filter results by locations that have finderbot enabled (true) or don’t (false). hasStorefront boolean Filter results by locations that have physical storefronts (true) or don’t (false).
The Full Request
This is the entire request that will inquire about an inventory.
{
"manufacturerID": "00000",
"items": [
{
"sku": "testsku120",
"quantity": 1
}]
}
The Full Response
The response is aggregate total without location information.
[
{
"manufacturerID": 00000,
"onHand": 101,
"available": 94,
"partNumber": "testsku120",
"sku": "testsku120"
}
]