Сравнение версий

Ключ

  • Эта строка добавлена.
  • Эта строка удалена.
  • Изменено форматирование.

Image Added

Оглавление
Features

Please read information below to find out how goods search is performed and what search settings can be done.

...

Use GetProviderInfoList method to get list of available providers and information about them.

Taobao and Tmall

Taobao search can be done in different directions. Direction depends on website goals on which you integrate OT API Key.

 

TitleID
          Description
        
Extended searchExtendedSearch on whole Taobao catalog using special OT
          algorithms
        
Tmall searchOfficialOnly Tmall search using official API

Yahoo.co.jp

Includes 2 providers:

  • Usual goods from Yahoo Japan.
  • Yahoo Japan Auction.

Each provider has one type of search.

Own catalog

   "Warehouse" provider will be added with additional Goods from Stock Module. You can use it to create your own catalog and add any goods (either from available providers or your own). 

Read more about module

Search options and conditions

Each provider has its own set of search conditions. It can be varied depending on website goals. Use GetProviderSearchMethodInfoList method to get list of available search options and information what they support. 

Search can be done by two methods: SearchItemsFrame and BatchSearchItemsFrame. They are completely identical. Difference is that BatchSearchItemsFrame allows to get additional information right per one request besides search itself. Possible additional information will be described below. 

Search conditions are also identical. They are sent into xmlParameters and presented by structure OtapiSearchItemsParameters. It has xml format (like other structure parameters). xmlParameters is obligatory as it defines what we are looking for. Examples will be described below. 

The following table provides a comparative description of search methods as they appear in parameters structure and how they are presented in search methods description.

 

Own catalog

"Warehouse" provider will be added with additional Goods from Stock Module. You can use it to create your own catalog and add any goods (either from available providers or your own).

Read more about module

Search options and conditions

Each provider has its own set of search conditions. It can be varied depending on website goals. Use GetProviderSearchMethodInfoList method to get list of available search options and information what they support. 

Search can be done by two methods: SearchItemsFrame and BatchSearchItemsFrame. They are completely identical. Difference is that BatchSearchItemsFrame allows to get additional information right per one request besides search itself. Possible additional information will be described below. 

Search conditions are also identical. They are sent into xmlParameters and presented by structure SearchItemsParameters (this structure can be found, for example, in BatchSearchItemsFrame under "xmlParameters" field by clicking on "Structure"). It has xml format (like other structure parameters). xmlParameters is obligatory as it defines what we are looking for. Examples will be described below. 

What is called search conditions 

  • The main search criteria: search phrase, category, vendor, brand.
  • Additional search criteria: filters by characteristics, novelty of goods, and another different product’s parameters.
  • Sorting of search results.

From information about search methods you can get information what is available from these, and what variants are available. 

Getting information about search methods

In the following table you can see what can be known in information about search method and what search conditions it affects. For example, for search condition OrderBy (items sorting) can be found possible values from AvailableSorts field. In information about search method these parameters are in the table in one line. 

Comparison of search conditions and capabilities 

The following table provides a comparative description of search methods as they appear in parameters structure and how they are presented in search methods description.


Parameter

Search methodsSearch

Parameter

Search methodsSearch
method information
Parameter nameValue exampleParameter desription

Parameter title

Value exampleParameter desription
ProviderProviderTaobao

Provider will be defined by other conditions (for example, categories) if provider was not explicitly specified in search methods. Search will be done by default provider if none of conditions defines provider.


Search is impossible and will give an error if different search methods lead to different providers. 

ProviderTaobaoProvider ID
Search method

 

 



SearchMethodOfficialDefault search method defined in settings is used if another one is not set.SearchMethodOfficialSearch method title
DisplayNameBranded goods (Tmall)Displayed search method title (in necessary language)
Flags
    

List of search method features
Goods quantity limitationsUseOptimalFrameSizetrue/false

Feature of using optimal frame size insted of sent one.

frameSize parameter is ignored and OptimalFrameSize parameter will be used from chosen search method if this condition was sent in true value.

   






OptimalFrameSize40

Optimal number of requested goods (page size).

Maximum possible search speed is available if such size of pages is used because it meets size of provider's pages.

   




MaximumFrameSize200

Maximum quantity of pages received for 1 query.

It can work much faster when using optimum number.

   




MaximumItemsCount4000

Number of goods received by the same search methods. Change and define search conditions to receive more goods.

Goods orderOrderByPrice:AscDefault sorting set in settings will be used if value is not set or is not included into available.AvailableSorts
 

List of available sorting in search method.

Category

CategoryId16Category ID for search.
 



Item title

  

Item title

ItemTitle

dress

Search box for item title.
ItemTitle

dress

Search box for item title.

If only item ID (item code) or link to provider's website page is indicated then only this item will be found and shown in search results (or empty if there is no such product).

   




LanguageOfQueryru

Search box language by item title. It is equal to language of goods query if not set.

Autotranslation to provider language is done if it is not equal to provider language.

  

 



Vendor

VendorId
 

Vendor IDVendortrue/falseIf search by vendor is supported.
VendorName
 

Vendor name

Vendor area

VendorAreaId
 

Vendor area IDVendorLocationtrue/falseIf search method supports vendor area.

Vendor rating

   

 




VendorRatingRangetrue/falseIf search method supports filter by vendor rating.
MinVendorRating5Minimum value of vendor ratingMinVendorRating1Minimum value of vendor rating.
MaxVendorRating15Maximum value of vendor ratingMaxVendorRating20

Maximum value of vendor rating.

BrandBrandId 

NOTE! Maximum value of vendor rating varies from trade provider to trade provider. You can find it in provider's available search methods.

BrandBrandId
Brand ID
Brand
true/falseIf search method supports brands.
BrandPropertyValueId
 

Vrand Value ID (old parameter, use BrandId)
PriceMinPrice10Minimum pricePriceRangetrue/false
 


If search method supports filter by item price.
MaxPrice1000Maximum price
CurrencyCodeCNY

Currency code for price range
First showcase currency is default one. It is converted by reverse charge and courses into provider currency for search.

 


Sales volume

MinVolume100Minimum sales volumeVolumeRange true/falseIf search method supports filter by sales volume. 
MaxVolume500Maximum sales volume
  
 



VolumeRangeLogicNone / Range / OnlyMin / OnlyMax
The
logic
of
conditions
by
sales
volume:
range,
only
minimum,
only
maximum.
Item status (new, second-hand, unused)StuffStatusNew / Unused / SecondItem statusStuffStatustrue/falseIf search method supports filter by item status.

Item configurations (color, model, etc.)

Configurators
 

List of search features provided by structure.

 

Configuratorstrue/false

If search method supports item features.

MultipleConfiguratorLogicNone / All / And

The logic of search method by several values of one feature.

Use in search of several values of one feature (for example, it is possible to output only red AND green or red OR green).

 


Item featuresFeatures
 

List of item features.

Features

 


List of special filters supported by search method.

Search by photoImageUrl
 

Address
of
the
image
to
search
for
goods
ModuleImage Photo search parameters are allowed only in the search mode, in which the Module property is equal to Image
ImageFileId
 

Image File ID for Product Search

Used if the image you searched for was first uploaded via OTAPI.

Output modeOutputModeFull / TotalCount / Provider

Search results output mode.

Usual search with goods output and all related information is done. Other variants:

  • TotalCount — output of only total number of goods without information about goods.
    It is thus possible to get total number without wasting time for processing goods themselves.
  • Provider — output of only provider and search method without search itself. Provider and search method are defined on the basis of all search conditions and different settings.
   



CategoryModeNothing
CategoryModeNothing
/ External / InternalLeaf / CurrentLevel

Categories in search results output mode.

There is categories list (not always) besides goods in search results. These categories include found goods. They are usually called clarifying categories. There are several variants of processing and output:

  • Nothing — no categories output (if they are unnecessary)
  • External — output of external categories as they are without cast to internal
  • InternalLeaf — external categories cast to internal final categories (in any place of catalog)
  • CurrentLevel — external categories cast to internal categories of current level or to root categories (if search was not by category) or to those inside category (if search was by category). Thus, clarifying categories never go beyond current level of directory view.
 



Old conditions
 
IsTmall
 IsClearItemTitles
true/falseFeature of only Tmall goods
titles cleanup
choice.

True by default, that is search outputs only original untranslated goods titles. Such behavior strongly saves translator resources and speeds up search results output as in most cases titles are not shown in goods list.

Each item also has translated title if value is false.

 

   Old conditionsIsOriginaltrue/falseFeature of only original goods choice.   IsTmalltrue/falseFeature of only Tmall goods choice.   

 

Examples of parameters with search conditions and search requests

ExamplexmlParameters valueTest request
Search by provider goods: Taobao  
Search by category: otc-4, Taobao, 50000671  

Search by characteristics: T-shirt, size XL, red color

  
Search of first 100 goods in category/catalog or request: first 100 goods by request «red T-Shirt»  
Search by code: 534184932247  
Search by key code: red women T-shirt  
Search by vendor: maxmartin玛玛绨旗舰店  
Search in original language: 红色T恤  

Search in website language:

  • website in Russian — «red T-Shirt »,
  • website in English — Red T-shirt
  
Search by brand name: vero moda  
Search by English word (without translation to Chinese): 3D  Vision  
Search in certain region: Guangzhou  
Goods search by vendor rating Image Removed  and more  
Goods s earch with price limit: from 10 to 40 yuan  
Goods s earch with discount: goods with discount  
Auction goods search: goods from auction  
Goods s earch by sales volume: descending sales number  
Search by second-hand or new goods: only new goods  
Goods search by special feature: footwear - beach  




Examples of parameters with search conditions and search requests

ExamplexmlParameters valueTest requestComment
20 items of Taobao provider


Блок кода
languagexml
firstline1
linenumberstrue
collapsetrue
<SearchItemsParameters>
<Provider>Taobao</Provider>
<CategoryId>0</CategoryId>
</SearchItemsParameters>


Documentation exampleMethod requires at least one of parameter (CategoryId, VendorName, VendorId, ItemTitle, BrandId, Configurators). Get RootCategoryId from GetProviderInfo and pass it to CategoryId (for provider's root category search).
Follow the link to set up search's items count (and other parameters)
20 items of Alibaba1688 provider by 'Storage' search method


Блок кода
languagexml
firstline1
linenumberstrue
collapsetrue
<SearchItemsParameters>
<Provider>Alibaba1688</Provider>
<CategoryId>abb-0</CategoryId>
<SearchMethod>Storage</SearchMethod>
</SearchItemsParameters> 


Documentation exampleSearch method is selected automatic (by instance key settings and search parameters) by default.
Sometimes search method must be explicit. For example, search by reviews.
More details about search methods.
T-shirts search with system's optimal requested items count/number/batch (page size)


Блок кода
languagexml
firstline1
linenumberstrue
collapsetrue
<SearchItemsParameters>
<ItemTitle>t-shirt</ItemTitle>
<UseOptimalFrameSize>true</UseOptimalFrameSize>
</SearchItemsParameters>


Documentation exampleYou can find more details about search with system's optimal requested items count/number/batch (page size) in paragraph "Goods quantity limitations". Pass any positive number into frameSize.
Sort 20 items of Taobao provider by descending price


Блок кода
languagexml
firstline1
linenumberstrue
collapsetrue
<SearchItemsParameters>
<Provider>Taobao</Provider>
<CategoryId>0</CategoryId>
<OrderBy>Price:Desc</OrderBy>
</SearchItemsParameters>


Documentation exampleMore details about available sorts.
20 items of Taobao provider sorted by descending reviews count


Блок кода
languagexml
firstline1
linenumberstrue
collapsetrue
<SearchItemsParameters>
<Provider>Taobao</Provider>
<CategoryId>0</CategoryId>
<SearchMethod>Reviews</SearchMethod>
<OrderBy>ReviewCount:Desc</OrderBy>
</SearchItemsParameters>


Documentation example

Available with "Reviews" module only.

More details about available sorts.

Search t-shirts by descending sales count


Блок кода
languagexml
firstline1
linenumberstrue
collapsetrue
<SearchItemsParameters>
<ItemTitle>t-shirt</ItemTitle>
<OrderBy>Volume:Desc</OrderBy>
</SearchItemsParameters>


Documentation exampleMore details about available sorts.
Search by internal category identifier otc-4


Блок кода
languagexml
firstline1
linenumberstrue
collapsetrue
<SearchItemsParameters>
<CategoryId>otc-4</CategoryId>
</SearchItemsParameters>


Documentation example
Search by Taobao provider's category identifier 50000671


Блок кода
languagexml
firstline1
linenumberstrue
collapsetrue
<SearchItemsParameters>
<Provider>Taobao</Provider>
<CategoryId>50000671</CategoryId>
</SearchItemsParameters>


Documentation example
Search by Alibaba1688 provider's category identifier


Блок кода
languagexml
firstline1
linenumberstrue
collapsetrue
<SearchItemsParameters>
<CategoryId>abb-1031918</CategoryId>
</SearchItemsParameters>


Documentation example
Searching for the first 100 items for "red t-shirt" query


Блок кода
languagexml
firstline1
linenumberstrue
collapsetrue
<SearchItemsParameters>
<ItemTitle>red t-shirt</ItemTitle>
</SearchItemsParameters>


Documentation example
Search in original language: 红色T恤


Блок кода
languagexml
firstline1
linenumberstrue
collapsetrue
<SearchItemsParameters>
<ItemTitle>红色T恤</ItemTitle>
<LanguageOfQuery>zh-chs</LanguageOfQuery>
</SearchItemsParameters>


Documentation example
Search in russian language - "red t-shirt"


Блок кода
languagexml
firstline1
linenumberstrue
collapsetrue
<SearchItemsParameters>
<ItemTitle>красная футболка</ItemTitle>
<LanguageOfQuery>ru</LanguageOfQuery>
</SearchItemsParameters>


Documentation example
Search in english language — red t-shirt


Блок кода
languagexml
firstline1
linenumberstrue
collapsetrue
<SearchItemsParameters>
<ItemTitle>red t-shirt</ItemTitle>
<LanguageOfQuery>en</LanguageOfQuery>
</SearchItemsParameters>


Documentation example
Search in english by phrase (without translation on chinese): 3D Vision


Блок кода
languagexml
firstline1
linenumberstrue
collapsetrue
<SearchItemsParameters>
<ItemTitle>3D Vision</ItemTitle>
<LanguageOfQuery>zh-chs</LanguageOfQuery>
</SearchItemsParameters>


Documentation example
Search by article: 583346884671


Блок кода
languagexml
firstline1
linenumberstrue
collapsetrue
<SearchItemsParameters>
<ItemTitle>583346884671</ItemTitle>
</SearchItemsParameters>


Documentation example
Search by link from Alibaba1688


Блок кода
languagexml
firstline1
linenumberstrue
collapsetrue
<SearchItemsParameters>
<ItemTitle>
https://detail.1688.com/offer/530220113667.html
</ItemTitle>
</SearchItemsParameters>


Documentation example
Search by vendor: maxmartin玛玛绨旗舰店


Блок кода
languagexml
firstline1
linenumberstrue
collapsetrue
<SearchItemsParameters>
<VendorId>maxmartin玛玛绨旗舰店</VendorId>
</SearchItemsParameters>


Documentation exampleValue of VendorId (vendor identifier) can be found in any item's information.
Search t-shirts by minimal vendor's rating 19


Блок кода
languagexml
firstline1
linenumberstrue
collapsetrue
<SearchItemsParameters>
<ItemTitle>t-shirt</ItemTitle>
<MinVendorRating>19</MinVendorRating>
</SearchItemsParameters>


Documentation example
Search by brand's name: vero moda


Блок кода
languagexml
firstline1
linenumberstrue
collapsetrue
<SearchItemsParameters>
<BrandId>29902</BrandId>
</SearchItemsParameters>


Documentation example
Search t-shirts by price interval: from 10 to 40 yuan


Блок кода
languagexml
firstline1
linenumberstrue
collapsetrue
<SearchItemsParameters>
<ItemTitle>t-shirt</ItemTitle>
<CurrencyCode>CNY</CurrencyCode>
<MinPrice>10</MinPrice>
<MaxPrice>40</MaxPrice>
</SearchItemsParameters>


Documentation exampleSelection includes items with promotion price (PromotionPrice). Currency (if not explicit) gets from administrators panel (first currency from list) and converts.
Search t-shirt by USD equivalent price not exceed 3


Блок кода
languagexml
firstline1
linenumberstrue
collapsetrue
<SearchItemsParameters>
<ItemTitle>t-shirt</ItemTitle>
<MaxPrice>3</MaxPrice>
<CurrencyCode>USD</CurrencyCode>
</SearchItemsParameters>


Documentation exampleGet currency code (CurrencyCode) by using GetCurrencyInstanceList or GetInstanceCurrencyInfoList methods.
Search t-shirt with minimal sales count of 50


Блок кода
languagexml
firstline1
linenumberstrue
collapsetrue
<SearchItemsParameters>
<ItemTitle>t-shirt</ItemTitle>
<MinVolume>50</MinVolume>
</SearchItemsParameters>


Documentation example
Search t-shirt with minimal first lot 5


Блок кода
languagexml
firstline1
linenumberstrue
collapsetrue
<SearchItemsParameters>
<Provider>Alibaba1688</Provider>
<ItemTitle>t-shirt</ItemTitle>
<MinFirstLot>5</MinFirstLot>
</SearchItemsParameters>


Documentation exampleAlibaba1688 only.
Search t-shirt with maximal first lot 1 (equals to retail order)


Блок кода
languagexml
firstline1
linenumberstrue
collapsetrue
<SearchItemsParameters>
<Provider>Alibaba1688</Provider>
<ItemTitle>t-shirt</ItemTitle>
<MaxFirstLot>1</MaxFirstLot>
</SearchItemsParameters>


Documentation example
Search t-shirts by condition (new)


Блок кода
languagexml
firstline1
linenumberstrue
collapsetrue
<SearchItemsParameters>
<ItemTitle>t-shirt</ItemTitle>
<StuffStatus>New</StuffStatus>
</SearchItemsParameters>


Documentation exampleActualy we have 2 conditions right now: 'new' and 'used'.
New: new
Second: used
Search by attribute: red coloured XL size t-shirt


Блок кода
languagexml
firstline1
linenumberstrue
collapsetrue
<SearchItemsParameters>
<ItemTitle>t-shirt</ItemTitle>
<Configurators>
<Configurator Pid="20509" Vid="28317" />
<Configurator Pid="1627207" Vid="13535612018" />
</Configurators>
</SearchItemsParameters>


Documentation exampleSearch attributes for selected item by using BatchGetItemFullInfo (example's item - id 646674173023) (<Attributes> )
<ItemAttribute Pid="20509" Vid="28317"> (for XL size)
<ItemAttribute Pid="1627207" Vid="13535612018"> (for "red" colour)
With additional information block 'SearchProperties' pass (more details about additional information blocks)
Search t-shirts with discount


Блок кода
languagexml
firstline1
linenumberstrue
collapsetrue
<SearchItemsParameters>
<ItemTitle>t-shirt</ItemTitle>
<Features>
<Feature Name="Discount">true</Feature>
</Features>
</SearchItemsParameters>


Documentation exampleList of available features can get from documentation's paragraph #2.
Search t-shirts in stock


Блок кода
languagexml
firstline1
linenumberstrue
collapsetrue
<SearchItemsParameters>
<ItemTitle>t-shirt</ItemTitle>
<Features>
<Feature Name="IsStock">true</Feature>
</Features>
</SearchItemsParameters>


Documentation example
Search TMall t-shirts


Блок кода
languagexml
firstline1
linenumberstrue
collapsetrue
<SearchItemsParameters>
<ItemTitle>t-shirt</ItemTitle>
<Features>
<Feature Name="Tmall">true</Feature>
</Features>
</SearchItemsParameters>


Documentation example
Search items with reviews after purchase in "dress" category


Блок кода
languagexml
firstline1
linenumberstrue
collapsetrue
<SearchItemsParameters>
<CategoryId>162104</CategoryId>
<SearchMethod>Reviews</SearchMethod>
<Features>
<Feature Name="PurchasedItemReviews">true</Feature>
</Features>
</SearchItemsParameters>


Documentation exampleAvailable with "Reviews" module only.
Search by image


Блок кода
languagexml
firstline1
linenumberstrue
collapsetrue
<SearchItemsParameters>
<ImageUrl>
https://img.alicdn.com/imgextra/i1/529782397/O1CN01qnZeTY1TZs3xAcmOv_!!529782397.jpg
</ImageUrl>
</SearchItemsParameters>


Documentation example
Can search by image URL or by uploaded through API file: more details about search by image.

...


Search results description

...