| Name
(* = required)
|
Data Type | Description |
| name
*
|
string |
|
|
Type |
Description |
| TotalResults |
int
|
|
| ResourceList |
IList<Inventory.Models.Audit>
|
|
| Description |
string
|
description for human eyes, not unique
|
| Notes |
string
|
|
| CollectTrackbys |
bool
|
true: scanner application will direct operator to collect the track-bys for each sku
|
| Priority |
int
|
user-defined value for sorting audits; useful in scanner app for operator to give preference when choosing to perform an audit
|
| ReadOnly |
Inventory.Models.AuditReadOnly
|
non-editable attributes of an audit
|
| AuditId |
int
|
|
| FacilityIdentifier |
Generic.Models.FacilityIdentifier
|
|
| Name |
string
|
|
| Id |
int
|
|
| CreationDate |
DateTime
|
|
| CreatedBy |
Generic.Models.UserIdentifier
|
|
| Name |
string
|
|
| Id |
int
|
|
| Status |
Common.Enum.InventoryAuditStatus
|
|
|
- 0: Open |
|
|
- 1: Counting |
|
|
- 2: Counted |
|
|
- 3: Closed |
|
|
- 4: Paused |
|
| ClosedDate |
DateTime?
|
|
| ClosedBy |
Generic.Models.UserIdentifier
|
|
| Name |
string
|
|
| Id |
int
|
|
| BatchJobCount |
int
|
|
| CountedDate |
DateTime?
|
|
| CountedBy |
Generic.Models.UserIdentifier
|
|
| Name |
string
|
|
| Id |
int
|
|
| ReconciledDate |
DateTime?
|
|
| ReconciledBy |
Generic.Models.UserIdentifier
|
|
| Name |
string
|
|
| Id |
int
|
|
| AssignedTo |
Generic.Models.UserIdentifier
|
who is assigned to count the inventory in the specified locations
|
| Name |
string
|
|
| Id |
int
|
|
| Locations |
IList<Inventory.Models.AuditLocation>
|
locations included in this audit task; each entry contains a link to add counts to the location
|
| Location |
Generic.Models.LocationIdentifier
|
location assigned to an audit
|
| NameKey |
Generic.Models.LocationNameKey
|
|
| FacilityIdentifier |
Generic.Models.FacilityIdentifier
|
|
| Name |
string
|
|
| Id |
int
|
|
| Name |
string
|
|
| Id |
int
|
|
| LocationEmpty |
bool
|
|
| Links |
IList<WebApi.Hal.Link>
|
|
|
-
/rels/inventory/auditlocationcounts
|
POST to add a count to this location, DELETE to remove all counts for this location |
|
-
/rels/inventory/empty
|
PUT to mark a location as counted and empty |
| AuditType |
string
|
|
| BaseItemTraits |
Generic.Models.ItemTraits
|
Base traits related to an item based audit
|
|
Generic.Models.ItemTraits |
unique identifying characteristics of an item in a location
|
| ItemIdentifier |
Generic.Models.ItemIdentifier
|
|
| Sku |
string
|
|
| Id |
int
|
|
| Qualifier |
string
|
|
| LotNumber |
string
|
|
| SerialNumber |
string
|
|
| Cost |
decimal?
|
|
| ExpirationDate |
DateTime?
|
|
| PalletIdentifier |
Generic.Models.PalletIdentifier
|
|
| NameKey |
Generic.Models.PalletNameKey
|
|
| FacilityIdentifier |
Generic.Models.FacilityIdentifier
|
|
| Name |
string
|
|
| Id |
int
|
|
| Name |
string
|
|
| Id |
int
|
|
| BaseItemDesc |
string
|
Sku description for an item based audit
|
| ItemAuditCustomerId |
int?
|
|
| MovableUnitsEnabled |
Common.Enum.UsageLevel
|
|
|
- 0: Disallow |
|
|
- 1: Allow |
|
|
- 2: Require |
|
| BatchName |
string
|
|
| Links |
IList<WebApi.Hal.Link>
|
|
|
-
edit |
|
|
-
/rels/inventory/auditstatechange
|
|
|
-
/rels/inventory/auditevent
|
|
|
-
/rels/inventory/auditcounts
|
|
|
-
/rels/inventory/auditbatch
|
|
| Links |
IList<WebApi.Hal.Link>
|
|
|
-
next |
|
|
-
prev |
|
Sample accept: application/hal+json
{
"totalResults": 1,
"_embedded": {
"http://api.3plCentral.com/rels/inventory/audit": [
{
"description": "str",
"notes": "str",
"collectTrackbys": true,
"priority": 4,
"readOnly": {
"auditId": 1,
"facilityIdentifier": {
"name": "str",
"id": 2
},
"creationDate": "2016-12-25T23:00:00",
"createdBy": {
"name": "str",
"id": 2
},
"status": 0,
"closedDate": "2016-12-25T23:00:00",
"closedBy": {
"name": "str",
"id": 2
},
"batchJobCount": 3,
"countedDate": "2016-12-25T23:00:00",
"countedBy": {
"name": "str",
"id": 2
},
"reconciledDate": "2016-12-25T23:00:00",
"reconciledBy": {
"name": "str",
"id": 2
}
},
"assignedTo": {
"name": "str",
"id": 2
},
"auditType": "str",
"baseItemTraits": {
"itemIdentifier": {
"sku": "str",
"id": 2
},
"qualifier": "str",
"lotNumber": "str",
"serialNumber": "str",
"cost": 1.0,
"expirationDate": "2016-12-25T23:00:00",
"palletIdentifier": {
"nameKey": {
"facilityIdentifier": {
"name": "str",
"id": 2
},
"name": "str"
},
"id": 1
}
},
"baseItemDesc": "str",
"itemAuditCustomerId": 1,
"movableUnitsEnabled": 0,
"batchName": "str",
"_embedded": {
"item": [
{
"location": {
"nameKey": {
"facilityIdentifier": {
"name": "str",
"id": 2
},
"name": "str"
},
"id": 1
},
"locationEmpty": true
}
]
}
}
]
}
}