Skip to end of metadata
Go to start of metadata

Features

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

Trade provider

Trade provider is a service (or marketplace) for trading. Information about goods (titles, settings, configuration, etc.) and categories is sent to OT API from trade provider and then is broadcasted to website via OT API Key.

Check available trade providers.

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.

 

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

 

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

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 ratingMaxVendorRating20Maximum value of vendor rating.
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 / OnlyMaxThe 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 goodsModuleImage 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 / 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.
   
IsClearItemTitlestrue/false

Feature of goods titles cleanup.

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

 

Search results description

Search results are presented by OtapiItemSearchResult structure, fields' description is shown below.

ParameterDescription
ItemsList of found goods with full number of goods
CategoriesList of categories containing searched goods (clarifying goods)
BrandsList of brands containing goods (clarifying brands)
TranslatedItemTitleText by which goods were really searched (translated to provider language)
ProviderProvider in which search was done
SearchMethodSearch method used for search
CurrentSortReal current sorting
CurrentFrameSizeReal current frame size (page)
MaximumPageCountMaximum number of pages in search
IsFoundByItemIdIf true, then search results contain 1 product found by code or link

Additional blocks of information in BatchSearchItemsFrame

It is possible to get additional information for one OTAPI request using BatchSearchItemsFrame. List of additional blocks is available in blockList parameter separated by commas. Result is BatchItemSearchResult including usual OtapiItemSearchResult and also all properties for additional information.

Block nameDescription
SubCategoriesget all subcategories if search by category
SearchPropertiesget filters  by  characteristics/properties
RootPath get path to root if search  by  category
Vendorget information on seller if search  by  seller
Brandget information on brand if search  by  brand
Categoryget information on category of search  by  category
HintCategoriesget appropriate categories for title if search by text
AvailableSearchMethodsget list of appropriate matching data for search methods  parameters  and all information on them
  • No labels