| Name | Description | Type | Additional information |
|---|---|---|---|
| Weight |
(Mandatory) the weight of the package |
decimal number |
None. |
| Width |
(Optional) the Width of the Package |
decimal number |
None. |
| Length |
(Optional) the Length of the Package |
decimal number |
None. |
| Height |
(Optional) the Height of the Package |
decimal number |
None. |
| FreightClassId |
(Optional) - Mandatory for US LTL Carriers |
decimal number |
None. |
| NMFCItem |
(Optional) NMFC item number |
string |
None. |
| NMFCSub |
(Optional) NMFC item subclass number |
string |
None. |
| WeightType |
(Optional) the default value of WeightType is "Pounds" |
WS_Repository.Models.Requests.Edit.WeightType |
None. |
| DimensionType |
(Optional) the default value of DimensionType is "Inches" |
WS_Repository.Models.Requests.Edit.DimensionType |
None. |
| DimensionCode |
(Optional) The internal 2ship Dimension Code |
string |
None. |
| Packaging |
(Optional) The type of the Package (default is Customer) |
WS_Repository.Models.Requests.Edit.PackagingType |
None. |
| InsuranceAmount |
(Optional) the Value of your Shipment (this can influence the cost of your shipment) |
decimal number |
None. |
| InsuranceCurrency |
(Optional) the Currency of you Insurance Value(CAD, USD... etc) |
string |
None. |
| Reference1 |
(Optional) a string representing Reference1 |
string |
None. |
| Reference2 |
(Optional) a string representing Reference2 |
string |
None. |
| PONumber |
(Optional) a string representing PO Number |
string |
None. |
| NumberOfPiecesInSkid |
(Optional) default value is 1. Represent the number of pieces in the skid Used when the shipping carrier is heavy weight carrier |
integer |
None. |
| SkidDescription |
(Optional) Description of skid Used when the shipping carrier is heavy weight carrier |
string |
None. |
| ShipmentId |
(Optional) a string representing a Package Reference |
string |
None. |
| InvoiceNo |
(Optional) a string representing a Package Reference |
string |
None. |
| IsStackable |
(Optional) Indicating if the Skid is stackable Used when the shipping carrier is heavy weight carrier |
boolean |
None. |
| LicencePlate |
(Optional) Licence Plate # |
string |
None. |
| PreAssignTrackingNumber |
(Optional) Piece Tracking Number pre-assign - Used by some carriers that accept this feautere |
string |
None. |
| ApplyWeightAndDimsFromTheAssignedCommodity |
(Optional) Flag to specify to update the weight and dims from the commodity assigned to this package - The Package/Skid weight and dims will be overrided only if there is a commodity with QUANTITY = 1 assigned and the commodity has weight and dims |
boolean |
None. |
| SkidIndex |
(Optional) It specify the skid index (0 based index) |
integer |
None. |