Rate Quote Web Service

URL Format Representational State Transfer (REST) Web Service

Version

V2X1 (Major Version 2, Minor Version 1)

Description

Rate Quote service provides a quote for shipping based on supplied parameters.

Useful links

Test Page

URL format (REST/URLweb service)

https://my.yrcregional.com/XMLServices/REST/v2/x1/doRateQuote?
accessKey=&accountId=&originZipCode=&destZipCode=&direction=&chargeType
=&pickupDate=&shipmentClass1=50&shipmentWeight1=100&output=

Request structure

Parameter Value Description
accessKey String (required) Access Key identifying the user invoking the service.
accountId String (required) Holland or Reddaway Account ID associated with yrcregional.com login
originZipCode String (required) Origin ZIP code: must match ZIP code of origin when direction is Shipper
destZipCode String (required) Destination ZIP code, must match ZIP code of destination location when direction is Consignee.
direction String (required) Shipper, Consignee or 3rdParty
chargeType String (required) Prepaid or Collect
pickupDate Date (optional) Pickup date (MM-DD-YYYY); if not set, will default to today
shipmentClass[1..5] String Shipment class; maximum of 5 can be passed
shipmentWeight[1..5] Decimal Shipment weight, corresponding to shipment class
addedService [1..10] String (optional)

A total of 10 addedServices can be entered, which includes storageDays, sortSegregationPieces and CODAmount.

Holland values:
HazardousMaterials, LiftgateDelivery, ProtectFromFreezing, InBondShipment,
ResidentialNonCommericalDelivery, InsideDeliveryGroundFloor, InsideDeliveryNotGroundFloor,
AppointmentDelivery

Reddaway values:
HazardousMaterials, ExtremeLength, LiftgateService, InsideDelivery, ConstructionSiteDelivery, InBondShipment, LiftgateDelivery, ResidentialNonCommericalDelivery, AppointmentDelivery, ProtectFromFreezing

storageDays String (optional) Number of days for storage. Maximum number of 999. Holland-only field.
sortSegregationPieces String (optional) Number of pieces related to sort and segregate. Maximum number of 9999. Holland-only field.
CODAmount String (optional) Amount that will be collected from consignee at delivery. Maximum number of 999999.
output String (optional) Format of the output response. Valid values are:
xml: XML (default)
xsd: XML with XSD (schemas)
html: HTML
raw: Native format of the document, available only for Get Image service.


Response structure

Parameter Value Description
STATUS:CODE Integer Status code of the response. Valid values are:
0: Success
1: Error
STATUS:ERROR_TYPE String Error type returned if applicable. Valid values are:
AUTHENTICATION_ERROR: Invalid yrcregional.com credentials were supplied
INPUT_ERROR: Error in input parameters
PROCESSING_ERROR: Internal processing error. Please retry or contact YRC Regional Support
NOT_FOUND_ERROR: Requested information not found
NOT_ALL_FOUND_ERROR: Some requested information not found
STATUS:VIEW String Response View. Valid values are:
PUBLIC: Unsecured view. Returned when service is invoked with no credentials or when business rules prevent access to secured information.
SECURED: Secured View. Complete information including secured data.
ERROR: Error View.
STATUS:MESSAGE String Error message (if applicable)
STATUS:VERSION:CURRENT String Version of service. Format is V[Major version number]X[Minor version number]
STATUS:VERSION:CURRENT_RELEASE_DATE Date Release date of service. Format is MM/DD/YYYY
STATUS:VERSION:LATEST String Latest available version of this service. Format is V[Major version number]X[Minor version number]
STATUS:VERSION:LATEST_RELEASE_DATE Date Release date of latest available service. Format is MM/DD/YYYY
ORIGIN:NAME String Origin Service Center Name
ORIGIN:CARRIER String Origin Service Center Company
ORIGIN:ADDRESS String Origin Service Center Address
ORIGIN:CITY String Origin Service Center City
ORIGIN:STATE String Origin Service Center State
ORIGIN:ZIP String Origin Service Center ZIP
ORIGIN:PHONE String Origin Service Center Contact Phone
ORIGIN:PHONE_TOLLFREE String Origin Service Center Toll-Free Phone
ORIGIN:FAX String Origin Service Center Fax Number
DESTINATION:NAME String Destination Service Center Name
DESTINATION:CARRIER String Destination Service Center Carrier Company
DESTINATION:ADDRESS String Destination Service Center Address
DESTINATION:CITY String Destination Service Center City
DESTINATION:STATE String Destination Service Center State
DESTINATION:ZIP String Destination Service Center ZIP
DESTINATION:PHONE String Destination Service Center Contact Phone
DESTINATION:PHONE_TOLLFREE String Destination Service Center Toll-Free Phone
DESTINATION:FAX String Destination Service Center Fax Number
ORIGIN_ZIP String Origin ZIP code
DESTINATION_ZIP String Destination ZIP code
TOTAL_COST Decimal Total Cost
MINIMUMCHARGES Decimal Minimum charges
DISCOUNTPERCENTAGE Decimal Applicable discount percentage
DISCOUNTAMOUNT Decimal Applicable discount amount
SERVICEDAYS Number Service days
INDUSTRYDAYS Number Industry transit time average computed from an independent resource
CLASSWEIGHT Multiple Class-weight information; up to 5
CLASSWEIGHT:CLASS Number Class value
CLASSWEIGHT:ASCLASS Number Effective Class value
CLASSWEIGHT:WEIGHT Decimal Weight
CLASSWEIGHT:RATE Decimal Rate
CLASSWEIGHT:CHARGES Decimal Charges
DEFICIT Multiple Weight Deficit information; up to 5
DEFICIT:DEFICITWEIGHT Number Deficit weight
DEFICIT:RATE Decimal Deficit rate
DEFICIT:CLASSWEIGHT:CHARGES Decimal Charges
ASWEIGHT Multiple Effective weight information; up to 5
ASWEIGHT:ASWEIGHT Number Effective weight
ASWEIGHT:RATE Decimal Effective rate
ASWEIGHT:CHARGES Decimal Effective charges
ADDIONALCHARGES Multiple Additional charges information; up to 5
ADDIONALCHARGES:RATE String Additional charge
ADDIONALCHARGES:CHARGES String Amount
ADDIONALCHARGES:DESCRIPTION String Additional charge description
ADDEDSERVICECHARGES Multiple Added service charges information; up to 10
ADDEDSERVICECHARGES:RATE String Added service charge
ADDEDSERVICECHARGES:AMOUNT-QUANTITY String Storage day count, sort and segregation piece count or COD Amount
ADDEDSERVICECHARGES:CHARGES String Amount
SERVICEUPGRADES Multiple Special Service upgrades; up to 10
SERVICEUPGRADES:DELIVERYDATE String Delivery date (MM/DD/YYYY)
SERVICEUPGRADES:DELIVERYDAYS Number Number of days
SERVICEUPGRADES:DELIVERYTIME String Delivery time description
SERVICEUPGRADES:SERVICE_TYPE String Description of service
SERVICEUPGRADES:TOTAL_COST Decimal Total cost of upgrade