Rel doc - Rel

GET

/inventory/facilities/{id}/audits/{aid}/locations/{lid}/counts/{cid}

always returns 404; here for rel doc generation; obtain this resource via AuditCounts
Success status: 200

Params
Response body (Inventory.Models.AuditCount)

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
PalletInfo	Inventory.Models.PalletInfo	in GETs: the movable unit; in POSTs or PUTs: identifies existing movable unit or properties of new movable unit
PalletId	int? ...	for identifying: if known specify only this; other fields are ignored
Label	string	for identifying: if known but PalletId unknown, specify label, other fields ignored; for creating: new unique label or leave blank for system to generate unique label number
SplitOverCapacityOnCreate	bool? ...	if true will use PalletInfo as template to create multiples and splits associated receive items accordingly
QtyOverrideOnSplit	decimal? ...	when creating and SplitOverCapacityOnCreate is true, overrides the Item.Options.Pallets.Qty otherwise used to create multiples
PalletTypeIdentifier	Generic.Models.PalletTypeIdentifier	required when creating new movable unit
Name	string
Id	int
Metric	Generic.Models.Dimension	optional when creating; if only Metric specified, Imperial is calculated
Length	decimal? ...
Width	decimal? ...
Height	decimal? ...
Weight	decimal? ...
Imperial	Generic.Models.Dimension	optional when creating; if only Imperial specified, Metric is calculated
Length	decimal? ...
Width	decimal? ...
Height	decimal? ...
Weight	decimal? ...
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
SystemQty	decimal? ...	how many are expected
AllocatedQty	decimal? ...	how many the system has onhand at the time of counting
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,
  "palletInfo": {
    "palletId": 1,
    "label": "str",
    "splitOverCapacityOnCreate": true,
    "qtyOverrideOnSplit": 1.0,
    "palletTypeIdentifier": {
      "name": "str",
      "id": 2
    },
    "metric": {
      "length": 1.0,
      "width": 1.0,
      "height": 1.0,
      "weight": 1.0
    },
    "imperial": {
      "length": 1.0,
      "width": 1.0,
      "height": 1.0,
      "weight": 1.0
    }
  },
  "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,
  "systemQty": 1.0,
  "allocatedQty": 1.0,
  "otherInventoryOnHand": [
    {
      "lotNumber": "str",
      "serialNumber": "str",
      "expirationDate": "2016-12-25T23:00:00",
      "onHand": 3.0,
      "available": 4.0
    }
  ]
}

DELETE

/inventory/facilities/{id}/audits/{aid}/locations/{lid}/counts/{cid}

deletes a single count from an audit location; etag from GetAuditCounts required
If-Match request header required; Success status: 204

Params

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.