complexType "ns:StoreType" | eBay Trading API

Overview

Namespace

WSDL

Schema

Component

Index

PREV C-TYPE NEXT C-TYPE

FRAMES NO FRAMES NS-Bindings

SUMMARY: XML REP | DERIVED | USE

DETAIL: DESC | XML SRC | TYPE | ATTR | CHILD

eBay Trading API

complexType "ns:StoreType"

Namespace:	urn:ebay:apis:eBLBaseComponents
Content:	complex, 19 elements, elem. wildcard
Defined:	globally in Schema in ebaySvc.wsdl; see XML source
Includes:	definitions of 19 elements, elem. wildcard
Used:	at 2 locations

Component Diagram

XML Representation Summary

<...>

Content:

</...>

All Direct / Indirect Based Elements (2):

ns:Store (in ns:GetStoreResponse),

ns:Store (in ns:SetStoreRequest)

Known Usage Locations

As direct type of elements (2):

ns:Store (in ns:GetStoreResponse),

ns:Store (in ns:SetStoreRequest)

Annotation

The configuration of an eBay Store.

XML Source (w/o annotations (20); see within schema source)

<xs:complexType name="StoreType">

<xs:sequence>

<xs:element minOccurs="0" name="Name" type="xs:string"/>

<xs:element minOccurs="0" name="URLPath" type="xs:string"/>

<xs:element minOccurs="0" name="URL" type="xs:anyURI"/>

<xs:element minOccurs="0" name="SubscriptionLevel" type="ns:StoreSubscriptionLevelCodeType"/>

<xs:element minOccurs="0" name="Description" type="xs:string"/>

<xs:element minOccurs="0" name="Logo" type="ns:StoreLogoType"/>

<xs:element minOccurs="0" name="Theme" type="ns:StoreThemeType"/>

<xs:element minOccurs="0" name="HeaderStyle" type="ns:StoreHeaderStyleCodeType"/>

<xs:element minOccurs="0" name="HomePage" type="xs:long"/>

<xs:element minOccurs="0" name="ItemListLayout" type="ns:StoreItemListLayoutCodeType"/>

<xs:element minOccurs="0" name="ItemListSortOrder" type="ns:StoreItemListSortOrderCodeType"/>

<xs:element minOccurs="0" name="CustomHeaderLayout" type="ns:StoreCustomHeaderLayoutCodeType"/>

<xs:element minOccurs="0" name="CustomHeader" type="xs:string"/>

<xs:element minOccurs="0" name="ExportListings" type="xs:boolean"/>

<xs:element minOccurs="0" name="CustomCategories" type="ns:StoreCustomCategoryArrayType"/>

<xs:element minOccurs="0" name="CustomListingHeader" type="ns:StoreCustomListingHeaderType"/>

<xs:element minOccurs="0" name="MerchDisplay" type="ns:MerchDisplayCodeType"/>

<xs:element minOccurs="0" name="LastOpenedTime" type="xs:dateTime"/>

<xs:element minOccurs="0" name="TitleWithCompatibility" type="xs:boolean"/>

<xs:any maxOccurs="unbounded" minOccurs="0" processContents="lax"/>

</xs:sequence>

</xs:complexType>

Content Element Detail (all declarations defined in this component; 20/20)

ns:CustomCategories

Type:

ns:StoreCustomCategoryArrayType, complex content

Container consisting of an array of one or more CustomCategory containers. Each CustomCategory container consists of details related to an eBay Store custom category.

To modify an eBay Store's custom categories, an eBay Store owner would use the StoreCategories container in the request of a SetStoreCategories call.

Component Diagram

XML Representation Summary

<ns:CustomCategories>

Content:

ns:CustomCategory*

</ns:CustomCategories>

XML Source (w/o annotations (1); see within schema source)

<xs:element minOccurs="0" name="CustomCategories" type="ns:StoreCustomCategoryArrayType"/>

ns:CustomHeader

Type:

xs:string, predefined, simple content

Custom header text for the Store.

XML Representation Summary

<ns:CustomHeader>

Content:

{ xs:string }

</ns:CustomHeader>

XML Source (w/o annotations (1); see within schema source)

<xs:element minOccurs="0" name="CustomHeader" type="xs:string"/>

ns:CustomHeaderLayout

Type:

ns:StoreCustomHeaderLayoutCodeType, simple content

Layout for the Store's custom header.

XML Representation Summary

<ns:CustomHeaderLayout>

Content:

{ enumeration of xs:token }

</ns:CustomHeaderLayout>

Simple Content

Enumeration:

"NoHeader"	-	Specifies that the Store does not have a custom header.
"CustomHeaderShown"	-	Specifies that the Store does have a custom header.
"CustomCode"	-	(out) Reserved for internal or future use.

XML Source (w/o annotations (1); see within schema source)

<xs:element minOccurs="0" name="CustomHeaderLayout" type="ns:StoreCustomHeaderLayoutCodeType"/>

ns:CustomListingHeader

Type:

ns:StoreCustomListingHeaderType, complex content

Custom listing header for the Store.

Component Diagram

XML Representation Summary

<ns:CustomListingHeader>

Content:

ns:DisplayType?, ns:Logo?, ns:SearchBox?, ns:LinkToInclude*, ns:AddToFavoriteStores?, ns:SignUpForStoreNewsletter?, {any}*

</ns:CustomListingHeader>

XML Source (w/o annotations (1); see within schema source)

<xs:element minOccurs="0" name="CustomListingHeader" type="ns:StoreCustomListingHeaderType"/>

ns:Description

Type:

xs:string, predefined, simple content

Store description (300 characters maximum).

XML Representation Summary

<ns:Description>

Content:

{ xs:string }

</ns:Description>

XML Source (w/o annotations (1); see within schema source)

<xs:element minOccurs="0" name="Description" type="xs:string"/>

ns:ExportListings

Type:

xs:boolean, predefined, simple content

Specifies whether to export the Store listings to comparison shopping websites.

XML Representation Summary

<ns:ExportListings>

Content:

{ xs:boolean }

</ns:ExportListings>

XML Source (w/o annotations (1); see within schema source)

<xs:element minOccurs="0" name="ExportListings" type="xs:boolean"/>

ns:HeaderStyle

Type:

ns:StoreHeaderStyleCodeType, simple content

Style for the Store header.

XML Representation Summary

<ns:HeaderStyle>

Content:

{ enumeration of xs:token }

</ns:HeaderStyle>

Simple Content

Enumeration:

"Full"	-	The full Store header is used.
"Minimized"	-	A minimized Store header is used.
"CustomCode"	-	(out) Reserved for internal or future use.

XML Source (w/o annotations (1); see within schema source)

<xs:element minOccurs="0" name="HeaderStyle" type="ns:StoreHeaderStyleCodeType"/>

ns:HomePage

Type:

xs:long, predefined, simple content

Page to use as the Store's homepage (default is 0). To change the homepage, specify the PageID of one of the Store's custom pages.

XML Representation Summary

<ns:HomePage>

Content:

{ xs:long }

</ns:HomePage>

XML Source (w/o annotations (1); see within schema source)

<xs:element minOccurs="0" name="HomePage" type="xs:long"/>

ns:ItemListLayout

Type:

ns:StoreItemListLayoutCodeType, simple content

The default layout type to use for the Store items.

XML Representation Summary

<ns:ItemListLayout>

Content:

{ enumeration of xs:token }

</ns:ItemListLayout>

Simple Content

Enumeration:

"ListView"	-	Displays item list as a single column, with smaller item pictures.
"GalleryView"	-	Displays item list in two columns, with larger item pictures.
"CustomCode"	-	(out) Reserved for internal or future use.

XML Source (w/o annotations (1); see within schema source)

<xs:element minOccurs="0" name="ItemListLayout" type="ns:StoreItemListLayoutCodeType"/>

ns:ItemListSortOrder

Type:

ns:StoreItemListSortOrderCodeType, simple content

The default sort order to use for the items for sale in the Store.

XML Representation Summary

<ns:ItemListSortOrder>

Content:

{ enumeration of xs:token }

</ns:ItemListSortOrder>

Simple Content

Enumeration:

"EndingFirst"	-	Lists items with those ending soon listed first.
"NewlyListed"	-	Lists items with those newly listed appearing in the list first.
"LowestPriced"	-	Lists items by price in ascending order. The item with the lowest starting price is listed first.
"HighestPriced"	-	Lists items by price in descending order. The item with the highest starting price is listed first.
"LowestPricedPlusShipping"	-	Lists items by combined price and shipping cost in ascending order. The item with the lowest combined starting price plus shipping cost is listed first.
"HighestPricedPlusShipping"	-	Reserved for future use. Lists items by combined price and shipping cost in descending order. The item with the highest combined starting price plus shipping cost is listed first.
"CustomCode"	-	(out) Reserved for internal or future use.

XML Source (w/o annotations (1); see within schema source)

<xs:element minOccurs="0" name="ItemListSortOrder" type="ns:StoreItemListSortOrderCodeType"/>

ns:LastOpenedTime

Type:

xs:dateTime, predefined, simple content

Indicates the time the store was last opened or reopened.

XML Representation Summary

<ns:LastOpenedTime>

Content:

{ xs:dateTime }

</ns:LastOpenedTime>

XML Source (w/o annotations (1); see within schema source)

<xs:element minOccurs="0" name="LastOpenedTime" type="xs:dateTime"/>

ns:Logo

Type:

ns:StoreLogoType, complex content

Store logo.

Component Diagram

XML Representation Summary

<ns:Logo>

Content:

ns:LogoID?, ns:Name?, ns:URL?, {any}*

</ns:Logo>

XML Source (w/o annotations (1); see within schema source)

<xs:element minOccurs="0" name="Logo" type="ns:StoreLogoType"/>

ns:MerchDisplay

Type:

ns:MerchDisplayCodeType, simple content

This field is deprecated.

XML Representation Summary

<ns:MerchDisplay>

Content:

{ enumeration of xs:token }

</ns:MerchDisplay>

Simple Content

Enumeration:

"DefaultTheme"	-	This value is not used.
"StoreTheme"	-	This value is not used.
"CustomCode"	-	This value is not used.

XML Source (w/o annotations (1); see within schema source)

<xs:element minOccurs="0" name="MerchDisplay" type="ns:MerchDisplayCodeType"/>

ns:Name

Type:

xs:string, predefined, simple content

Name of the eBay Store. The name is shown at the top of the Store page.

XML Representation Summary

<ns:Name>

Content:

{ xs:string }

</ns:Name>

XML Source (w/o annotations (1); see within schema source)

<xs:element minOccurs="0" name="Name" type="xs:string"/>

ns:SubscriptionLevel

Type:

ns:StoreSubscriptionLevelCodeType, simple content

For the GetStore call, the value returned in this field indicates the user's eBay Store subscription level.

For the SetStore call, the user can only cancel the current eBay Store subscription (using the Close enumeration value), and cannot change the subscription level. A seller will have to go to the Subscriptions area of My eBay to change their subscription level. Keep in mind that an early termination fee may apply if a user has a yearly subscription, and then either cancels their subscription, or downgrades their subscription level.

XML Representation Summary

<ns:SubscriptionLevel>

Content:

{ enumeration of xs:token }

</ns:SubscriptionLevel>

Simple Content

Enumeration:

"Close"	-	This value is passed into the Store.SubscriptionLevel field of a SetStore call to cancel your current eBay Store subscription. Despite its name, this action does not close your store immediately. Any active listings will remain available through your eBay Store until those listings have ended (either through a sale or when listing end time has been reached).
"Basic"	-	This enumeration value indicates that the eBay user has a Basic eBay Store subscription.
"Featured"	-	This enumeration value indicates that the eBay user has a Premium eBay Store subscription.
"Anchor"	-	This enumeration value indicates that the eBay user has an Anchor eBay Store subscription.
"Starter"	-	This enumeration value indicates that the eBay user has a Starter eBay Store subscription.
"Enterprise"	-	This enumeration value indicates that the eBay user has an Enterprise eBay Store subscription.
"CustomCode"	-	Reserved for internal or future use.

XML Source (w/o annotations (1); see within schema source)

<xs:element minOccurs="0" name="SubscriptionLevel" type="ns:StoreSubscriptionLevelCodeType"/>

ns:Theme

Type:

ns:StoreThemeType, complex content

Store theme.

Component Diagram

XML Representation Summary

<ns:Theme>

Content:

ns:ThemeID?, ns:Name?, ns:ColorScheme?, {any}*

</ns:Theme>

XML Source (w/o annotations (1); see within schema source)

<xs:element minOccurs="0" name="Theme" type="ns:StoreThemeType"/>

ns:TitleWithCompatibility

Type:

xs:boolean, predefined, simple content

A flag indicating if a Compatibility tab exists for the Store item listing. This field is only applicable to Parts & Accessories listings in eBay US Motors. The Compatibility tab will contain vehicles that are compatible with the part in the listing. The seller specifies this information at listing time.

XML Representation Summary

<ns:TitleWithCompatibility>

Content:

{ xs:boolean }

</ns:TitleWithCompatibility>

XML Source (w/o annotations (1); see within schema source)

<xs:element minOccurs="0" name="TitleWithCompatibility" type="xs:boolean"/>

ns:URL

Type:

xs:anyURI, predefined, simple content

The complete URL of the user's Store. This field is only ever returned, and does not need to be explicitly set.

XML Representation Summary

<ns:URL>

Content:

{ xs:anyURI }

</ns:URL>

XML Source (w/o annotations (1); see within schema source)

<xs:element minOccurs="0" name="URL" type="xs:anyURI"/>

ns:URLPath

Type:

xs:string, predefined, simple content

The URL path of the Store (58 characters maximum). Only if you are using Chinese characters in the Name property do you need to use this field, such as if you are opening a Store on the Taiwan site. The reason for this is that the URL path is normally derived from the Store name, but it cannot be derived from the name of the Store if it contains Chinese characters because URLs cannot contain Chinese characters.

XML Representation Summary

<ns:URLPath>

Content:

{ xs:string }

</ns:URLPath>

XML Source (w/o annotations (1); see within schema source)

<xs:element minOccurs="0" name="URLPath" type="xs:string"/>

{any element from any namespace}

XML Source (see within schema source)

<xs:any maxOccurs="unbounded" minOccurs="0" processContents="lax"/>

Overview

Namespace

WSDL

Schema

Component

Index

PREV C-TYPE NEXT C-TYPE

FRAMES NO FRAMES NS-Bindings

SUMMARY: XML REP | DERIVED | USE

DETAIL: DESC | XML SRC | TYPE | ATTR | CHILD

eBay Trading API

WSDL documentation generated with FlexDoc/XML 1.13 using FlexDoc/XML WSDLDoc 1.2.5 template set. All XSD diagrams generated by FlexDoc/XML DiagramKit.