Overview

The purpose of this method is to obtain rates for an individual shipment.

Rating options include:

  1. Request a rate for a particular service. This option would be used when the service level is known and the rate needs to be advised to the customer or includes for check out price.
  2. Request rates for all services enabled for a particular carrier. This option would be used when the service level is unknown and the cost and transit time is a factor in selecting the delivery service.

As rating is to determine the estimated rate, not all shipment details are required to rate. Minimally the following data is needed: ship to city, state, zip, country and shipment weight. Any additional data will aide in making the rate as accurate as possible.

Rating availability is dependent upon the carrier’s availability. If the carrier does not offer rating out of the box, then customized rate handling can be offered. This would require the delivery of the negotiated rates and custom configuration.

The function and output of AbolSimpleRate is identical to that of the AbolRate method. The main difference is that this method offers simplified objects that will cover the needs for basic rating for domestic and international shipments.

This section is to outline the request and response layout and the functions available within this method. Review the reference table below to see the different request types and entities that can be queried within this method.

List Of Parameters

Download PDF

Request Layout

AbolSimpleRate
  └── AbolSimpleRate
      └── Request
          ├── Authentication
          │   ├── ActivationKey
          │   ├── LoginName
          │   ├── Password
          │   └── AltID
          └── SimpleRate
              ├── CarrierId
              ├── BillType
              ├── BillAccountNumber
              ├── BillAccountZipCode
              ├── DriverInstructions
              ├── ResidentialFlag
              ├── SaturdayDeliveryFlag
              ├── SaturdayPickupFlag
              ├── LabelType
              ├── LabelSize
              ├── HolidayDeliveryFlag
              ├── SundayDeliveryFlag
              ├── DimensionUnit
              ├── WeightUnit
              ├── ShipDate
              ├── ServiceCode
              ├── DeclaredValue
              ├── CurrencyCode
              ├── DimWeight
              ├── TrackingNumber
              ├── Length
              ├── Height
              ├── Width
              ├── PackagingType
              ├── ReferenceNumber
              ├── Weight
              ├── AddlPackageReference1
              ├── AddlPackageReference2
              ├── AddlPackageReference3
              ├── AddlPackageReference4
              ├── AddlPackageReference5
              ├── AddlPackageReference6
              ├── AddlPackageReference7
              ├── AddlPackageReference8
              ├── ContentDescription
              ├── NotificationType
              ├── NotificationValue
              ├── ImageRotation
              ├── EveningDeliveryFlag
              ├── ReturnType
              ├── ReturnServiceCode
              ├── DeliveryConfirmationFlag
              ├── SignatureConfirmationFlag
              ├── SignatureConfirmationType
              ├── InsuranceAmount
              ├── InsurancePayType
              ├── InsuranceType
              ├── EndorsementType
              ├── OverrideShipToAddressValidationFlag
              ├── ShipFrom
              │   ├── Company
              │   ├── Attn
              │   ├── AddressLine1
              │   ├── AddressLine2
              │   ├── AddressLine3
              │   ├── City
              │   ├── StateCode
              │   ├── Zip
              │   ├── Zip4
              │   ├── CountryCode
              │   ├── CountryName
              │   ├── PhoneAreaCode
              │   ├── Phone
              │   ├── PhoneExt
              │   ├── Fax
              │   ├── EMail
              │   ├── Department
              │   ├── Reference
              │   ├── ResidentialFlag
              │   └── IsPOBox
              ├── ShipTo
              │   ├── Company
              │   ├── Attn
              │   ├── AddressLine1
              │   ├── AddressLine2
              │   ├── AddressLine3
              │   ├── City
              │   ├── StateCode
              │   ├── Zip
              │   ├── Zip4
              │   ├── CountryCode
              │   ├── CountryName
              │   ├── PhoneAreaCode
              │   ├── Phone
              │   ├── PhoneExt
              │   ├── Fax
              │   ├── EMail
              │   ├── Department
              │   ├── Reference
              │   ├── ResidentialFlag
              │   └── IsPOBox
              ├── Return
              │   ├── Company
              │   ├── Attn
              │   ├── AddressLine1
              │   ├── AddressLine2
              │   ├── AddressLine3
              │   ├── City
              │   ├── StateCode
              │   ├── Zip
              │   ├── Zip4
              │   ├── CountryCode
              │   ├── CountryName
              │   ├── PhoneAreaCode
              │   ├── Phone
              │   ├── PhoneExt
              │   ├── Fax
              │   ├── EMail
              │   ├── Department
              │   ├── Reference
              │   ├── ResidentialFlag
              │   └── IsPOBox
              ├── SimpleInternationalShipment
              │   ├── DeclaredValue
              │   ├── CN22DescriptionType
              │   ├── Incoterms
              │   ├── ExportReasonCode
              │   ├── ShipperEin
              │   ├── SEDFilingOption
              │   ├── AESTransactionNumber
              │   ├── FTRExemtionCode
              │   ├── FormRequested
              │   ├── FormGenerationType
              │   ├── ExportType
              │   ├── ExceptionCode
              │   ├── CustomFormType
              │   ├── DutyAccountNumber
              │   ├── DutyBillType
              │   ├── DutyServiceType
              │   ├── IncludeDutyCalculation
              │   ├── CommercialImporterFlag
              │   ├── TotalMonthlyImportedWeight
              │   └── TotalMonthlyImportedValue
              └── SimpleExportLineItemList
                  └── SimpleExportLineItem
                      ├── Code
                      ├── Description
                      ├── Weight
                      ├── UnitWeight
                      ├── Price
                      ├── Quantity
                      ├── UnitQuantity
                      ├── UnitPrice
                      ├── CountryOfManufacture
                      ├── Harmonizedcode
                      ├── SalesTaxAmount
                      ├── DutyAmount
                      ├── Currency
                      ├── OutputCurrency
                      └── Amount

Response Layout

AbolSimpleRateResponse
  └── AbolSimpleRateResponse
      └── SimpleRateResult
          ├── Version
          ├── Error
          │   ├── code
          │   └── message
          └── SimpleRateResultList
              └── SimpleRateResult
                  ├── ReferenceNbr
                  └── Service
                      ├── Carrier
                      ├── ServiceCode
                      ├── ServiceDesc
                      ├── Rate
                      ├── DeliveryDate
                      ├── DeliveryTime
                      ├── GuaranteedService
                      └── Fees
                          ├── Fee @name="DC" @charge=""
                          ├── Fee @name="SC" @charge=""
                          ├── Fee @name="COD" @charge=""
                          ├── Fee @name="INSURANCE" @charge=""
                          ├── Fee @name="SATURDAYDELIVERY" @charge=""
                          ├── Fee @name="SATURDAYPICKUP" @charge=""
                          ├── Fee @name="FUELSURCHARGE" @charge=""
                          ├── Fee @name="LARGEPACKAGESURCHARGE" @charge=""
                          └── Fee @name="ADDITIONALHANDLINGSURCHARGE" @charge="

Soap Example Request

The request below is for rating all services available for the UPS carrier that will support the specified destination and package criteria.

<?xml version="1.0" encoding="utf-8"?>
<soap:Envelope xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:soap="http://schemas.xmlsoap.org/soap/envelope/">
  <soap:Body>
    <AbolSimpleRate xmlns="http://abolsoft.com/webservices/">
      <AbolSimpleRate>
        <Request>
          <Authentication>
            <ActivationKey>JS03122010-5DF7A827-C833-4999-AD9D-0021CACC8445</ActivationKey>
            <LoginName>shipper</LoginName>
            <Password>shipper</Password>
          </Authentication>
          <SimpleRate>
            <BillType>102</BillType>
            <ResidentialFlag>false</ResidentialFlag>
            <SaturdayDeliveryFlag>false</SaturdayDeliveryFlag>
            <SaturdayPickupFlag>false</SaturdayPickupFlag>
            <LabelType>6</LabelType>
            <LabelSize>0</LabelSize>
            <HolidayDeliveryFlag>false</HolidayDeliveryFlag>
            <SundayDeliveryFlag>false</SundayDeliveryFlag>
            <ShipDate>2013-07-29T00:00:00-04:00</ShipDate>
            <DeclaredValue>100.5</DeclaredValue>
            <CurrencyCode>USD</CurrencyCode>
            <DimWeight>0</DimWeight>
            <Length>10</Length>
            <Height>10</Height>
            <Width>10</Width>
            <PackagingType>105</PackagingType>
            <ReferenceNumber>SimpleRate</ReferenceNumber>
            <Weight>5.5555</Weight>
            <AddlPackageReference1>AddlPackageReference1</AddlPackageReference1>
            <AddlPackageReference2>AddlPackageReference2</AddlPackageReference2>
            <AddlPackageReference3>AddlPackageReference3</AddlPackageReference3>
            <AddlPackageReference4>AddlPackageReference4</AddlPackageReference4>
            <AddlPackageReference5>AddlPackageReference5</AddlPackageReference5>
            <AddlPackageReference6>AddlPackageReference6</AddlPackageReference6>
            <AddlPackageReference7>AddlPackageReference7</AddlPackageReference7>
            <AddlPackageReference8>AddlPackageReference8</AddlPackageReference8>
            <ContentDescription>ContentDescription</ContentDescription>
            <NotificationType>0</NotificationType>
            <ImageRotation>0</ImageRotation>
            <EveningDeliveryFlag>false</EveningDeliveryFlag>
            <ReturnType>0</ReturnType>
            <DeliveryConfirmationFlag>false</DeliveryConfirmationFlag>
            <SignatureConfirmationFlag>false</SignatureConfirmationFlag>
            <SignatureConfirmationType>0</SignatureConfirmationType>
            <InsuranceAmount>10.555555555</InsuranceAmount>
            <InsurancePayType>0</InsurancePayType>
            <InsuranceType>0</InsuranceType>
            <EndorsementType>0</EndorsementType>
            <OverrideShipToAddressValidationFlag>false</OverrideShipToAddressValidationFlag>
            <ShipTo>
              <City>North Haledon</City>
              <StateCode>NJ</StateCode>
              <Zip>07508</Zip>
              <CountryCode>US</CountryCode>
              <ResidentialFlag>false</ResidentialFlag>
              <IsPOBox>false</IsPOBox>
            </ShipTo>
            <CarrierId>UPS</CarrierId>
          </SimpleRate>
        </Request>
      </AbolSimpleRate>
    </AbolSimpleRate>
  </soap:Body>
</soap:Envelope>

Soap Example Response

<?xml version="1.0" encoding="utf-8"?>
<soap:Envelope xmlns:soap="http://schemas.xmlsoap.org/soap/envelope/" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:xsd="http://www.w3.org/2001/XMLSchema">
  <soap:Body>
    <AbolSimpleRateResponse xmlns="http://abolsoft.com/webservices/">
      <AbolSimpleRateResponse>
        <SimpleRateResult>
          <Error>
            <code>0</code>
            <message>Success</message>
          </Error>
          <SimpleRateResultList>
            <SimpleRateResult>
              <ReferenceNbr>SimpleRate</ReferenceNbr>
              <Service>
                <Carrier>UPS</Carrier>
                <ServiceCode>4003</ServiceCode>
                <ServiceDesc>UPS Next Day Air®</ServiceDesc>
                <Rate>90.48</Rate>
                <DeliveryDate>2013-07-30T00:00:00</DeliveryDate>
                <DeliveryTime>10:30 AM</DeliveryTime>
                <GuaranteedService>false</GuaranteedService>
                <Fees>
                  <Fee name="DC" charge="0.0" />
                  <Fee name="SC" charge="0.0" />
                  <Fee name="COD" charge="0.0" />
                  <Fee name="INSURANCE" charge="0.0" />
                  <Fee name="SATURDAYDELIVERY" charge="0.0" />
                  <Fee name="SATURDAYPICKUP" charge="0.0" />
                  <Fee name="FUELSURCHARGE" charge="0.0" />
                  <Fee name="LARGEPACKAGESURCHARGE" charge="0.0" />
                  <Fee name="ADDITIONALHANDLINGSURCHARGE" charge="0.0" />
                </Fees>
              </Service>
              <Service>
                <Carrier>UPS</Carrier>
                <ServiceCode>4002</ServiceCode>
                <ServiceDesc>UPS Next Day Air® Early AM®</ServiceDesc>
                <Rate>123.48</Rate>
                <DeliveryDate>2013-07-30T00:00:00</DeliveryDate>
                <DeliveryTime>08:30 AM</DeliveryTime>
                <GuaranteedService>false</GuaranteedService>
                <Fees>
                  <Fee name="DC" charge="0.0" />
                  <Fee name="SC" charge="0.0" />
                  <Fee name="COD" charge="0.0" />
                  <Fee name="INSURANCE" charge="0.0" />
                  <Fee name="SATURDAYDELIVERY" charge="0.0" />
                  <Fee name="SATURDAYPICKUP" charge="0.0" />
                  <Fee name="FUELSURCHARGE" charge="0.0" />
                  <Fee name="LARGEPACKAGESURCHARGE" charge="0.0" />
                  <Fee name="ADDITIONALHANDLINGSURCHARGE" charge="0.0" />
                </Fees>
              </Service>
              <Service>
                <Carrier>UPS</Carrier>
                <ServiceCode>4004</ServiceCode>
                <ServiceDesc>UPS Next Day Air Saver®</ServiceDesc>
                <Rate>83.16</Rate>
                <DeliveryDate>2013-07-30T00:00:00</DeliveryDate>
                <DeliveryTime>03:00 PM</DeliveryTime>
                <GuaranteedService>false</GuaranteedService>
                <Fees>
                  <Fee name="DC" charge="0.0" />
                  <Fee name="SC" charge="0.0" />
                  <Fee name="COD" charge="0.0" />
                  <Fee name="INSURANCE" charge="0.0" />
                  <Fee name="SATURDAYDELIVERY" charge="0.0" />
                  <Fee name="SATURDAYPICKUP" charge="0.0" />
                  <Fee name="FUELSURCHARGE" charge="0.0" />
                  <Fee name="LARGEPACKAGESURCHARGE" charge="0.0" />
                  <Fee name="ADDITIONALHANDLINGSURCHARGE" charge="0.0" />
                </Fees>
              </Service>
              <Service>
                <Carrier>UPS</Carrier>
                <ServiceCode>4006</ServiceCode>
                <ServiceDesc>UPS 2nd Day Air®</ServiceDesc>
                <Rate>35.64</Rate>
                <DeliveryDate>2013-07-31T00:00:00</DeliveryDate>
                <DeliveryTime>11:00 PM</DeliveryTime>
                <GuaranteedService>false</GuaranteedService>
                <Fees>
                  <Fee name="DC" charge="0.0" />
                  <Fee name="SC" charge="0.0" />
                  <Fee name="COD" charge="0.0" />
                  <Fee name="INSURANCE" charge="0.0" />
                  <Fee name="SATURDAYDELIVERY" charge="0.0" />
                  <Fee name="SATURDAYPICKUP" charge="0.0" />
                  <Fee name="FUELSURCHARGE" charge="0.0" />
                  <Fee name="LARGEPACKAGESURCHARGE" charge="0.0" />
                  <Fee name="ADDITIONALHANDLINGSURCHARGE" charge="0.0" />
                </Fees>
              </Service>
              <Service>
                <Carrier>UPS</Carrier>
                <ServiceCode>4005</ServiceCode>
                <ServiceDesc>UPS 2nd Day Air A.M.®</ServiceDesc>
                <Rate>40.98</Rate>
                <DeliveryDate>2013-07-31T00:00:00</DeliveryDate>
                <DeliveryTime>10:30 AM</DeliveryTime>
                <GuaranteedService>false</GuaranteedService>
                <Fees>
                  <Fee name="DC" charge="0.0" />
                  <Fee name="SC" charge="0.0" />
                  <Fee name="COD" charge="0.0" />
                  <Fee name="INSURANCE" charge="0.0" />
                  <Fee name="SATURDAYDELIVERY" charge="0.0" />
                  <Fee name="SATURDAYPICKUP" charge="0.0" />
                  <Fee name="FUELSURCHARGE" charge="0.0" />
                  <Fee name="LARGEPACKAGESURCHARGE" charge="0.0" />
                  <Fee name="ADDITIONALHANDLINGSURCHARGE" charge="0.0" />
                </Fees>
              </Service>
              <Service>
                <Carrier>UPS</Carrier>
                <ServiceCode>4008</ServiceCode>
                <ServiceDesc>UPS Ground</ServiceDesc>
                <Rate>13.9</Rate>
                <DeliveryDate>2013-07-31T00:00:00</DeliveryDate>
                <DeliveryTime>11:00 PM</DeliveryTime>
                <GuaranteedService>false</GuaranteedService>
                <Fees>
                  <Fee name="DC" charge="0.0" />
                  <Fee name="SC" charge="0.0" />
                  <Fee name="COD" charge="0.0" />
                  <Fee name="INSURANCE" charge="0.0" />
                  <Fee name="SATURDAYDELIVERY" charge="0.0" />
                  <Fee name="SATURDAYPICKUP" charge="0.0" />
                  <Fee name="FUELSURCHARGE" charge="0.0" />
                  <Fee name="LARGEPACKAGESURCHARGE" charge="0.0" />
                  <Fee name="ADDITIONALHANDLINGSURCHARGE" charge="0.0" />
                </Fees>
              </Service>
            </SimpleRateResult>
          </SimpleRateResultList>
          <Version>3.5.286.17470</Version>
        </SimpleRateResult>
      </AbolSimpleRateResponse>
    </AbolSimpleRateResponse>
  </soap:Body>
</soap:Envelope>
Back to top