Type
Description
ReadOnly
Customer.Models.ItemReadOnly
CustomerIdentifier
Generic.Models.CustomerIdentifier
ExternalId
string
Name
string
Id
int
ItemId
int
CreationDate
DateTime?
LastModifiedDate
DateTime?
Deactivated
bool
LastPriceChange
DateTime?
HasStorageRates
bool
ItemId
int
Sku
string
Upc
string
Description
string
Description2
string
InventoryCategory
string
ClassificationIdentifier
Generic.Models.ItemClassificationIdentifier
Name
string
Id
int
Nmfc
string
Cost
decimal?
Price
decimal?
Temperature
decimal?
MaxAllocateFromPickline
decimal?
PicklineMin
decimal?
PicklineMax
decimal?
AccountRef
string
CountryOfManufacture
string
HarmonizedCode
string
Qualifiers
IList<Customer.Models.ItemQualifier>
Qualifier
string
Links
IList<WebApi.Hal.Link>
-
/rels/inventory/stocksummaries
QualifierRenamers
IEnumerable<Customer.Models.QualifierRenamer>
Qualifier
string
Renames
string
Kit
Customer.Models.Kit
to determine whether an item is a kit/assembly, use 'rql=kit.materialnotes=hv=true'
MaterialNotes
string
Components
IEnumerable<Customer.Models.Component>
ItemIdentifier
Generic.Models.ItemIdentifier
Sku
string
Id
int
Qualifier
string
Qty
decimal?
NonSkuMaterial
string
Options
Customer.Models.ItemOptions
InventoryUnit
Customer.Models.InventoryUnit
UnitIdentifier
Generic.Models.UnitOfMeasureIdentifier
Name
string
Id
int
MinimumStock
decimal?
MaximumStock
decimal?
ReorderQuantity
decimal?
InventoryMethod
Common.Enum.InventoryMethodEnum
- 1: FIFO
- 2: LIFO
- 3: FEFO
SecondaryUnit
Customer.Models.SecondaryUnit
InventoryAlso
bool
Upc
string
UnitIdentifier
Generic.Models.UnitOfMeasureIdentifier
Name
string
Id
int
InventoryUnitsPerUnit
decimal
PackageUnit
Customer.Models.PackageUnit
Imperial
Customer.Models.DimensionNet
NetWeight
decimal?
Length
decimal?
Width
decimal?
Height
decimal?
Weight
decimal?
Metric
Customer.Models.DimensionNet
NetWeight
decimal?
Length
decimal?
Width
decimal?
Height
decimal?
Weight
decimal?
Upc
string
UnitIdentifier
Generic.Models.UnitOfMeasureIdentifier
Name
string
Id
int
InventoryUnitsPerUnit
decimal
TrackBys
Customer.Models.TrackBys
TrackLotNumber
Common.Enum.UsageLevel
- 0: Disallow
- 1: Allow
- 2: Require
TrackSerialNumber
Common.Enum.SerialNumberUsageLevel
- 0: Disallow
- 1: Allow
- 2: AllowUnique
- 3: Require
- 4: RequireUnique
TrackExpirationDate
Common.Enum.UsageLevel
- 0: Disallow
- 1: Allow
- 2: Require
TrackCost
Common.Enum.UsageLevel
- 0: Disallow
- 1: Allow
- 2: Require
OutboundMobileSerialization
Common.Enum.OutboundMobileSerializationBehavior
- 0: Disabled
- 1: IgnoreQuantityMismatches
- 2: DisallowQuantityMismatches
AutoHoldExpirationDaysThreshold
int?
IsPickLotNumberRequired
bool
IsPickSerialNumberRequired
bool
IsPickExpirationDateRequired
bool
Pallets
Customer.Models.Pallets
TypeIdentifier
Generic.Models.PalletTypeIdentifier
Name
string
Id
int
Tie
decimal?
High
decimal?
Qty
decimal?
the number of primary units of this item on a typical pallet
Imperial
Generic.Models.Dimension
Length
decimal?
Width
decimal?
Height
decimal?
Weight
decimal?
Metric
Generic.Models.Dimension
Length
decimal?
Width
decimal?
Height
decimal?
Weight
decimal?
Upc
string
HazMat
Customer.Models.HazMat
IsHazMat
bool
Id
string
ShippingName
string
HazardClass
string
PackingGroup
string
FlashPoint
string
LabelCode
string
Flag
string
DirectedPutAway
Customer.Models.DirectedPutAway
LocationZones
string
PalletLocationZones
string
OverAllocLocationZones
string
PreferredLocationIdentifier
Generic.Models.LocationIdentifier
NameKey
Generic.Models.LocationNameKey
FacilityIdentifier
Generic.Models.FacilityIdentifier
Name
string
Id
int
Name
string
Id
int
ForceIntoPreferredLocation
bool
AllowMixedItemStorage
bool
AllowMixedLotStorage
bool
MixedExpirationDaysThreshold
int?
DaysBetweenCounts
int?
AutoHoldOnReceive
bool
Replenishment
bool
Sample content-type: application/hal+json Copy to clipboard copied
{
"readOnly": {
"customerIdentifier": {
"externalId": "str" ,
"name": "str" ,
"id": 3
},
"itemId": 1 ,
"creationDate": "2016-12-25T23:00:00" ,
"lastModifiedDate": "2016-12-25T23:00:00" ,
"deactivated": true ,
"lastPriceChange": "2016-12-25T23:00:00" ,
"hasStorageRates": true ,
"rowVersion": "str"
},
"itemId": 1 ,
"sku": "str" ,
"upc": "str" ,
"description": "str" ,
"description2": "str" ,
"inventoryCategory": "str" ,
"classificationIdentifier": {
"name": "str" ,
"id": 2
},
"nmfc": "str" ,
"cost": 1.0 ,
"price": 1.0 ,
"temperature": 1.0 ,
"maxAllocateFromPickline": 1.0 ,
"picklineMin": 1.0 ,
"picklineMax": 1.0 ,
"accountRef": "str" ,
"countryOfManufacture": "str" ,
"harmonizedCode": "str" ,
"qualifierRenamers": [
{
"qualifier": "str" ,
"renames": "str"
}
],
"kit": {
"materialNotes": "str" ,
"components": [
{
"itemIdentifier": {
"sku": "str" ,
"id": 2
},
"qualifier": "str" ,
"qty": 1.0 ,
"nonSkuMaterial": "str"
}
]
},
"options": {
"inventoryUnit": {
"unitIdentifier": {
"name": "str" ,
"id": 2
},
"minimumStock": 1.0 ,
"maximumStock": 1.0 ,
"reorderQuantity": 1.0 ,
"inventoryMethod": 1
},
"secondaryUnit": {
"inventoryAlso": true ,
"upc": "str" ,
"unitIdentifier": {
"name": "str" ,
"id": 2
},
"inventoryUnitsPerUnit": 3.0
},
"packageUnit": {
"imperial": {
"netWeight": 1.0 ,
"length": 1.0 ,
"width": 1.0 ,
"height": 1.0 ,
"weight": 1.0
},
"metric": {
"netWeight": 1.0 ,
"length": 1.0 ,
"width": 1.0 ,
"height": 1.0 ,
"weight": 1.0
},
"upc": "str" ,
"unitIdentifier": {
"name": "str" ,
"id": 2
},
"inventoryUnitsPerUnit": 2.0
},
"trackBys": {
"trackLotNumber": 0 ,
"trackSerialNumber": 0 ,
"trackExpirationDate": 0 ,
"trackCost": 0 ,
"outboundMobileSerialization": 0 ,
"autoHoldExpirationDaysThreshold": 1 ,
"isPickLotNumberRequired": true ,
"isPickSerialNumberRequired": true ,
"isPickExpirationDateRequired": true
},
"pallets": {
"typeIdentifier": {
"name": "str" ,
"id": 2
},
"tie": 1.0 ,
"high": 1.0 ,
"qty": 1.0 ,
"imperial": {
"length": 1.0 ,
"width": 1.0 ,
"height": 1.0 ,
"weight": 1.0
},
"metric": {
"length": 1.0 ,
"width": 1.0 ,
"height": 1.0 ,
"weight": 1.0
},
"upc": "str"
},
"hazMat": {
"isHazMat": true ,
"id": "str" ,
"shippingName": "str" ,
"hazardClass": "str" ,
"packingGroup": "str" ,
"flashPoint": "str" ,
"labelCode": "str" ,
"flag": "str"
},
"directedPutAway": {
"locationZones": "str" ,
"palletLocationZones": "str" ,
"overAllocLocationZones": "str" ,
"preferredLocationIdentifier": {
"nameKey": {
"facilityIdentifier": {
"name": "str" ,
"id": 2
},
"name": "str"
},
"id": 1
},
"forceIntoPreferredLocation": true ,
"allowMixedItemStorage": true ,
"allowMixedLotStorage": true ,
"mixedExpirationDaysThreshold": 1
},
"daysBetweenCounts": 1 ,
"autoHoldOnReceive": true
},
"replenishment": true ,
"_embedded": {
"item": [
{
"qualifier": "str"
}
]
}
}
Type
Description
ReadOnly
Customer.Models.ItemReadOnly
CustomerIdentifier
Generic.Models.CustomerIdentifier
ExternalId
string
Name
string
Id
int
ItemId
int
CreationDate
DateTime?
LastModifiedDate
DateTime?
Deactivated
bool
LastPriceChange
DateTime?
HasStorageRates
bool
ItemId
int
Sku
string
Upc
string
Description
string
Description2
string
InventoryCategory
string
ClassificationIdentifier
Generic.Models.ItemClassificationIdentifier
Name
string
Id
int
Nmfc
string
Cost
decimal?
Price
decimal?
Temperature
decimal?
MaxAllocateFromPickline
decimal?
PicklineMin
decimal?
PicklineMax
decimal?
AccountRef
string
CountryOfManufacture
string
HarmonizedCode
string
Qualifiers
IList<Customer.Models.ItemQualifier>
Qualifier
string
Links
IList<WebApi.Hal.Link>
-
/rels/inventory/stocksummaries
QualifierRenamers
IEnumerable<Customer.Models.QualifierRenamer>
Qualifier
string
Renames
string
Kit
Customer.Models.Kit
to determine whether an item is a kit/assembly, use 'rql=kit.materialnotes=hv=true'
MaterialNotes
string
Components
IEnumerable<Customer.Models.Component>
ItemIdentifier
Generic.Models.ItemIdentifier
Sku
string
Id
int
Qualifier
string
Qty
decimal?
NonSkuMaterial
string
Options
Customer.Models.ItemOptions
InventoryUnit
Customer.Models.InventoryUnit
UnitIdentifier
Generic.Models.UnitOfMeasureIdentifier
Name
string
Id
int
MinimumStock
decimal?
MaximumStock
decimal?
ReorderQuantity
decimal?
InventoryMethod
Common.Enum.InventoryMethodEnum
- 1: FIFO
- 2: LIFO
- 3: FEFO
SecondaryUnit
Customer.Models.SecondaryUnit
InventoryAlso
bool
Upc
string
UnitIdentifier
Generic.Models.UnitOfMeasureIdentifier
Name
string
Id
int
InventoryUnitsPerUnit
decimal
PackageUnit
Customer.Models.PackageUnit
Imperial
Customer.Models.DimensionNet
NetWeight
decimal?
Length
decimal?
Width
decimal?
Height
decimal?
Weight
decimal?
Metric
Customer.Models.DimensionNet
NetWeight
decimal?
Length
decimal?
Width
decimal?
Height
decimal?
Weight
decimal?
Upc
string
UnitIdentifier
Generic.Models.UnitOfMeasureIdentifier
Name
string
Id
int
InventoryUnitsPerUnit
decimal
TrackBys
Customer.Models.TrackBys
TrackLotNumber
Common.Enum.UsageLevel
- 0: Disallow
- 1: Allow
- 2: Require
TrackSerialNumber
Common.Enum.SerialNumberUsageLevel
- 0: Disallow
- 1: Allow
- 2: AllowUnique
- 3: Require
- 4: RequireUnique
TrackExpirationDate
Common.Enum.UsageLevel
- 0: Disallow
- 1: Allow
- 2: Require
TrackCost
Common.Enum.UsageLevel
- 0: Disallow
- 1: Allow
- 2: Require
OutboundMobileSerialization
Common.Enum.OutboundMobileSerializationBehavior
- 0: Disabled
- 1: IgnoreQuantityMismatches
- 2: DisallowQuantityMismatches
AutoHoldExpirationDaysThreshold
int?
IsPickLotNumberRequired
bool
IsPickSerialNumberRequired
bool
IsPickExpirationDateRequired
bool
Pallets
Customer.Models.Pallets
TypeIdentifier
Generic.Models.PalletTypeIdentifier
Name
string
Id
int
Tie
decimal?
High
decimal?
Qty
decimal?
the number of primary units of this item on a typical pallet
Imperial
Generic.Models.Dimension
Length
decimal?
Width
decimal?
Height
decimal?
Weight
decimal?
Metric
Generic.Models.Dimension
Length
decimal?
Width
decimal?
Height
decimal?
Weight
decimal?
Upc
string
HazMat
Customer.Models.HazMat
IsHazMat
bool
Id
string
ShippingName
string
HazardClass
string
PackingGroup
string
FlashPoint
string
LabelCode
string
Flag
string
DirectedPutAway
Customer.Models.DirectedPutAway
LocationZones
string
PalletLocationZones
string
OverAllocLocationZones
string
PreferredLocationIdentifier
Generic.Models.LocationIdentifier
NameKey
Generic.Models.LocationNameKey
FacilityIdentifier
Generic.Models.FacilityIdentifier
Name
string
Id
int
Name
string
Id
int
ForceIntoPreferredLocation
bool
AllowMixedItemStorage
bool
AllowMixedLotStorage
bool
MixedExpirationDaysThreshold
int?
DaysBetweenCounts
int?
AutoHoldOnReceive
bool
Replenishment
bool
Links
IList<WebApi.Hal.Link>
-
edit
-
/rels/customers/itemactivate
-
/rels/customers/customer
-
/rels/customers/itemrates
-
/rels/customers/itemimage
Sample accept: application/hal+json
{
"readOnly": {
"customerIdentifier": {
"externalId": "str" ,
"name": "str" ,
"id": 3
},
"itemId": 1 ,
"creationDate": "2016-12-25T23:00:00" ,
"lastModifiedDate": "2016-12-25T23:00:00" ,
"deactivated": true ,
"lastPriceChange": "2016-12-25T23:00:00" ,
"hasStorageRates": true ,
"rowVersion": "str"
},
"itemId": 1 ,
"sku": "str" ,
"upc": "str" ,
"description": "str" ,
"description2": "str" ,
"inventoryCategory": "str" ,
"classificationIdentifier": {
"name": "str" ,
"id": 2
},
"nmfc": "str" ,
"cost": 1.0 ,
"price": 1.0 ,
"temperature": 1.0 ,
"maxAllocateFromPickline": 1.0 ,
"picklineMin": 1.0 ,
"picklineMax": 1.0 ,
"accountRef": "str" ,
"countryOfManufacture": "str" ,
"harmonizedCode": "str" ,
"qualifierRenamers": [
{
"qualifier": "str" ,
"renames": "str"
}
],
"kit": {
"materialNotes": "str" ,
"components": [
{
"itemIdentifier": {
"sku": "str" ,
"id": 2
},
"qualifier": "str" ,
"qty": 1.0 ,
"nonSkuMaterial": "str"
}
]
},
"options": {
"inventoryUnit": {
"unitIdentifier": {
"name": "str" ,
"id": 2
},
"minimumStock": 1.0 ,
"maximumStock": 1.0 ,
"reorderQuantity": 1.0 ,
"inventoryMethod": 1
},
"secondaryUnit": {
"inventoryAlso": true ,
"upc": "str" ,
"unitIdentifier": {
"name": "str" ,
"id": 2
},
"inventoryUnitsPerUnit": 3.0
},
"packageUnit": {
"imperial": {
"netWeight": 1.0 ,
"length": 1.0 ,
"width": 1.0 ,
"height": 1.0 ,
"weight": 1.0
},
"metric": {
"netWeight": 1.0 ,
"length": 1.0 ,
"width": 1.0 ,
"height": 1.0 ,
"weight": 1.0
},
"upc": "str" ,
"unitIdentifier": {
"name": "str" ,
"id": 2
},
"inventoryUnitsPerUnit": 2.0
},
"trackBys": {
"trackLotNumber": 0 ,
"trackSerialNumber": 0 ,
"trackExpirationDate": 0 ,
"trackCost": 0 ,
"outboundMobileSerialization": 0 ,
"autoHoldExpirationDaysThreshold": 1 ,
"isPickLotNumberRequired": true ,
"isPickSerialNumberRequired": true ,
"isPickExpirationDateRequired": true
},
"pallets": {
"typeIdentifier": {
"name": "str" ,
"id": 2
},
"tie": 1.0 ,
"high": 1.0 ,
"qty": 1.0 ,
"imperial": {
"length": 1.0 ,
"width": 1.0 ,
"height": 1.0 ,
"weight": 1.0
},
"metric": {
"length": 1.0 ,
"width": 1.0 ,
"height": 1.0 ,
"weight": 1.0
},
"upc": "str"
},
"hazMat": {
"isHazMat": true ,
"id": "str" ,
"shippingName": "str" ,
"hazardClass": "str" ,
"packingGroup": "str" ,
"flashPoint": "str" ,
"labelCode": "str" ,
"flag": "str"
},
"directedPutAway": {
"locationZones": "str" ,
"palletLocationZones": "str" ,
"overAllocLocationZones": "str" ,
"preferredLocationIdentifier": {
"nameKey": {
"facilityIdentifier": {
"name": "str" ,
"id": 2
},
"name": "str"
},
"id": 1
},
"forceIntoPreferredLocation": true ,
"allowMixedItemStorage": true ,
"allowMixedLotStorage": true ,
"mixedExpirationDaysThreshold": 1
},
"daysBetweenCounts": 1 ,
"autoHoldOnReceive": true
},
"replenishment": true ,
"_embedded": {
"item": [
{
"qualifier": "str"
}
]
}
}
REL documentation