Type
Description
PackageId
int
PackageTypeId
int
largely ignored, default is 2 ("Package"), if supplied must match a value in the PackageType table
PackageDefIdentifier
Generic.Models.PackageDefIdentifier
optional; if supplied will be used to fill in Length, Width, Height, Weight if those are not supplied
Name
string
Id
int
Length
decimal?
dimensions are in the measurement system of the order's facility
Width
decimal?
Height
decimal?
Weight
decimal?
CodAmount
decimal?
InsuredAmount
decimal?
TrackingNumber
string
Description
string
CreateDate
DateTime
ReadOnly
Order.Models.PackageReadOnly
Oversize
bool?
Cod
bool?
Ucc128
int?
incremental package id used to create the UCC128. Increments every time a package is created. Full UCC128 is stored as CartonId
CartonId
string
full UCC128 value Gs1CompanyPrefix+UCC128(incremental package id)
Label
Byte[]
PackageContents
IList<Order.Models.PackageContent>
PackageContentId
int
PackageId
int
OrderItemId
int
ReceiveItemId
int
OrderItemPickExceptionId
int?
Qty
decimal
LotNumber
string
SerialNumber
string
ExpirationDate
DateTime?
CreateDate
DateTime
SerialNumbers
IEnumerable<string>
Links
IList<WebApi.Hal.Link>
-
edit
-
/rels/orders/order
The containing order.
-
/rels/orders/package
The containing package.
-
/rels/orders/packagecontents
All contents of containing package.
-
/rels/orders/item
-
/rels/inventory/receiveritem
Sample content-type: application/hal+json
Copy to clipboard
copied
{
"packageId": 1 ,
"packageTypeId": 2 ,
"packageDefIdentifier": {
"name": "str" ,
"id": 2
},
"length": 1.0 ,
"width": 1.0 ,
"height": 1.0 ,
"weight": 1.0 ,
"codAmount": 1.0 ,
"insuredAmount": 1.0 ,
"trackingNumber": "str" ,
"description": "str" ,
"createDate": "2016-12-25T23:00:00" ,
"readOnly": {
"oversize": true ,
"cod": true ,
"ucc128": 1 ,
"cartonId": "str" ,
"label": "QA=="
},
"_embedded": {
"http://api.3plCentral.com/rels/orders/packagecontent": [
{
"packageContentId": 1 ,
"packageId": 2 ,
"orderItemId": 3 ,
"receiveItemId": 4 ,
"orderItemPickExceptionId": 1 ,
"qty": 5.0 ,
"lotNumber": "str" ,
"serialNumber": "str" ,
"expirationDate": "2016-12-25T23:00:00" ,
"createDate": "2016-12-25T23:00:00" ,
"serialNumbers": [
"str"
]
}
]
}
}
Type
Description
PackageId
int
PackageTypeId
int
largely ignored, default is 2 ("Package"), if supplied must match a value in the PackageType table
PackageDefIdentifier
Generic.Models.PackageDefIdentifier
optional; if supplied will be used to fill in Length, Width, Height, Weight if those are not supplied
Name
string
Id
int
Length
decimal?
dimensions are in the measurement system of the order's facility
Width
decimal?
Height
decimal?
Weight
decimal?
CodAmount
decimal?
InsuredAmount
decimal?
TrackingNumber
string
Description
string
CreateDate
DateTime
ReadOnly
Order.Models.PackageReadOnly
Oversize
bool?
Cod
bool?
Ucc128
int?
incremental package id used to create the UCC128. Increments every time a package is created. Full UCC128 is stored as CartonId
CartonId
string
full UCC128 value Gs1CompanyPrefix+UCC128(incremental package id)
Label
Byte[]
PackageContents
IList<Order.Models.PackageContent>
PackageContentId
int
PackageId
int
OrderItemId
int
ReceiveItemId
int
OrderItemPickExceptionId
int?
Qty
decimal
LotNumber
string
SerialNumber
string
ExpirationDate
DateTime?
CreateDate
DateTime
SerialNumbers
IEnumerable<string>
Links
IList<WebApi.Hal.Link>
-
edit
-
/rels/orders/order
The containing order.
-
/rels/orders/package
The containing package.
-
/rels/orders/packagecontents
All contents of containing package.
-
/rels/orders/item
-
/rels/inventory/receiveritem
Links
IList<WebApi.Hal.Link>
-
edit
-
/rels/orders/order
The containing order.
-
/rels/orders/orderparcellabelrefs
The order parcel label references.
-
/rels/orders/packages
All packages for the order.
-
/rels/orders/packagecontents
The contents of this package.
-
/rels/orders/packageucc128label
The ucc128 label for the package as zpl.
Sample accept: application/hal+json
{
"packageId": 1 ,
"packageTypeId": 2 ,
"packageDefIdentifier": {
"name": "str" ,
"id": 2
},
"length": 1.0 ,
"width": 1.0 ,
"height": 1.0 ,
"weight": 1.0 ,
"codAmount": 1.0 ,
"insuredAmount": 1.0 ,
"trackingNumber": "str" ,
"description": "str" ,
"createDate": "2016-12-25T23:00:00" ,
"readOnly": {
"oversize": true ,
"cod": true ,
"ucc128": 1 ,
"cartonId": "str" ,
"label": "QA=="
},
"_embedded": {
"http://api.3plCentral.com/rels/orders/packagecontent": [
{
"packageContentId": 1 ,
"packageId": 2 ,
"orderItemId": 3 ,
"receiveItemId": 4 ,
"orderItemPickExceptionId": 1 ,
"qty": 5.0 ,
"lotNumber": "str" ,
"serialNumber": "str" ,
"expirationDate": "2016-12-25T23:00:00" ,
"createDate": "2016-12-25T23:00:00" ,
"serialNumbers": [
"str"
]
}
]
}
}