![]() |
![]() |
![]() |
![]() |
|
| |
|
|
|
|
|
|
API Methods SummaryRating API Methods SummaryThe principal methods provided by the AuctionInc API to compute packaging and comparative shipping rates.
|
|
Method |
Version |
Description |
|---|---|---|
|
GetTime |
2.0 |
Use GetTime to retrieve the DateTime value from the Paid Shipping API web service. |
The GetItemShipRateSS method is used to package one or more items into appropriate packages and calculate shipping rates for each package.
The method is used in conjunction with saved account preferences, which provides for the greatest functionality and flexibility.
Current Version: 2.0
The GetItemShipRateSS Request schema is the XML that is used in the request message that appears in the Request Body element.
|
Element Name |
Data Type |
Max Size |
Description |
|---|---|---|---|
|
Version |
xs:string |
8 |
Attribute that indicates the version of the API method that the caller can support. |
|
DetailLevel |
xs:string |
1 |
The Detail Level determines the detail of the data returned. Two levels are currently supported: (Optional, default=1) |
|
Currency |
xs:string |
3 |
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 |
|
One DestinationAddress indicating where the order will be delivered to. 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.0">
<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>
The GetItemShipRateXS method is used to package one or more items into appropriate packages and calculate shipping rates for each package.
The method is similar to the GetItemShipRateSS method except instead of using saved shipping preferences, the shipping preferences are provided in the XML of the call.
Current Version: 2.0
The GetItemShipRateXS call returns rates which do not include some features which are only available thru the AuctionInc saved preferences
(and thus available through GetItemShipRateSS calls) as indicated in the following list.
Not Calculated Through XS Calls
The GetItemShipRateXS Request schema is the XML that is used in the request message that appears in the Request Body element.
|
Element Name |
Data Type |
Max Size |
Description |
|---|---|---|---|
|
Version |
xs:string |
8 |
Attribute that indicates the version of the API method that the caller can support. |
|
DetailLevel |
xs:string |
1 |
The Detail Level determines the detail of the data returned. Two levels are currently supported: (Optional, default=1) |
|
Currency |
xs:string |
3 |
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 |
|
List of one or more Carrier schema that details the carrier and services to be rated. (Required) | |
|
OriginAddressList |
|
The address(es) that the item(s) in the shipment are originating from. | |
|
DestinationAddress |
|
The address that the shipment is to be delivered to. | |
|
ItemList |
|
|
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.0">
<Currency>USD</Currency>
<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="DHLNDA" />
</ServiceList>
</Carrier>
<Carrier code="USPS">
<EntryPoint></EntryPoint>
<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>
|
Element Name |
Data Type |
Max Size |
Description |
|---|---|---|---|
|
Currency |
xs:string |
3 |
Currency associated to the monetary elements in the results. |
|
ErrorList |
|
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 |
|
A collection of ShipRate elements that represent each carrier service that was rated by method. |
Example of ErrorList XML Document
<ErrorList>
<Error>
<Code>111</Code>
<Message>Inadequate destination address information for rating</Message>
<Severity>CRITICAL</Severity>
</Error>
</ErrorList>
Example of ItemShipRate XML document (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 | ||
|
Copyright © 2008 AuctionInc. A division of Paid, Inc. Paid Inc. 4 Brussels St, Worcester, MA 01610. 1-866-323-8833. |