API Methods

Request Info

Getting Started Guide

API XML Schema

API Appendix

AuctionInc Shipping API

Methods Summary

Ship Rate API Methods

The principal methods provided by the AuctionInc API to compute packaging and comparative shipping rates.

Method

Version

Description

GetItemShipRateSS

2.1

Packages one or more items into the optimal packaging configurations and returns comparative shipping rates. Typically used with shopping cart applications.

The GetItemShipRateSS method relies on shipping preferences that are configured at the AuctionInc website for one seller.

This method is appropriate for applications where the API access key will be representative of only one seller.

GetItemShipRateXS

2.1

The GetItemShipRateXS method is similar to the GetItemShipRateSS method except that the shipping preferences are passed in the XML instead of residing at the AuctionInc website. Some configuration options of the shipping rate engine are not available (see method specification for details), but, as opposed to SS calls, unlimited sellers are supported.

This method is used for applications where the API access key is representative of multiple sellers, each using independent sets of shipping preferences for the shipping calculations.

Utility API Methods

Method	Version	Description
GetTime	1.0	Use GetTime to retrieve the DateTime value from the Paid Shipping API web service. Example: <GetTime version="1.0"> </GetTime>

Methods Detail

GetItemShipRateSS Method

(Single Seller)

The GetItemShipRateSS method is used for a single seller to package one or more items into appropriate packages and calculate shipping rates for each package. The method is used in conjunction with AuctionInc account saved seller preferences. This method supports one seller only (although it does support drop-shipping items from multiple locations for this seller).

Current Version: 2.1 (Version column shows the version at which the element was introduced)

Header Schema

Element Name

Data Type

Max Size

Version

Description

AccountId

xs:string

128

1.0

Your valid AuctionInc API Account ID.

(Required)

Example:

<Header>
   <AccountId>Your valid account ID</AccountId>
</Header>

Request Schema

The GetItemShipRateSS Request schema is the XML that is used in the request message that appears in the Body element.

Element Name	Data Type	Max Size	Version	Description
Version	xs:string	8	1.0	Attribute that indicates the version of the API method that the caller can support. Current method version: 2.1 Currently both method call and response have no deprecated elements. Your inclusion of any elements added in versions later than your indicated supported version will take precedence. This will change at such time when future versions are incompatible with earlier versions.
DetailLevel	xs:string	1	1.0	The Detail Level determines the detail of the rate data returned by AuctionInc. Higher levels include data from lower levels. Level 1: Summary rates per service Level 2: Rate component data per service Level 3: Package detail per service (note: not all carriers support the same details) (Optional, default=1)
Currency	xs:string	3	1.0	The currency that monetary values represent. Currency can be set in any method that contains any monetary attributes in the request or response. (Optional, default=USD, Presently only USD is supported.)
DestinationAddress	DestinationAddress Schema			One DestinationAddress indicating to where the shipment will be delivered. See DestinationAddress Schema (Required)
ItemList	Item Collection			List of one or more Item schemas that represent the items that will be packaged and rated. (Required)

Example of GetItemShipRateSS XML document

<GetItemShipRateSS version="2.1">
     <DetailLevel>1</DetailLevel>
     <Currency>USD</Currency>
     <DestinationAddress>
          <ResidentialDelivery>true</ResidentialDelivery>
          <CountryCode>US</CountryCode>
          <PostalCode>90210</PostalCode>
          <StateOrProvinceCode>CA</StateOrProvinceCode>
     </DestinationAddress>
     <ItemList>
          <Item>
               <RefCode>keyboard-101</RefCode>
               <Quantity>2</Quantity>
               <CalcMethod Code="C">
                    <CarrierCalcProps>
                         <Length>8</Length>
                         <Width>5</Width>
           <Height>2.5</Height>
                         <DimUOM>IN</DimUOM>
                         <Weight>4</Weight>
                         <WeightUOM>LBS</WeightUOM>
                         <DeclaredValue>59.95</DeclaredValue>
                         <PackMethod>T</PackMethod>
                    </CarrierCalcProps>
               </CalcMethod>
          </Item>
          <Item>
               <RefCode>monitor-vga</RefCode>
               <Quantity>1</Quantity>
               <CalcMethod Code="C">
                    <CarrierCalcProps>
                         <Length>6</Length>
                         <Width>4</Width>
           <Height>3</Height>
                         <DimUOM>IN</DimUOM>
                         <Weight>2.5</Weight>
                         <WeightUOM>LBS</WeightUOM>
                         <DeclaredValue>18.50</DeclaredValue>
                         <PackMethod>T</PackMethod>
                         <OriginCode>FL-WHS</OriginCode>
                    </CarrierCalcProps>
               </CalcMethod>
          </Item>
     </ItemList>
</GetItemShipRateSS>

GetItemShipRateXS Method

(Unlimited Sellers)

The GetItemShipRateXS method supports multiple sellers for packaging one or more items into appropriate packages and calculating shipping rates for each package. The method is similar to the GetItemShipRateSS method except instead of using the saved shipping preferences of a single seller, the seller shipping preferences are provided in the XML of the call. This difference allows the XS call to support unlimited sellers. The ShipRateXS Method is appropriate for cart integrators and other projects where multiple sellers are involved.

Current Version: 2.1 (Version column shows the version at which the element was introduced)

GetItemShipRateXS calls do not support some features which are only available thru the AuctionInc saved seller preferences (and thus through GetItemShipRateSS calls) as indicated in the following list. These are primarily features which involve a simple modification of the shiprates returned by AuctionInc; the integrator may elect to support some of these, such as the additon of a handling charge, directly thru collection and application of the appropriate setting to the calculated rates.

Not Calculated Through XS Calls

Shipping Rate Discount Promotions
Packaging Weight Factoring
Insurance Thresholds
Handling Fees
Supplemental Handling Fee Codes
Fixed Fee Codes

Header Schema

Element Name

Data Type

Max Size

Version

Description

AccountId

xs:string

128

1.0

Your valid AuctionInc API Account ID.

(Required)

RefCode

xs:string

2.1

Reference code you can use for tracking customer usage or other call categories. Our API Statistics report allows grouping by this value.

(Optional)

Example:

<Header>
   <AccountId>Your valid account ID</AccountId>
   <RefCode>1234</RefCode>
</Header>

Request Schema

The GetItemShipRateXS Request schema is the XML that is used in the request message that appears in the Body element.

Element Name	Data Type	Max Size	Version	Description
Version	xs:string	8	1.0	Attribute that indicates the version of the API method that the caller can support. Current method version: 2.1 Currently both method call and response have no deprecated elements. Your inclusion of any elements added in versions later than your indicated supported version will take precedence. This will change at such time when future versions are incompatible with earlier versions.
DetailLevel	xs:string	1	1.0	The Detail Level determines the detail of the rate data returned by AuctionInc. Higher levels include data from lower levels. Level 1: Summary rates per service Level 2: Rate component data per service Level 3: Package detail per service (note: not all carriers support the same details) (Optional, default=1)
Currency	xs:string	3	1.0	The currency that monetary values represent. Currency can be set in any method that contains any monetary attributes in the request or response. (Optional, default=USD, Presently only USD is supported.)
CarrierList	Carrier schema			List of one or more Carrier schema that details the carrier and services to be rated. (Required)
OriginAddressList	Origin Address Collection			The address(es) that the item(s) in the shipment are originating from. (Required)
DestinationAddress	Destination Address Collection			The address to which the the shipment is to be delivered. (Required)
ItemList	Item Collection			List of one or more Item schemas that represent the items that will be packaged and rated. (Required)

Example of GetItemShipRateXS XML document

  <GetItemShipRateXS version="2.1">
    <Currency>USD</Currency>
    <CarrierList>
         <Carrier code="UPS">
              <EntryPoint>D</EntryPoint>
              <ServiceList>
                   <Service code="UPSGND">
                        <PkgMaxWeight>45</PkgMaxWeight>
                   </Service>
                   <Service code="UPSNDA">
                        <PkgMaxWeight>45</PkgMaxWeight>
                   </Service>
             </ServiceList>
         </Carrier>
         <Carrier code="DHL">
              <EntryPoint>P</EntryPoint>
              <AccessKey>12345678</AccessKey>
              <PostalCode>01610</PostalCode>
              <ServiceList>
                   <Service code="DHLGND" />
                   <Service code="DHLNDA" />
              </ServiceList>
         </Carrier>
         <Carrier code="USPS">
              <EntryPoint></EntryPoint>
              <FlatRatePackaging>PKG</FlatRatePackaging>
              <ServiceList>
                   <Service code="USPPM" />
                   <Service code="USPMM">
                      <OnDemand>true</OnDemand>
                   </Service>
              </ServiceList>
         </Carrier>
    </CarrierList>
    <OriginAddressList>
         <OriginAddress>
              <OriginCode></OriginCode>
              <CountryCode>US</CountryCode>
              <PostalCode>01610</PostalCode>
              <StateOrProvinceCode>MA</StateOrProvinceCode>
         </OriginAddress>
         <OriginAddress>
             <OriginCode>CA-WHS</OriginCode>
             <CountryCode>US</CountryCode>
             <PostalCode>90210</PostalCode>
             <StateOrProvinceCode>CA</StateOrProvinceCode>
        </OriginAddress>
    </OriginAddressList>
    <DestinationAddress>
        <ResidentialDelivery>true</ResidentialDelivery>
         <CountryCode>US</CountryCode>
         <PostalCode>90210</PostalCode>
         <StateOrProvinceCode>CA</StateOrProvinceCode >
    </DestinationAddress>
    <ItemList>
         <Item>
              <RefCode>keyboard-101</RefCode>
              <Quantity>2</Quantity>
              <CalcMethod code="C">
                   <CarrierCalcProps>
                        <Length>2</Length>
                        <Width>10</Width>
                        <Height>2.5</Height>
                        <DimUOM>IN</DimUOM>
                        <Weight>4</Weight>
                        <WeightUOM>LBS</WeightUOM>
                        <DeclaredValue>59.95</DeclaredValue>
                        <PackMethod>T</PackMethod>
                   </CarrierCalcProps>
              </CalcMethod>
         </Item>
         <Item>
              <RefCode>mouse</RefCode>
              <Quantity>1</Quantity>
              <CalcMethod code="C">
                   <CarrierCalcProps>
                        <Length>2</Length>
                        <Width>2</Width>
                        <Height>2.5</Height>
                        <DimUOM>IN</DimUOM>
                        <Weight>.5</Weight>
                        <WeightUOM>LBS</WeightUOM>
                        <DeclaredValue>29.95</DeclaredValue>
                        <PackMethod>T</PackMethod>
                        <OriginCode>CA-WHS</OriginCode>
                   </CarrierCalcProps>
              </CalcMethod>
         </Item>
    </ItemList>
</GetItemShipRateXS>

GetItemShipRate (SS & XS) Response Schema

Element Name	Data Type	Max Size	Version	Description
Currency	xs:string	3	1.0	Currency associated to the monetary elements in the results.
ErrorList	Error Collection			The presence of this element indicates that the API call failed and will contain one or more Error Schema datasets that identify the cause of the error(s). See Appendix A.
ShipRateList	ShipRate Collection			A collection of ShipRate elements that represent each carrier service that was rated by method.

Example of ErrorList Response

<ErrorList>
   <Error>
      <Code>111</Code>
      <Message>Inadequate destination address information for rating</Message>
      <Severity>CRITICAL</Severity>
</Error>
</ErrorList>

Example of ShipRateList Response (Detail Level = 1)

<ItemShipRate>
     <Currency>USD</Currency>
     <ShipRateList>
          <ShipRate>
               <Valid>true</Valid>
               <CarrierCode>USPS</CarrierCode>
               <ServiceCode>USPSPM</ServiceCode>
               <ServiceName>PriorityMail</ServiceName>
               <CalcMethod>C</CalcMethod>
               <Rate>48.26</Rate>
          </ShipRate>
          <ShipRate>
               <Valid>true</Valid>
               <CarrierCode>UPS</CarrierCode>
               <ServiceCode>UPSGND</ServiceCode>
               <ServiceName>Ground</ServiceName>
               <CalcMethod>C</CalcMethod>
               <Rate>31.21</Rate>
          </ShipRate>
          <ShipRate>
               <Valid>true</Valid>
               <CarrierCode>USPS</CarrierCode>
               <ServiceCode>USPSPP</ServiceCode>
               <ServiceName>ParcelPost</ServiceName>
               <CalcMethod>C</CalcMethod>
               <Rate>20.21</Rate>         
          </ShipRate>
     </ShipRateList>
</ItemShipRate>


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

AuctionInc Shipping APIMethods Summary

Ship Rate API Methods

Utility API Methods

Methods Detail

GetItemShipRateSS Method

Header Schema

Request Schema

GetItemShipRateXS Method

Header Schema

Request Schema

GetItemShipRate (SS & XS) Response Schema

AuctionInc Shipping API

Methods Summary