List inventory

GET /api/v2/inventory.json

Get or search for one or more Inventory entries using a range of accepted query parameters.

Scopes

Requires either the inventory or inventory.readonly OAuth scope.

Parameters

Accepts the following query parameters:

createdOn:min
Return inventory with a createdOn datetime greater than or equal to the datetime supplied in ISO-8601 format (e.g. 2024-04-27T16:39:56+01:00)

createdOn:max
Return inventory with a createdOn datetime less than or equal to the datetime supplied in ISO-8601 format (e.g. 2024-04-27T16:39:56+01:00)

createdOn:after
Return inventory with a createdOn datetime greater than the datetime supplied in ISO-8601 format (e.g. 2024-04-27T16:39:56+01:00)

createdOn:before
Return inventory with a createdOn datetime less than the datetime supplied in ISO-8601 format (e.g. 2024-04-27T16:39:56+01:00)

id:in
Return inventory specified within a comma-separated list of Inventory IDs.

id:min
Return inventory with an ID greater than or equal to that specified.

id:max
Return inventory with an ID less than or equal to that specified.

id:after
Return inventory with an ID greater than that specified.

id:before
Return inventory with an ID less than that specified.

locationId
Return inventory associated with a single Location ID.

locationId:in
Return inventory associated with one or more comma-separated Location IDs.

modifiedOn:min
Return inventory with a modifiedOn datetime greater than or equal to the datetime supplied in ISO-8601 format (e.g. 2024-04-27T16:39:56+01:00)

modifiedOn:max
Return inventory with a modifiedOn datetime less than or equal to the datetime supplied in ISO-8601 format (e.g. 2024-04-27T16:39:56+01:00)

modifiedOn:after
Return inventory with a modifiedOn datetime greater than the datetime supplied in ISO-8601 format (e.g. 2024-04-27T16:39:56+01:00)

modifiedOn:before
Return inventory with a modifiedOn datetime less than the datetime supplied in ISO-8601 format (e.g. 2024-04-27T16:39:56+01:00)

productId
Return Inventory associated with a single Product ID.

productId:in
Return Inventory associated with one or more comma-separated Product IDs.

JSON response

Evance will return a JSON object containing the following properties:

success
A successful search request containing zero or more results will always return a true value.

status
An integer matching the HTTP response code. A successful request will have a status of 200.

data
An array containing zero or more Inventory data objects.

pagination
Search results include a pagination object contain information about the current page, total pages, the limit per page and the total number of results available.

limit - the number of items to return per page
page - the current page number
total - the total number of available results
totalPages - the total number of available pages of results

links
An object containing links to traverse available search results.

self - the URL for the current search.
previous - a URL for the previous results page, or nullif there isn't one.
next - a URL for the next results page, or null if there isn't one

Example response


{
    "success": true,
    "status": 200,
    "data": [
        {
            "id": 5641,
            "productId": 7604,
            "locationId": 854,
            "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"
        }
    ],
    "pagination": {
        "page": 1,
        "limit": 100,
        "total": 1,
        "totalPages": 1
    },
    "links": {
        "self": "https://examples.evance.me/api/v2/inventory.json",
        "previous": null,
        "next": null
    }
}

List inventory

Scopes

Parameters

JSON response

Example response

Website builder

Themes

Partners

Resources

Evance