| 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. |
| IsStackable |
(Optional) - Used by LTL Carriers |
boolean |
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.Rate.WeightType |
None. |
| DimensionType |
(Optional) the default value of DimensionType is "Inches" |
WS_Repository.Models.Requests.Rate.DimensionType |
None. |
| DimensionCode |
(Optional) The internal 2ship Dimension Code - auto-populate dimensions info |
string |
None. |
| Packaging |
(Optional) The type of the Package (default is Customer) |
WS_Repository.Models.Requests.Rate.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. |
| RateType |
(Optional) Default Value is NotSet. Used to differentiate between small package items and skid items in your rate request.You can now categorize each package you add in your request. 2Ship will rate all SmallPackage packages with Small Package carriers and services, while rating all Skid packages with your LTL/FTL and other pallet carriers and services. You now have 2 very different ways to list packages in your shipment for more accurate rates across your different modes of transportation.One API request to find LTL rates and compare them to a small package ground service for instance. If NotSet is used, we will rate with ALL carriers and services regardless of the type of carrier and packaging they transport and we use the same data to rate with all carriers. If you assign a package RateType to one package you will need to assign a package RateType to ALL packages. We cannot have one package with a specific RateType and another with a NotSet value or no RateType. RateType is only used when the CarrierId is not set or is 0; once you select a specific carrier then we ignore RateType and rate all packages with the specific carrier. |
WS_Repository.Models.Requests.Rate.PackageRateType |
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. |