Name
(* = required)
Data Type Description
id
*
int
Type
Description
PackageDefId
int
readonly
Name
string
required, must be unique as an alternate lookup field
Barcode
string
must be unique as an alternate lookup field
Description
string
optional, describe package def
IsDefault
bool
required, at most one PackageDef can be true
LengthImperial
decimal?
optional, imperial length
WidthImperial
decimal?
optional, imperial width
HeightImperial
decimal?
optional, imperial height
WeightImperial
decimal?
optional, imperial weight
LengthMetric
decimal?
optional, imperial width
WidthMetric
decimal?
optional, metric length
HeightMetric
decimal?
optional, metric height
WeightMetric
decimal?
optional, metric weight
Cost
decimal?
optional, cost
DefaultMarkupPercent
decimal?
optional, markup percent
DefaultMarkupFlat
decimal?
optional, markup flat
AssignedCustomers
List<int>
optional, customer id's
PackageDefFacilities
IList<Property.Models.PackageDefFacility>
FacilityIdentifier
Generic.Models.FacilityIdentifier
required, defines facility containing this package
Name
string
Id
int
CurrentQuantity
decimal?
optional, defines current quantity
MinQuantity
decimal?
optional, defines min quantity to generate alerts
UserIdentifier
Generic.Models.UserIdentifier
optional, UserLoginID that will receive the alerts.
Name
string
Id
int
AlertRecipient
int?
PackageName
string
AssignedCustomerIdentifiers
IEnumerable<Generic.Models.CustomerIdentifier>
ExternalId
string
Name
string
Id
int
Sample content-type: application/hal+json
Copy to clipboard
copied
{
"packageDefId": 1 ,
"name": "str" ,
"barcode": "str" ,
"description": "str" ,
"isDefault": true ,
"lengthImperial": 1.0 ,
"widthImperial": 1.0 ,
"heightImperial": 1.0 ,
"weightImperial": 1.0 ,
"lengthMetric": 1.0 ,
"widthMetric": 1.0 ,
"heightMetric": 1.0 ,
"weightMetric": 1.0 ,
"cost": 1.0 ,
"defaultMarkupPercent": 1.0 ,
"defaultMarkupFlat": 1.0 ,
"assignedCustomers": [
1
],
"assignedCustomerIdentifiers": [
{
"externalId": "str" ,
"name": "str" ,
"id": 3
}
],
"_embedded": {
"item": [
{
"facilityIdentifier": {
"name": "str" ,
"id": 2
},
"currentQuantity": 1.0 ,
"minQuantity": 1.0 ,
"userIdentifier": {
"name": "str" ,
"id": 2
},
"alertRecipient": 1 ,
"packageName": "str"
}
]
}
}
Type
Description
PackageDefId
int
readonly
Name
string
required, must be unique as an alternate lookup field
Barcode
string
must be unique as an alternate lookup field
Description
string
optional, describe package def
IsDefault
bool
required, at most one PackageDef can be true
LengthImperial
decimal?
optional, imperial length
WidthImperial
decimal?
optional, imperial width
HeightImperial
decimal?
optional, imperial height
WeightImperial
decimal?
optional, imperial weight
LengthMetric
decimal?
optional, imperial width
WidthMetric
decimal?
optional, metric length
HeightMetric
decimal?
optional, metric height
WeightMetric
decimal?
optional, metric weight
Cost
decimal?
optional, cost
DefaultMarkupPercent
decimal?
optional, markup percent
DefaultMarkupFlat
decimal?
optional, markup flat
AssignedCustomers
List<int>
optional, customer id's
PackageDefFacilities
IList<Property.Models.PackageDefFacility>
FacilityIdentifier
Generic.Models.FacilityIdentifier
required, defines facility containing this package
Name
string
Id
int
CurrentQuantity
decimal?
optional, defines current quantity
MinQuantity
decimal?
optional, defines min quantity to generate alerts
UserIdentifier
Generic.Models.UserIdentifier
optional, UserLoginID that will receive the alerts.
Name
string
Id
int
AlertRecipient
int?
PackageName
string
AssignedCustomerIdentifiers
IEnumerable<Generic.Models.CustomerIdentifier>
ExternalId
string
Name
string
Id
int
Links
IList<WebApi.Hal.Link>
-
edit
Sample accept: application/hal+json
{
"packageDefId": 1 ,
"name": "str" ,
"barcode": "str" ,
"description": "str" ,
"isDefault": true ,
"lengthImperial": 1.0 ,
"widthImperial": 1.0 ,
"heightImperial": 1.0 ,
"weightImperial": 1.0 ,
"lengthMetric": 1.0 ,
"widthMetric": 1.0 ,
"heightMetric": 1.0 ,
"weightMetric": 1.0 ,
"cost": 1.0 ,
"defaultMarkupPercent": 1.0 ,
"defaultMarkupFlat": 1.0 ,
"assignedCustomers": [
1
],
"assignedCustomerIdentifiers": [
{
"externalId": "str" ,
"name": "str" ,
"id": 3
}
],
"_embedded": {
"item": [
{
"facilityIdentifier": {
"name": "str" ,
"id": 2
},
"currentQuantity": 1.0 ,
"minQuantity": 1.0 ,
"userIdentifier": {
"name": "str" ,
"id": 2
},
"alertRecipient": 1 ,
"packageName": "str"
}
]
}
}