REL documentation
inventory auditcount (http://api.3plcentral.com/rels/inventory/auditcount)
Resource:
a count for one location and sku of an audit, including actual and expected quantities
C# Rel Const:
Rels.InventorySvc.AuditCount
URI template:
facilities/{id}/audits/{aid}/locations/{lid}/counts/{cid}
Obtain URI from:
always returns 404; here for rel doc generation; obtain this resource via AuditCounts
Success status: 200
Name (* = required) Data Type Description
id * int facility id
aid * int audit id
lid * int location id
cid * int count id
a count for a location with an audit task
always returns 404
Type Description
CountId int internal id for this count; use in AuditCountIdentifier when moving and adjusting
LocationIdentifier Generic.Models.LocationIdentifier
NameKey Generic.Models.LocationNameKey
FacilityIdentifier Generic.Models.FacilityIdentifier
Name string
Id int
Name string
Id int
ItemTraits Generic.Models.ItemTraits either what was counted or what is contained within a location
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
Counted decimal how many was counted; zero if not counted but system thinks inventory is in given location
OnHand decimal how many the system thinks is on hand in given location
Available decimal how many the system thinks is available in given location
OtherInventoryOnHand IEnumerable<Inventory.Models.NotCounted> if Audit's CollectTrackbys true when counted or item doesn't allow trackbys: null; otherwise not null, listing on-hand quantities with any non-empty trackby in given location
LotNumber string
SerialNumber string
ExpirationDate DateTime? ...
OnHand decimal
Available decimal
Links IList<WebApi.Hal.Link>
- /rels/inventory/auditcounts Links to all audit counts on get
- /rels/inventory/auditlocationcounts DELETE to remove all counts for this location
- /rels/inventory/auditswap swap inventory quantity to this location from other specified locations
- /rels/inventory/audit
Sample accept: application/hal+json
{
  "countId": 1,
  "locationIdentifier": {
    "nameKey": {
      "facilityIdentifier": {
        "name": "str",
        "id": 2
      },
      "name": "str"
    },
    "id": 1
  },
  "itemTraits": {
    "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
    }
  },
  "counted": 2.0,
  "onHand": 3.0,
  "available": 4.0,
  "otherInventoryOnHand": [
    {
      "lotNumber": "str",
      "serialNumber": "str",
      "expirationDate": "2016-12-25T23:00:00",
      "onHand": 3.0,
      "available": 4.0
    }
  ]
}
deletes a single count from an audit location; etag from GetAuditCounts required
If-Match request header required; Success status: 204
Name (* = required) Data Type Description
id * int facility id
aid * int audit id
lid * int location id
cid * int count id

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.