NameDescriptionTypeAdditional information
WS_Key

(Mandatory) Webservice Key provided by 2ship support

string

None.

CarrierId

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

integer

None.

ServiceCode

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

string

None.

Sender

(Mandatory) Sender Contact

WS_Repository.Models.Requests.Rate.Contact

None.

Recipient

(Mandatory) Recipient Contact

WS_Repository.Models.Requests.Rate.Contact

None.

Packages

(Mandatory) Array of Package

Collection of WS_Repository.Models.Requests.Rate.Package

None.

PickupDate

(Optional) the date of the pickup (default is today)

date

None.

Billing

(Optional) used to rate with other account

WS_Repository.Models.Requests.Rate.BillingOptions

None.

ShipmentOptions

(Optional) Used to filter services that include some options

WS_Repository.Models.Requests.Rate.RateOptions

None.

ServiceGroups

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

Collection of integer

None.

LocationId

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

integer

None.

LocationName

string

None.

RateFilter

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

WS_Repository.Models.Requests.Rate.RateFilterType

None.

FilterByNearestDropOffLocation

(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

boolean

None.

ShowAutomatedParcelMachine

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

boolean

None.

RecipientIsAutomatedParcelMachineLocation

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

boolean

None.

MaxDistanceToDropOffLocation

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

decimal number

None.

MaxDistanceToDropOffLocationUM

(Optional) the default value is Kilometers

WS_Repository.Models.Requests.Rate.DistanceType

None.

FilterByDeliveryDate

(Optional) Filter by max delivery date

boolean

None.

MaxDeliveryDate

(Optional) Max delivery date to filter by

date

None.

CustomerMarkups

(Optional) Provide your own values for Customer Pricing calculation

Collection of WS_Repository.Models.Requests.Rate.CustomerMarkup

None.

ConsolidationUnitId

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

integer

None.

RateCurrencySelect

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

string

None.

GetUngroupedServices

(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

boolean

None.

RateTimeout

(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)

integer

None.

PickupRequest

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

boolean

None.

RateKey

(Internal) DO NOT USE

string

None.

Contents

(Optional) Contents of the shipment packages

WS_Repository.Models.Requests.Rate.Contents

None.

CalculatePackagesByContents

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

boolean

None.

CalculatePackagesByContentsOptions

(Optional) Packages generation parameters

WS_Repository.Models.Requests.Rate.CalculatePackagesByContentsOptions

None.