InventoryLocationsCostAndQuantity

Get the list of Inventory Locations cost and quantity

Path

GET /odata/InventoryLocationsCostAndQuantity

Description

Returns a paged list of existing Inventory Locations cost and quantity within the logged-in organization.

Note

You can filter the results as follows:

For an exact match, use: $filter parameter–entity eq ‘string’
For a partial match, use: $filter=contains parameter–contains(entity, ‘string’)

Request parameters

Parameter	Explanation
includeInactiveInventory: boolean default: false in query	Include inactive Inventory Items.
includeInactiveLocations: boolean default: false in query	Include inactive Locations.
includeInactiveInventoryLocations: boolean default: false in query	Include inactive Inventory Locations.
api-version: string default: 1.0 in header	The requested API version.
$filter: string in query	Restricts the set of Items returned. The maximum number of expressions is 100.
$orderby: string in query	Specifies the order in which items are returned. The maximum number of expressions is 5.
$search: string in query	Picks the value in all possible fields.
$top: string in query	Returns only the first n results.
$skip: string in query	Skips the first n results.
Authorization: string default: Bearer access_token in header	Specify the type of the token (bearer) and then insert the `access_token`, which was obtained during authentication.

Responses

Response	Explanation
200 OK	OK
400 Bad Request	Incorrect input data or organization ID does not match with the organization ID user is logged in.
400 Bad Request	The limit for the `$top` query has been exceeded. The value from the incoming request is 'N' (N is your value from the request). You can find the data on the current limit here.
401 Unauthorized	Incorrect specified `access_token` or `access_token` got expired.
403 Forbidden	User doesn’t have appropriate privileges.
500 Internal Server Error	Server encountered an unexpected condition that prevented it from fulfilling the request.

Properties

Property	Explanation
inventoryLocationId: string (uuid)	Unique Identifier of the Inventory Location
inventoryId: string (uuid)	Unique Identifier of the Inventory Item
inventoryNo: string	Identification code of the Inventory Item
locationNo: string	Identification Number of the Location
cost: number (double)	Cost for the Location
quantityOnHand: integer (int32)	The total number of stock-keeping Inventory Items that are physically located in the Location
activeStatus: boolean	Is Location active or not?
dateAdded: string (date-time)	Date when the Location was added
addedBy: string (uuid)	Unique Identifier of the user who added the Location
lastUpdated: string (date-time)	Last Date when the Location was updated
lastUpdatedBy: string (uuid)	Unique Identifier of the last user who updated the Location
costLastUpdated: string (date-time)	Last Date when the Cost was updated
costLastUpdatedBy: string (uuid)	Unique Identifier of the last user who updated the Cost

Response Content-types: APPLICATION/JSON, APPLICATION/XML
Response example (200 OK)

{
    "@odata.context": "link",
    "@odata.count": "number",
    "value": [
        {
            "inventoryLocationId": "00000000-0000-0000-0000-000000000000",
            "inventoryId": "00000000-0000-0000-0000-000000000000",
            "inventoryNo": "string",
            "locationNo": "string",
            "cost": "number (double)",
            "quantityOnHand": "integer (int32)",
            "activeStatus": "boolean",
            "dateAdded": "string (date-time)",
            "addedBy": "00000000-0000-0000-0000-000000000000",
            "lastUpdated": "string (date-time)",
            "lastUpdatedBy": "00000000-0000-0000-0000-000000000000",
            "costLastUpdated": "string (date-time)",
            "costLastUpdatedBy": "00000000-0000-0000-0000-000000000000"
        }
    ],
    "@odata.nextLink": "link"
}

Get the specified Inventory Location cost and quantity