REL documentation
inventory audits (http://api.3plcentral.com/rels/inventory/audits)
Resource:
Collection: of audit
C# Rel Const:
Rels.InventorySvc.Audits
URI template:
facilities/{id}/audits{?pgsiz,pgnum,rql,sort,transferLocations}
Obtain URI from:
/rels/properties/facility
get a list of audits
Success status: 200
Name (* = required) Data Type Description
id * int facility id in which to perform the audit
pgsiz int max records to return per response; use "next" or "prev" link to paginate
pgnum int considering pgsiz, returns the pgnum-th page, 1-indexed
rql string see RQL documentation
sort string see RQL documentation
list of audits
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
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? ...
Links IList<WebApi.Hal.Link>
- edit
- /rels/inventory/auditstatechange
- /rels/inventory/auditevent
- /rels/inventory/auditcounts
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
          }
        },
        "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,
        "_embedded": {
          "item": [
            {
              "location": {
                "nameKey": {
                  "facilityIdentifier": {
                    "name": "str",
                    "id": 2
                  },
                  "name": "str"
                },
                "id": 1
              },
              "locationEmpty": true
            }
          ]
        }
      }
    ]
  }
}
create new audit
Success status: 201; ETag response header supplied
Name (* = required) Data Type Description
id * int facility id in which to perform the audit
transferLocations bool true: if any specified locations are in an active audit, transfer the locations to this new audit (removes old counts)
a task to count inventory in a subset of locations within a facility
Type Description
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
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? ...
Sample content-type: application/hal+json
 
{
  "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
    }
  },
  "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,
  "_embedded": {
    "item": [
      {
        "location": {
          "nameKey": {
            "facilityIdentifier": {
              "name": "str",
              "id": 2
            },
            "name": "str"
          },
          "id": 1
        },
        "locationEmpty": true
      }
    ]
  }
}
a task to count inventory in a subset of locations within a facility
Type Description
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
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? ...
Links IList<WebApi.Hal.Link>
- edit
- /rels/inventory/auditstatechange
- /rels/inventory/auditevent
- /rels/inventory/auditcounts
Sample accept: application/hal+json
{
  "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
    }
  },
  "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,
  "_embedded": {
    "item": [
      {
        "location": {
          "nameKey": {
            "facilityIdentifier": {
              "name": "str",
              "id": 2
            },
            "name": "str"
          },
          "id": 1
        },
        "locationEmpty": true
      }
    ]
  }
}

This documentation is subject to change, and is updated often and without warning. The models documented may or may not be available to users now or in the future. Use this documentation at your own risk.
Contact api@3plcentral.com with any questions about this documentation.