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 briadcased 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.
| Title | ID | Desription |
|---|---|---|
| Extended search | Extended | Search on whole Taobao catalog using special OTalgorithms |
| Tmall search | Official | Only 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). 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). 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 methods | Search method information | ||||
|---|---|---|---|---|---|---|
| Parameter name | Value example | Parameter desription | Parameter title | Value example | Parameter desription | |
| Provider | Provider | Taobao | 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.
| Provider | Taobao | Provider ID |
| Search method
| SearchMethod | Official | Default search method defined in settings is used if another one is not set. | SearchMethod | Official | Search method title |
| DisplayName | Branded goods (Tmall) | Displayed search method title (in necessary language) | ||||
| Flags | List of search method features | |||||
| Goods quantity limitations | UseOptimalFrameSize | true/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. | |||
| OptimalFrameSize | 40 | Optimal number of requested goods (page size). Maximum possible search speed is available if such size of pages is used becauseit meets size of provider's pages. | ||||
| MaximumFrameSize | 200 | Maximum quantity of pages received for 1 query. It can work much faster when using optimum number. | ||||
| MaximumItemsCount | 4000 | Number of goods received by the same search methods. Change and define search conditions to receive more goods. | ||||
| Goods order | OrderBy | Price:Asc | Если не указано, или указанное значение не входит в число допустимых, будет использована определенная в настройках сортировка по умолчанию. | AvailableSorts | Список допустимых сортировок в способе поиска. | |
Category | CategoryId | 16 | Идентификатор категории, в которой искать товары. | |||
Item title | ItemTitle | платье | Поисковая строка по названию товара. Если в поисковой строке указаны только идентификатор (артикул) товара или ссылка на страницу на сайте провайдера, то будет найден и выдан именно этот единственный товар (или пусто, если таковой товар отсутствует). | |||
| LanguageOfQuery | ru | Язык поисковой строки по названию товара. Если не указан, считается равным языку выдачи товаров. Если не равен языку провайдера, то производится автоперевод на язык провайдера. | ||||
Vendor | VendorId | Vendor ID | Vendor | true/false | Поддерживается ли поиск по продавцу | |
| VendorName | Vendor name | |||||
Vendor area | VendorAreaId | Vendor area ID | VendorLocation | true/false | Поддерживает ли способ поиска местонахождение продавца | |
Vendor rating | VendorRatingRange | true/false | Поддерживает ли способ поиска фильтр по рейтингу продавца | |||
| MinVendorRating | 5 | Minimum value of vendor rating | MinVendorRating | 1 | Минимальное значение рейтинга продавца | |
| MaxVendorRating | 15 | Maximum value of vendor rating | MaxVendorRating | 20 | Максимальное значение рейтинга продавца | |
| Brand | BrandId | Brand ID | Brand | true/false | Поддерживает ли способ поиска бренды | |
| BrandPropertyValueId | Vrand Value ID (old parameter, use BrandId) | |||||
| Price | MinPrice | 10 | Minimum price | PriceRange | true/false
| Поддерживает ли способ поиска фильтр по цене товара |
| MaxPrice | 1000 | Maximum price | ||||
| CurrencyCode | CNY | Currency code for price range
| ||||
Sales volume | MinVolume | 100 | Minimum sales volume | VolumeRange | true/false | Поддерживает ли способ поиска фильтр по объему продаж |
| MaxVolume | 500 | Maximum sales volume | ||||
| VolumeRangeLogic | None / Range / OnlyMin / OnlyMax | Логика работы условий по объему продаж: диапазон, только минимум, только максимум. | ||||
| Item status (new, second-hand, unused) | StuffStatus | New / Unused / Second | Item status | StuffStatus | true/false | Поддерживает ли способ поиска фильтр по состоянию товара |
Item configurations (color, model, etc.) | Configurators | List of search features provided by structure.
| Configurators | true/false | Поддерживает ли способ поиска характеристики товара. | |
| MultipleConfiguratorLogic | None / All / And | Логика работы способа поиска по нескольким значениям одной характеристики. Использование в поиске нескольких значений одной характеристики. (например, можно вывести только красное, красное И зеленое, красное ИЛИ зеленое)
| ||||
| Item features | Features | List of item features. | Features | Список специальных фильтров, поддерживаемых способом поиска | ||
| Output mode | OutputMode | Full / TotalCount / Provider | Режим выдачи результатов поиска. По умолчанию делается обычный поиск, с выдачей товаров и всего сопутствующего. Другие варианты:
| |||
| CategoryMode | Nothing / External / InternalLeaf / CurrentLevel | Режим выдачи категорий в результатах поиска. В результатах поиска помимо товаров есть еще, хоть и не всегда, список категорий, в которых находятся найденные товары. Обычно они называются уточняющими категориями. Есть несколько вариантов обработки и выдачи данного списка.
| ||||
| IsClearItemTitles | true/false | Признак очистки заголовков товаров. По умолчанию true, то есть поиск выдает только оригинальные не-переведенные названия товаров, т.к. в большинстве случаев названия не показываются в списке товаров, то данное поведение сильно экономит ресурсы транслятора и немного ускоряет получение результатов поиска. При значении false, в каждом товаре также выдается и переведенное название. | ||||
| Old conditions | IsOriginal | true/false | Признак выбора только оригинальных товаров | |||
| IsTmall | true/false | Признак выбора только товаров из Tmall | ||||
Примеры параметров с условиями поиска и запросов поиска
| Пример | Значение xmlParameters | Тестовый запрос |
|---|---|---|
Описание результатов поиска
Результаты поиска представлены структурой OtapiItemSearchResult, ниже описание её полей.
| Параметр | Описание |
|---|---|
| Items | Список найденных товаров с указанием полного числа товаров |
| Categories | Список категорий, в которых есть искомые товары (уточняющие товары) |
| Brands | Список брендов, в которых встречаются товары (уточняющие бренды) |
| TranslatedItemTitle | Текст, по которому реально искались товары (переведенный на язык провайдера) |
| Provider | Товарный провайдер, в котором был произведен поиск |
| SearchMethod | Способ поиска, которым был произведен поиск |
| CurrentSort | Реальная текущая сортировка |
| CurrentFrameSize | Реальный текущий размер фрейма (страницы) |
| MaximumPageCount | Максимальное число страниц в поиске |
| IsFoundByItemId | Если true, то в результатах поиска содержится 1 товар, который был найден по артикулу или ссылке |
Дополнительные блоки информации в BatchSearchItemsFrame
Используя метод BatchSearchItemsFrame, можно получить дополнительную информацию за тот же один запрос к OTAPI. Список дополнительных блоков передается в параметре blockList, через запятую. Результатом является BatchItemSearchResult, который включает в себя обычный OtapiItemSearchResult, а также все свойства для дополнительной информации.
| Название блока | Описание |
|---|---|
| SubCategories | get all subcategories if search by category |
| SearchProperties | get filters by characteristics/properties |
| RootPath | get path to root if search by category |
| Vendor | get information on seller if search by seller |
| Brand | get information on brand if search by brand |
| Category | get information on category of search by category |
| HintCategories | get appropriate categories for title if search by text |
| AvailableSearchMethods | get list of appropriate matching data for search methods parameters and all information on them |