eBay Trading API901

SetStoreCustomPage

Use this call to create a custom page for a user's eBay Store. The page can include static HTML content as well as dynamic content that is added using the special eBay Stores tags.

For more information on setting up and managing an eBay store, and for information on using this call, see Opening and Managing an eBay Store.

Usage Details

Before you can call SetStoreCustomPage, the user must have an eBay Store to which they can add custom pages.

In the request, if you set CustomPage.IsPreview to false, the custom page will not be set. However, the Content field in the response will contain the content of the page as it will appear within the Store. This can be useful to preview your eBay Stores tags on the page.

Testing SetStoreCustomPage

You can test this call in the Sandbox. To test SetStoreCustomPage, you must first create an eBay Store with a test user on the Sandbox website. Once the store has been added, you can add one or more custom pages to it using this call. View the StoreCustomPage.Content property in the response to verify that the custom page renders as expected.

Related Information

See Managing Custom Pages.

See also the reference documentation for these calls:



Back to top

Input

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 Samples.

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"?>
<SetStoreCustomPageRequest xmlns="urn:ebay:apis:eBLBaseComponents">
  <!-- Call-specific Input Fields -->
  <CustomPage> StoreCustomPageType
    <Content> string </Content>
    <LeftNav> boolean </LeftNav>
    <Name> string </Name>
    <Order> int </Order>
    <PageID> long </PageID>
    <PreviewEnabled> boolean </PreviewEnabled>
    <Status> StoreCustomPageStatusCodeType </Status>
    <URLPath> string </URLPath>
  </CustomPage>
  <!-- Standard Input Fields -->
  <ErrorLanguage> string </ErrorLanguage>
  <MessageID> string </MessageID>
  <Version> string </Version>
  <WarningLevel> WarningLevelCodeType </WarningLevel>
</SetStoreCustomPageRequest>
Argument Type Occurrence Meaning
Call-specific Input Fields [Jump to standard fields]
CustomPage StoreCustomPageType Required The custom page being submitted.
CustomPage.Content string Conditional The HTML content of the eBay Store custom page. This field has a maximum size of 96 kilobytes. If the PreviewEnabled field is set to 'true', then this field is required in a SetStoreCustomPage call. Otherwise, it is optional.

The Content field is only returned in the GetStoreCustomPage response if a PageID value is included in the request.
CustomPage.LeftNav boolean Conditional This flag controls whether or not the left navigation bar is included in the eBay Store custom page. To include the left navigation bar in a custom page, the seller will include the LeftNav field in the SetStoreCustomPage request and set it to 'true'.

The LeftNav field is only returned in the GetStoreCustomPage response if a PageID value is included in the request.
CustomPage.Name string Conditional Name of the eBay Store custom page. This value is required if you are creating a new page (and omitting a PageID value). Note that you must include a name for the page even if you are using the PreviewEnabled flag. However, since using the preview functionality means that the page will not be persisted, you can enter a dummy value for this field if you have not decided on a name for the page. The Name value is used in links to the page.
CustomPage.Order int Conditional This integer value controls the order in which the corresponding eBay Store custom page is displayed in the list of custom pages. To make the corresponding custom page appear first in the list of custom pages, the seller would include the Order field and set its value to '1'.

The Order value is always returned in the GetStoreCustomPage response.
CustomPage.PageID long Conditional Unique identifier for an eBay Store custom page. If you specify a valid PageID value in a SetStoreCustomPage call, the existing custom page is updated. If you do not specify a PageID value, you are creating a new custom page.

The PageID field is always returned in GetStoreCustomPage.
CustomPage.PreviewEnabled boolean Optional This flag controls whether or not a custom page preview is enabled. To enable the a custom page preview, the seller will include the PreviewEnabled field in the SetStoreCustomPage request and set it to 'true'.

The PreviewEnabled field is only returned in the GetStoreCustomPage response if a PageID value is included in the request.
CustomPage.Status StoreCustomPageStatusCodeType Conditional This value indicates the status of the eBay custom page. In a SetStoreCustomPage call, the seller uses the optional Status field to make an inactive custom page active, to make an active custom page inactive, or to delete an active or inactive custom page. To change the status (including delete) of a custom page, a PageID value must be included to identify the custom page to modify.

The Status value is always returned in the GetStoreCustomPage response.

Applicable values:

Active
(in/out) The page is visible.
CustomCode
(in/out) Reserved for internal or future use.
Delete
(in/out) The page is to be deleted.
Inactive
(in/out) The page is not visible.

CustomPage.URLPath string Conditional The URL path of the eBay Store custom page. This field is only required if you are using Chinese characters in the Name field. The URL path of the eBay Store custom page is normally derived from the Name field, but the URL path cannot be derived from the name of the custom page if it contains Chinese characters because URLs cannot contain Chinese characters.

The URLPath is only returned in the GetStoreCustomPage response if it is defined for the eBay Store custom page, and if a PageID value is included in the 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
en_AU Australia
de_AT Austria
nl_BE Belgium (Dutch)
fr_BE Belgium (French)
en_CA Canada
fr_CA Canada (French)
zh_CN China
fr_FR France
de_DE Germany
zh_HK Hong Kong
en_IN India
en_IE Ireland
it_IT Italy
nl_NL Netherlands
en_SG Singapore
es_ES Spain
de_CH Switzerland
en_GB United Kingdom
en_US United States

See Tags for the Identification of Languages.

MessageID string Optional Most Trading API calls support a MessageID element in the request and a CorrelationID element in the response. If you pass in a MessageID in a request, the same value will be returned in the CorrelationID field in the response. Pairing these values can help you track and confirm that a response is returned for every request and to match specific responses to specific requests. If you do not pass a MessageID value in the request, CorrelationID is not returned.

Note: GetCategories is 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., 859). 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 performed in the Production environment.

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.



Back to top

Output

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 Samples.

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"?>
<SetStoreCustomPageResponse xmlns="urn:ebay:apis:eBLBaseComponents">
  <!-- Call-specific Output Fields -->
  <CustomPage> StoreCustomPageType
    <Content> string </Content>
    <LeftNav> boolean </LeftNav>
    <Name> string </Name>
    <Order> int </Order>
    <PageID> long </PageID>
    <PreviewEnabled> boolean </PreviewEnabled>
    <Status> StoreCustomPageStatusCodeType </Status>
    <URLPath> string </URLPath>
  </CustomPage>
  <!-- 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>
</SetStoreCustomPageResponse>
Return Value Type Occurrence Meaning
Call-specific Output Fields [Jump to standard fields]
CustomPage StoreCustomPageType Always The custom page that was submitted.
CustomPage.Content string Conditionally The HTML content of the eBay Store custom page. This field has a maximum size of 96 kilobytes. If the PreviewEnabled field is set to 'true', then this field is required in a SetStoreCustomPage call. Otherwise, it is optional.

The Content field is only returned in the GetStoreCustomPage response if a PageID value is included in the request.
CustomPage.LeftNav boolean Conditionally This flag controls whether or not the left navigation bar is included in the eBay Store custom page. To include the left navigation bar in a custom page, the seller will include the LeftNav field in the SetStoreCustomPage request and set it to 'true'.

The LeftNav field is only returned in the GetStoreCustomPage response if a PageID value is included in the request.
CustomPage.Name string Conditionally Name of the eBay Store custom page. This value is required if you are creating a new page (and omitting a PageID value). Note that you must include a name for the page even if you are using the PreviewEnabled flag. However, since using the preview functionality means that the page will not be persisted, you can enter a dummy value for this field if you have not decided on a name for the page. The Name value is used in links to the page.
CustomPage.Order int Conditionally This integer value controls the order in which the corresponding eBay Store custom page is displayed in the list of custom pages. To make the corresponding custom page appear first in the list of custom pages, the seller would include the Order field and set its value to '1'.

The Order value is always returned in the GetStoreCustomPage response.
CustomPage.PageID long Conditionally Unique identifier for an eBay Store custom page. If you specify a valid PageID value in a SetStoreCustomPage call, the existing custom page is updated. If you do not specify a PageID value, you are creating a new custom page.

The PageID field is always returned in GetStoreCustomPage.
CustomPage.PreviewEnabled boolean Conditionally This flag controls whether or not a custom page preview is enabled. To enable the a custom page preview, the seller will include the PreviewEnabled field in the SetStoreCustomPage request and set it to 'true'.

The PreviewEnabled field is only returned in the GetStoreCustomPage response if a PageID value is included in the request.
CustomPage.Status StoreCustomPageStatusCodeType Conditionally This value indicates the status of the eBay custom page. In a SetStoreCustomPage call, the seller uses the optional Status field to make an inactive custom page active, to make an active custom page inactive, or to delete an active or inactive custom page. To change the status (including delete) of a custom page, a PageID value must be included to identify the custom page to modify.

The Status value is always returned in the GetStoreCustomPage response.

Applicable values:

Active
(in/out) The page is visible.
CustomCode
(in/out) Reserved for internal or future use.
Delete
(in/out) The page is to be deleted.
Inactive
(in/out) The page is not visible.

CustomPage.URLPath string Conditionally The URL path of the eBay Store custom page. This field is only required if you are using Chinese characters in the Name field. The URL path of the eBay Store custom page is normally derived from the Name field, but the URL path cannot be derived from the name of the custom page if it contains Chinese characters because URLs cannot contain Chinese characters.

The URLPath is only returned in the GetStoreCustomPage response if it is defined for the eBay Store custom page, and if a PageID value is included in the request.
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 the Ack field.

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.)
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 Most Trading API calls support a MessageID element in the request and a CorrelationID element in the response. If you pass in a MessageID in a request, the same value will be returned in the CorrelationID field in the response. Pairing these values can help you track and confirm that a response is returned for every request and to match specific responses to specific requests. If you do not pass a MessageID value in the request, CorrelationID is not returned.

Note: GetCategories is 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.

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) The request that triggered the error was not processed successfully. When a serious application-level error occurs, the error is returned instead of the business data.

If the source of the problem is within the application (such as a missing required element), change the application before you retry the request.
  • If the problem is due to end-user input data, please alert the end-user to the problem and provide the means for them to correct the data. Once the problem in the application or data is resolved, you can attempt to re-send the request to eBay.
  • If the source of the problem is on eBay's side, 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.


See the Compatible Application Check section of the eBay Features Guide for more information.
Warning
(out) The request was processed successfully, but something occurred that may affect your application or the user. For example, eBay may have changed a value the user sent in. In this case, eBay returns a normal, successful response and also returns the warning.

When a warning occurs, the error is returned in addition to the business data. In this case, you do not need to retry the request (as the original request was successful). However, depending on the cause or nature of the warning, you might need to contact either the end user or eBay to effect a long term solution to the problem to prevent it from reoccurring in the future.

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 the Time Values section in the eBay Features Guide for information about this time format and converting to and from the GMT time zone.

Note: GetCategories and other Trading API calls 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 the Standard Data for All Calls section in the eBay Features Guide for information on using the response version when troubleshooting CustomCode values that appear in the response.



Back to top

Detail Controls


DetailLevel

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



Back to top

Samples

New to making API calls? Please see Routing the Request.

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.

Available samples:

Sample: Basic Call

Updates an existing page in an eBay store.

Description

This sample updates the name of an existing custom page for a store by specifying the page ID and the updated property value.

Input

XML format (HTTP POST). Also available are the .txt version of this XML.

<?xml version="1.0" encoding="utf-8"?>
<SetStoreCustomPageRequest xmlns="urn:ebay:apis:eBLBaseComponents">
  <RequesterCredentials>
    <eBayAuthToken>ABC...123</eBayAuthToken>
  </RequesterCredentials>
  <CustomPage>
    <PageID>132234</PageID>
    <Name>About Us</Name>
  </CustomPage>
</SetStoreCustomPageRequest>

Output

XML format.
<?xml version="1.0" encoding="utf-8"?>
<SetStoreCustomPageResponse xmlns="urn:ebay:apis:eBLBaseComponents">
  <Timestamp>2006-02-21T23:39:43.230Z</Timestamp>
  <Ack>Success</Ack>
  <Version>463</Version>
  <Build>e463_core_Bundled_3001562_R1</Build>
  <CustomPage>
    <Name>About Us</Name>
    <PageID>132234</PageID>
  </CustomPage>
</SetStoreCustomPageResponse>

Back to list of samples

Sample: Adds content to an eBay store page.

Adds a page with content to an existing eBay store.

Description

This sample adds a simple FAQ page to your store.

Input

XML format (HTTP POST). Also available are the .txt version of this XML.

<?xml version="1.0" encoding="utf-8"?>
<SetStoreCustomPageRequest xmlns="urn:ebay:apis:eBLBaseComponents">
  <RequesterCredentials>
    <eBayAuthToken>ABC...123</eBayAuthToken>
  </RequesterCredentials>
  <CustomPage>
    <Name>Customer Service</Name>
    <Status>Active</Status>
    <Content>
<![CDATA[
<p><b>Frequently Asked Questions</b></p>

<p>Q: How can I view the status of my order?<br>
A: Go to the Customer Service, Account Information page. This page<br>
lists all your orders. Click the date of the order whose status you<br>
wish to view.
</p>

<p>Q: What are your shipping costs?<br>
A: You can view an estimate of shipping costs by viewing your cart.<br>
Final shipping costs will be displayed on the Invoice you see<br>
before confirming your order.
</p>

<p><a href="javascript:history.back()">Go Back</a></p>
]]>
    </Content>
    <LeftNav>true</LeftNav>
    <Order>3</Order>
    <PreviewEnabled>true</PreviewEnabled>
  </CustomPage>
</SetStoreCustomPageRequest>

Output

XML format.
<?xml version="1.0" encoding="utf-8"?>
<SetStoreCustomPageResponse xmlns="urn:ebay:apis:eBLBaseComponents">
  <Timestamp>2006-02-21T23:39:43.230Z</Timestamp>
  <Ack>Success</Ack>
  <Version>463</Version>
  <Build>e463_core_Bundled_3001562_R1</Build>
   <CustomPage>
    <Name>Customer Service</Name>
    <Status>Active</Status>
    <Content><html>
<head>
<META http-equiv="Content-Type" content="text/html; charset=ISO-8859-1">
<meta http-equiv="Content-Type" content="text/html; charset=ISO-8859-1"><script
src="http://include.qa-api002.qa.ebaystatic.com/js/v/us/legacy/store_customization.js">
</script><!--srcId: --></head>

<body bgcolor="#FFFFFF">
<table width="100%" border="0" align="left" cellpadding="0" cellspacing="0">
<tr>
<td>
<table width="100%" border="0" cellpadding="0" cellspacing="0">
<tr>
<td width="100%"><p><b>Frequently Asked Questions</b></p>

<p>
Q: How can I view the status of my order?<br> 
A: Go to the Customer Service, Account Information page. This page<br>
lists all your orders. Click the date of the order whose status you<br>
wish to view.
</p>

<p>Q: What are your shipping costs?<br>
A: You can view an estimate of shipping costs by viewing your cart.<br>
Final shipping costs will be displayed on the Invoice you see<br>
before confirming your order.
</p> 

<p><a href="javascript:history.back()">Go Back</a></p></td>
</tr>
</table>
</td>
</tr>
</table>
</body>
</html></Content>
    <LeftNav>true</LeftNav>
    <PreviewEnabled>true</PreviewEnabled>
    <Order>3</Order>
  </CustomPage>
</SetStoreCustomPageResponse>


Back to list of samples



Back to top

Change History

Version Description
499
2007-02-07
  • CustomPage.PageID (modified): The data types for IDs used for eBay Stores have changed from xs:int to xs:long to prepare for future increases in ID values.



Back to top

User-Contributed Notes