Request Info

AuctionInc Shipping Rates API

XML Schema

This document details theXML schema used by the AuctfionInc Shipping Rates API. Theses schemas are combined in composite schemas that make up the dataset necessary for each method, detailed in the Methods document.

Various methods in the API can optionally utilize predefined configuration settings referred to as Saved Settings. These values are managed through the AuctionInc web site in the Settings menu. These preferences provide sophisticated and flexible options for the shipping and packaging methods. The documentation indicates when these preferences are required with an [SS] notation.

Carrier Schema

The Carrier schema appears in the request XML of the XS method to indicate which carrier services should be rated.

Element Name	Data Type	Max Size	Description
Code	xs:string	10	Attribute value indicating the carrier code (see Appendix C).
EntryPoint	xs:string	2	The entry point indicates the method used to deliver the packages to the carrier. (see Appendix E)
ServiceList	Service Schemas Collection		List of the carrier services to be rated (see Appendix D).
AccessKey	xs:string	20	Your DHL account ID (to access their web service API). (Required for DHL only)
PostalCode	xs:string	5	The account postal code to utilize the DHL web service. This is required by DHL. (Required for DHL only)

Carrier Schema Example:

<CarrierList>
     <Carrier code="UPS">
          <EntryPoint>D</EntryPoint>
          <ServiceList>
               <Service code="UPSGND" />
               <Service code="UPSNDA" />
          </ServiceList>
     </Carrier>
     <Carrier code="DHL">
          <EntryPoint>P</EntryPoint>
          <AccessKey>12345678</AccessKey>
          <PostalCode>01610</PostalCode>
          <ServiceList>
               <Service code="DHLGND" />
               <Service code="DHL2D" />
          </ServiceList>
     </Carrier>
     <Carrier code="USPS">
          <EntryPoint></EntryPoint>
          <ServiceList>
               <Service code="USPPM" />
               <Service code="USPMM">
                    <OnDemand>true</OnDemand>
               </Service>
          </ServiceList>     
     </Carrier>
</CarrierList>

Service Schema

The Service schema appears as a sub-element within the Carrier schema in the request XML of the XS method to indicate
which carrier services should be rated in the call.

Element Name

Data Type

Max Size

Description

Code

xs:string

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

OnDemand

xs:boolean

Controls if the engine will only calculate shipping rates for the service if all of the items indicate that they qualify for the service (i.e., especially useful for content-restricted services such as USPS Media Mail).

(Optional, default=false)

Service Schema Example:

<ServiceList> <Service code="USPMM"> <OnDemand>true</OnDemand> </Service> <Service code="USPPM" /> </ServiceList>

DestinationAddress Schema

The DestinationAddress represents the geographic destination location for the shipment.

Element Name	Data Type	Max Size	Description
ResidentialDelivery	xs:boolean	5	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	xs:string	2	The country code from where the shipment will originate. For a list of country codes see Appendix F.
PostalCode	xs:string	11	The Postal Code from where the shipment will originate.
StateOrProvinceCode	xs:string	2	The State or Province Code from where the shipment will originate. Only required when origination is from USA or Canada.

Destination Address Example:

<DestinationAddress> <ResidentialDelivery>true</ResidentialDelivery> <CountryCode>US</CountryCode> <PostalCode>90210</PostalCode> <StateOrProvinceCode>CA</StateOrProvinceCode> </DestinationAddress>

Item Schema

The Item schema is used in various request schemas and represents an object with physical, monetary, and shipping characteristics.

Element Name

Data Type

Max Size

Description

Quantity

xs:integer

Quantity of the item to be packaged. (optional, default=1)

CalcMethod

xs:element

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 to for the appropriate attributes. The CalcMethod element will contain the appropriate schema as indicated below: All items in a shipment must exclusively use carrier rates or fixed fees.

Code	Calc Method	Schema
C	Carrier Rates	CarrierCalcProps
F	Fixed Fee	FixedCalcProps

Item Schema Example:

<Item> <RefCode>keyboard-101-e</RefCode> <Quantity>2</Quantity> <CalcMethod Code="C"> <CarrierCalcProps> ... </CarrierCalcProps> </CalcMethod> </Item>

CarrierCalcProps Schema

The CarrierCalcProps schema to represent various characteristics of an item relevant to a Carrier Calculation Method.

Element Name	Data Type	Max Size	Description
Weight	xs:decimal	5.4	Weight of item (required)
WeightUOM	xs:string	3	Unit of measure associated with the item weight. Possible values include: LBS = Pounds OZ = Ounces KGS = Kilograms (Optional, default = LBS)
Length	xs:decimal	6.2	Length dimension of individual item (Optional)
Width	xs:decimal	6.2	Width dimension of individual item or diameter of a tube (optional)
Height	xs:decimal	6.2	Height dimension of individual item (optional) Leave empty if item is a tube
DimUOM	xs:string	2	Dimension unit of measure. Possible values include: IN = Inches (default) CM = Centimeters
LotSize	xs:integer	6	Number of units an item consists of to be packaged. This property provides the ability to calculate shipping for a product that consists of multiple units (i.e. 4 tires). The property is primarily used with items that are packed separately. (Optional, default=1)
DeclaredValue	xs:decimal	6.2	Insurable value of the item. In XS calls carrier insurance will be calculated based on this value. In SS calls your configured insurance thresholds will be utilized.
PackMethod	xs:string	1	Indicates the way the packaging engine is to combine items into a container. Possible values are: T = Together with other items S = Separately Note: The dimensions and weight of items that are packaged separately should be indicative of the container that the item will be packaged in.
OnDemandServices	OnDemandServices Element		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)
SpecialServices	SpecialServices Element		List of special services to be applied to the package containing this item. See SpecialServices schema. (Optional)
OriginCode	xs:string	20	This user-defined code either refers to configured origin codes set up in account preferences (SS) or to addresses included in the OrginAddress schema (XS). Links this item to the origin address defined by the code. (Optional)
SuppHandlingFee	xs:decimal	6.2	A handling fee that is applied to each item. If you have stored handling preferences (SS), this fee will supplement your configured package and/or order level fees. (Optional)
SuppHandlingCode	xs:string	20	This user-defined code references configured supplemental item-level handling codes set up in account preferences (SS). (Optional) (SS only)

CarrierCalcProps Schema Example:

<CarrierCalcProps> <Weight>2.5</Weight> <WeightUOM>LBS</WeightUOM> <Length>6</Length> <Width>4</Width> <Height>3</Height> <DimUOM>IN</DimUOM> <LotSize>2</LotSize> <DeclaredValue>18.50</DeclaredValue> <PackMethod>T</PackMethod> <SpecialServices> ... </SpecialServices> <OriginCode>CA-WHS</OriginCode> <SuppHandlingFee>10</SuppHandlingFee></CarrierCalcProps>

FixedCalcProps Schema

The FixedCalcProps schema represent various characteristics of an item relevant to a Fixed Calculation Method.
Note: The Shipping API does not suport mixing CarrierCalcProp items and FixedCalcProp items in the same shipment
at this time.

Element Name	Data Type	Max Size	Description
FeeType	xs:string	1	Indentifies which values are used to calculate 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	xs:decimal	6.2	Fixed fee applied to first item.
Fee2	xs:decimal	6.2	Fixed fee applied to additional items or when quantity of item exceeds one (1). (Optional, default=0)
FeeCode	xs:string	20	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 allowsfor setting unique fixed fees for each carrier or carrier service. (Optional) (SS method only)

FixedCalcProps Schema Example:

<FixedCalcProps> <FeeType>F</FeeType> <Fee1>3.00</Fee1> <Fee2>2.50</Fee2></FixedCalcProps>

OR

<FixedCalcProps> <FeeType>C</FeeType> <FeeCode>PictureFee</FeeCode></FixedCalcProps>

OnDemandServices Schema

On Demand Services qualify an item to be rated for the indicated on-demand carrier service.

Element Name	Data Type	Max Size	Description
ODService	xs:string	5	Carrier Services code which enables rating for this item of a service set to on-demand

OnDemandServices Schema Example:

<OnDemandServices> <ODService>USPMM</ODService> <ODService>USPBPM</ODService> </OnDemandServices>

SpecialServices Schema

Special services apply additional fees onto packages to account for extra services provided by the carrier, such as P.O.D., additonal handling,
or hazardous package handling.

Element Name	Data Type	Max Size	Description
AddlHandling	xs:boolean	5	Apply additional handling charges to ship rates of supporting carriers. Possible values: true/false
AddlHandlingUPS	xs:boolean	5	Apply additional handling charges to UPS ship rates. For more info read here. Possible values: true/false
AddlHandlingDHL	xs:boolean	5	Apply additional handling charges to DHL ship rates. For more info read here. Possible values: true/false
AddlHandlingFDX	xs:boolean	5	Apply additional handling charges to Fedex ship rates. For more info read here. Possible values: true/false
Hazard	xs:boolean	5	Indicate that this package qualifies as hazardous content for all carriers. Possible values: true/false
HazardUPS	xs:boolean	5	Indicate that this package qualifies as hazardous content for UPS. For more info read here. Possible values: true/false
HazardDHL	xs:boolean	5	Indicate that this package qualifies as hazardous content for DHL. For more info read here. Possible values: true/false
HazardFDX	xs:boolean	5	Indicate that this package qualifies as hazardous content for Fedex. For more info read here. Possible values: true/false
SignatureReq	xs:boolean	5	Apply additional charge for signature required for all supporting carriers. Possible values: true/false
SignatureReqUPS	xs:boolean	5	Apply additional charge for signature required for UPS. For more info read here. Possible values: true/false
SignatureReqDHL	xs:boolean	5	Apply additional charge for signature required for DHL. For more info read here. Possible values: true/false
SignatureReqFDX	xs:boolean	5	Apply additional charge for (indirect) signature required for FedEx. For more info read here. Possible values: true/false
SignatureReqUSP	xs:boolean	5	Apply additional charge for signature required for USPS. For more info read here. Possible values: true/false
UPSAdultSignature	xs:boolean	5	Apply additional charge for adult signature required for UPS. For more info read here. Possible values: true/false
DHLAdultSignature	xs:boolean	5	Apply additional charge for adult signature required for DHL. For more info read here. Possible values: true/false
FDXAdultSignature	xs:boolean	5	Apply additional charge for adult signature required for FedEx. For more info read here. Possible values: true/false
DHLPrefSignature	xs:boolean	5	Apply additional charge for signature preferred for DHL. For more info read here. Possible values: true/false
FDXDirectSignature	xs:boolean	5	Apply additional charge for direct signature required for FedEx. For more info read here. Possible values: true/false
FDXHomeCertain	xs:boolean	5	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	xs:boolean	5	Apply additional charge for home evening delivery for FedEx Home Delivery (FDXHD) carrier service. For more info read here. Possible values: true/false
FDXHomeAppmnt	xs:boolean	5	Apply additional charge for home appointment delivery for FedEx Home Delivery (FDXHD) carrier service. For more info read here. Possible values: true/false
Pod	xs:boolean	5	Apply additional charge for proof of delivery for all supporting carriers. Possible values: true/false
PodUPS	xs:boolean	5	Apply additional charge for peoof of delivery for UPS. For more info read here. Possible values: true/false
PodDHL	xs:boolean	5	Apply additional charge for proof of delivery for DHL. For more info read here. Possible values: true/false
PodFDX	xs:boolean	5	Apply additional charge for proof of delivery for FedEx. For more info read here. Possible values: true/false
PodUSP	xs:boolean	5	Apply additional charge for proof of delivery for USPS. For more info read here. Possible values: true/false
UPSDelivery	xs:boolean	5	Apply additional charge for delivery confirmation for UPS. For more info read here. Possible values: true/false
USPCertified	xs:boolean	5	Apply additional charge for certified delivery for USPS. For more info read here. Possible values: true/false
USPRestricted	xs:boolean	5	Apply additional charge for restricted delivery for USPS. For more info read here. Possible values: true/false
USPDelivery	xs:boolean	5	Apply additional charge for delivery confirmation for USPS. For more info read here. Possible values: true/false
USPReturn	xs:boolean	5	Apply additional charge for return receipt for USPS. For more info read here. Possible values: true/false
USPReturnMerchandise	xs:boolean	5	Apply additional charge for return receipt for merchandise for USPS. For more info read here. Possible values: true/false
USPRegistered	xs:boolean	5	Apply additional charge for registered mail for USPS. For more info read here. Possible values: true/false
IrregularUSP	xs:boolean	5	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

SpecialServices Schema Example:

<SpecialServices> <AddlHandlingUPS>true</AddlHandlingUPS> <AddlHandlingFDX>true</AddlHandlingFDX> <Hazard>true</Hazard></SpecialServices>

OriginAddress Schema

The OriginAddress represents the address location from which the shipment will originate from (XS calls). Multiple OriginAddresses
may be included.

Element Name	Data Type	Max Size	Description
OriginCode	xs:string	20	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. (Optional)
CountryCode	xs:string	2	The country code from where the shipment will originate. For a list of country codes see Appendix F.
PostalCode	xs:string	11	The Postal Code from where the shipment will originate.
StateOrProvinceCode	xs:string	2	The State or Province Code from where the shipment will originate. Only required when origination is from USA or Canada.

OriginAddress Schema Example:

<OriginAddress> <OriginCode>CA-WHS</OriginCode> <CountryCode>US</CountryCode> <PostalCode>90210</PostalCode> <StateOrProvinceCode>CA</StateOrProvinceCode> </OriginAddress>

ShipRate Schema

A ShipRate schema appears in the response of the rating methods and represents the rate and breakdown of how the rate
was determined for a single carrier service.

Element Name	Data Type	Max Size	Detail Level	Description
Valid	xs:string	5	1	Indicates if rate engine was successful in computing the shipping rate of the carrier service. Possible values: true/false
CarrierCode	xs:string	10	1	Rated Carrier Code. (see Appendix C).
ServiceCode	xs:string	10	1	Rated Carrier Service Code. (see Appendix D).
ServiceName	xs:string	30	1	Rated Carrier Service Name. (see Appendix D)
CalcMethod	xs:string	1	1	Method that the shipping calculator used determine rate for this carrier service. Possible values are: C (calulated) F (fixed) PU (pickup at seller's location)
Rate	xs:decimal	6.2	1	Total rate for this carrier service for all packages in shipment.
CarrierRate	xs:decimal	6.2	2	Aggregate of the base rates returned from carrier APIs for all packages in shipment.
Surcharges	xs:decimal	6.2	2	Aggregate of the surcharges for all packages in shipment.
FuelSurcharges	xs:decimal	6.2	2	Aggregate of the fuel surcharges for all packages in shipment (not all carriers report this seperately from surcharges).
HandlingFees	xs:decimal	6.2	2	Aggregate of the handling fees calculated for all packages in shipment
DeclaredValue	xs:decimal	6.2	2	Aggregate of the value for all items in shipment
InsuranceCharges	xs:decimal	6.2	2	Aggregate of the insurance calculated for all packages in shipment
Weight	xs:decimal	6.2	2	Total weight for all packages in shipment
PackageCount	xs:integer	3	2	Number of packages constructed by AuctionInc shipping engine

ShipRate Example (Detail Level = 2)

<ItemShipRate>
    <Currency>USD</Currency>
    <ShipRateList>
       <ShipRate>
         <Valid>true</Valid>
         <CarrierCode>USPS</CarrierCode>
         <ServiceCode>USPPP</ServiceCode>
         <ServiceName>USPS Parcel Post</ServiceName>
         <CalcMethod>C</CalcMethod>
         <Rate>6.84</Rate>
         <CarrierRate>5.19</CarrierRate>
         <Surcharges>0.00</Surcharges>
         <FuelSurcharges>0.00</FuelSurcharges>
         <HandlingFees>0.00</HandlingFees>
         <DeclaredValue>19.95</DeclaredValue>
         <InsuranceCharges>1.65</InsuranceCharges>
         <Weight>10.00</Weight>
         <PackageCount>1</PackageCount>
      </ShipRate>
      <ShipRate>
         <Valid>true</Valid>
         <CarrierCode>UPS</CarrierCode>
         <ServiceCode>UPSGND</ServiceCode>
         <ServiceName>UPS Ground</ServiceName>
         <CalcMethod>C</CalcMethod>
         <Rate>11.30</Rate>
         <CarrierRate>10.81</CarrierRate>
         <Surcharges>0.00</Surcharges>
         <FuelSurcharges>0.49</FuelSurcharges>
         <HandlingFees>0.00</HandlingFees>
         <DeclaredValue>19.95</DeclaredValue>
         <InsuranceCharges>0.00</InsuranceCharges>
         <Weight>10.00</Weight>
         <PackageCount>1</PackageCount>
      </ShipRate>
      <ShipRate>
         <Valid>true</Valid>
         <CarrierCode>UPS</CarrierCode>
         <ServiceCode>UPS2ND</ServiceCode>
         <ServiceName>UPS 2 Day</ServiceName>
         <CalcMethod>C</CalcMethod>
         <Rate>27.47</Rate>
         <CarrierRate>24.20</CarrierRate>
         <Surcharges>0.00</Surcharges>
         <FuelSurcharges>3.27</FuelSurcharges>
         <HandlingFees>0.00</HandlingFees>
         <DeclaredValue>19.95</DeclaredValue>
         <InsuranceCharges>0.00</InsuranceCharges>
         <Weight>10.00</Weight>
         <PackageCount>1</PackageCount>
      </ShipRate>
   </ShipRateList>
</ItemShipRate>

Error Schema

The Error Schema contains error, warning or notice information that may be generated during a method call. The Error node
can appear in the reply (root) level which would indicate a failed API call or at a sub-node level indicating a failure for individual services.
Error schema appear only in response schemas.

Element Name	Data Type	Max Size	Description
Code	xs:string	1	Identifies the error that occurred. See Appendix A for error details.
Message	xs:string	64	Contains descriptive error message pertaining to the error code.
Detail	xs:string	64	One or more optional elements containing descriptive detail pertaining to the error message.
Severity	xs:string	10	Indicates the severity of the error. Possible values are: NOTICE = a non-fatal issue that may be appropriate to address. WARNING = A non-fatal error that may indicate a problem with configuration settings or missing data. CRITICAL = A fatal error that could not be handled and must be corrected.

Error Schema Example:

<Error> <Code>510</Code> <Message> Packaging Engine unable to determine any services to be rated </Message> <Detail>USPPM:Item weight exceeds limit</Detail> <Detail>USPPP:Item weight exceeds limit</Detail> <Severity>CRITICAL</Severity> </Error>


	Home \| About Us \| Contact Us \| Partnerships \| User Agreement \| Privacy Policy

AuctionInc Shipping Rates APIXML Schema