Find the answer to your question
Advanced Search
How can I get the description of a ShippingService or PaymentOption?
Summary
You can use GeteBayDetails to get the following informatioin used by eBay:
- Country
- Currency
- Payment Methods
- Regions
- Shipping Locations
- Shipping Services
- Site
- Tax Jurisdication
- URL Details
The call is Site dependent. Ensure that you set the SiteID correctly in the header if you use Schema XML or at the Call level if you use SOAP / SDK, otherwise it will default to SiteID 0 and you will get the information for US.
Detailed Description
Here is a sample GeteBayDetails request to find out the Shipping Services and Payment Option details for SiteID 0. GeteBayDetails takes an optional parameter to specify the DetailName(s) for which you need the information. This request uses the DetailName for Shipping Services and Payment Options:
<?xml version="1.0" encoding="utf-8"?>
<GeteBayDetailsRequest xmlns="urn:ebay:apis:eBLBaseComponents">
<RequesterCredentials>
<eBayAuthToken>*****</eBayAuthToken>
</RequesterCredentials>
<ErrorLanguage>en_US</ErrorLanguage>
<WarningLevel>High</WarningLevel>
<DetailName>PaymentOptionDetails</DetailName>
<DetailName>ShippingServiceDetails</DetailName>
<!--Ensure that site ID, in the Header, is set to the site you want-->
</GeteBayDetailsRequest>
Response:
<?xml version="1.0" encoding="UTF-8"?>
<GeteBayDetailsResponse
xmlns="urn:ebay:apis:eBLBaseComponents">
<Timestamp>2022-07-29T15:42:33.017Z</Timestamp>
<Ack>Success</Ack>
<Version>1201</Version>
<Build>E1201_CORE_API6_19110890_R1</Build>
<PaymentOptionDetails>
<PaymentOption>MOCC</PaymentOption>
<Description>Money order / Cashier's check</Description>
<DetailVersion>3</DetailVersion>
<UpdateTime>2010-06-11T06:51:58.000Z</UpdateTime>
</PaymentOptionDetails>
<PaymentOptionDetails>
<PaymentOption>PersonalCheck</PaymentOption>
<Description>Personal check</Description>
<DetailVersion>3</DetailVersion>
<UpdateTime>2010-06-11T06:51:58.000Z</UpdateTime>
</PaymentOptionDetails>
<PaymentOptionDetails>
<PaymentOption>VisaMC</PaymentOption>
<Description>Visa or Master Card</Description>
<DetailVersion>3</DetailVersion>
<UpdateTime>2010-06-11T06:51:58.000Z</UpdateTime>
</PaymentOptionDetails>
<PaymentOptionDetails>
<PaymentOption>AmEx</PaymentOption>
<Description>American Express</Description>
<DetailVersion>3</DetailVersion>
<UpdateTime>2010-06-11T06:51:58.000Z</UpdateTime>
</PaymentOptionDetails>
<PaymentOptionDetails>
<PaymentOption>Discover</PaymentOption>
<Description>Discover Card</Description>
<DetailVersion>3</DetailVersion>
<UpdateTime>2010-06-11T06:51:58.000Z</UpdateTime>
</PaymentOptionDetails>
<PaymentOptionDetails>
<PaymentOption>PaymentSeeDescription</PaymentOption>
<Description>Other - See item description</Description>
<DetailVersion>3</DetailVersion>
<UpdateTime>2010-06-11T06:51:58.000Z</UpdateTime>
<PaymentOption>PayPal</PaymentOption>
<Description>PayPal</Description>
<DetailVersion>3</DetailVersion>
<UpdateTime>2010-06-11T06:51:58.000Z</UpdateTime>
</PaymentOptionDetails>
<PaymentOptionDetails>
<PaymentOption>IntegratedMerchantCreditCard</PaymentOption>
<Description>Integrated Merchant Credit Card</Description>
<DetailVersion>3</DetailVersion>
<UpdateTime>2010-06-11T06:51:58.000Z</UpdateTime>
</PaymentOptionDetails>
<PaymentOptionDetails>
<PaymentOption>CashOnPickup</PaymentOption>
<Description>Cash On Pickup Accepted</Description>
<DetailVersion>3</DetailVersion>
<UpdateTime>2010-06-11T06:51:58.000Z</UpdateTime>
</PaymentOptionDetails>
</PaymentOptionDetails>
<ShippingServiceDetails>
<Description>US Postal Service Priority Mail</Description>
<ShippingService>USPSPriority</ShippingService>
<ShippingServiceID>7</ShippingServiceID>
<ShippingTimeMax>3</ShippingTimeMax>
<ShippingTimeMin>2</ShippingTimeMin>
</ShippingServiceDetails>
<ShippingServiceDetails>
<Description>US Postal Service Express Mail</Description>
<ExpeditedService>true</ExpeditedService>
<ShippingService>USPSExpressMail</ShippingService>
<ShippingServiceID>11</ShippingServiceID>
<ShippingTimeMax>1</ShippingTimeMax>
<ShippingTimeMin>0</ShippingTimeMin>
</ShippingServiceDetails>
<ShippingServiceDetails>
<Description>US Postal Service Parcel Post</Description>
<ShippingService>USPSParcel</ShippingService>
<ShippingServiceID>8</ShippingServiceID>
<ShippingTimeMax>9</ShippingTimeMax>
<ShippingTimeMin>2</ShippingTimeMin>
</ShippingServiceDetails>
<ShippingServiceDetails>
<Description>US Postal Service Media Mail</Description>
<ShippingService>USPSMedia</ShippingService>
<ShippingServiceID>9</ShippingServiceID>
<ShippingTimeMax>9</ShippingTimeMax>
<ShippingTimeMin>2</ShippingTimeMin>
</ShippingServiceDetails>
<ShippingServiceDetails>
<Description>US Postal Service First Class Mail</Description>
<ShippingService>USPSFirstClass</ShippingService>
<ShippingServiceID>10</ShippingServiceID>
<ShippingTimeMax>5</ShippingTimeMax>
<ShippingTimeMin>2</ShippingTimeMin>
</ShippingServiceDetails>
<ShippingServiceDetails>
<Description>UPS Ground</Description>
<ShippingService>UPSGround</ShippingService>
<ShippingServiceID>3</ShippingServiceID>
<ShippingTimeMax>6</ShippingTimeMax>
<ShippingTimeMin>1</ShippingTimeMin>
</ShippingServiceDetails>
<ShippingServiceDetails>
<Description>UPS 3 Day Select</Description>
<ShippingService>UPS3rdDay</ShippingService>
<ShippingServiceID>4</ShippingServiceID>
<ShippingTimeMax>3</ShippingTimeMax>
<ShippingTimeMin>1</ShippingTimeMin>
</ShippingServiceDetails>
<ShippingServiceDetails>
<Description>UPS 2nd Day Air</Description>
<ShippingService>UPS2ndDay</ShippingService>
<ShippingServiceID>5</ShippingServiceID>
<ShippingTimeMax>2</ShippingTimeMax>
<ShippingTimeMin>1</ShippingTimeMin>
</ShippingServiceDetails>
<ShippingServiceDetails>
<Description>UPS Next Day Air Saver</Description>
<ExpeditedService>true</ExpeditedService>
<ShippingService>UPSNextDay</ShippingService>
<ShippingServiceID>6</ShippingServiceID>
<ShippingTimeMax>1</ShippingTimeMax>
<ShippingTimeMin>1</ShippingTimeMin>
</ShippingServiceDetails>
<ShippingServiceDetails>
<Description>UPS Next Day Air</Description>
<ExpeditedService>true</ExpeditedService>
<ShippingService>UPSNextDayAir</ShippingService>
<ShippingServiceID>12</ShippingServiceID>
<ShippingTimeMax>1</ShippingTimeMax>
<ShippingTimeMin>1</ShippingTimeMin>
</ShippingServiceDetails>
<ShippingServiceDetails>
<Description>Standard Flat Rate Shipping Service</Description>
<ShippingService>ShippingMethodStandard</ShippingService>
<ShippingServiceID>1</ShippingServiceID>
</ShippingServiceDetails>
<ShippingServiceDetails>
<Description>Expedited Flat Rate Shipping Service</Description>
<ShippingService>ShippingMethodExpress</ShippingService>
<ShippingServiceID>2</ShippingServiceID>
</ShippingServiceDetails>
<ShippingServiceDetails>
<Description>Overnight Flat Rate Shipping Service</Description>
<ExpeditedService>true</ExpeditedService>
<ShippingService>ShippingMethodOvernight</ShippingService>
<ShippingServiceID>18</ShippingServiceID>
<ShippingTimeMax>1</ShippingTimeMax>
<ShippingTimeMin>1</ShippingTimeMin>
</ShippingServiceDetails>
<ShippingServiceDetails>
<Description>Other (see description)</Description>
<ShippingService>Other</ShippingService>
<ShippingServiceID>14</ShippingServiceID>
</ShippingServiceDetails>
<ShippingServiceDetails>
<Description>Local Delivery/Pickup</Description>
<ShippingService>LocalDelivery</ShippingService>
<ShippingServiceID>15</ShippingServiceID>
</ShippingServiceDetails>
<ShippingServiceDetails>
<Description>USPS Global Express Mail</Description>
<InternationalService>true</InternationalService>
<ShippingService>USPSGlobalExpress</ShippingService>
<ShippingServiceID>50003</ShippingServiceID>
<ShippingTimeMax>5</ShippingTimeMax>
<ShippingTimeMin>3</ShippingTimeMin>
</ShippingServiceDetails>
<ShippingServiceDetails>
<Description>USPS Global Priority Mail</Description>
<InternationalService>true</InternationalService>
<ShippingService>USPSGlobalPriority</ShippingService>
<ShippingServiceID>50005</ShippingServiceID>
<ShippingTimeMax>6</ShippingTimeMax>
<ShippingTimeMin>4</ShippingTimeMin>
</ShippingServiceDetails>
<ShippingServiceDetails>
<Description>USPS Economy Letter Post</Description>
<InternationalService>true</InternationalService>
<ShippingService>USPSEconomyLetter</ShippingService>
<ShippingServiceID>50007</ShippingServiceID>
<ShippingTimeMax>42</ShippingTimeMax>
<ShippingTimeMin>28</ShippingTimeMin>
</ShippingServiceDetails>
<ShippingServiceDetails>
<Description>USPS Economy Parcel Post</Description>
<InternationalService>true</InternationalService>
<ShippingService>USPSEconomyParcel</ShippingService>
<ShippingServiceID>50006</ShippingServiceID>
<ShippingTimeMax>42</ShippingTimeMax>
<ShippingTimeMin>28</ShippingTimeMin>
</ShippingServiceDetails>
<ShippingServiceDetails>
<Description>USPS Airmail Letter Post</Description>
<InternationalService>true</InternationalService>
<ShippingService>USPSAirmailLetter</ShippingService>
<ShippingServiceID>50008</ShippingServiceID>
<ShippingTimeMax>10</ShippingTimeMax>
<ShippingTimeMin>4</ShippingTimeMin>
</ShippingServiceDetails>
<ShippingServiceDetails>
<Description>USPS Airmail Parcel Post</Description>
<InternationalService>true</InternationalService>
<ShippingService>USPSAirmailParcel</ShippingService>
<ShippingServiceID>50009</ShippingServiceID>
<ShippingTimeMax>10</ShippingTimeMax>
<ShippingTimeMin>4</ShippingTimeMin>
</ShippingServiceDetails>
<ShippingServiceDetails>
<Description>UPS Worldwide Express Plus</Description>
<InternationalService>true</InternationalService>
<ShippingService>UPSWorldWideExpressPlus</ShippingService>
<ShippingServiceID>50010</ShippingServiceID>
<ShippingTimeMax>2</ShippingTimeMax>
<ShippingTimeMin>1</ShippingTimeMin>
</ShippingServiceDetails>
<ShippingServiceDetails>
<Description>UPS Worldwide Express</Description>
<InternationalService>true</InternationalService>
<ShippingService>UPSWorldWideExpress</ShippingService>
<ShippingServiceID>50011</ShippingServiceID>
<ShippingTimeMax>2</ShippingTimeMax>
<ShippingTimeMin>1</ShippingTimeMin>
</ShippingServiceDetails>
<ShippingServiceDetails>
<Description>UPS Worldwide Expedited</Description>
<InternationalService>true</InternationalService>
<ShippingService>UPSWorldWideExpedited</ShippingService>
<ShippingServiceID>50012</ShippingServiceID>
<ShippingTimeMax>5</ShippingTimeMax>
<ShippingTimeMin>2</ShippingTimeMin>
</ShippingServiceDetails>
<ShippingServiceDetails>
<Description>UPS Standard To Canada</Description>
<InternationalService>true</InternationalService>
<ShippingService>UPSStandardToCanada</ShippingService>
<ShippingServiceID>50013</ShippingServiceID>
</ShippingServiceDetails>
<ShippingServiceDetails>
<Description>Standard Int'l Flat Rate Shipping</Description>
<InternationalService>true</InternationalService>
<ShippingService>StandardInternational</ShippingService>
<ShippingServiceID>50001</ShippingServiceID>
</ShippingServiceDetails>
<ShippingServiceDetails>
<Description>Expedited Int'l Flat Rate Shipping</Description>
<InternationalService>true</InternationalService>
<ShippingService>ExpeditedInternational</ShippingService>
<ShippingServiceID>50002</ShippingServiceID>
</ShippingServiceDetails>
<ShippingServiceDetails>
<Description>Other Int'l Shipping (see description)</Description>
<InternationalService>true</InternationalService>
<ShippingService>OtherInternational</ShippingService>
<ShippingServiceID>50014</ShippingServiceID>
</ShippingServiceDetails>
<UpdateTime>2020-08-20T17:33:41.000Z</UpdateTime>
</GeteBayDetailsResponse>
Version Info
The code example above was based on the versions specified below:
| API Schema Version | 1201 |
Additional Resources
- Documentation: GeteBayDetails