• Getting Started Guide
• API XML Schema
• API XML Methods
• API Appendix

Code

X

xs:string

10

1.0

Attribute value indicating the carrier code (see Appendix C).

EntryPoint

X

xs:string

2

1.0

The entry point indicates the method used to deliver the  packages to the carrier. (see Appendix E)

ServiceList

X

Service Schemas Collection

List of the carrier services to be rated (see Appendix D).

AccessKey
(DHL only)

X

xs:string

20

1.0

Your DHL account ID (for account rates). If not present, DHL "list" rates will be returned. 

(Optional, for DHL only)

AcctCountryCode
(DHL only)

X

xs:string

2

2.4

The account country code which correlates to the DHL Account ID (for account rates). Required when the AccessKey is optionally included, but if not present, will default to the Origin Address country code. 

(Optional, for DHL only)

PostalCode
(DHL only)
(Deprecated June 2013)

X

xs:string

5

1.0

The account postal code which correlates to the DHL Account ID, required when the AccessKey is optionally included.

 (Deprecated June 2013: no longer needed when submitting the DHL AccessKey)

FlatRatePackaging
(optional:
USPS & FEDEX only)

X

xs:string

5

2.1

USPS & FEDEX provide various flat rate packaging options using their pre-paid boxes & envelopes. These products support USPS Priority and Express (both domestic and international) and FEDEX International Priority services. This flag allows you to request that AuctionInc attempt to qualify, for each appropriate service, your items into each eligible flat rate product, in turn from smallest to largest. (The items must both fit and not exceed any weight limit for the particular product.)  If your USPS Entry Point is Commercial Base, packages will also be tested for fit into the Regional flat rate boxes for (domestic) Priority Mail. 

In all cases qualification means that a) item dimensions have been provided in the API for all items in the package; b) the items in the shipment fit; c) the weight of the package is not greater than any weight limit for the flat rate product; and d) the cost of the fitted flat rate product is less expensive than the regular calculated rate for the same service. (Please take note this final test; a comparison of the product's cost is made with the regular calculated rate.) If all these tests are passed, the underlying service (USPS Priority, Express, or FedEx Priority) will be priced at the appropriate flat rate, and the appropriate code will be returned in the ShipRate schema indicating if and which flat rate product qualified.

If the USPS Entry Point is Commercial Base, the lowest-price option for Priority Mail will be selected from among the weight-based calculated rate, the retail flat rate boxes, and the commercial base flat rate boxes.

Valid values are:

FEDEX:

• PKG (packages)

USPS:

• PKG (packages)
• ENV (envelopes)
• ALL (both packages & envelopes will be considered for qualification, including, if the entry point indicates eligibility, regional boxes)

Additional information:

USPS Flat Rate Boxes
USPS Flat Rate Envelopes
FEDEX Flat Rate Packages

(Optional, and utilized for USPS & FEDEX only)

Code

X

xs:string

10

1.0

Attribute value indicating the carrier service code (see Appendix B).

PkgMaxWeight

X

xs:decimal

3.2

2.1

Sets the maximum weight of the package for the service. When packaging multiple items with PackMethod = "T", this value, if present, will be used instead of the service's maximum weight as established by the carrier. (The weight must be less than the carrier's maximum weight for the service, or it will be ignored.)  If packaging a single item with a weight exceeding this value, this value is ignored.

(Optional)

PkgMaxLength

X

xs:decimal

4.2

2.3

Sets the maximum length of the package for the service (the three dimensions are interchangeable). When packaging multiple items with PackMethod = "T", this value, if present, will be used to calculate total box volume for this service, and if this calculated volume is less than the maximum service volume established by the carrier, it will be used to determine volume splits.Splits will also occur if any item dimension exceeds the largest package dimension, or if the sum of the smallest dimension for each item exceeds the largest package dimension. If packaging a single item with a dimension exceeding this value, this value is ignored.

(Optional)

PkgMaxWidth

X

xs:decimal

4.2

2.3

Sets the maximum width of the package for the service (the three dimensions are interchangeable). When packaging multiple items with PackMethod = "T", this value, if present, will be used to calculate total box volume for this service, and if this calculated volume is less than the maximum service volume established by the carrier, it will be used to determine volume splits. Splits will also occur if any item dimension exceeds the largest package dimension, or if the sum of the smallest dimension for each item exceeds the largest package dimension. If packaging a single item with a dimension exceeding this value, this value is ignored.

(Optional)

PkgMaxHeight

X

xs:decimal

4.2

2.3

Sets the maximum height of the package for the service (the three dimensions are interchangeable). When packaging multiple items with PackMethod = "T", this value, if present, will be used to calculate total box volume for this service, and if this calculated volume is less than the maximum service volume established by the carrier, it will be used to determine volume splits.Splits will also occur if any item dimension exceeds the largest package dimension, or if the sum of the smallest dimension for each item exceeds the largest package dimension.  If packaging a single item with a dimension exceeding this value, this value is ignored.

(Optional)

OnDemand

X

xs:boolean

5

2.0

Restrict our shipping engine to only calculating shipping rates for this service if all of the items in a given package are flagged to indicate that they qualify for this service. (This is especially useful for content-restricted services such as  USPS Media Mail; also used if shipping from different origins, each of which supports different carrier services.)

(Optional, default=false)

ResidentialDelivery

X

X

xs:boolean

5

1.0

Set to true if the delivery address is going to a residential address. Most carriers charge additional fees for delivering to residential addresses. Possible values: true/false

(Optional, default=true)

CountryCode

X

X

xs:string

2

1.0

The country code to where the shipment will be delivered. For a list of country codes see Appendix F.

PostalCode

X

X

xs:string

11

1.0

The Postal Code to where shipment will be delivered. (Not required for countries that do not use postal codes.)

StateOrProvinceCode

X

X

xs:string

2

1.0

The State or Province Code to where the shipment will be delivered. Only required when destination is to USA or Canada.

RefCode

X

X

xs:string

128

1.0

User-definable item code that is passed thru to the Packaging Detail (Detail Level = 3) of the reply ShipRate schema

(Optional)

Quantity

X

X

xs:integer

8

1.0

Quantity of the item to be packaged.

(optional, default=1)

CalcMethod

X

X

xs:element

2

1.0

This element contains the attribute code that indicates the method that the shipping calculator should use to determine shipping. Each calculation method has its own schema for the appropriate attributes (except free shipping items). The CalcMethod element will contain the appropriate schema as indicated below. Items in the shipment may utilize carrier rates and/or fixed fees (including, for SS calls, fixed fee codes) or offer free shipping. See our Knowledgebase article for the business logic employed when these calculations methods are mixed together.

The "CI" CalcMethod will quote free rates for domestic destinations (relative to the shipping origin address) and carrier rates for international destinations.

Weight

X

X

xs:decimal

5.4

1.0

Weight of item (required)

WeightUOM

X

X

xs:string

3

1.0

Unit of measure associated with the item weight. Possible values include:

• LBS = Pounds
• OZ = Ounces
• KGS = Kilograms

(Optional, default = LBS)

Length

X

X

xs:decimal

6.2

1.0

Length dimension of individual item (the three item dimensions are interchangeable).
(Optional, but dimensions will be utilized only if all three are sent)

Width

X

X

xs:decimal

6.2

1.0

Width dimension of individual item (the three item dimensions are interchangeable).
(Optional, but dimensions will be utilized only if all three are sent)

Height

X

X

xs:decimal

6.2

1.0

Height dimension of individual item (the three item dimensions are interchangeable).
(Optional, but dimensions will be utilized only if all three are sent)

DimUOM

X

X

xs:string

2

1.0

Dimension unit of measure. Possible values include:

• IN = Inches (default)
• CM = Centimeters

LotSize

X

X

xs:integer

6

1.0

Number of units an item breaks into (with each unit typically packed seperately). This property simplifies shipping calculations for a product that consists of multiple units (i.e., four tires). Primarily used with units that are packed separately; when setting Item PackMethod to "S" in conjunction with lot size > 1, each item unit will be packed seperately. When setting lot size > 1, set the weight/dims to those of the item unit rather than the item.

(Optional, default=1)

DeclaredValue

X

X

xs:decimal

6.2

1.0

Insurable value of the item (expected currency is that set in the Currency element).  For XS calls carrier insurance will be calculated based on this value; your inclusion of a nonzero value will result in carrier insurance, if available for the service, being calculated and added to the shipping rate.  For SS calls your configured insurance thresholds and other insurance settings will be utilized to determine if insurance is added. 

For SS calls, this value is also used to determine applicability of any configured Shipping Promotions.

PackMethod

X

X

xs:string

1

1.0

Indicates if this item should be packaged seperately by our packaging engine, or whether it is combinable with other items from the same origin (or origin code, if you are assigning them) that are also flagged as packagable together. Possible values are:

• T = Together with other items
• S = Separately

Important Note: For items that are packaged seperately, item weight and dimensions should be that of the package rather than the item. (For SS calls, any Packaging Weight settngs will be ignored for items packaged seperately.)

X

X

2.0

List of on-demand carrier services to be applied to the package containing this item. See OnDemandServices schema.  All the items in the package must be qualified for the service for it to be rated.

(Optional)

X

X

2.0

List of special services to be applied to the package containing this item. See SpecialServices schema.

(Optional)

OriginCode

X

X

xs:string

20

2.0

This user-defined code either refers to configured origin codes set up in account preferences (SS) or to addresses included in the OriginAddress schema (XS).  Links this item to the origin address defined by the code.  Use OriginCode if the items in your shipment are originating in different ship locations. Can also be used to group items together that are packageable with each other but not with other items.

(Optional)

SuppHandlingFee

X

X

xs:decimal

6.2

2.0

A handling fee that is applied at the item level (expected currency is that set in the Currency element). (For SS calls, this fee will supplement your configured package and/or order level fees.) The fee is applied for each unit of quantity of the item.

(Optional)

SuppHandlingCode

X

xs:string

20

2.0

This user-defined code references configured supplemental item-level handling codes set up in account preferences (SS).

(Optional)  (SS only)

FeeType

X

X

xs:string

1

1.0

Identifies which values are used to calculate the fixed fee. Use either fee1 and fee2 OR FeeCode, but not both. Possible values are:

• F = Fees 1 & 2
• C = Fee Code (SS method only)

Fee1

X

X

xs:decimal

6.2

1.0

Fixed fee applied to first item.
(Expected currency is that set in the Currency element.)

Fee2

X

X

xs:decimal

6.2

1.0

Fixed fee applied to additional fixed fee items or when quantity of the fixed fee item > 1. When there is more than one fixed fee item in package, the largest fee1 is applied first, and then fee2 for the additional items.  If you do not set Fee2, it will default to your Fee1 value.

(Expected currency is that set in the Currency element.)

(Optional, default=Fee1)

FeeCode

X

xs:string

20

2.0

References stored Fixed Fee Codes in the account preferences which allow for greater flexibility of Fixed Fees. Fees can be based on geography and also allows for setting unique fixed fees for each carrier or carrier service.

(Optional)
(SS method only)

OriginCode

X

xs:string

20

2.1

Required if XS API call is submitting multiple origin address schemas; in this case all items, including fixed fee items, need to be linked to one of the origin codes defined in your origin address schemas.

(Optional)
(XS method only)

ODService

X

X

xs:string

10

2.0

Carrier Services code which qualifies this item for a service which has been set to on-demand. All items in the package must be flagged as on-demand for same service for the service to be rated for the package. 

If multiple items are being rated from different ship origins, rating engine will rate all services shared by all resulting packages. If there are no shared services, a "mixed" service rate will be constructed by accruing the cost of the least expensive service supported by each package.

AddlHandling

X

X

xs:boolean

5

2.0

Apply additional handling charges to ship rates of all supporting carriers. Possible values: true/false

AddlHandlingUPS

X

X

xs:boolean

5

2.0

Apply additional handling charges to UPS ship rates. For more info read here. Possible values: true/false

AddlHandlingDHL

X

X

xs:boolean

5

2.0

Apply additional handling charges to DHL ship rates. For more info read here. Possible values: true/false

AddlHandlingFDX

X

X

xs:boolean

5

2.0

Apply additional handling charges to Fedex ship rates. For more info read here. Possible values: true/false

Hazard

X

X

xs:boolean

5

2.0

Indicate that this package qualifies as hazardous content for all carriers. Possible values: true/false

HazardUPS

X

X

xs:boolean

5

2.0

Indicate that this package qualifies as hazardous content for UPS. For more info read here. Possible values: true/false

HazardDHL

X

X

xs:boolean

5

2.0

Indicate that this package qualifies as hazardous content for DHL. For more info read here. Possible values: true/false

HazardFDX

X

X

xs:boolean

5

2.0

Indicate that this package qualifies as hazardous content for Fedex. For more info read here. Possible values: true/false

SignatureReq

X

X

xs:boolean

5

2.0

Apply additional charge for signature required for all supporting carriers. Possible values: true/false

SignatureReqUPS

X

X

xs:boolean

5

2.0

Apply additional charge for signature required for UPS. For more info read here. Possible values: true/false

SignatureReqDHL

X

X

xs:boolean

5

2.0

Apply additional charge for signature required for DHL. For more info read here. Possible values: true/false

SignatureReqFDX

X

X

xs:boolean

5

2.0

Apply additional charge for (indirect) signature required for FedEx. For more info read here. Possible values: true/false

SignatureReqUSP

X

X

xs:boolean

5

2.0

Apply additional charge for signature required for USPS. For more info read here. Possible values: true/false

UPSAdultSignature

X

X

xs:boolean

5

2.0

Apply additional charge for adult signature required for UPS. For more info read here. Possible values: true/false

DHLAdultSignature

X

X

xs:boolean

5

2.0

Apply additional charge for adult signature required for DHL. For more info read here. Possible values: true/false

FDXAdultSignature

X

X

xs:boolean

5

2.0

Apply additional charge for adult signature required for FedEx. For more info read here. Possible values: true/false

DHLPrefSignature

X

X

xs:boolean

5

2.0

Apply additional charge for signature preferred for DHL. For more info read here. Possible values: true/false

FDXDirectSignature

X

X

xs:boolean

5

2.0

Apply additional charge for direct signature required for FedEx. For more info read here. Possible values: true/false

FDXHomeCertain

X

X

xs:boolean

5

2.0

Apply additional charge for home date certain delivery for FedEx Home Delivery (FDXHD) carrier service. For more info read here. Possible values: true/false

FDXHomeEvening

X

X

xs:boolean

5

2.0

Apply additional charge for home evening delivery for FedEx Home Delivery (FDXHD) carrier service. For more info read here. Possible values: true/false

FDXHomeAppmnt

X

X

xs:boolean

5

2.0

Apply additional charge for home appointment delivery for FedEx Home Delivery (FDXHD) carrier service. For more info read here. Possible values: true/false

Pod

X

X

xs:boolean

5

2.0

Apply additional charge for proof of delivery for all supporting carriers. Possible values: true/false

PodUPS

X

X

xs:boolean

5

2.0

Apply additional charge for proof of delivery for UPS. For more info read here. Possible values: true/false

PodDHL

X

X

xs:boolean

5

2.0

Apply additional charge for proof of delivery for DHL. For more info read here. Possible values: true/false

PodFDX

X

X

xs:boolean

5

2.0

Apply additional charge for proof of delivery for FedEx. For more info read here. Possible values: true/false

PodUSP

X

X

xs:boolean

5

2.0

Apply additional charge for proof of delivery for USPS. For more info read here. Possible values: true/false

UPSDelivery

X

X

xs:boolean

5

2.0

Apply additional charge for delivery confirmation for UPS. For more info read here. Possible values: true/false

USPCertified

X

X

xs:boolean

5

2.0

Apply additional charge for certified delivery for USPS. For more info read here. Possible values: true/false

USPRestricted

X

X

xs:boolean

5

2.0

Apply additional charge for restricted delivery for USPS. For more info read here. Possible values: true/false

USPDelivery

X

X

xs:boolean

5

2.0

Apply additional charge for delivery confirmation for USPS. For more info read here. Possible values: true/false

USPReturn

X

X

xs:boolean

5

2.0

Apply additional charge for return receipt for USPS. For more info read here. Possible values: true/false

USPReturnMerchandise

X

X

xs:boolean

5

2.0

Apply additional charge for return receipt for merchandise for USPS. For more info read here. Possible values: true/false

USPRegistered

X

X

xs:boolean

5

2.0

Apply additional charge for registered mail for USPS. For more info read here. Possible values: true/false

IrregularUSP

X

X

xs:boolean

5

2.0

Indicate that this package qualifies for the USPS dimensional weighting discount for irregularly-shaped items. When set to true, must be used in conjunction with PackMethod = "S" to be valid.For more info read here. Possible values: true/false

OriginCode

X

xs:string

20

1.0

Origin Codes provide the functionality to connect each of multiple items in a shipment to different origin addresses. This user-defined code "names"  the addresses included in the OrginAddress schema (XS).  Reference to this defined code at the item level connects each item to a particular origin.  Not needed if you are using a single origin address for your shipment.

Our Packaging Engine will sort all items from unique OriginCodes and package them seperately from items from differing OriginCodes.

(Optional)

CountryCode

X

xs:string

2

1.0

The country code from where the shipment will originate. For a list of country codes see Appendix F.

PostalCode

X

xs:string

11

1.0

The Postal Code from where the shipment will originate.

StateOrProvinceCode

X

xs:string

2

1.0

The State or Province Code from where the shipment will originate. Only required when origination is from USA or Canada.