WS_Repository.Models.Requests.Rate.RateRequest

(Mandatory) Webservice Key provided by 2ship support

(Optional) if pressent will get all services for that carrier

(Optional) can be present just if there is a Carrier Id and then will get just that service rate.

(Mandatory) Sender Contact

(Mandatory) Recipient Contact

(Optional) Cross Dock Address - used for 2 leg shipments to determinate the middle address of the shipment. this address become 1'st leg recipient and 2'nd leg sender

(Mandatory) Array of Package

(Optional) the Value of your Shipment (this can influence the cost of your shipment)

(Optional) the Currency of you Insurance Value(CAD, USD... etc)

(Optional) The Ship Date (default is today)

(Optional) used to rate with other account

(Optional) Used to filter services that include some options

(Optional) Array of Service Groups Codes - used to filter services which are in these Groups

(Optional) If not set will use the sender address to match the right Location to use.

(Optional) If not set will use the LocationId or the sender address to match the right Location to use.

(Optional) used to filter rates by cheapest, fastest... (Default Value = GetAllServices)

(Optional) used to filter carriers that have a Drop Off Location (Office, Postal Office) in the Maximum distance of Km/Miles specified in MaxDistanceToDropOffLocation field

(Optional) used to show Show Automated Parcel Machine when FilterByNearestDropOffLocation = true

(Optional) Specify that the Recipient is an Automated Parcel Machine Location

(Mandatory if FilterByNearestDropOffLocation is true) the maximum distance of a Drop Off Location (valid values: 0.1 ... 100 km/miles)

(Optional) the default value is Kilometers

(Optional) Filter by max delivery date

(Optional) Max delivery date to filter by

(Optional) Drop Off Location has QR code label printing available

(Optional) Provide your own values for Customer Pricing calculation

(Optional) Used to rate through a consolidation unit, get by calling GetAllOpenedConsolidationUnits

(Optional) Used to return rates in your selected currency using the 2Ship exchange rate from openexchangerates.org

(Optional) Used to return also carrier services that are not present in any service group, this is applying when you don't specify any Service Groups in the Request and when the RateFilter is one of the following: GetJustCheapestServiceForEachServiceGroup, GetJustCheapestServiceForEachServiceGroupAndAverageListPrice, GetJustFastestServiceForEachServiceGroup, GetAllServicesForEachServiceGroup

(Optional) Maximum # of miliseconds before a rate response will be returned. Response from 2Ship will include services and rates acquired within this time frame Default Value is 60,000 (1 Minute)

(Optional) Used to return rates with the pickup request charge

(Internal) DO NOT USE

(Optional) Contents of the shipment packages

(Optional) Internation Options of the order(if the order is international)

(Optional) if this flag is set true then Packages field will be overridden with generated packages based on a 2ship packing algorithm

(Optional) Packages generation parameters

(Optional) It specify to load the default global options from 2Ship

(Optional) Specify ship from a locker / carrier location / carrier retail location

(Required if ShipFromLockerOrLocation = true)

(Optional) Specify ship to a locker / carrier location / carrier retail location

(Required if ShipFromLockerOrLocation = true)

(Optional) It specify to get estimated duties and taxes cost for international shipments

If is set it returns the RatedPackages object list and its content assignament

(Optional) Use this filter to find the Carrier services that allow you to ship without the need for a printed label

(Optional) Order Info

(Optional) This field will store source of order for history, search, reports, etc. (Maximum length = 100 characters. Default value = "API".)

(Optional) the shipment will be treated as an inbound

(Optional) Used to make rules with it

(Optional) Used to make rules with it

(Optional) Used to make rules with it

(Optional) Used to make rules with it

(Optional) Used to make rules with it

(Optional) Specify to check the inventory and split the order if the contents are located to multiple warehouses. Only works for if your client has the inventory feature enabled.

(Optional) filter out carriers that do not deliver to po box - only apply if your customer has this setting tuned on in client settings