eBay Trading APIVersion 1131

StoreCustomPageType

Types that use StoreCustomPageType:

Calls that use StoreCustomPageType:

Fields



Content ( string ) [0..1]
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.
See the Field Index to learn which calls use Content.

LeftNav ( boolean ) [0..1]
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.
See the Field Index to learn which calls use LeftNav.

Name ( string ) [0..1]
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.
See the Field Index to learn which calls use Name.

Order ( int ) [0..1]
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.
See the Field Index to learn which calls use Order.

PageID ( long ) [0..1]
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.
See the Field Index to learn which calls use PageID.

PreviewEnabled ( boolean ) [0..1]
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.
See the Field Index to learn which calls use PreviewEnabled.

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.
See the Field Index to learn which calls use Status.

URL ( anyURI ) [0..1]
The full URL of the eBay Store custom page, which is generally derived from the CustomPage.Name value. The exception to this rule is if the seller specified a custom URL using the CustomPage.URLPath field in a SetStoreCustomPage call.

The URL is only returned in the GetStoreCustomPage response if a PageID value is included in the request.
See the Field Index to learn which calls use URL.

URLPath ( string ) [0..1]
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.
See the Field Index to learn which calls use URLPath.