eBay Trading APIVersion 989

GetDescriptionTemplates

Use this call to retrieve the Theme and Layout specifications for the display of an item's description. If desired, you can retrieve template information for specific categories and you can set the LastModifiedTime field to return templates by date.

See Using Description Templates.



Input

See also Samples.

The box below lists all fields that could be included in the call request. To learn more about an individual field or its type, click its name in the box (or scroll down to find it in the table below the box).

See also the Deprecated Objects link above. Fields presented in this color are deprecated, and fields presented in this color are (or soon will be) non-operational.

The XML prototype does not include requester credentials. This is a documentation limitation only (see Standard Requester Credentials for Making Calls).

<?xml version="1.0" encoding="utf-8"?>
<GetDescriptionTemplatesRequest xmlns="urn:ebay:apis:eBLBaseComponents">
  <!-- Call-specific Input Fields -->
  <CategoryID> string </CategoryID>
  <LastModifiedTime> dateTime </LastModifiedTime>
  <MotorVehicles> boolean </MotorVehicles>
  <!-- Standard Input Fields -->
  <ErrorLanguage> string </ErrorLanguage>
  <MessageID> string </MessageID>
  <Version> string </Version>
  <WarningLevel> WarningLevelCodeType </WarningLevel>
</GetDescriptionTemplatesRequest>
Argument Type Occurrence Meaning
Call-specific Input Fields [Jump to standard fields]
CategoryID string Optional A CategoryID value can be specified if the seller would like to only see the Listing Designer templates that are available for that eBay category. This field will be ignored if the MotorVehicles boolean field is also included in the call request and set to true.
Max length: 10.
LastModifiedTime dateTime Optional This dateTime filter can be included and used if the user only wants to check for recently-added Listing Designer templates. If this filter is used, only the Listing Designer templates that have been added/modified after the specified timestamp will be returned in the response.

Typically, you will pass in the timestamp value that was returned the last time you refreshed the list of Listing Designer templates.
MotorVehicles boolean Optional This boolean field should be included and set to true if the user would only like to see the Listing Designer templates that are available for motor vehicle categories. This field will override any CategoryID value that is specified in the call request.
Standard Input Fields  
ErrorLanguage string Optional Use ErrorLanguage to return error strings for the call in a different language from the language commonly associated with the site that the requesting user is registered with. Specify the standard RFC 3066 language identification tag (e.g., en_US).
ID--- country
----- -----
de_AT Austria
de_CH Switzerland
de_DE Germany
en_AU Australia
en_CA Canada
en_GB United Kingdom
en_SG Singapore
en_US United States
es_ES Spain
fr_BE Belgium (French)
fr_CA Canada (French)
fr_FR France
it_IT Italy
nl_BE Belgium (Dutch)
nl_NL Netherlands
zh_CN China
en_IN India
en_IE Ireland
zh_HK Hong Kong

See Tags for the Identification of Languages.

MessageID string Optional In most cases, all calls support a MessageID element in the request and a CorrelationID element in the response. If you pass a message ID in a request, we will return the same value in CorrelationID in the response. You can use this for tracking that a response is returned for every request and to match particular responses to particular requests. If you do not pass MessageID in the request, CorrelationID is not returned.

Note: GetCategories, GetAttributesCS, GetCategory2CS, GetAttributesXSL, GetProductFinder, GetProductFinderXSL, and GetProductSearchPage are designed to retrieve very large sets of metadata that change once a day or less often. To improve performance, these calls return cached responses when you request all available data (with no filters). When this occurs, the MessageID and CorrelationID fields aren't applicable. However, if you specify an input filter to reduce the amount of data returned, the calls retrieve the latest data (not cached). When this occurs, MessageID and CorrelationID are applicable.
Version string Conditional The version number of the API code that you are programming against (e.g., 549). The version you specify for a call has these basic effects:
- It indicates the version of the code lists and other data that eBay should use to process your request.
- It indicates the schema version you are using.
You need to use a version that is greater than or equal to the lowest supported version.

For the SOAP API: If you are using the SOAP API, this field is required. Specify the version of the WSDL your application is using.

For the XML API: If you are using the XML API, this field has no effect. Instead, specify the version in the X-EBAY-API-COMPATIBILITY-LEVEL HTTP header. (If you specify Version in the body of an XML API request and it is different from the value in the HTTP header, eBay returns an informational warning that the value in the HTTP header was used instead.)

See:
    Routing the Request (Gateway URLs)
    eBay Schema Versioning Strategy
    Lowest Supported Version

WarningLevel WarningLevelCodeType Optional Controls whether or not to return warnings when the application passes unrecognized or deprecated elements in a request.

An unrecognized element is one that is not defined in any supported version of the schema. Schema element names are case-sensitive, so using WarningLevel can also help you remove any potential hidden bugs within your application due to incorrect case or spelling in field names before you put your application into the Production environment.

WarningLevel only validates elements; it doesn't validate XML attributes. It also doesn't control warnings related to user-entered strings or numbers, or warnings for logical errors.

We recommend that you only use this during development and debugging. Do not use this in requests in your production code.

Applicable values:

High
(in) Return warnings when the application passes unrecognized or deprecated elements in a request.
Low
(in) Do not return warnings when the application passes unrecognized or deprecated elements in a request. This is the default value if WarningLevel is not specified.

See Warning Level.



Output

See also Samples.

The box below lists all fields that might be returned in the response. To learn more about an individual field or its type, click its name in the box (or scroll down to find it in the table below the box).

See also the Deprecated Objects link above. Fields presented in this color are deprecated, and fields presented in this color are not returned (or soon will not be returned) or are not operational (or soon will be non-operational).

<?xml version="1.0" encoding="utf-8"?>
<GetDescriptionTemplatesResponse xmlns="urn:ebay:apis:eBLBaseComponents">
  <!-- Call-specific Output Fields -->
  <DescriptionTemplate> DescriptionTemplateType
    <GroupID> int </GroupID>
    <ID> int </ID>
    <ImageURL> anyURI </ImageURL>
    <Name> string </Name>
    <TemplateXML> string </TemplateXML>
    <Type> DescriptionTemplateCodeType </Type>
  </DescriptionTemplate>
  <!-- ... more DescriptionTemplate nodes allowed here ... -->
  <LayoutTotal> int </LayoutTotal>
  <ObsoleteLayoutID> int </ObsoleteLayoutID>
  <!-- ... more ObsoleteLayoutID values allowed here ... -->
  <ObsoleteThemeID> int </ObsoleteThemeID>
  <!-- ... more ObsoleteThemeID values allowed here ... -->
  <ThemeGroup> ThemeGroupType
    <GroupID> int </GroupID>
    <GroupName> string </GroupName>
    <ThemeID> int </ThemeID>
    <!-- ... more ThemeID values allowed here ... -->
    <ThemeTotal> int </ThemeTotal>
  </ThemeGroup>
  <!-- ... more ThemeGroup nodes allowed here ... -->
  <ThemeTotal> int </ThemeTotal>
  <!-- Standard Output Fields -->
  <Ack> AckCodeType </Ack>
  <Build> string </Build>
  <CorrelationID> string </CorrelationID>
  <Errors> ErrorType
    <ErrorClassification> ErrorClassificationCodeType </ErrorClassification>
    <ErrorCode> token </ErrorCode>
    <ErrorParameters ParamID="string"> ErrorParameterType
      <Value> string </Value>
    </ErrorParameters>
    <!-- ... more ErrorParameters nodes allowed here ... -->
    <LongMessage> string </LongMessage>
    <SeverityCode> SeverityCodeType </SeverityCode>
    <ShortMessage> string </ShortMessage>
  </Errors>
  <!-- ... more Errors nodes allowed here ... -->
  <HardExpirationWarning> string </HardExpirationWarning>
  <Timestamp> dateTime </Timestamp>
  <Version> string </Version>
</GetDescriptionTemplatesResponse>
Return Value Type Occurrence Meaning
Call-specific Output Fields [Jump to standard fields]
DescriptionTemplate DescriptionTemplateType Always,
repeatable: [1..*]
A DescriptionTemplate container is retrieved for each available Listing Designer template. Each DescriptionTemplate container includes the unique identifier of the template, the Listing Designer Theme Group that it belongs to, the CDATA representation of the Listing Designer template, and the URL to an image that serves as an example of the Listing Designer template.
DescriptionTemplate.GroupID int Conditionally This integer value is a unique identifier for the Listing Designer Theme group, such as Holiday/Seasonal, Special Events, or Patterns/Textures. This field is not applicable and will not be returned for a Listing Designer Layout.
DescriptionTemplate.ID int Always This integer value is a unique identifier of the Listing Designer Theme or Layout.
DescriptionTemplate.ImageURL anyURI Always This URL is the path to a small image providing a sample of the appearance of a Listing Designer Theme or Layout.
DescriptionTemplate.Name string Always This string value is the name of the Listing Designer Theme or Layout.
DescriptionTemplate
  .TemplateXML
string Conditionally This string value is actually a CDATA representation of the Listing Designer template. Image-related elements in a template include ThemeTop, ThemeUserCellTop, ThemeUserContent,, ThemeUserCellBottom, and ThemeBottom. This field is not applicable and will not be returned for a Listing Designer Layout.
DescriptionTemplate.Type DescriptionTemplateCodeType Always This enumeration value indicates that the information returned under the DescriptionTemplate container is related to a Listing Designer Theme or Layout.

Applicable values:

CustomCode
(out) Reserved for future use.
Layout
(out) This value indicates that the Listing Designer template is a layout template that controls how pictures and description text are positioned on the View Item page.
Theme
(out) This value indicates that the Listing Designer template is a theme template that determines which eBay-provided theme (e.g. Valentine's Day) is to be applied for presenting pictures and description text.

Code so that your app gracefully handles any future changes to this list.
LayoutTotal int Always This integer value indicates the total number of Listing Designer Layout templates that were retrieved. This field is always returned, even if it is 0
ObsoleteLayoutID int Conditionally,
repeatable: [0..*]
The unique identifier of a Listing Designer Layout template that is now obsolete. An ObsoleteLayoutID field is returned for each obsolete Listing Designer Layout template.
ObsoleteThemeID int Conditionally,
repeatable: [0..*]
The unique identifier of a Listing Designer Theme template that is now obsolete. An ObsoleteThemeID field is returned for each obsolete Listing Designer Theme template.
ThemeGroup ThemeGroupType Conditionally,
repeatable: [0..*]
A ThemeGroup container is retrieved for each available Listing Designer Theme Group. Each ThemeGroup container includes the unique identifier of the Theme Group, the Theme Group name, and all of the Listing Designer Theme template that belong to that Theme Group.
ThemeGroup.GroupID int Conditionally Unique identifier for this theme group.
ThemeGroup.GroupName string Conditionally Name of this theme group (localized to the language associated with the eBay site).
ThemeGroup.ThemeID int Conditionally,
repeatable: [0..*]
Unique identifier for each theme in this group. There is at least one theme in a theme group.
ThemeGroup.ThemeTotal int Conditionally The number of ThemeID elements in this group.
ThemeTotal int Always This integer value indicates the total number of Listing Designer Theme templates that were retrieved. This field is always returned, even if it is 0
Standard Output Fields  
Ack AckCodeType Always A token representing the application-level acknowledgement code that indicates the response status (e.g., success). The AckCodeType list specifies the possible values for Ack.

Applicable values:

CustomCode
(out) Reserved for internal or future use.
Failure
(out) Request processing failed
Success
(out) Request processing succeeded
Warning
(out) Request processing completed with warning information being included in the response message

(Not all values in AckCodeType apply to this field.)

Code so that your app gracefully handles any future changes to this list.
Build string Always This refers to the specific software build that eBay used when processing the request and generating the response. This includes the version number plus additional information. eBay Developer Support may request the build information when helping you resolve technical issues.
CorrelationID string Conditionally In most cases, all calls support a MessageID element in the request and a CorrelationID element in the response. If you pass a message ID in a request, we will return the same value in CorrelationID in the response. You can use this for tracking that a response is returned for every request and to match particular responses to particular requests. If you do not pass MessageID in the request, CorrelationID is not returned.

Note: GetCategories, GetAttributesCS, GetCategory2CS, GetAttributesXSL, GetProductFinder, GetProductFinderXSL, and GetProductSearchPage are designed to retrieve very large sets of metadata that change once a day or less often. To improve performance, these calls return cached responses when you request all available data (with no filters). When this occurs, the MessageID and CorrelationID fields aren't applicable. However, if you specify an input filter to reduce the amount of data returned, the calls retrieve the latest data (not cached). When this occurs, MessageID and CorrelationID are applicable.
Errors ErrorType Conditionally,
repeatable: [0..*]
A list of application-level errors (if any) that occurred when eBay processed the request.

See Error Handling.

Errors.ErrorClassification ErrorClassificationCodeType Conditionally API errors are divided between two classes: system errors and request errors.

Applicable values:

CustomCode
(out) Reserved for internal or future use.
RequestError
(out) An error has occurred either as a result of a problem in the sending application or because the application's end-user has attempted to submit invalid data (or missing data). In these cases, do not retry the request. The problem must be corrected before the request can be made again. If the problem is due to something in the application (such as a missing required field), the application must be changed. If the problem is a result of end-user data, the application must alert the end-user to the problem and provide the means for the end-user to correct the data. Once the problem in the application or data is resolved, resend the request to eBay with the corrected data.
SystemError
(out) Indicates that an error has occurred on the eBay system side, such as a database or server down. An application can retry the request as-is a reasonable number of times (eBay recommends twice). If the error persists, contact Developer Technical Support. Once the problem has been resolved, the request may be resent in its original form.

Code so that your app gracefully handles any future changes to this list.
Errors.ErrorCode token Conditionally A unique code that identifies the particular error condition that occurred. Your application can use error codes as identifiers in your customized error-handling algorithms. See the "Errors by Number" document.
Errors.ErrorParameters ErrorParameterType Conditionally,
repeatable: [0..*]
This optional element carries a list of context-specific error variables that indicate details about the error condition. These are useful when multiple instances of ErrorType are returned.
Errors.ErrorParameters
  [ attribute ParamID ]
string Conditionally This optional element carries a list of context-specific error variables that indicate details about the error condition. These are useful when multiple instances of ErrorType are returned.
Errors.ErrorParameters.Value string Conditionally The value of the variable (e.g., the attribute set ID)
Errors.LongMessage string Conditionally A more detailed description of the condition that raised the error.
Errors.SeverityCode SeverityCodeType Conditionally Indicates whether the error is a severe error (causing the request to fail) or an informational error (a warning) that should be communicated to the user.

Applicable values:

CustomCode
(out) Reserved for internal or future use
Error
(out) Application-level error
Warning
(out) Warning or informational error

Code so that your app gracefully handles any future changes to this list.
Errors.ShortMessage string Conditionally A brief description of the condition that raised the error.
HardExpirationWarning string Conditionally Expiration date of the user's authentication token. Only returned within the 7-day period prior to a token's expiration. To ensure that user authentication tokens are secure and to help avoid a user's token being compromised, tokens have a limited life span. A token is only valid for a period of time (set by eBay). After this amount of time has passed, the token expires and must be replaced with a new token.
Timestamp dateTime Always This value represents the date and time when eBay processed the request. The time zone of this value is GMT and the format is the ISO 8601 date and time format (YYYY-MM-DDTHH:MM:SS.SSSZ). See Time Values in the eBay Web Services guide for information about this time format and converting to and from the GMT time zone.

Note: GetCategories, GetAttributesCS, GetCategory2CS, GetAttributesXSL, GetProductFinder, GetProductFinderXSL, and GetProductSearchPage are designed to retrieve very large sets of metadata that change once a day or less often. To improve performance, these calls return cached responses when you request all available data (with no filters). When this occurs, this time value reflects the time the cached response was created. Thus, this value is not necessarily when the request was processed. However, if you specify an input filter to reduce the amount of data returned, the calls retrieve the latest data (not cached). When this occurs, this time value does reflect when the request was processed.
Version string Always The version of the response payload schema. Indicates the version of the schema that eBay used to process the request. See "Standard Data for All Calls" in the eBay Web Services Guide for information on using the response version when troubleshooting "CustomCode" values that appear in the response.



Detail Controls


DetailLevel

This call does not support varying Detail Levels. You do not need to pass DetailLevel in the request.



Samples

New to making API calls? Please see Making a Call.

Note: Some item IDs, user IDs, or other data in these samples might no longer be active on eBay. If necessary, you can substitute current eBay data in your requests.

Sample: Basic Call

Retrieves the current set of item description templates.

Description

Specify a CategoryID if you want to return the templates for a specific category.

Input

XML format.

<?xml version="1.0" encoding="utf-8"?>
<GetDescriptionTemplatesRequest xmlns="urn:ebay:apis:eBLBaseComponents">
  <RequesterCredentials>
    <eBayAuthToken>ABC...123</eBayAuthToken>
  </RequesterCredentials>
  <ErrorLanguage>en_US</ErrorLanguage>
  <WarningLevel>High</WarningLevel>
</GetDescriptionTemplatesRequest>

Output

XML format.
<GetDescriptionTemplatesResponse xmlns="urn:ebay:apis:eBLBaseComponents">
  <Timestamp>2016-02-12T20:06:27.564Z</Timestamp>
  <Ack>Success</Ack>
  <Version>967</Version>
  <Build>E967_CORE_BUNDLED_10639415_R1</Build>
  <DescriptionTemplate>
    <GroupID>0</GroupID>
    <ID>10</ID>
    <ImageURL>http://pics.ebay.com/aw/pics/vit/None2_sample_100x120.gif</ImageURL>
    <Name>None</Name>
    <TemplateXML>&lt;ThemeUserContent>&lt;/ThemeUserContent></TemplateXML>
    <Type>Theme</Type>
  </DescriptionTemplate>
  <DescriptionTemplate>
    <GroupID>2</GroupID>
    <ID>37339</ID>
    <ImageURL>http://pics.ebay.com/aw/pics/ca/vit/clothing_and_accessories_sample_100x120.gif</ImageURL>
    <Name>Accessories for Women</Name>
    <TemplateXML><![CDATA[<ThemeTop><![CDATA[<TABLE CELLPADDING="0" CELLSPACING="0" BORDER="0" WIDTH="100%">
        <TR><TD WIDTH="1%"><IMG SRC="http://pics.ebay.com/aw/pics/x.gif" WIDTH="35" HEIGHT="1" /></TD>
        <TD WIDTH="35%"><IMG SRC="http://pics.ebay.com/aw/pics/x.gif" WIDTH="196" HEIGHT="1" /></TD>
        <TD WIDTH="23%"><IMG SRC="http://pics.ebay.com/aw/pics/x.gif" WIDTH="121" HEIGHT="1" /></TD>
        <TD WIDTH="40%"><IMG SRC="http://pics.ebay.com/aw/pics/x.gif" WIDTH="215" HEIGHT="1" /></TD>
        <TD WIDTH="1%"><IMG SRC="http://pics.ebay.com/aw/pics/x.gif" WIDTH="37" HEIGHT="1" /></TD>
        </TR><TR ALIGN="center">
        <TD ROWSPAN="3" BACKGROUND="http://pics.ebay.com/aw/pics/vit/fashions/fashionLeft_35x600.gif">
        <IMG SRC="http://pics.ebay.com/aw/pics/x.gif" WIDTH="1" HEIGHT="1" /></TD>
        <TD BACKGROUND="http://pics.ebay.com/aw/pics/vit/fashions/fashionHeadExpand_1x78.gif">
        <IMG SRC="http://pics.ebay.com/aw/pics/vit/fashions/fashionHead2_196x78.gif" WIDTH="196" HEIGHT="78" /></TD>
        <TD BACKGROUND="http://pics.ebay.com/aw/pics/vit/fashions/fashionHeadExpand_1x78.gif">
        <IMG SRC="http://pics.ebay.com/aw/pics/vit/fashions/fashionhead3_121x78.gif" WIDTH="121" HEIGHT="78" /></TD>
        <TD BACKGROUND="http://pics.ebay.com/aw/pics/vit/fashions/fashionHeadExpand_1x78.gif">
        <IMG SRC="http://pics.ebay.com/aw/pics/vit/fashions/fashionhead4_215x78.gif" WIDTH="215" HEIGHT="78" /></TD>
        <TD ROWSPAN="3" BACKGROUND="http://pics.ebay.com/aw/pics/vit/fashions/fashionhead5_37x600.gif">
        <IMG SRC="http://pics.ebay.com/aw/pics/x.gif" WIDTH="1" HEIGHT="1" /></TD></TR><TR><TD COLSPAN="3"
        BGCOLOR="#FFE79C">]]]]>><![CDATA[</ThemeTop><ThemeUserCellTop>
        <![CDATA[<TABLE CELLPADDING="0" CELLSPACING="0" BORDER="0" WIDTH="100%"><TR BGCOLOR="#996699"">
        <TD WIDTH="1%"><IMG SRC="http://pics.ebay.com/aw/pics/x.gif" WIDTH="3" HEIGHT="3" /></TD>
        <TD WIDTH="98%"><IMG SRC="http://pics.ebay.com/aw/pics/x.gif" WIDTH="526" HEIGHT="1" /></TD>
        <TD WIDTH="1%"><IMG SRC="http://pics.ebay.com/aw/pics/x.gif" WIDTH="3" HEIGHT="1" /></TD>
        </TR><TR><TD BGCOLOR="#996699"><IMG SRC="http://pics.ebay.com/aw/pics/x.gif" WIDTH="1" HEIGHT="1" /></TD>
        <TD align="center">]]]]>><![CDATA[</ThemeUserCellTop><ThemeUserContent/><ThemeUserCellBottom><![CDATA[</TD>
        <TD BGCOLOR="#996699"><IMG SRC="http://pics.ebay.com/aw/pics/x.gif" WIDTH="1" HEIGHT="1" /></TD></TR><TR>
        <TD BGCOLOR="#996699" COLSPAN="3"><IMG SRC="http://pics.ebay.com/aw/pics/x.gif" WIDTH="1" HEIGHT="3" /></TD>
        </TR></TABLE>]]]]>><![CDATA[</ThemeUserCellBottom><ThemeBottom><![CDATA[</TD></TR><TR><TD COLSPAN="3"
        BGCOLOR="#000000"><IMG SRC="http://pics.ebay.com/aw/pics/x.gif" WIDTH="1" HEIGHT="22" /></TD></TR></TABLE>]]]]>>
        <![CDATA[</ThemeBottom>]]></TemplateXML>
    <Type>Theme</Type>
  </DescriptionTemplate>
  <DescriptionTemplate>
    <GroupID>6</GroupID>
    <ID>373250</ID>
    <ImageURL>http://pics.ebaystatic.com/aw/pics/vit/animal_sample_100x120.gif</ImageURL>
    <Name>Animal Prints</Name>
    <TemplateXML> ... </TemplateXML>
    <Type>Theme</Type>
  </DescriptionTemplate>
  ...
  <LayoutTotal>0</LayoutTotal>
  <ObsoleteLayoutID>10000</ObsoleteLayoutID>
  <ObsoleteLayoutID>10001</ObsoleteLayoutID>
  <ObsoleteLayoutID>10002</ObsoleteLayoutID>
  <ObsoleteLayoutID>10003</ObsoleteLayoutID>
  <ObsoleteLayoutID>10004</ObsoleteLayoutID>
  <ThemeGroup>
    <GroupID>1</GroupID>
    <GroupName>New</GroupName>
    <ThemeID>10</ThemeID>
    <ThemeID>223353096</ThemeID>
    <ThemeID>223353095</ThemeID>
    ...
    <ThemeID>373139</ThemeID>
  </ThemeGroup>
  ...
  <ThemeTotal>231</ThemeTotal>
</GetDescriptionTemplatesResponse>



Change History

Change Date Description