PARAreaItems

Get the list of PAR Area Items

Path

GET /odata/parAreaLineItems

Description

Returns a paged list of PAR Area Items 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
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
parAreaItemId: string (uuid)	Unique Identifier of the PAR Area Item
parAreaId: string (uuid)	Unique Identifier of the PAR Area
parAreaNo: string	Identification Number of the PAR Area
parAreaName: string	Name of the PAR Area
inventoryLocationId: string (uuid)	Unique Identifier of the Inventory Location
locationNo: string	Identification Number of the Location
locationName: string	Name of the Location
lineItemNo: integer (int32)	Number of the Line Item
inventoryNo: string	Identification code of the Inventory Item
inventoryDescription: string	Description of the Inventory Item
notes: string	Comments about the PAR Area Item
minQuantity: integer (int32)	Minimal Items Quantity for this PAR Area
maxQuantity: integer (int32)	Maximal Items Quantity for this PAR Area
uom: string	Unit of Measure
conversionFactor: integer (int32)	Number of Stock Keeping Units in another Unit of Measure
binShelf: string	Level of storage within PAR Area
lastCountDate: string (date-time)	Date when last PAR Count was created for this PAR Area Item
gtin: string	Global Trade Item Number
manufacturerItemNo: string	Item Number of the Manufacturer
activeStatus: boolean	Is the status of the PAR Area Item active or not?
dateCreated: string (date-time)	Date when PAR Area Item the was created
createdBy: string (uuid)	Unique Identifier of the user who created the PAR Area Item
createdByName: string	First Name and Last Name of the user who added PAR Area Item
lastUpdated: string (date-time)	Last Date when the PAR Area Item was updated
lastUpdatedBy: string (uuid)	Unique Identifier of the last user who updated the PAR Area Item
lastUpdatedByName: string	First Name and Last Name of the last user who updated the PAR Area Item

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

{
    "@odata.context": "link",
    "@odata.count": "number",
    "value": [
        {
            "parAreaItemId": "00000000-0000-0000-0000-000000000000",
            "parAreaId": "00000000-0000-0000-0000-000000000000",
            "parAreaNo": "string",
            "parAreaName": "string",
            "inventoryLocationId": "00000000-0000-0000-0000-000000000000",
            "locationNo": "string",
            "locationName": "string",
            "lineItemNo": "integer (int32)",
            "inventoryNo": "string",
            "inventoryDescription": "string",
            "notes": "string",
            "minQuantity": "integer (int32)",
            "maxQuantity": "integer (int32)",
            "uom": "string",
            "conversionFactor": "integer (int32)",
            "binShelf": "string",
            "lastCountDate": "string (date-time)",
            "gtin": "string",
            "manufacturerItemNo": "string",
            "activeStatus": "boolean",
            "dateCreated": "string (date-time)",
            "createdBy": "00000000-0000-0000-0000-000000000000",
            "createdByName": "string",
            "lastUpdated": "string (date-time)",
            "lastUpdatedBy": "00000000-0000-0000-0000-000000000000",
            "lastUpdatedByName": "string"
        }
    ],
    "@odata.nextLink": "link"
}

Get the specified PAR Area Item