| Name | Description | Type | Additional information |
|---|---|---|---|
| Residential |
Indicates if the address is residential. If QueryData.Shipment.Delivery.Residential = null, then the results will include ALL rates/surcharges/schedules. If QueryData.Shipment.Delivery.Residential = true, then the results will include RESIDENTIAL and UNIVERSAL rates/surcharges/schedules. If QueryData.Shipment.Delivery.Residential = false, then the results will include COMMERCIAL and UNIVERSAL rates/surcharges/schedules. |
boolean |
None. |
| SaturdayService |
Requests saturday delivery service (if available) in places where saturday is not a standard delivery day. |
boolean |
None. |
| CountryCode |
The 2-letter ISO code of the country. |
string |
Required |
| PostalCode |
The postal code of the address. Use only alphanumeric characters (A-Z, 0-9). Do NOT use spaces or any other characters. For example: "LIMA18", "1438AN". |
string |
None. |
| RequestedDate |
The requested date. Use the international date format: YYYY-MM-DD. For example: "2016-03-31". If NOT set, then any date will be acceptable. |
date |
None. |
| RequestedDateOperator |
The requested date operator. If NOT set, then the default value is ">=" for pickup and "<=" for delivery. |
string |
None. |
| IgnoreHolidays |
Indicates if the holidays of the country should be added to the transit time or ignored. If NOT set, then the default value is FALSE (do NOT ignore). |
boolean |
None. |
| RequestedTimeStart |
Indicates the start of the requested time window. For example: "08:00". If NOT set, then any time will be acceptable. |
time interval |
None. |
| RequestedTimeEnd |
Indicates the end of the requested time window. For example: "18:00". If NOT set, then any time will be acceptable. |
time interval |
None. |