Skip to main content
Published: April 06 2006, 3:41:00 PMUpdated: November 28 2020, 1:13:26 PM

Why is CustomCode returned as the value of some tags in the API call responses?

Why is CustomCode returned as the value of some tags in the API call responses?

In each request, you need to pass the version of the payload schema you are using. This indicates the version of the Code Lists and other data that eBay will use to process your request.  If your application uses an outdated version, eBay will still process the request as long as that version is at or above the lowest supported version. However, it will return the value CustomCode if the values are not available in the outdated version. In these cases, it is always a good idea to update the version to the latest version to resolve the issue.

Here is an example of a GetStore call with version 347:
<?xml version="1.0" encoding="utf-8"?>
  <GetStoreRequest xmlns="urn:ebay:apis:eBLBaseComponents">
  <Version>347</Version>
  <RequesterCredentials>
    <eBayAuthToken>*****</eBayAuthToken>
  </RequesterCredentials>
</
GetStoreRequest>

Here is the response with CustomCode:
<?xml version="1.0" encoding="utf-8"?>
<
GetStoreResponse xmlns="urn:ebay:apis:eBLBaseComponents">
  <Timestamp>2006-04-06T22:29:14.064Z</Timestamp>
  <Ack>Success</Ack>
  <Version>455</Version>
  <Build>e455_core_Bundled_2714420_R1</Build>
  +<Store>
    <Name>Test Super Store</Name>
    <URLPath>testsuperstore</URLPath>
    <URL>http://stores.ebay.com/testsuperstore</URL>
    <SubscriptionLevel>CustomCode</SubscriptionLevel>
    <Description>A test Store</Description>
    +<Logo>
    +<Theme>
    +<HeaderStyle>CustomCode</HeaderStyle>
    <HomePage>0</HomePage>
    <
ItemListLayout>CustomCode</ItemListLayout>
    <ItemListSortOrder>CustomCode</ItemListSortOrder>
    <CustomHeaderLayout>CustomHeaderShown</CustomHeaderLayout>
    <CustomHeader>foobar</CustomHeader>
    <ExportListings>false</ExportListings>
    +<CustomCategories>
    +<CustomListingHeader>
    <MerchDisplay>StoreTheme</MerchDisplay>
    <LastOpenedTime>2005-06-28T19:04:33.000Z</LastOpenedTime>
  </Store>
</
GetStoreResponse>

Here is the request with version 455:
<?xml version="1.0" encoding="utf-8"?>
  <GetStoreRequest xmlns="urn:ebay:apis:eBLBaseComponents">
  <Version>455</Version>
  <RequesterCredentials>
    <eBayAuthToken>*****</eBayAuthToken>
  </RequesterCredentials>
</
GetStoreRequest>

Here is the response, with the correct values instead of CustomCode:
<?xml version="1.0" encoding="utf-8"?>
<
GetStoreResponse xmlns="urn:ebay:apis:eBLBaseComponents">
  <Timestamp>2006-04-06T22:29:14.064Z</Timestamp>
  <Ack>Success</Ack>
  <Version>455</Version>
  <Build>e455_core_Bundled_2714420_R1</Build>
  +<Store>
    <Name>Test Super Store</Name>
    <URLPath>testsuperstore</URLPath>
    <URL>http://stores.ebay.com/testsuperstore</URL>
    <SubscriptionLevel>Basic</SubscriptionLevel>
    <Description>A test Store</Description>
    +<Logo>
    +<Theme>
    +<HeaderStyle>Full</HeaderStyle>
    <HomePage>0</HomePage>
    <
ItemListLayout>ListView</ItemListLayout>
    <ItemListSortOrder>HighestPriced</ItemListSortOrder>
    <CustomHeaderLayout>CustomHeaderShown</CustomHeaderLayout>
    <CustomHeader>foobar</CustomHeader>
    <ExportListings>false</ExportListings>
    +<CustomCategories>
    +<CustomListingHeader>
    <MerchDisplay>StoreTheme</MerchDisplay>
    <LastOpenedTime>2005-06-28T19:04:33.000Z</LastOpenedTime>
  </Store>
</
GetStoreResponse>

 

How well did this answer your question?
Answers others found helpful