Less-Than-Truckload

API Implementation Guide — LTL Rating

API Version 1.0

Latest Publication Date 2021-07-18

Document Owner XPO Less-Than-Truckload IT Service Governance Team

API Name LTL Rating

API Description This API provides tools to rate shipments (get “Rate Quotes”).

Document Purpose This document details the use of the LTL Rating API.
The operations will show the request and response interfaces for the
operations, describing mandatory and optional elements. They will
also specify values permitted for a field, any formatting constraints, as
well as any errors that may be encountered.

Operation Descriptions getXpoLtlRateQuote: Creates a rate quote for a customer based on

the account’s pricing agreement.
getXpoLtlRateQuoteDetails: Retrieves details of an existing rate
quote based on an entered confirmation number.
getXpoLtlSpotQuote: Provides a spot quote rate if available for a
single request using origin/destination zip codes, weight, class and
commodity dimensions.

P a g e 1 | 72 Version 1.0
Less-Than-Truckload

Table of Contents
1 Introduction............................................................................................................................................ 3
1.1 Purpose ....................................................................................................................................... 3
1.2 Scope .......................................................................................................................................... 3
2 Rating Execution ................................................................................................................................... 3
2.1 Production Environment .............................................................................................................. 3
3 getXpoLtlRateQuote .............................................................................................................................. 3
3.1 Business Rules ............................................................................................................................ 4
3.2 Description................................................................................................................................... 5
3.3 Request Elements ....................................................................................................................... 5
3.4 Response Elements .................................................................................................................. 12
3.5 getXpoLtlRateQuote Samples ................................................................................................... 25
3.5.1 Rate quote has no accessorials ..................................................................................... 25
3.5.2 Rate quote contains accessorials .................................................................................. 29
3.5.3 Account is Third-Party Bill-To ......................................................................................... 32
4 getXpoLtlRateQuoteDetails ................................................................................................................. 35
4.1 Description................................................................................................................................. 35
4.2 Business rules: .......................................................................................................................... 35
4.3 Request Elements ..................................................................................................................... 35
4.4 Response Elements .................................................................................................................. 36
4.5 getXpoLtlRateQuoteDetails Response Samples ....................................................................... 48
4.5.1 Registered user uses a pricing agreement .................................................................... 48
4.6 Pricing agreement not used....................................................................................................... 52
5 getXpoLtlSpotQuote ............................................................................................................................ 56
5.1 Business Rules .......................................................................................................................... 56
5.2 Request Elements ..................................................................................................................... 57
5.3 Response Elements .................................................................................................................. 59
5.4 getXpoLtlSpotQuote Samples ................................................................................................... 60
5.4.1 Request a Spot Quote .................................................................................................... 60
6 listRateQuoteAccessorials .................................................................................................................. 62
6.1 Business Rules .......................................................................................................................... 62
6.2 Request Elements ..................................................................................................................... 63
6.3 Response Elements .................................................................................................................. 63
6.4 listRateQuoteAccessorials Samples.......................................................................................... 63
6.4.1 Request Accessorials – Origin and Destination are US ................................................. 63
6.4.2 Request Accessorials – Origin is US destination is MX ................................................. 65
Implementation Guide Revision History..................................................................................................... 68

P a g e 2 | 72 Version 1.0
Less-Than-Truckload

1 Introduction
1.1 Purpose
The purpose of this document is to provide a technical guide for the LTL Rating JSON API service. For information
on general XPO LTL API setup, including security; health check; rate limits; discovering API options; response
structures; and test mode, see the API Help Center on [Link].

1.2 Scope
This document covers the execution environment, operation definitions, input and output
descriptions, and sample inputs and outputs.

2 Rating Execution
2.1 Production Environment
Endpoint
Production: [Link]
Endpoint Resource Value
API
Operation Name URI Prefix
Method

/ratequotes/{confirmationNbr} GET
getXpoLtlRateQuoteDetails

/ratequotes POST
getXpoLtlRateQuote

/spotquotes POST
getXpoLtlSpotQuote

3 getXpoLtlRateQuote
This operation generates a shipping rate quote. The caller can use an account with a pricing
agreement to use for the rate quote calculation, or use a discount level. Note that it may improve the
ease of use of your application if you offer NMFC choices via a dropdown list (it is suggested not to
set a default value).
If you expect to incur charges due to lineal foot, excessive length, or cubic capacity charges, use the
calculateLinealFeet operation in the LTLShippingTools API, and add the resulting following
information to the rate quote call:
• totalLinealFt
• excessiveLength
• cubicCapacity
Special Pricing

P a g e 3 | 72 Version 1.0
Less-Than-Truckload

Aside from your contracted rates, XPO offers the following LTL pricing options for large shipments:

Volume Shipment Pricing:

This price cap is automatically introduced when the shipment is rated more than a certain amount. This
pricing does not need to be requested, it will apply when appropriate conditions are met.

Spot Quote:

This special pricing is offered based on the weight of the shipment, and when the lane (route from origin to
the destination) has the option available. When this happens, the rate quote call will return a message that
indicates “This shipment may qualify for additional savings. If interested, please request a volume
shipment Spot Quote.“ At this point, if you’d like to check if it is available for the shipment, call the
getXpoLtlSpotQuote operation.

Instant Guaranteed Service (G!)

To request this service, pass in the code GUR as an accessorial.

3.1 Business Rules

1. If the account chosen is a pickup/delivery account, that account location must be used
for either the shipper or consignee location. If the account chosen is a bill-to account,
any postal code may be used for the shipper and consignee locations.
2. If the account was chosen for the shipper, the system will use the account’s postal
code for the shipper’s location and will not utilize the ZIP or city entered for the
shipper. Conversely, If the account was chosen for the consignee, the system will use
the account’s postal code for the consignee’s location and will not utilize the ZIP or city
entered for the consignee.
3. While postal codes are used for US and Canada locations, city names are used for
Mexico.
a. For a given location, if both a postal code and a Mexico city name are entered,
the Mexico city name will be used.
4. A discount level may be entered only if an account is not entered (as the rate quote
calculation will use the account’s pricing agreement).
5. The system will reject rate quotes with gross weights that are greater than 25,000
pounds. Due to capacity constraints, please contact your local service center to get a
rate quote for this shipment.
6. Dimensions can be entered for each commodity in order for the rating engine to
calculate which accessorials may apply (lineal foot or excessive length). If any
dimension is entered for a commodity, all dimensions must be entered for the
commodity in inches. The unit of measure must also be entered as inches.
7. Border crossing (accessorial code DRA) is required when shipping US-Mexico. This
may be performed by XPO Logistics, or your own broker. If you choose XPO Logistics,
please enter the DRA accessorial code.
8. Maximum total weight for any shipment is 99,999 lbs.

P a g e 4 | 72 Version 1.0
Less-Than-Truckload

9. Mutually exclusive rules for accessorials, shipment weight, and geographical

limitations

3.2 Description
3.2.1 This operation calculates and returns an estimated shipping cost rate quote. Note that
if your account is operating as a third-party biller for the rate quote, please indicate
this using the account ID in the bill2Party attribute. See the sample “Account is Third-
Party Bill-To” for more information. Includes estimated transit time information.

3.3 Request Elements

Valid Values or Required

Element Type Cardinality Description
Sample Values (Y)

shipmentInfo Object One

[Link]
Object One to Ten
orials

[Link] Identifier code of the

String
[Link] accessorial

[Link] Number of units that applies

Integer
[Link] to the accessorial

[Link] Unit of measure that applies

String
[Link] to the accessorial

[Link]
[Link] String Description of the Accessorial
sc
P a g e 5 | 72 Version 1.0
Less-Than-Truckload

Valid Values or Required

Element Type Cardinality Description
Sample Values (Y)

[Link]
Object
[Link]

[Link]
[Link] Decimal
t
[Link]
[Link] String ISO 3 Letter Currency codes
rencyCd
shipmentInfo.bill2Pa Account to use to determine
Object
rty the pricing agreement

Account ID to use to
shipmentInfo.bill2Pa determine the pricing
String
[Link] agreement if the account is of
“Bill to” (3rd Party) type
shipmentInfo.bill2Pa if the account is of “Bill to” (3rd
String
[Link] Party) type

shipmentInfo.bill2Pa
Object *** not used ***
[Link]

shipmentInfo.bill2Pa
[Link] String *** not used ***
TypeCd

shipmentInfo.bill2Pa
String *** not used ***
[Link]
shipmentInfo.bill2Pa
[Link] String *** not used ***
ame
shipmentInfo.bill2Pa
[Link] String *** not used ***
Line1
shipmentInfo.bill2Pa
[Link] String *** not used ***
Line2
shipmentInfo.bill2Pa
[Link] String *** not used ***
eBox
shipmentInfo.bill2Pa Required
[Link] if the city City Name part of the
String Mexico City
is in address.
e Mexico
shipmentInfo.bill2Pa
String *** not used ***
[Link]

P a g e 6 | 72 Version 1.0
Less-Than-Truckload

Valid Values or Required

Element Type Cardinality Description
Sample Values (Y)

shipmentInfo.bill2Pa
[Link] String *** not used ***
d
Required
shipmentInfo.bill2Pa if the city US or Canada postal (ZIP)
String
[Link] is in US or code
CA
shipmentInfo.bill2Pa
String *** not used ***
[Link].usZip4

[Link]
Object 1-20 Y
odity

[Link]
Integer 1 to 9,999 number of commodity items
[Link]

[Link] Examples: SKD, Type of Package (pallete,

String PLT, PCS, CRT, skid, bundle, crate, drum,
[Link]
BDL, BOX, CAS rack, tote)

[Link]
Object Y
[Link]
[Link]
[Link].w String Y Commodity gross weight
eight
[Link]
[Link].w Unit of measure for gross
String LBS
weight. MUST BE IN LBS.
eightUom

[Link] The weight of the pallet or

Object packaging used to ship a
[Link]
commodity.
[Link]
[Link] Decimal Y
ght
[Link]
[Link] Weight unit of measure.
String LBS
MUST be in LBS
ghtUom

[Link]
Object *** not used ***
[Link]

[Link]
Decimal *** not used ***
[Link]

[Link]
[Link] String *** not used ***
UOM

P a g e 7 | 72 Version 1.0
Less-Than-Truckload

Valid Values or Required

Element Type Cardinality Description
Sample Values (Y)

[Link]
String *** not used ***
[Link]

NMFC classes
are 50, 55, 60,
[Link] 65, 70, 77.5, 85,
String 92.5, 100, 110, Y Standard NMFC class code
[Link]
125, 150, 175,
200, 250, 300,
400, and 500.
[Link] NMFC Item code of the
String
[Link] commodity

[Link] Set to True if there is any

Boolean
[Link] Hazardous material

[Link]
Object Dimensions of the commodity
[Link]

If any
dimension
s are
entered
for a
[Link] commodit
[Link] decimal y, all Length of the commodity
gth dimension
s must be
entered
for that
commodit
y
If any
dimension
s are
entered
for a
[Link] commodit
[Link] decimal y, all Width of the commodity
th dimension
s must be
entered
for that
commodit
y
If any
dimension
[Link] s are
[Link] decimal entered Height of the commodity
ght for a
commodit
y, all
P a g e 8 | 72 Version 1.0
Less-Than-Truckload

Valid Values or Required

Element Type Cardinality Description
Sample Values (Y)

dimension
s must be
entered
for that
commodit
y
Y (if
dimension Unit of measure for the
[Link] s are commodity dimensions.
[Link] String Inches entered IMPORTANT: Until a future
mensionsUom for that release, the dimensions are
commodit in inches.
y)
[Link]
Object Consignee account info
nee

[Link]
String Database key for customer
[Link]

[Link]
String Business key for customer
[Link]

[Link]
Object Consignee address info
[Link]

[Link]
String *** not used ***
[Link]

[Link]
String *** not used ***
[Link]

[Link]
[Link] String *** not used ***
Name
[Link]
[Link] String *** not used ***
sLine1
[Link]
[Link] String *** not used ***
sLine2
[Link]
[Link] String *** not used ***
ceBox
[Link] Required
[Link] if the city
String Mexico city name
is in
me Mexico

P a g e 9 | 72 Version 1.0
Less-Than-Truckload

Valid Values or Required

Element Type Cardinality Description
Sample Values (Y)

[Link]
String *** not used ***
[Link]

[Link]
[Link] String *** not used ***
Cd
[Link] Required
[Link] Postal code for US or Canada
String for US or
location
d Canada

[Link]
String *** not used ***
[Link].usZip4

[Link]
bleInd Boolean *** not used ***

[Link] Set to True if there is any

Boolean
tInd Hazardous material

[Link] Total Lineal Feet of the

Decimal
Shipment

[Link] P (Prepaid) or C
String Y Shipment Payment term
ntTermCd (Collect)

[Link]
String Y Shipment Date
ntDate

Required
if shipping
[Link]
Volume to or from Shipment volume.
ntVolume
Mexico or
Hawaii

[Link]
Number Volume measurement
[Link]

[Link] Volume unit of measure –

[Link] String CFT Note this MUST be in CFT
M (Cubic Feet).

[Link]
Object
r

[Link]
String Database key for customer
[Link]

[Link]
String Business key for customer
[Link]

P a g e 10 | 72 Version 1.0
Less-Than-Truckload

Valid Values or Required

Element Type Cardinality Description
Sample Values (Y)

[Link]
Object
[Link]

[Link]
[Link] String *** not used ***
peCd

[Link]
String *** not used ***
[Link]

[Link]
[Link] String *** not used ***
me
[Link]
[Link] String *** not used ***
ne1
[Link]
[Link] String *** not used ***
ne2
[Link]
[Link] String *** not used ***
Box
Required
[Link]
String if city is in City name for Mexico city
[Link]
Mexico

[Link]
String *** not used ***
[Link]

[Link]
String *** not used ***
[Link]

Required
if the
[Link] US or Canada postal (ZIP)
String location is
[Link] code
in US or
CA

[Link]
String *** not used ***
[Link].usZip4

shipmentInfo.
Integer Total pallet count
palletCnt

[Link] Comments related to the rate

String
ent quote

Discount level to use for

[Link] calculating rate quote – If a
Decimal
ntLevel bill to party is entered, the
party’s pricing agreement is

P a g e 11 | 72 Version 1.0
Less-Than-Truckload

Valid Values or Required

Element Type Cardinality Description
Sample Values (Y)

ignored in favor of the

discount level.

3.4 Response Elements

Valid
Values or
Element Type Cardinality Description
Sample
Values
rateQuote Object Contains rate quote information
The rate quote confirmation
[Link] String
number
[Link]
Object
rials
[Link]
String
rials accessorialCd
[Link]
Integer
[Link]
[Link]
rials accessorialDesc String
quantityUom
[Link]
String
rials accessorialDesc
[Link]
Object
rials chargeAmt
[Link]
Decimal
rials [Link]
[Link]
String
rials [Link]
[Link]
String *** not used ***
e
The actual discount percentage
[Link] Decimal applied to the linehaul charges of
the shipment.

[Link] Object

[Link] Decimal

[Link] String

[Link] Boolean *** not used ***

[Link]
Object
ity
[Link]
Integer 1 to 9,999 number of commodity items
[Link]

P a g e 12 | 72 Version 1.0
Less-Than-Truckload

Valid
Values or
Element Type Cardinality Description
Sample
Values
Examples:
SKD, PLT,
[Link]
String PCS, CRT, Type of Package
[Link]
BDL, BOX,
CAS
The total weight of a shipment of
[Link]
Object goods, including their packaging
[Link]
such as crates, pallets etc.
[Link]
Decimal
[Link]
[Link] Unit of measure for Gross weight
String LBS
[Link] of the commodity – will be in LBS.
The weight of the pallet or
[Link]
Object packaging used to ship a
[Link]
commodity.
[Link]
Decimal Tare weight measurement
[Link]
[Link] Unit of measurement for weight.
String LBS
[Link] WILL BE IN LBS.
[Link]
Object Charge for the commodity
[Link]
[Link] Charge type code for the
String
[Link] commodity
[Link] Sequence number for the
Integer
[Link] commodity charge
[Link] Charge code for the commodity
String
[Link] charge
[Link]
Object
[Link]
[Link]
Decimal
[Link]
[Link]
[Link] String ISO 3 Letter Currency codes
d
[Link] Minimum charge indicator code for
Boolean
[Link] the commodity
[Link] Maximum charge indicator code
Boolean
[Link] for the commodity
[Link]
Object *** not used ***
[Link]
[Link]
Indicates calculation method: spot
[Link] String
quote or rate-based
dTypeCd
[Link]
Integer *** not used ***
[Link]

P a g e 13 | 72 Version 1.0
Less-Than-Truckload

Valid
Values or
Element Type Cardinality Description
Sample
Values
[Link]
[Link] String *** not used ***
OM
[Link]
[Link] Decimal Per unit rate of the commodity
te
[Link]
[Link] String *** not used ***
teEffDate
[Link]
[Link] Object
nfo
[Link] Currency Code in standard format
[Link] String e.g. USD. The exchange rate is to
cyCd convert from this currency.
[Link] Currency Code in standard format
[Link] String e.g. USD. The exchange rate is to
[Link] convert to thi s currency.
[Link] Currency code that is the basis for
[Link]. both the from and to conversions.
String
.[Link] For example - from SEK to USD
CrncyCd and from USD to EUR
[Link] The exchange rate to convert
[Link] String amount given in fromCrncyCd to
[Link] toCrncyCd.
[Link]
The dates on which this exchange
[Link] String
rate is effective.
[Link]
[Link]
[Link] String The source of the exchange rate
[Link]
[Link]
[Link] Decimal
eFactor
[Link]
String *** not used ***
[Link]
[Link]
String *** not used ***
[Link]
[Link]
Object *** not used ***
[Link]
[Link]
String *** not used ***
[Link]
[Link]
[Link] String *** not used ***
scr
[Link]
[Link] String *** not used ***
peCd

P a g e 14 | 72 Version 1.0
Less-Than-Truckload

Valid
Values or
Element Type Cardinality Description
Sample
Values
[Link]
Object Volume of the commodity
[Link]
[Link]
Decimal Volume measurement
[Link]
[Link] Volume unit of measure – this will
String CFT
[Link] be in cubic geet
[Link]
String Description of the commodity
[Link]
[Link]
String
[Link]
[Link]
String
[Link]
Total charge for all the
[Link]
Object commodities before the discount
modityCharge
was applied.
[Link]
Decimal Charge amount
[Link]
[Link] 3 letter currency code of the
String
[Link] charge amount
Set to True if there are any
[Link] Boolean
hazardous materials

[Link] Information about commodity

Object
s package dimensions
[Link]
decimal Package length
[Link]
[Link]
decimal Package width
[Link]
[Link]
decimal Package height
[Link]
[Link] Unit of measure for the package.
String Inches
[Link] Note this must be in inches.

[Link] Object

The freight class for this

[Link] calculation. This will be either the
String
Class actual class or if the customer has
an FAK, it will be the FAK
[Link]
Object
[Link]
[Link]
Decimal
[Link]
[Link] Unit of measure for deficit weight.
String LBS
[Link] MUST BE IN LBS

P a g e 15 | 72 Version 1.0
Less-Than-Truckload

Valid
Values or
Element Type Cardinality Description
Sample
Values
[Link]
Object
tedWeight
[Link]
Decimal
[Link]
[Link] Unit of measure for as rated
String LBS
[Link] weight. MUST BE IN LBS
[Link]
Object
tRate
[Link]
Decimal
[Link]
[Link]
String ISO 3 Letter Currency codes
[Link]
[Link]
Object
tAmt
[Link]
Decimal
[Link]
[Link]
String ISO 3 Letter Currency codes
[Link]
String
[Link]
array

[Link] String *** not used ***

[Link] String *** not used ***

[Link] Object

Charge types are linehaul,

[Link] accessorial, tax, discount, COD,
String
TypeCd cash ppd, cash coll, part ppd, part
coll
Sequence of charge. This is used
[Link] Integer for accessorials and miscellaneous
line items
a descriptive code identifying the
accessorial, tax type, discount, etc.
[Link] NotifyOnAr
string For chargeType codes that have
Cd rival.
sub codes, this will be used and
include the description for them.
[Link]
Object
Amt
[Link]
Decimal Linehaul charge amount
[Link]
[Link]
String ISO 3 Letter Currency codes
[Link]
[Link] Minimum charge indicator.
Boolean
argeInd Indicates if the charges associated

P a g e 16 | 72 Version 1.0
Less-Than-Truckload

Valid
Values or
Element Type Cardinality Description
Sample
Values
with the line are the minimum
charges for the commodity.
True if the charge associated with
[Link]
Boolean the accessorial line is the
argeInd
maximum charge
[Link]
Object
thod
[Link]
String spot quote, rate-based
[Link]
[Link] whatever if being multiplied by unit
Integer
[Link] rate - hours, weight, miles
[Link]
String
[Link]
[Link]
Decimal
[Link]
[Link]
String
[Link]
[Link]
Object
[Link]
Currency Code in standard format
[Link]
String e.g. USD. The exchange rate is to
[Link]
convert from this currency.
Currency Code in standard format
[Link]
String e.g. USD. The exchange rate is to
[Link]
convert to thi s currency.
Currency code that is the basis for
[Link] both the from and to conversions.
String
[Link] For example - from SEK to USD
and from USD to EUR
The exchange rate to convert
[Link]
Decimal amount given in fromCrncyCd to
[Link]
toCrncyCd.
[Link] The dates on which this exchange
String
[Link] rate is effective.
[Link]
String source of exchange rate
[Link]
[Link]
Decimal source of exchange rate
[Link]
A code indicating which party or
parties get the revenue from the
[Link] accessorial - PayToAdvance,
String
sibleParty PayToPrimary, SplitBetweenAll,
SplitAdvancePrimaryOnly,
SplitPrimaryBeyondOnly
Textual description of charge other
than a standard description
[Link] String
represented by the description in
ChargeTypeCd
P a g e 17 | 72 Version 1.0
Less-Than-Truckload

Valid
Values or
Element Type Cardinality Description
Sample
Values
[Link]
Object *** not used ***
ce
[Link]
String *** not used ***
[Link]
[Link]
String *** not used ***
[Link]
[Link]
String *** not used ***
[Link]
XPO service center of entry or exit
[Link] String
into or from the US

[Link] String *** not used ***

[Link] String *** not used ***

[Link] String *** not used ***

[Link] String

rateQuote.bill2Party Object

[Link] String Database key for customer

[Link] String Business key for customer

[Link] Object

[Link]
String *** not used ***
ressTypeCd
[Link]
String *** not used ***
me
[Link]
String *** not used ***
eOfName
[Link]
String *** not used ***
ressLine1
[Link]
String *** not used ***
ressLine2
[Link]
String *** not used ***
tOfficeBox
[Link]
String City name for Mexico city
Name
[Link]
String *** not used ***
eCd
[Link]
String *** not used ***
ntryCd
[Link]
String Postal code for US or CA address
talCd

P a g e 18 | 72 Version 1.0
Less-Than-Truckload

Valid
Values or
Element Type Cardinality Description
Sample
Values
[Link] This is a 4 digit extension to US 5
String
ip4 digit zip code.

[Link] Object

[Link] String Database key for customer

[Link] String Business key for customer

[Link] Object

[Link]
String *** not used ***
essTypeCd

[Link] String *** not used ***

[Link]
String *** not used ***
OfName
[Link]
String *** not used ***
essLine1
[Link]
String *** not used ***
essLine2
[Link]
String *** not used ***
OfficeBox
[Link]
String City name for Mexico city
ame
[Link]
String *** not used ***
Cd
[Link]
String *** not used ***
ryCd
[Link]
String Postal code for US or CA address
lCd
[Link]
String *** not used ***
4

[Link] Object

[Link] String Database key for customer

[Link] String Business key for customer

[Link] Object

[Link]
String *** not used ***
dressTypeCd
[Link]
String *** not used ***
me
[Link]
String *** not used ***
reOfName

P a g e 19 | 72 Version 1.0
Less-Than-Truckload

Valid
Values or
Element Type Cardinality Description
Sample
Values
[Link]
String *** not used ***
dressLine1
[Link]
String *** not used ***
dressLine2
[Link]
String *** not used ***
OfficeBox
[Link]
String City name of a Mexico city
yName
[Link]
String *** not used ***
ateCd
[Link]
String *** not used ***
untryCd
[Link]
String *** not used ***
stalCd
[Link]
String *** not used ***
Zip4
[Link]
integer *** not used ***
Miles

[Link] Object Total accessorial amount

[Link]
Decimal Total accessorial amount
t
[Link]
String ISO 3 Letter Currency codes
rencyCd

[Link] Object Zero to Many

[Link] Decimal zzxx

[Link] String ISO 3 Letter Currency codes

[Link] Object

Currency Code in standard format

[Link]
String e.g. USD. The exchange rate is to
ncyCd
convert from this currency.
Currency Code in standard format
[Link]
String e.g. USD. The exchange rate is to
yCd
convert to thi s currency.
Currency code that is the basis for
[Link] both the from and to conversions.
String
rncyCd For example - from SEK to USD
and from USD to EUR
The exchange rate to convert
[Link]
String amount given in fromCrncyCd to
ate
toCrncyCd.
[Link] The dates on which this exchange
String
ate rate is effective.

P a g e 20 | 72 Version 1.0
Less-Than-Truckload

Valid
Values or
Element Type Cardinality Description
Sample
Values
[Link] String The source of the exchange rate

[Link] Object

[Link] Decimal

[Link]
String ISO 3 Letter Currency codes
cyD

[Link]

[Link] Charge type code for the

String
eCd commodity
Sequence number for the
[Link] Integer
commodity charge
Charge code for the commodity
[Link] String
charge
[Link]
Object
t
[Link]
Decimal
[Link]
[Link]
String ISO 3 Letter Currency codes
[Link]
[Link] Minimum charge indicator code for
Boolean
eInd the commodity
[Link] Maximum charge indicator code
Boolean
eInd for the commodity
[Link]
Object *** not used ***
d
[Link] Indicates calculation method: spot
String
[Link] quote or rate-based
[Link]
Integer *** not used ***
[Link]
[Link]
String *** not used ***
[Link]
[Link]
Decimal Per unit rate of the commodity
[Link]
[Link]
String *** not used ***
[Link]
[Link]
Object
[Link]
Currency Code in standard format
[Link]
String e.g. USD. The exchange rate is to
[Link]
convert from this currency.
Currency Code in standard format
[Link]
String e.g. USD. The exchange rate is to
[Link]
convert to thi s currency.

P a g e 21 | 72 Version 1.0
Less-Than-Truckload

Valid
Values or
Element Type Cardinality Description
Sample
Values
Currency code that is the basis for
[Link].
both the from and to conversions.
.[Link] String
For example - from SEK to USD
CrncyCd
and from USD to EUR
The exchange rate to convert
[Link]
String amount given in fromCrncyCd to
[Link]
toCrncyCd.
[Link] The dates on which this exchange
String
[Link] rate is effective.
[Link]
String The source of the exchange rate
[Link]
[Link]
Decimal
[Link]
[Link]
String *** not used ***
eParty

[Link] String *** not used ***

[Link] Object *** not used ***

[Link].
String *** not used ***
reference
[Link].
String *** not used ***
referenceDescr
[Link].
String *** not used ***
referenceTypeCd
[Link]
Object
mt
[Link]
Decimal
[Link]
[Link]
String ISO 3 Letter Currency codes
[Link]

[Link] Object

[Link] Decimal

[Link] String ISO 3 Letter Currency codes

[Link] Object

[Link].a
Decimal
mt
[Link].c
String ISO 3 Letter Currency codes
urrency
[Link]
Object
mt
[Link]
Decimal
[Link]
P a g e 22 | 72 Version 1.0
Less-Than-Truckload

Valid
Values or
Element Type Cardinality Description
Sample
Values
[Link]
String ISO 3 Letter Currency codes
[Link]

[Link] Object

[Link] Decimal

[Link] String ISO 3 Letter Currency codes

[Link] Decimal *** not used ***

P(Prepaid)
[Link]
String or Shipment Payment term code
TermCd
C(Collect)
[Link] Comments related to the rate
String
t quote
Indicates whether or not volume
[Link] Boolean shipment pricing (VSP) was
applied (vs. regular rating).
transitTime Object Transit time information
[Link] String Destination state code
[Link] String Destination postal code
Destination service center that is
[Link] String
delivering the freight
Delivery date derived from
[Link] date requested pick up date and transit
days
If true then guaranteed service is
[Link] boolean
available on this service
Latest date by which the freight
[Link] date should be picked up in order to
meet the requested delivery date
[Link] String Origin postal code
[Link] String Origin state code
Origin service center that is picking
[Link] String
up the freight
Delivery date as requested by the
[Link] Date
customer
Customer requested pickup date. If
[Link] Date not provided, then defaults to the
date the request was created.
Standard service transit (business)
days (excluding weekends and
[Link] Integer
holidays) to move from origin to
destination.
Earliest date by which the freight
[Link] Date should be picked up in order to
meet the requested delivery date.
P a g e 23 | 72 Version 1.0
Less-Than-Truckload

Valid
Values or
Element Type Cardinality Description
Sample
Values
[Link] String Note about the transit time
Set to true if the requested pickup
[Link] boolean
date is holidat or non-working day
Set to true of the requested
[Link]
Boolean delivery date is a holiday or non-
oliday
working day
Messages returned from the
msgs Object Zero to Many service call that contain important
information

[Link] String *** not used ***

[Link] String Warning or informational message

[Link] String *** not used ***

[Link] String *** not used ***

P a g e 24 | 72 Version 1.0
Less-Than-Truckload

3.5 getXpoLtlRateQuote Samples

3.5.1 Rate quote has no accessorials

Request URL: [Link]

Request Message:

"shipmentInfo": {

"paymentTermCd": "P",

"accessorials": [],

"commodity": [{

"grossWeight": {

"weight": 500,

"weightUom": "LBS"

},

"nmfcClass": 100,

"hazmatInd": false,

"pieceCnt":2,

"dimensions" : {

"length" : 11,

"width" : 20,

"height" : 50,

"dimensionsUom" : "INCH"

}],

"consignee": {

"address": {

"postalCd": "M4B1B3"

},

"shipper": {

P a g e 25 | 72 Version 1.0
Less-Than-Truckload

"acctInstId": "1234567"

},

"bill2Party": {

"address": {

"usZip4": ""

},

"shipmentDate": "2018-05-10T12:00:00.000-0700",

"palletCnt": 0,

"linealFt": 0

Response Message:

"code": "201",

"transactionTimestamp": 1525455060046,

"data": {

"rateQuote": {

"confirmationNbr": "7133312345678893",

"amcInd": false,

"deficitRatingInfo": {

"deficitRate": {

"amt": 368.06

},

"deficitAmt": {

"amt": 0

},

"totAccessorialAmt": {

"amt": 124.37

P a g e 26 | 72 Version 1.0
Less-Than-Truckload

},

"totCharge": [

"amt": 541.01

],

"totDiscountAmt": {

"amt": 1423.66

},

"shipmentInfo": {

"accessorials": [

"accessorialCd": "HMS",

"accessorialDesc": "HOMELAND SECURITY FEE, 1/1/03",

"chargeAmt": {

"amt": 22.5

},

"accessorialCd": "FSC",

"accessorialDesc": "FUEL SURCHARGE 24.45%",

"chargeAmt": {

"amt": 101.87

],

"commodity": [

"dimensions": {

"length": 11,

P a g e 27 | 72 Version 1.0
Less-Than-Truckload

"width": 20,

"height": 50

},

"pieceCnt": 2,

"grossWeight": {

"weight": 500

},

"charge": {

"chargeAmt": {

"amt": 1840.3

},

"calcMethod": {

"perUnitRate": 368.06

},

"nmfcClass": "100.0",

"hazmatInd": false

],

"shipper": {

"address": {

"postalCd": "72143 "

},

"consignee": {

"address": {

"postalCd": "M4B1B3"

},

"paymentTermCd": "P",

P a g e 28 | 72 Version 1.0
Less-Than-Truckload

"comment": "",

"totCommodityCharge": {

"amt": 1840.3

},

"vspApplied": false

},

"msgs": [],

"transitTime": {

"destStateCd": "ON",

"destPostalCd": "M4B1B3",

"destSicCd": "XKR",

"estdDlvrDate": 1526367600000,

"garntInd": true,

"origPostalCd": "72143",

"origStateCd": "AR",

"origSicCd": "LLR",

"requestedPkupDate": 1525960800000,

"transitDays": 3

3.5.2 Rate quote contains accessorials

Request URL: [Link]

Request Message:
{
"shipmentInfo":
{
"accessorials":
[
{
"accessorialCd":"ELS",
"quantity":110,
"quantityUom":"Inch"
},
{

P a g e 29 | 72 Version 1.0
Less-Than-Truckload

"accessorialCd":"OLG",
"quantity":0
}
],
"commodity":
[
{
"pieceCnt":5,
"packageCode":"PLT",
"grossWeight":
{
"weight":500,
"weightUom":"lbs"
},

"desc":"Wool",
"nmfcClass":"100",
"nmfcItemCd":"057410",
"hazmatInd":false,
"dimensions" : {
"length" : 15,
"width" : 25,
"height" : 60,
"dimensionsUom" : "INCH"
}
}],
"freezableInd":false,
"hazmatInd":false,
"paymentTermCd":"P",
"shipmentDate":"2018-02-09T17:00:00.000Z",
"shipper": {
"acctInstId": "1234567"
},
"consignee": {
"address": {
"postalCd": "90210"
}
},
"bill2Party": {
"address": {
"usZip4": ""
}
},
"palletCnt":1
}
}

Response Message:
{
"code": "201",
"transactionTimestamp": 1525455644592,
"data": {
"rateQuote": {
"confirmationNbr": "1237054568789",
"amcInd": false,
"deficitRatingInfo": {
"deficitRate": {
"amt": 451.98
},
"deficitAmt": {

P a g e 30 | 72 Version 1.0
Less-Than-Truckload

"amt": 0
}
},
"totAccessorialAmt": {
"amt": 323.34
},
"totCharge": [
{
"amt": 834.98
}
],
"totDiscountAmt": {
"amt": 1748.26
},
"shipmentInfo": {
"accessorials": [
{
"accessorialCd": "HCD",
"accessorialDesc": "HIGH COST DELIVERY REGION SRCHG",
"chargeAmt": {
"amt": 41.5
}
},
{
"accessorialCd": "CCS",
"accessorialDesc": "CALIFORNIA COMPLIANCE SURCHARGE",
"chargeAmt": {
"amt": 6.8
}
},
{
"accessorialCd": "OLG",
"accessorialDesc": "ORIG LIFTGATE SERVICE",
"chargeAmt": {
"amt": 152.5
}
},
{
"accessorialCd": "FSC",
"accessorialDesc": "FUEL SURCHARGE 23.95%",
"chargeAmt": {
"amt": 122.54
}
}
],
"commodity": [
{
"dimensions": {
"length": 15,
"width": 25,
"height": 60
},
"pieceCnt": 5,
"grossWeight": {
"weight": 500
},
"charge": {
"chargeAmt": {
"amt": 2259.9
},

P a g e 31 | 72 Version 1.0
Less-Than-Truckload

"calcMethod": {
"perUnitRate": 451.98
}
},
"nmfcClass": "100.0",
"hazmatInd": false
}
],
"shipper": {
"address": {
"postalCd": "72143 "
}
},
"consignee": {
"address": {
"postalCd": "90210 "
}
},
"paymentTermCd": "P",
"comment": "",
"totCommodityCharge": {
"amt": 2259.9
}
},
"vspApplied": false
},
"msgs": [],
"transitTime": {
"destStateCd": "CA",
"destPostalCd": "90210",
"destSicCd": "ULX",
"estdDlvrDate": 1518595200000,
"garntInd": true,
"origPostalCd": "72143",
"origStateCd": "AR",
"origSicCd": "LLR",
"requestedPkupDate": 1518192000000,
"transitDays": 3
}
}
}

3.5.3 Account is Third-Party Bill-To

Request URL: [Link]

Request Message:
{
"shipmentInfo":
{
"accessorials":[
{
"accessorialCd":"ELS",
"quantity":96,
"quantityUom":"Inch"
},
{
"accessorialCd":"OLG",
"quantity":0
}
P a g e 32 | 72 Version 1.0
Less-Than-Truckload

],
"commodity":[
{
"pieceCnt":2,
"packageCode":"PLT",
"grossWeight":
{
"weight":141,
"weightUom":"lbs"
},

"desc":"Fabric",
"nmfcClass":"92.5",
"nmfcItemCd":"057410",
"hazmatInd":false,
"dimensions" : {
"length" : 11,
"width" : 20,
"height" : 50,
"dimensionsUom" : "INCH"
}
}],
"freezableInd":false,
"garntInd":false,
"hazmatInd":false,
"paymentTermCd":"P",
"shipmentDate":"2018-02-09T17:00:00.000Z",
"shipper":
{
"address":
{
"stateCd":"WI",
"countryCd":"US",
"postalCd":"54304"
}
},
"consignee":
{
"address":
{
"stateCd":"WA",
"countryCd":"US",
"postalCd":"98612"
}
},
"bill2Party":
{
"acctInstId":"12345678"},
"palletCnt":1
}
}

Response Message:
{
"code": "201",
"transactionTimestamp": 1525453698009,
"data": {
"rateQuote": {
"confirmationNbr": "9877654932183",
"amcInd": false,
"deficitRatingInfo": {
"deficitRate": {

P a g e 33 | 72 Version 1.0
Less-Than-Truckload

"amt": 610.38
},
"deficitAmt": {
"amt": 0
}
},
"totAccessorialAmt": {
"amt": 199.17
},
"totCharge": [
{
"amt": 394.02
}
],
"totDiscountAmt": {
"amt": 665.79
},
"shipmentInfo": {
"accessorials": [
{
"accessorialCd": "OLG",
"accessorialDesc": "ORIG LIFTGATE SERVICE",
"chargeAmt": {
"amt": 152.5
}
},
{
"accessorialCd": "FSC",
"accessorialDesc": "FUEL SURCHARGE 23.95%",
"chargeAmt": {
"amt": 46.67
}
}
],
"commodity": [
{
"dimensions": {
"length": 11,
"width": 20,
"height": 50
},
"pieceCnt": 2,
"grossWeight": {
"weight": 141
},
"charge": {
"chargeAmt": {
"amt": 860.64
},
"calcMethod": {
"perUnitRate": 610.38
}
},
"nmfcClass": "92.5",
"hazmatInd": false
}
],
"shipper": {
"address": {
"postalCd": "54304 "
}
},

P a g e 34 | 72 Version 1.0
Less-Than-Truckload

"consignee": {
"address": {
"postalCd": "98612 "
}
},
"paymentTermCd": "P",
"comment": "Reminder: Single Shipments less than 500 lbs may be subject to a special service charge.",
"totCommodityCharge": {
"amt": 860.64
}
},
"vspApplied": false
},
"msgs": [],
"transitTime": {
"destStateCd": "WA",
"destPostalCd": "98612",
"destSicCd": "UPE",
"estdDlvrDate": 1519113600000,
"garntInd": true,
"origPostalCd": "54304",
"origStateCd": "WI",
"origSicCd": "XGB",
"requestedPkupDate": 1518192000000,
"transitDays": 7
}
}
}

4 getXpoLtlRateQuoteDetails
4.1 Description
This service will retrieve the details of an existing rate quote based on its confirmation
number. Rate quote details will be sent back in response. Note that the confirmation number
is passed in the URL in this format: /ratequotes/{confirmationNbr}. Includes estimated transit
time information.
Post-conditions:
• If a valid rate quote confirmation number is provided, then rate quote details for the
input rate quote confirmation number are returned.
• If an invalid rate quote confirmation number is provided, a 'Not found' error message is
returned.

4.2 Business rules:

1. A valid rate quote confirmation number must be entered.
2. The caller must have permission to access the information.

4.3 Request Elements

P a g e 35 | 72 Version 1.0
Less-Than-Truckload

Valid Values Required/

Element Type Cardinality or Sample Optional Description
Values (Y/N)

The rate quote confirmation

confirmationNbr String Y
number.

4.4 Response Elements

Valid
Values or
Element Type Cardinality Description
Sample
Values
rateQuote Object
The rate quote confirmation
[Link] String
number
[Link]
String *** not used ***
e
The actual discount percentage
[Link] Decimal applied to the linehaul charges of
the shipment.

[Link] Object

[Link] Decimal

[Link] String

[Link] Boolean *** not used ***

[Link] Object

The freight class for this

[Link] calculation. This will be either the
String
Class actual class or if the customer has
an FAK, it will be the FAK
[Link]
Object
[Link]
[Link]
Decimal
[Link]
[Link]
String LBS Unit of weight for deficit weight
[Link]
[Link]
Object
tedWeight
[Link]
Decimal
[Link]
[Link] Unit of weight for as weighted
String LBS
[Link] weight
[Link]
Object
tRate
[Link]
Decimal
[Link]
P a g e 36 | 72 Version 1.0
Less-Than-Truckload

Valid
Values or
Element Type Cardinality Description
Sample
Values
[Link]
String ISO 3 Letter Currency codes
[Link]
[Link]
Object
tAmt
[Link]
Decimal
[Link]
[Link]
String ISO 3 Letter Currency codes
[Link]
String
[Link]
array

[Link] String *** not used ***

[Link] String *** not used ***

[Link] Object

Charge types are linehaul,

[Link] accessorial, tax, discount, COD,
String
TypeCd cash ppd, cash coll, part ppd, part
coll
Sequence of charge. This is used
[Link] Integer for accessorials and miscellaneous
line items
a descriptive code identifying the
accessorial, tax type, discount, etc.
[Link] NotifyOnAr
string For chargeType codes that have
Cd rival.
sub codes, this will be used and
include the description for them.
[Link]
Object
Amt
[Link]
Decimal Linehaul charge amount
[Link]
[Link]
String ISO 3 Letter Currency codes
[Link]
Minimum charge indicator.
[Link] Indicates if the charges associated
Boolean
argeInd with the line are the minimum
charges for the commodity.
True if the charge associated with
[Link]
Boolean the accessorial line is the
argeInd
maximum charge
[Link]
Object
thod
[Link]
String spot quote, rate-based
[Link]
[Link] whatever if being multiplied by unit
Integer
[Link] rate - hours, weight, miles

P a g e 37 | 72 Version 1.0
Less-Than-Truckload

Valid
Values or
Element Type Cardinality Description
Sample
Values
[Link]
String
[Link]
[Link]
Decimal
[Link]
[Link]
String
[Link]
[Link]
Object
[Link]
Currency Code in standard format
[Link]
String e.g. USD. The exchange rate is to
[Link]
convert from this currency.
Currency Code in standard format
[Link]
String e.g. USD. The exchange rate is to
[Link]
convert to thi s currency.
Currency code that is the basis for
[Link] both the from and to conversions.
String
[Link] For example - from SEK to USD
and from USD to EUR
The exchange rate to convert
[Link]
Decimal amount given in fromCrncyCd to
[Link]
toCrncyCd.
[Link] The dates on which this exchange
String
[Link] rate is effective.
[Link]
String source of exchange rate
[Link]
[Link]
Decimal source of exchange rate
[Link]
A code indicating which party or
parties get the revenue from the
[Link] accessorial - PayToAdvance,
String
sibleParty PayToPrimary, SplitBetweenAll,
SplitAdvancePrimaryOnly,
SplitPrimaryBeyondOnly
Textual description of charge other
than a standard description
[Link] String
represented by the description in
ChargeTypeCd
[Link]
Object *** not used ***
ce
[Link]
String *** not used ***
[Link]
[Link]
String *** not used ***
[Link]
[Link]
String *** not used ***
[Link]
XPO service center of entry or exit
[Link] String
into or from the US

P a g e 38 | 72 Version 1.0
Less-Than-Truckload

Valid
Values or
Element Type Cardinality Description
Sample
Values
[Link] String *** not used ***

[Link] String *** not used ***

[Link] String *** not used ***

[Link] Object Total accessorial amount

[Link]
Decimal Total accessorial amount
t
[Link]
String ISO 3 Letter Currency codes
rencyCd

[Link] Object

[Link] Decimal zzxx

[Link] String ISO 3 Letter Currency codes

[Link] Object

Currency Code in standard format

[Link]
String e.g. USD. The exchange rate is to
ncyCd
convert from this currency.
Currency Code in standard format
[Link]
String e.g. USD. The exchange rate is to
yCd
convert to thi s currency.
Currency code that is the basis for
[Link] both the from and to conversions.
String
rncyCd For example - from SEK to USD
and from USD to EUR
The exchange rate to convert
[Link]
String amount given in fromCrncyCd to
ate
toCrncyCd.
[Link] The dates on which this exchange
String
ate rate is effective.

[Link] String The source of the exchange rate

[Link] Object

[Link] Decimal

[Link]
String ISO 3 Letter Currency codes
cyD

[Link]

[Link] Charge type code for the

String
eCd commodity
P a g e 39 | 72 Version 1.0
Less-Than-Truckload

Valid
Values or
Element Type Cardinality Description
Sample
Values
Sequence number for the
[Link] Integer
commodity charge
Charge code for the commodity
[Link] String
charge
[Link]
Object
t
[Link]
Decimal
[Link]
[Link]
String ISO 3 Letter Currency codes
[Link]
[Link] Minimum charge indicator code for
Boolean
eInd the commodity
[Link] Maximum charge indicator code
Boolean
eInd for the commodity
[Link]
Object *** not used ***
d
[Link] Indicates calculation method: spot
String
[Link] quote or rate-based
[Link]
Integer *** not used ***
[Link]
[Link]
String *** not used ***
[Link]
[Link]
Decimal Per unit rate of the commodity
[Link]
[Link]
String *** not used ***
[Link]
[Link]
Object
[Link]
Currency Code in standard format
[Link]
String e.g. USD. The exchange rate is to
[Link]
convert from this currency.
Currency Code in standard format
[Link]
String e.g. USD. The exchange rate is to
[Link]
convert to thi s currency.
Currency code that is the basis for
[Link].
both the from and to conversions.
.[Link] String
For example - from SEK to USD
CrncyCd
and from USD to EUR
The exchange rate to convert
[Link]
String amount given in fromCrncyCd to
[Link]
toCrncyCd.
[Link] The dates on which this exchange
String
[Link] rate is effective.
[Link]
String The source of the exchange rate
[Link]

P a g e 40 | 72 Version 1.0
Less-Than-Truckload

Valid
Values or
Element Type Cardinality Description
Sample
Values
[Link]
Decimal
[Link]
[Link]
String *** not used ***
eParty

[Link] String *** not used ***

[Link] Object *** not used ***

[Link].
String *** not used ***
reference
[Link].
String *** not used ***
referenceDescr
[Link].
String *** not used ***
referenceTypeCd
[Link]
Object
mt
[Link]
Decimal
[Link]
[Link]
String ISO 3 Letter Currency codes
[Link]

[Link] Object

[Link] Decimal

[Link] String ISO 3 Letter Currency codes

[Link] Object

[Link].a
Decimal
mt
[Link].c
String ISO 3 Letter Currency codes
urrencyCd
[Link]
Object
mt
[Link]
Decimal
[Link]
[Link]
String ISO 3 Letter Currency codes
[Link]

[Link] Object

[Link] Decimal

[Link]
String ISO 3 Letter Currency codes
d

[Link] Object

P a g e 41 | 72 Version 1.0
Less-Than-Truckload

Valid
Values or
Element Type Cardinality Description
Sample
Values
[Link].
Object
accessorials
[Link]
String
[Link]
[Link]
Integer
[Link]
[Link]
[Link] String
quantityUom
[Link]
String
[Link]
[Link].o
Object
[Link]
[Link]
Decimal
[Link]
[Link]
String
[Link]
[Link]
Integer number of commodity items
[Link]
Examples:
SKD, PLT,
[Link]
String PCS, CRT, Type of Package
[Link]
BDL, BOX,
CAS
The total weight of a shipment of
[Link]
Object goods, including their packaging
[Link]
such as crates, pallets etc.
[Link]
Decimal
[Link]
[Link] Unit of measure for gross weight.
String LBS
[Link] MUST BE IN LBS.
The weight of the pallet or
[Link]
Object packaging used to ship a
[Link]
commodity.
[Link]
Decimal Tare weight measurement
[Link]
[Link] Unit of measurement for tare
String LBS
[Link] weight. MUST BE IN POUNDS
[Link]
Object Charge for the commodity
[Link]
[Link] Charge type code for the
String
[Link] commodity
[Link] Sequence number for the
Integer
[Link] commodity charge
[Link] Charge code for the commodity
String
[Link] charge

P a g e 42 | 72 Version 1.0
Less-Than-Truckload

Valid
Values or
Element Type Cardinality Description
Sample
Values
[Link]
Object
[Link]
[Link]
Decimal
[Link]
[Link]
[Link] String ISO 3 Letter Currency codes
d
[Link] Minimum charge indicator code for
Boolean
[Link] the commodity
[Link] Maximum charge indicator code
Boolean
[Link] for the commodity
[Link]
Object *** not used ***
[Link]
[Link]
Indicates calculation method: spot
[Link] String
quote or rate-based
dTypeCd
[Link]
Integer *** not used ***
[Link]
[Link]
[Link] String *** not used ***
OM
[Link]
[Link] Decimal Per unit rate of the commodity
te
[Link]
[Link] String *** not used ***
teEffDate
[Link]
[Link] Object
nfo
[Link] Currency Code in standard format
[Link] String e.g. USD. The exchange rate is to
cyCd convert from this currency.
[Link] Currency Code in standard format
[Link] String e.g. USD. The exchange rate is to
[Link] convert to thi s currency.
[Link] Currency code that is the basis for
[Link]. both the from and to conversions.
String
.[Link] For example - from SEK to USD
CrncyCd and from USD to EUR
[Link] The exchange rate to convert
[Link] String amount given in fromCrncyCd to
[Link] toCrncyCd.
[Link]
The dates on which this exchange
[Link] String
rate is effective.
[Link]

P a g e 43 | 72 Version 1.0
Less-Than-Truckload

Valid
Values or
Element Type Cardinality Description
Sample
Values
[Link]
[Link] String The source of the exchange rate
[Link]
[Link]
[Link] Decimal
eFactor
[Link]
String *** not used ***
[Link]
[Link]
String *** not used ***
[Link]
[Link]
Object *** not used ***
[Link]
[Link]
String *** not used ***
[Link]
[Link]
[Link] String *** not used ***
scr
[Link]
[Link] String *** not used ***
peCd
[Link]
Object Volume of the commodity
[Link]
[Link]
Decimal Volume measurement
[Link]
[Link]
String CFT Volume unit of measure
[Link]

[Link] String

[Link]
String
[Link]
[Link]
String
[Link]
[Link]
String
d
[Link].bill2Part
Object
y
[Link].bill2Part
String Database key for customer
[Link]
[Link].bill2Part
String Business key for customer
[Link]
[Link].bill2Part
Object
[Link]
[Link].bill2Part
String *** not used ***
[Link]
[Link].bill2Part
String *** not used ***
[Link]

P a g e 44 | 72 Version 1.0
Less-Than-Truckload

Valid
Values or
Element Type Cardinality Description
Sample
Values
[Link].bill2Part
String *** not used ***
[Link]
[Link].bill2Part
String *** not used ***
[Link].addressLine1
[Link].bill2Part
String *** not used ***
[Link].addressLine2
[Link].bill2Part
String *** not used ***
[Link]
[Link].bill2Part
String City name for Mexico city
[Link]
[Link].bill2Part
String *** not used ***
[Link]
[Link].bill2Part
String *** not used ***
[Link]
[Link].bill2Part
String Postal code for US or CA address
[Link]
[Link].bill2Part This is a 4 digit extension to US 5
String
[Link].usZip4 digit zip code.
[Link].
String Database key for customer
acctInstId
[Link].
String Business key for customer
madCd
[Link].
Object
address
[Link].
String *** not used ***
[Link]
[Link].
String *** not used ***
[Link]
[Link].
String *** not used ***
[Link]
[Link].
String *** not used ***
address.addressLine1
[Link].
String *** not used ***
address.addressLine2
[Link].
String *** not used ***
[Link]
[Link].
String City name for Mexico city
[Link]
[Link].
String *** not used ***
[Link]
[Link].
String *** not used ***
[Link]
[Link].
String Postal code for US or CA address
[Link]
[Link].
String *** not used ***
address.usZip4
P a g e 45 | 72 Version 1.0
Less-Than-Truckload

Valid
Values or
Element Type Cardinality Description
Sample
Values
[Link]
Object
ee
[Link]
String Database key for customer
[Link]
[Link]
String Business key for customer
[Link]
[Link]
Object
[Link]
[Link]
String *** not used ***
[Link]
[Link]
String *** not used ***
[Link]
[Link]
String *** not used ***
[Link]
[Link]
String *** not used ***
[Link].addressLine1
[Link]
String *** not used ***
[Link].addressLine2
[Link].
String *** not used ***
[Link]
[Link]
String City name of a Mexico city
[Link]
[Link]
String *** not used ***
[Link]
[Link]
String *** not used ***
[Link]
[Link]
String *** not used ***
[Link]
[Link]
String *** not used ***
[Link].usZip4
[Link]
integer *** not used ***
oConsigneeMiles
P(Prepaid)
[Link]
String or Shipment payment term code
TermCd
C(Collect)
[Link] “true” indicates the shipment
Boolean contains material that can be
leInd damaged by freezing
[Link] Set to True if there are any
Boolean
[Link] hazardous materials
[Link]
Dimensions of the commodity
[Link]
[Link]
decimal Length of the commodity
[Link]
[Link]
decimal Width of the commodity
[Link]

P a g e 46 | 72 Version 1.0
Less-Than-Truckload

Valid
Values or
Element Type Cardinality Description
Sample
Values
[Link]
decimal Height of the commodity
[Link]
[Link]
String Unit of measure of the commodity
[Link]

[Link] Decimal Total Lineal Feet of the Shipment

[Link]
String Shipment date
tDate
Required if
shipping to
[Link]
Volume or from Shipment volume.
tVolume
Mexico or
Hawaii
[Link]
Number Volume measurement
[Link]
[Link] Volume unit of measure – this will
String CFT
[Link] be in cubic feet (CFT)
[Link]. Comments related to the rate
comment quote
[Link] Discount level used if no pricing
decimal
Level agreement was used.
[Link] Total number of pallets in the
short
t shipment.
Number of trailers required to
[Link] decimal
convey the shipment.

transitTime Object Transit time information

[Link] String Destination state code

[Link] String Destination postal code

Destination service center that is

[Link] String
delivering the freight
Delivery date derived from
[Link] date requested pick up date and transit
days
If true then guaranteed service is
[Link] boolean
available on this service
Latest date by which the freight
[Link] date should be picked up in order to
meet the requested delivery date

[Link] String Origin postal code

[Link] String Origin state code

Origin service center that is picking

[Link] String
up the freight

P a g e 47 | 72 Version 1.0
Less-Than-Truckload

Valid
Values or
Element Type Cardinality Description
Sample
Values
Delivery date as requested by the
[Link] Date
customer
Customer requested pickup date. If
[Link] Date not provided, then defaults to the
date the request was created.
Standard service transit (business)
days (excluding weekends and
[Link] Integer
holidays) to move from origin to
destination.
Earliest date by which the freight
[Link] Date should be picked up in order to
meet the requested delivery date.

[Link] String Note about the transit time

Set to true if the requested pickup

[Link] boolean
date is holidat or non-working day
Set to true of the requested
[Link]
Boolean delivery date is a holiday or non-
oliday
working day

4.5 getXpoLtlRateQuoteDetails Response Samples

4.5.1 Registered user uses a pricing agreement

Request URL:
[Link]
Response Message:

{
"code": "200",
"transactionTimestamp": 1525120373490,

"data": {
"ratequote": {
"confirmationNbr": "4833703479827",

"actlDiscountPct": 0,
"lnhChargeAmt": {
"chargeAmt": {

"amt": 0,
"currencyCd": "USD"
}
},

P a g e 48 | 72 Version 1.0
Less-Than-Truckload

"totAccessorialAmt": {
"amt": 381.72,
"currencyCd": "USD"
},
"totCharge": [
{
"amt": 2501.11,

"currencyCd": "USD"
}
],
"totDiscountAmt": {
"amt": 0,
"currencyCd": "USD"
},
"shipmentInfo": {
"accessorials": [
{
"accessorialCd": "DNC",

"accessorialDesc": "DEST NOTIFICATION",

"chargeAmt": {
"amt": 0,

"currencyCd": "USD"
}
},

{
"accessorialCd": "CCS",
"accessorialDesc": "CALIFORNIA COMPLIANCE SURCHARGE",

"chargeAmt": {
"amt": 7.5,

"currencyCd": "USD"
}
},

{
"accessorialCd": "ZHM",
"accessorialDesc": "HAZARDOUS MATERIALS",

"chargeAmt": {
"amt": 33,

P a g e 49 | 72 Version 1.0
Less-Than-Truckload

"currencyCd": "USD"
}
},
{
"accessorialCd": "FSC",
"accessorialDesc": "FUEL SURCHARGE 16.10%",
"chargeAmt": {

"amt": 341.22,
"currencyCd": "USD"
}
},
{
"accessorialCd": "XLF",
"accessorialDesc": "LINEAL FOOT 959 MI X $2.21/MI",
"chargeAmt": {
"amt": 0,
"currencyCd": "USD"
}

}
],
"commodity": [

{
"dimensions": {
"length": 60,

"width": 51,
"height": 40,
"dimensionsUom": "INCH"

},
"pieceCnt": 9,

"grossWeight": {
"weight": 500,
"weightUom": "lbs"

},
"charge": {
"chargeAmt": {

"amt": 2119.39,
"currencyCd": "USD"

P a g e 50 | 72 Version 1.0
Less-Than-Truckload

},
"calcMethod": {
"perUnitRate": -1
}
},
"nmfcClass": "100.0"
}

],
"bill2Party": {
"acctInstId": "949252598"
},
"shipper": {
"address": {
"cityName": "BEVERLY HILLS",
"stateCd": "CA",
"countryCd": "US",
"postalCd": "90210"
}

},
"consignee": {
"address": {

"cityName": "PORTLAND",
"stateCd": "OR",
"countryCd": "US",

"postalCd": "97209"
}
},

"paymentTermCd": "C",
"shipmentDate": 1524726000000,

"comment": ""
}
},

"transitTime": {
"destStateCd": "OR",
"destPostalCd": "97209",

"destSicCd": "UPO",
"estdDlvrDate": 1525071600000,

P a g e 51 | 72 Version 1.0
Less-Than-Truckload

"garntInd": true,
"origPostalCd": "90210",
"origStateCd": "CA",
"origSicCd": "ULX",
"requestedPkupDate": 1524751200000,
"transitDays": 2
}

}
}

4.6 Pricing agreement not used

Request URL:
[Link]
Response Message:

{
"code": "200",
"transactionTimestamp": 1525120586979,

"data": {
"ratequote": {
"confirmationNbr": "4833705632509",

"actlDiscountPct": 0,
"lnhChargeAmt": {
"chargeAmt": {
"amt": 0,
"currencyCd": "USD"

}
},
"totAccessorialAmt": {

"amt": 787.57,
"currencyCd": "USD"
},

"totCharge": [
{
"amt": 3831.25,

"currencyCd": "USD"
}
],

P a g e 52 | 72 Version 1.0
Less-Than-Truckload

"totDiscountAmt": {
"amt": 0,
"currencyCd": "USD"
},
"shipmentInfo": {
"accessorials": [
{

"accessorialCd": "CCS",
"accessorialDesc": "CALIFORNIA COMPLIANCE SURCHARGE",
"chargeAmt": {
"amt": 7.5,
"currencyCd": "USD"
}
},
{
"accessorialCd": "DNC",
"accessorialDesc": "DEST NOTIFICATION",
"chargeAmt": {

"amt": 10.5,
"currencyCd": "USD"
}

},
{
"accessorialCd": "ZHM",

"accessorialDesc": "HAZARDOUS MATERIALS",

"chargeAmt": {
"amt": 33,

"currencyCd": "USD"
}

},
{
"accessorialCd": "FSC",

"accessorialDesc": "FUEL SURCHARGE 24.20%",

"chargeAmt": {
"amt": 736.57,

"currencyCd": "USD"
}

P a g e 53 | 72 Version 1.0
Less-Than-Truckload

},
{
"accessorialCd": "XLF",
"accessorialDesc": "LINEAL FOOT 2238 MI X $1.36/MI",
"chargeAmt": {
"amt": 0,
"currencyCd": "USD"

}
}
],
"commodity": [
{
"dimensions": {
"length": 60,
"width": 51,
"height": 40,
"dimensionsUom": "INCH"
},

"pieceCnt": 9,
"grossWeight": {
"weight": 500,

"weightUom": "lbs"
},
"charge": {

"chargeAmt": {
"amt": 3043.68,
"currencyCd": "USD"

},
"calcMethod": {

"perUnitRate": -1
}
},

"nmfcClass": "100.0"
}
],

"shipper": {
"address": {

P a g e 54 | 72 Version 1.0
Less-Than-Truckload

"cityName": "BEVERLY HILLS",

"stateCd": "CA",
"countryCd": "US",
"postalCd": "90210"
}
},
"consignee": {

"address": {
"cityName": "PERRYSBURG",
"stateCd": "OH",
"countryCd": "US",
"postalCd": "43551"
}
},
"paymentTermCd": "C",
"shipmentDate": 1524726000000,
"comment": ""
}

},
"transitTime": {
"destStateCd": "OH",

"destPostalCd": "43551",
"destSicCd": "XTO",
"estdDlvrDate": 1525330800000,

"garntInd": true,
"origPostalCd": "90210",
"origStateCd": "CA",

"origSicCd": "ULX",
"requestedPkupDate": 1524751200000,

"transitDays": 5
}
}

P a g e 55 | 72 Version 1.0
Less-Than-Truckload

5 getXpoLtlSpotQuote
This service is used to provide a XPO Less-Than-Truckload spot quote rate if available for
a single request using origin/destination zip codes, weight, class and commodity
dimensions.

5.1 Business Rules

1. To ensure the spot quote rates are used, write the spot quote confirmation number on
the Bill of Lading. Note the confirmation number starts with “SQ”.
2. Spot Quote rates apply to shipments that take up to 28 feet (1 pup) of a trailer and do
not exceed the maximum legal weight limit. Shipments tendered that exceed 1 pup
and/or the legal weight limit will be rerated accordingly and the SQ is no longer
available. Refer to CNWY 199, Item 234 and Item 30.
3. Spot Quotes are not to be applied to shipments that consist of loose freight.
4. The maximum liability on Spot Quote shipments is $1.00 per pound.
5. Spot Quotes are not Guaranteed
6. Exclusive Use cannot be used with Spot Quote.
7. To qualify for a Spot Quote, the shipment must be between 5,000 and 25,000 pounds.
8. Spot Quotes are good for one (1) move only. Should the customer desire to move
multiple shipments to the same location, they can obtain additional spot quotes.
9. The Spot Quote rate is valid for seven (7) calendar days or five (5) business days.
10. Commodity units to handle must be numeric between 1 and 9,999
11. Commodity length must be numeric and between 12 and 330 inches
12. Commodity width must be numeric and between 12 and 96 inches
13. Commodity height must be numeric and between 12 and 108 inches
14. For drum the length and width must be the same
15. Total floor space for the commodities must not exceed 31,680 square inches

P a g e 56 | 72 Version 1.0
 Less-Than-Truckload

5.2 Request Elements

4. Valid Values
5. Required
1. Element 2. Type 3. Cardinality or Sample 6. Description
(Y)
Values
7. Header 8. User-Id 9. String 10. 11. 12. The registered
user id identifying
the organization
calling the service
13. Header 14. Transaction-Timestamp
15. String 16. “2016-01- 17. 18. The data of the
20T00:00:00” API request
19. Header 20. Content-Type 21. 22. Application/json
23. y 24.
25. Header 26. Authorization 27. 28. Bearer <access
29. Required
30.
token>
31. Body 32. shipmentValue.amt33. Decimal
34. 35. 36. Shipment Value
amount
37. Body 38. [Link]
39. String 40. USD 41. 42. Shipment Value
Cd currency
43. Body 44. requestedCurrency 45. String 46. USD 47. 48.
49. Body 50. pkupDate 51. String 52. ”2016-01-20”
53. Y 54. Shipment Date
55. Body 56. shipperAcctId 57. String 58. 59.
Eg. 99999999 Y (enter60.
0 if Shipper XPO LTL
account ID Customer Account
is not Number
available)
61. Body 62. shipperPostalCd 63. String 64. Eg. 9720965.
for Y 66. Shipper zip code
Portland, OR
67. Body 68. shipperName 69. String 70. 71. Y (enter72.
0 if Shipper Name
account ID
is not
available)
73. Body 74. consigneeAcctId 75. String 76. 77.
Eg. “9999999” Y (enter78.
0 if Consignee XPO
account ID LTL customer
is not account number
available) (or 0)
79. Body 80. consigneePostalCd81. String 82. 83. Y 84. Consignee Zip
code
85. Body 86. consigneeName 87. String 88. 89. Y (enter90.
0 if Consignee name
account ID
is not
available)
91. Body 92. shipperBill2AcctId 93. String 94. 95.
Eg. “999999” Y (enter96.
0 if Shipper Bill-To
account ID XPO LTL
is not Customer account
available) number (or 0)
97. Body 98. consigneeBill2AcctId
99. String 100. 101.
Eg. “999999” Y (enter102.
0 if Consignee Bill-To
account ID XPO LTL
is not Customer account
available) number (or 0)
103. Body 104. thirdBill2AcctId 105. String 106. 107.
Eg. “999999” Y (enter108.
0 if Third party
account ID Customer account
is not number (or 0)
available)

P a g e 57 | 72 Version 1.0
 Less-Than-Truckload

109. Body 110. commodityLine 111. Array 112. 113. Y 114. One or more
repetitions (up to
10) of class,
weight,
dimensions, etc
115. Body 116. [Link]
117. 118.
String (3) “PLT”(Pallet),
119. Y 120. Type of packaging
Cd “SKD”(Skid), the commodity
“BDL”(Bundle), was originally
“CRT”(Carton), picked up in.
“DRM”(Drum),
“RCK”(Rack),
“TBN”(Tote)
121. Body 122. [Link]
123. Decimal
124. 125. Y 126. Weight of the
ight specified
commodity
127. Body 128. [Link]
129. Decimal
130. LBS 131. Defaults to
ightUom pounds.
132. Body 133. [Link]
134. Integer135. 1 to 9,999 136. Y 137. The number of
pieces or units of
specified
commodity
138. Body 139. [Link]
140. String (1)
141. “Y” or “N” 142. Y 143. Indicates if the
eInd packaged
commodity can be
stacked if the
height is less than
49 inches.
144. Body 145. [Link]
146. Integer147. Eg. 999.99148. Y 149. The length of the
specified
commodity
150. Body 151. [Link]
152. Integer153. Eg. 999.99154. Y 155. The width of the
specified
commodity
156. Body 157. [Link]
158. Integer159. Eg. 999.99160. Y 161. The height of the
specified
commodity
162. Body 163. [Link]
164. String 165. Eg. IN 166. 167. The uom for
nUom dimensions. Eg.
Inches
168. Body 169. [Link]
170. String 171. “50”, “55”, 172.
“60”, Y 173. The NMFC class
ss “65“,“70“,“775“, of the specified
“85“,“925“,“100“ commodity
, sequence
“110“,“125“,“15
0“, “175“,“200“,
“250“,
“300“,“400“,
“500“
174. Body 175. Reference 176. Array 177. 178. 179. Zero or more
repititions (up to
100) of reference
identifiers

P a g e 58 | 72 Version 1.0
 Less-Than-Truckload

180. Body 181. reference 182. String 183. 184. 185. Will be returned in
the response
message
186. Body 187. typeCd 188. String 189. 190. 191. Will be returned in
the response
message
192. Body 193. Accessorials 194. Array 195. 196. 197.
198. Body 199. Quantity 200. Integer201. 202. 203.
204. Body 205. QuantityUom 206. String 207. 208. 209. Unit of measure
for quantity
210. Body 211. accessorialCd 212. String 213. 214. 215. Accessorial
Service charge
code

5.3 Response Elements

Sample
Element Type Description
Values
spotQuoteNbr String “SQ2000101” The spot quote number that must be
placed on the Bill of Lading.
spotQuoteEffDate Date 1453334400 The effective date of the spot quote
spotQuoteExpDate Date 1453852800 The expiration date of the spot quote.
transitDays Integer i.e. 99 This is the number of shipping days that it
will take to deliver the shipment from time
of pickup.
rtgOrigZipCd String (6) i.e. “28277” This is the origin Zip code that was used
for rating the spot quote (first 5 characters
for [Link], 6 characters for Canadian
Postal Code).
rtgDestZipCd String (6) i.e. “44035” This is the destination Zip code that was
used for rating the spot quote (first 5
characters for [Link], 6 characters for
Canadian Postal Code).
totWeightGross Number i.e. 99999 Total actual weight of the commodities.
(11.2) The total BOL weigh must be within 500
pounds of this weight.
totChargeAmt Number i.e. 9999.99 This represents total spot quote rate
(13.2) includes fuel does not include ACs or
taxes.
lnhChargeAmt Number Not used Element for future use.
(13.2)
totAccessorialAmt Number Not used Element for future use.
(13.2)
totFSCChargeAmt Number Not used Element for future use.
(13.2)
totTaxAmt Number Not used Element for future use.
(13.2)
currencyCd String (3) “USD” The final rate currency code. Currently
only “USD” supported.
exchangeRate Number Not used Element for future use.
(13.2)
reference Array Zero or more repetitions of reference
[Link] String i.e. “XPOSQ” The reference from the spot quote request.

P a g e 59 | 72 Version 1.0
Less-Than-Truckload

Sample
Element Type Description
Values
[Link] String i.e. “12345” The reference type code from the spot
quote request.
Accessorials Array
accessorialDesc String Description of the accessorial charge
applied
accessorialCd String Accessorial Charge Code
chargeAmt Decimal Accessorial Charge Amount

5.4 getXpoLtlSpotQuote Samples

5.4.1 Request a Spot Quote

JSON REQUEST:
{
"requestDateTime": "2016-01-12T09:30:47Z",

"shipmentValue": {

{ "amt": 1000,

"currencyCd": "USD"

"requestedCurrency": "USD",

"pkupDate": "2016-01-21",

"shipperAcctId": 0,

"shipperPostalCd": "97209",

"shipperName": "Shipper Name",

"consigneeAcctId": 0,

"consigneePostalCd": "97006",

"consigneeName": "Consignee Name",

"shipperBill2AcctId": 0,

"consigneeBill2AcctId": 0,

"thirdBill2AcctId": 0,

"serviceTypeCd": "",

"commodityLine": [

{ "pieceCnt": 3,

"packageCd": "PLT",

"stackableInd": "Y",

P a g e 60 | 72 Version 1.0
Less-Than-Truckload

"length": 48,

"width": 42,

"height": 48,

"dimensionUOM": "IN",

"grossWeight": 5700,

"grossWeightUOM": "LBS",

"nmfcClass": "60"

],

"reference": [ {

{ "reference": "",

"typeCd": ""

JSON REPLY:
{
"spotQuoteResponseDTODelegate":{

"requestDateTime":"[Link]()",

"spotQuoteNbr":"SQ2072704",

"spotQuoteEffDate":" 1453334400",

"spotQuoteExpDate":" 1453852800",

"transitDays":"1",

"rtgOrigZipCd":"97209",

"rtgDestZipCd":"97006",

"totWeightGross":"5000.0",

"totChargeAmt":"251.0",

"lnhChargeAmt":null,

"totAccessorialAmt":null,

"totFSCChargeAmt":null,

"totTaxAmt":null,

"currencyCd":"USD",

"exchangeRate":null,

"spotQuoteResponseReferenceDTO":null,

"spotQuoteResponseRateErrorsDTO":null

P a g e 61 | 72 Version 1.0
Less-Than-Truckload

6 listRateQuoteAccessorials
This service is used to get a list of valid accessorials, given an origin country and
destination country.

6.1 Business Rules

1. Origin and destination countries must be valid country codes.

P a g e 62 | 72 Version 1.0
 Less-Than-Truckload

6.2 Request Elements

219. Valid Values
220. Required
216. Element 217. Type 218. Cardinality or Sample 221. Description
(Y)
Values
222. origCountry223. String 224. 225. US or CA or
226. y 227. Origin country
MX code
228. destCountry229. String 230. 231. US or CA or
232. y 233. Destination
MX country code

6.3 Response Elements

Sample
Element Type Description
Values
accessorial Object
[Link] String ACX 3-letter accessorial code
[Link] String Advancing Description of the accessorial
Charge
[Link] String Origin Indicates whether the accessorial applies
to the origin, destination, both, or within
certain Hawaii ZIP codes

6.4 listRateQuoteAccessorials Samples

6.4.1 Request Accessorials – Origin and Destination are US

Request URL:
[Link]

Response URL:

{
"code": "200",
"transactionTimestamp": 1547577512204,
"data": {
"accessorial": [
{
"accessorialCd": "IBC",
"accessorialDesc": "IBC IN BOND TIR CARNET",
"accessorialType": "Destination"
},
{
"accessorialCd": "OLG",
"accessorialDesc": "OLG ORIG LIFTGATE SERVICE",
"accessorialType": "Origin"
},
{
"accessorialCd": "DPW",
"accessorialDesc": "DPW DEST PIER/WHARF LOAD/UNLOAD",
"accessorialType": "Destination"
},
{
"accessorialCd": "ELS",
"accessorialDesc": "ELS EXCESSIVE LENGTH SHIPMENT",
"accessorialType": "Both"
},
{
"accessorialCd": "TDC",
"accessorialDesc": "TDC TIME DATE CRITICAL/APPOINTMENT",
"accessorialType": "Both"
},
{
"accessorialCd": "CSD",
"accessorialDesc": "CSD CONSTR/UTILITY SITE DELIVERY",
"accessorialType": "Destination"

P a g e 63 | 72 Version 1.0
Less-Than-Truckload

},
{
"accessorialCd": "SRT",
"accessorialDesc": "SRT DEST PALLETIZE, SORT, SEGREGATE",
"accessorialType": "Destination"
},
{
"accessorialCd": "WHI",
"accessorialDesc": "INSIDE PKUP/DLVRY TRUCK LEVEL",
"accessorialType": "Hawaii"
},
{
"accessorialCd": "DSH",
"accessorialDesc": "DSH DEST SAT, SUN, HOLIDAY DELIVERY",
"accessorialType": "Destination"
},
{
"accessorialCd": "CIB",
"accessorialDesc": "CIB CUSTOMS INBOND U.S.",
"accessorialType": "Destination"
},
{
"accessorialCd": "WHN",
"accessorialDesc": "INSIDE PKUP/DLVRY NON-TRUCK LEVEL",
"accessorialType": "Hawaii"
},
{
"accessorialCd": "DID",
"accessorialDesc": "DID DEST INSIDE DELIVERY",
"accessorialType": "Destination"
},
{
"accessorialCd": "ZHM",
"accessorialDesc": "ZHM HAZMAT",
"accessorialType": "Origin"
},
{
"accessorialCd": "RSD",
"accessorialDesc": "RSD DEST RESIDENTIAL DELIVERY",
"accessorialType": "Destination"
},
{
"accessorialCd": "SSC",
"accessorialDesc": "SSC SINGLE SHIPMENT",
"accessorialType": "Origin"
},
{
"accessorialCd": "GUR",
"accessorialDesc": "GUR XPO LOGISTICS GUARANTEED!",
"accessorialType": "Both"
},
{
"accessorialCd": "OSH",
"accessorialDesc": "OSH ORIG SAT, SUN, HOLIDAY PICKUP",
"accessorialType": "Origin"
},
{
"accessorialCd": "DCF",
"accessorialDesc": "DCF DEST CONTAINER FREIGHT STATION",
"accessorialType": "Destination"
},
{
"accessorialCd": "DMS",
"accessorialDesc": "DMS GOVT AIRPORT MINE GAS OIL DLVRY",
"accessorialType": "Destination"
},
{
"accessorialCd": "DAH",
"accessorialDesc": "DAH AFTER BUSINESS HOURS DELIVERY",
"accessorialType": "Destination"
},
{
"accessorialCd": "RSO",
"accessorialDesc": "RSO ORIG RESIDENTIAL PICKUP",

P a g e 64 | 72 Version 1.0
Less-Than-Truckload

"accessorialType": "Origin"
},
{
"accessorialCd": "OSS",
"accessorialDesc": "OSS ORIG PALLETIZE, SORT, SEGREGATE",
"accessorialType": "Origin"
},
{
"accessorialCd": "PED",
"accessorialDesc": "PED DEST EXHIBITION SITES DELIVERY",
"accessorialType": "Destination"
},
{
"accessorialCd": "OCF",
"accessorialDesc": "OCF ORIG CONTAINER FREIGHT STATION",
"accessorialType": "Origin"
},
{
"accessorialCd": "OIP",
"accessorialDesc": "OIP ORIG INSIDE PICKUP",
"accessorialType": "Origin"
},
{
"accessorialCd": "DNC",
"accessorialDesc": "DNC DEST NOTIFICATION",
"accessorialType": "Destination"
},
{
"accessorialCd": "PEO",
"accessorialDesc": "PEO ORIG EXHIBITION SITES PICKUP",
"accessorialType": "Origin"
},
{
"accessorialCd": "DLG",
"accessorialDesc": "DLG DEST LIFTGATE SERVICE",
"accessorialType": "Destination"
},
{
"accessorialCd": "OCS",
"accessorialDesc": "OCS CONSTR/UTILITY SITE PICKUP",
"accessorialType": "Origin"
}
]
}
}

6.4.2 Request Accessorials – Origin is US destination is MX

Request URL:
[Link]

Response Message:

{
"code": "200",
"transactionTimestamp": 1547585543008,
"data": {
"accessorial": [
{
"accessorialCd": "SSC",
"accessorialDesc": "SSC SINGLE SHIPMENT",
"accessorialType": "Origin"
},
{

P a g e 65 | 72 Version 1.0
Less-Than-Truckload

"accessorialCd": "RSD",
"accessorialDesc": "RSD DEST RESIDENTIAL DELIVERY",
"accessorialType": "Destination"
},
{
"accessorialCd": "OLG",
"accessorialDesc": "OLG ORIG LIFTGATE SERVICE",
"accessorialType": "Origin"
},
{
"accessorialCd": "RSO",
"accessorialDesc": "RSO ORIG RESIDENTIAL PICKUP",
"accessorialType": "Origin"
},
{
"accessorialCd": "OSS",
"accessorialDesc": "OSS ORIG PALLETIZE, SORT, SEGREGATE",
"accessorialType": "Origin"
},
{
"accessorialCd": "DRA",
"accessorialDesc": "DRA BORDER CROSSING SERVICE",
"accessorialType": "Both"
},
{
"accessorialCd": "CSD",
"accessorialDesc": "CSD CONSTR/UTILITY SITE DELIVERY",
"accessorialType": "Destination"
},
{
"accessorialCd": "SRT",
"accessorialDesc": "SRT DEST PALLETIZE, SORT, SEGREGATE",
"accessorialType": "Destination"
},
{
"accessorialCd": "OIP",
"accessorialDesc": "OIP ORIG INSIDE PICKUP",
"accessorialType": "Origin"
},
{
"accessorialCd": "WHI",
"accessorialDesc": "INSIDE PKUP/DLVRY TRUCK LEVEL",
"accessorialType": "Hawaii"
},
{
"accessorialCd": "DNC",
"accessorialDesc": "DNC DEST NOTIFICATION",
"accessorialType": "Destination"
},
{
"accessorialCd": "DSH",
P a g e 66 | 72 Version 1.0
Less-Than-Truckload

"accessorialDesc": "DSH DEST SAT, SUN, HOLIDAY DELIVERY",

"accessorialType": "Destination"
},
{
"accessorialCd": "CIB",
"accessorialDesc": "CIB CUSTOMS INBOND U.S.",
"accessorialType": "Destination"
},
{
"accessorialCd": "WHN",
"accessorialDesc": "INSIDE PKUP/DLVRY NON-TRUCK LEVEL",
"accessorialType": "Hawaii"
},
{
"accessorialCd": "DLG",
"accessorialDesc": "DLG DEST LIFTGATE SERVICE",
"accessorialType": "Destination"
},
{
"accessorialCd": "DID",
"accessorialDesc": "DID DEST INSIDE DELIVERY",
"accessorialType": "Destination"
}
]
}
}

P a g e 67 | 72 Version 1.0
 Less-Than-Truckload

Implementation Guide Revision History

234. API 235. Date 236. Summary of Changes
Version

237. 1.0 238. 3/10/2017 239. Initial version

240. 1.0 241. 5/31/2017 GetXpoLtlRateQuote:

Request:
1. Added an object “shipmentInfo” where everything is now
included
2. Changed “bill2PartyAccount” object name to “bill2Party”
3. Changed “commodities” object to “commodity”
4. totalPalletCount renamed to palletCount
Response:
1. Added an object “shipmentInfo” where shipment information
has been moved to.
2. Changed [Link] to
[Link]
3. Changed [Link] to
[Link]
GetXpoLtlRateQuoteDetails:
Request:
No changes
Response:
1. Added an object “shipmentInfo”
2. Moved accessorials, commodity, serviced, bill2Party,
shipper, consignee, shipperToConsigneeMiles,
paymentTermCd, shipmentVolume, comment, to
shipmentInfo. Added freezableInd, freezableInd,
garntInd, hazmatInd, linealFt, shipmentDate,
discountLevel, palletCnt, to shipmentInfo.
3. Renamed [Link] to [Link]
4. Added trailerCnt to rateQuote object
5. Renamed [Link] to [Link]
6. renamed [Link] to
[Link]
7. Renamed [Link] to
[Link]
Also replaced the request/response examples to reflect the new
structure.

P a g e 68 | 72 Version 1.0
 Less-Than-Truckload

242. 1.0 243. 6/07/2017 244. Included the XpoLtlSpotQuote operation (was previously
considered a unique API).

245. 1.0 246. 6/23/2017 247. XpoLtlSpotQuote: corrected the maximum amount of
commodityLine items to 10 (changed from 100). indicated the
valid range for [Link] is
[Link] is 1 – 9,999
248. XpoLtlRateQuote: indicated the valid range for
[Link] is 1 – 9,999

249. 1.0 250. 7/13/2017 251. * Removed references to DEV environment

252. * Corrected URLS in sample sections

253. 1.0 254. 7/31/2017 Changed the format of the Endpoint Resource Value section

255. 1.0 256. 8/30/2017 7 GetXpoLtlRateQuoteDetailsResp:

8 * Added the “vspApplied” field to indicate whether or not volume
shipment pricing (VSP) was applied
9 * added the “totCommodityCharge” object
10 getXpoLtlSpotQuote:
11 * Added information on how to add the spot quote confirmation
number to the BOL (required in order to receive the spot quote
rate)
12 * Accessorial information was consolidated into an accessorial
object.

257. 1.0 258. 10/24/2017 13 Corrected [Link] to be required

(previously only required if the Bill2Party is a pickup/delivery
location).

Extracted the following sections into a common API page on

259. 1.0 260. 11/02/07
[Link]:
• API security
• Rate limits
• Health Check
• Options
• Structure
14 Added explanations of what Volume Shipment Pricing and Spot
Quote are.
15 Added instructions on how to use the lineal foot calculator API in
261. 1.0 262. 12/08/2017
conjunction with this API

P a g e 69 | 72 Version 1.0
 Less-Than-Truckload

263. 1.0 264. 3/1/2018 • The following spot quote request elements are mandatory (though 0
may be entered if the account ID is not available)
o consigneeAcctId
o shipperBill2AcctId
o thirdBill2AcctId
• Production endpoint changed
• Changed the Spot Quote request sample
• getLtlXpoRateQuote request –
o changed [Link] to
[Link]
o [Link] changed to mandatory
o [Link] – removed
mandatory requirement

265. 1.0 266. 3/22/2018 16 Added cardinality to [Link] element

267. 1.0 268. 4/10/2018 17 Changed [Link] to

[Link]

269. 1.0 270. 5/04/2018 271. * Added dimension input for commodities, in order to calculate
lineal foot and excessive length accessorials. Note that these
must be entered as inches; and unit of measure must be
designated in inches. Applies to getXpoLtlRateQuote and
getXpoLtlRateQuoteDetails.
272. * Added transit time estimation in return from
getXpoLtlRateQuote and getXpoLtlRateQuoteDetails
273. * GetXpoLtlRateQuoteResp: Moved
[Link] to
[Link]
274. * [Link] – previously
LBS or KG were allowed; now only LBS are allowed.
275. * [Link] – previously
LBS or KG were allowed; now only LBS are allowed.
276. * [Link] -–
previously LBS or KG were allowed; now only LBS are allowed.
277. * [Link] -–
previously LBS or KG were allowed; now only LBS are allowed.
278. * [Link]
– previously LBS or KG were allowed; now only LBS are
allowed.
279. * [Link] -–
previously LBS or KG were allowed; now only LBS are allowed.
280. * [Link]
– previously LBS or KG were allowed; now only LBS are
allowed.

P a g e 70 | 72 Version 1.0
 Less-Than-Truckload

281. * [Link] –
previously LBS or KG were allowed; now only LBS are allowed.
282. * grossWeight UOM – changed sample code value from “LB” to
“LBS:”
283. * [Link] –
changed this to ONLY accept CFT.

284. 1.0 285. 6/21/2018 286. Added to business rules that border crossing service is required
when crossing the US-Mexico border. If you wish to have XPO
Logistics perform the service, please enter a DRA accessorial
code.
287. GetXpoLtlSpotQuote – removed “Exhibition sites cannot be used
with spot quote” business rule.

288. 1.0 289. 7/11/2018 1. Deleted [Link] input from the input and response
of [Link] of this is deprecated by the GUR
accessorial.
2. Deleted [Link] from the
response of getXpoLtlRateQuote.
3. Removed garntInd:true from getXpoLtlRateQuote samples.
4. Fixed some object structural typos in [Link]
5. Added a note to use GUR to request guaranteed shipment
accessorial.

6. 1.0 7. 8/21/2018 8. Updated samples of spotQuoteEffDate and spotQuoteExpDate

response elements to Unix time stamp format.

9. 1.0 10. 9/25/2018 11. Updated [Link] allowable range to be 1-20

(used to be 1-10)

12. 1.0 13. 11/21/2018 14. Indicated that maximum total weight for any shipment is 99,999
pounds.

15. 1.0 16. 2/15/2019 17. Added the listRateQuoteAccessorials service; removed the
Accessorials appendix.

18. 1.0 19. 4/26/2019 20. [Link] – changed type from

String to “object”; removed “not used” (it is mandatory);
[Link] – made mandatory;
[Link] – made
mandatory.

21. 1.0 22. 4/26/2019 23. Changed [Link] to [Link]

24. 1.0 25. 8/23/2019 26. getXpoLtlSpotQuote:

27. ShipperAcctId – made mandatory (enter 0 if account ID is not
available)
28. ShipperName – made mandatory (enter 0 if account ID is not
available)

P a g e 71 | 72 Version 1.0
 Less-Than-Truckload

29. ConsigneeName – made mandatory (enter 0 if account ID is not

available)
30. consigneeAcctId - made mandatory (enter 0 if account ID is not
available)
31. consigneeBill2AcctId – added this new field and made
mandatory (enter 0 if account ID is not available)
32.

33. 1.0 34. 5/26/2021 35. Added list of mutually exclusive conditions

1.0 07/18/2021 18 Updated the Mutual Exclusive conditions to support APT

accessorial

P a g e 72 | 72 Version 1.0