InventorySnapshots
Get the list of Inventory Snapshots
Path
GET /odata/InventorySnapshots
Description
Returns the list of Inventory Snapshots within a logged organization. You can filter the results by the strict match using the $filter parameter–entity eq ‘string’. Or filter the results by the partial match using $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. |
| 404 Not Found | Specified ID is absent in the system. |
| 500 Internal Server Error | Server encountered an unexpected condition that prevented it from fulfilling the request. |
Properties
Property |
Explanation |
|---|---|
| inventorySnapshotId: string (uuid) | Unique Identifier of the Inventory Snapshot |
| organizationId: string (uuid) | Unique Identifier of the Organization |
| organizationName: string | Name of the Organization |
| snapshotDate: string (date-time) | Date when the Snapshot was created |
| reference: string | Information concerning the Snapshot |
| dateCreated: string (date-time) | Date when the Snapshot was created |
| createdBy: string (uuid) | Unique Identifier of the user who created the Snapshot |
| createdByName: string | Name of the user who created the Snapshot |
| isFiltered: boolean (uuid) | Is the data for Inventory Snapshot filtered or not? |
| isAutoExecuted: boolean | Is the Inventory Snapshot autoexecuted or not? |
Response Content-types: APPLICATION/JSON, APPLICATION/XML
Response example (200 OK)
Response example (200 OK)
{
"items": [
{
"inventorySnapshotId": "00000000-0000-0000-0000-000000000000",
"organizationId": "00000000-0000-0000-0000-000000000000",
"organizationName": "string",
"snapshotDate": "string (date-time)",
"reference": "string",
"dateCreated": "string (date-time)",
"createdBy": "00000000-0000-0000-0000-000000000000",
"createdByName": "string",
"isFiltered": "boolean",
"isAutoExecuted": "boolean"
}
],
"nextPageLink": "string",
"count": "integer (int64)"
}
Get the specified Inventory Snapshot
Path
GET /odata/InventorySnapshots({inventorySnapshotId})
Description
Returns the details of the Inventory Snapshots specified by ID.
Request parameters
Parameter |
Explanation |
|---|---|
| inventorySnapshotId: string (uuid) required in path |
Enter the ID of the Inventory Snapshot here. |
| api-version: string default: 1.0 in header |
The requested API version. |
| 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. |
| 401 Unauthorized | Incorrect specified access_token or access_token got expired. |
| 403 Forbidden | User doesn’t have appropriate privileges. |
| 404 Not Found | Specified ID is absent in the system. |
| 500 Internal Server Error | Server encountered an unexpected condition that prevented it from fulfilling the request. |
Properties
Property |
Explanation |
|---|---|
| inventorySnapshotId: string (uuid) | Unique Identifier of the Inventory Snapshot |
| organizationId: string (uuid) | Unique Identifier of the Organization |
| organizationName: string | Name of the Organization |
| snapshotDate: string (date-time) | Date when the Snapshot was created |
| reference: string | Information concerning the Snapshot |
| dateCreated: string (date-time) | Date when the Snapshot was created |
| createdBy: string (uuid) | Unique Identifier of the user who created the Snapshot |
| createdByName: string | Name of the user who created the Snapshot |
| isFiltered: boolean (uuid) | Is the data for Inventory Snapshot filtered or not? |
| isAutoExecuted: boolean | Is the Inventory Snapshot autoexecuted or not? |
Response Content-types: APPLICATION/JSON, APPLICATION/XML
Response example (200 OK)
Response example (200 OK)
{
"inventorySnapshotId": "00000000-0000-0000-0000-000000000000",
"organizationId": "00000000-0000-0000-0000-000000000000",
"organizationName": "string",
"snapshotDate": "string (date-time)",
"reference": "string",
"dateCreated": "string (date-time)",
"createdBy": "00000000-0000-0000-0000-000000000000",
"createdByName": "string",
"isFiltered": "boolean",
"isAutoExecuted": "boolean"
}
Get the list of Inventory Snapshot Items for the specific Inventory Snapshot
Path
GET /odata/InventorySnapshots({inventorySnapshotId})/inventorySnapshotItems
Description
Returns the list of items of the Inventory Snapshot specified by ID within a logged organization. You can filter the results by the strict match using the $filter parameter–entity eq ‘string’. Or filter the results by the partial match using $filter=contains parameter–contains(entity, ‘string’).
Request parameters
Parameter |
Explanation |
|---|---|
| inventorySnapshotId: string (uuid) required in path |
Enter the ID of the Inventory Snapshot here. |
| 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 |
|---|---|
| inventorySnapshotItemId: string (uuid) |
Unique Identifier of the Inventory Snapshot Item |
| inventorySnapshotId: string (uuid) | Unique Identifier of the Inventory Snapshot |
| reference: string | Information concerning the Inventory Snapshot |
| inventoryId: string (uuid) | Unique Identifier of the Inventory Item |
| inventoryNo: string | Identification code of the Inventory Item |
| inventoryDescription: string | Description of the Inventory Item |
| inventoryLocationId: string (uuid) | Unique Identifier of the Inventory Location |
| locationNo: string | Identification Number of the Location |
| locationName: string | Name of the Location |
| cost: number (double) | Cost for the Inventory Item |
| quantity: integer (int32) | Quantity on hand of the Inventory Location when the Inventory Snapshot was created |
| itemTypeId: integer (int32) | Unique identifier of the Item type |
| itemTypeName: string | Name of the Item type |
| dateCreated: string (date-time) |
Date when the Inventory Snapshot Item was created |
Response Content-types: APPLICATION/JSON, APPLICATION/XML
Response example (200 OK)
Response example (200 OK)
{
"items": [
{
"inventorySnapshotItemId": "00000000-0000-0000-0000-000000000000",
"inventorySnapshotId": "00000000-0000-0000-0000-000000000000",
"reference": "string",
"inventoryId": "00000000-0000-0000-0000-000000000000",
"inventoryNo": "string",
"inventoryDescription": "string",
"inventoryLocationId": "00000000-0000-0000-0000-000000000000",
"locationNo": "string",
"locationName": "string",
"cost": "number (double)",
"quantity": "integer (int32)",
"itemTypeId": "integer (int32)",
"itemTypeName": "string",
"dateCreated": "string (date-time)"
}
],
"nextPageLink": "string",
"count": "integer (int64)"
}