Get a single Inventory object
GET
/api/v2/inventory/{id}.json
Retrieve a single Inventory object using its ID.
Scopes
Requires either the inventory or inventory.readonly OAuth
scope.
Parameters
Accepts the following parameters:
id
required
The ID of the Inventory object is supplied as a path parameter. |
Response
Returns an object with the following properties:
success
A boolean where a value of true represents a successful request.
|
status
The HTTP status code e.g. 200 for a successful request.
|
data
Contains the Inventory object. |
JSON Example
An example of JSON returned.
{
"success": true,
"status": 200,
"data": {
"id": 2464,
"productId": 7604,
"locationId": 845,
"shelfLocation": "SHELF-62977cbe0a46c",
"quantityInStock": 100,
"quantityReserved": null,
"quantityAvailable": 100,
"defaultReorderQuantity": 0,
"isPreferred": false,
"issueAlertAtQuantity": 0,
"modifiedOn": "2022-06-01T14:50:50+00:00",
"createdOn": "2022-06-01T14:50:50+00:00"
}
}