Поиск - qwep-ru/userapi GitHub Wiki

POST /search

Заголовки:

• Authorization: Bearer TOKEN (полученный методом авторизации)

Параметры:

• article — артикул для поиска, text
• brand — бренд, если указан, автоматически раскрываются уточнения с указанными article+brand, text
• timeout — таймаут поиска в миллисекундах, integer (по умолчанию — 10000 (10 секунд))
• excludePromo — исключить промо-предложения из поиска, boolean (по умолчанию — false)
• shortArticle — ID артикула из этого метода, text
• flatView — возвращать результаты в одном массиве, boolean (по умолчанию результаты находятся в массивах, разделенных по аккаунтам = false)
• accounts — массив аккаунтов, по которым нужно произвести поиск (если не передан — производится поиск по всем активным аккаунтам; если для поставщика заведено несколько аккаунтов, поиск произведется по всем этим аккаунтам)
  • id — ID аккаунта, integer
• vendors — массив поставщиков (или филиалов), по которым нужно произвести поиск (если не передан — производится поиск по всем активным аккаунтам)
  • id — ID поставщика, UUID
• type — 0 или 1, тип взаимодействия:
  • 0 - синхронное, результаты возвращаются в ответе на этот же запрос (по умолчанию)
  • 1 - асинхронное, ответ возвращается сразу с выданным searchId, поиск запускается, результаты можно получить методами /search/results или /search/updates. Если задан Callback URL, то результаты отправляются еще и на URL пользователя (Callback URL задается по запросу, подробнее в разделе отправка данных на внешний ресурс), integer
• highlightCross — проверять кроссировку товаров поставщиков, boolean
• replaceVendorName — выводить в результатах имена аккаунтов вместо имен поставщиков (указанный в методе /accounts/add), boolean

Ответ:

• searchId — уникальный ID поиска, по которому можно получить результаты с /search/results или /search/updates, UUID
• timeout — таймаут поиск в миллисекундах, integer
• finished — статус поиска (закончен или нет), boolean
• results — результаты поиска
  • vendorId — ID поставщика
  • vendorTitle — название поставщика
  • branchId — ID филиала
  • branchTitle — название филиала
  • accountId — ID аккаунта, integer
  • finished — статус поиска, boolean
  • executionTime — время выполнения поиска в секундах, float
  • clarifications — уточнения
    • article — артикул форматированный, text
    • clarificationId — ID уточнения, UUID
    • brand — Название компании, text
    • notes — доп. информация, text
    • photo — URL на фотографию, text
    • title — наименование, text
    • opened — было ли раскрыто уточнение, boolean
  • items — результаты
    • itemId — ID результата (используется при покупке)
    • article — артикул форматированный, text
    • city — ID города (если определился по складу)
    • brand — Название компании, text
    • delivery — срок поставки, text
    • deliveryStart — форматированная дата начала периода поставки, dateTime
    • deliveryEnd — форматированная дата окончания периода поставки (заполняется только в случае, если в delivery указан период "3-5 дн.", например), dateTime
    • fromClarification — ID раскрытого уточнения (если это результат раскрытия уточнения), UUID
    • notes — доп. информация, text
    • originalArticle — артикул оригинальный (как на сайте поставщика), text
    • photo — URL на фотографию, text
    • price — цена
      • value — значение, float
      • currency — валюта, text
      • formatted — форматированное значение, text
    • minQuantity — минимальное количество, которое можно добавить в корзину, integer
    • quantity — доступное количество
      • value — значение, integer
      • sign — знак ">", "<" или "=", text
      • unit — единица измерения, text
      • multiplicity — кратность товара (некратное количество нельзя добавить в корзину), integer
      • formatted — форматированное значение, text
    • info — характеристики поставки
      • supplyPercent — процент успешных поставок, integer
      • isMarkdown — уцененный товар, boolean
      • isRefundAvailable — возможность возврата, boolean
      • refundDescription — условия возврата, text
      • isUsed — Б/У товар, boolean
      • vendorRating — рейтинг поставщика (от 1 до 5), integer
      • isDealerWarehouse — признак дилерского склада, boolean
    • status — статус товара, text
    • subway — название метро, text
    • title — наименование, text
    • warehouse — склад, text
    • qwepCross — состояние кросса: 1 - товар является кроссом запрашиваемого, в остальных слуях - информации недостаточно, int
  • stats — статистика
    • counts — сводные данные по количествам
      • clarifications — кол-во уточнений
      • items — кол-во результатов
      • errors — кол-во ошибок
    • timings — данные по времени выполнения
      • api — данные по обработке запросов серверами QWEP
        • apiCount — кол-во запросов
        • apiAvg — среднее время выполнения
        • apiMin — минимальное время выполнения
        • apiMax — максимальное время выполнения
      • vendor — данные по обработке запросов серверами поставщика
        • venCount — кол-во запросов
        • venAvg — среднее время выполнения
        • venMin — минимальное время выполнения
        • venMax — максимальное время выполнения

Пример:

Запрос:

POST https://userapi.qwep.ru/search?json HTTP/1.1
Authorization: Bearer TPYDICJIDU883JXCUIA19IUGPP

{
	"Request": {
		"RequestData": {
			"article": "01244",
			"brand": "Febi",
			"accounts": [
				{
					"id": 14
				}
			],
			"type": 0
		}
	}
}

Ответ:

{
	"Response": {
		"entity": {
			"searchId": "9ea8c62f-5d56-4684-a14e-dd057d0a2006",
			"finished": true,
			"results": [
				{
					"accountId": 14,
					"vendorId": "b4cc36d8-edd5-40a7-ad58-cdc155e4b6ed",
					"vendorTitle": "Adeo Pro",
					"branchId": null,
					"branchTitle": null,
					"finished": true,
					"executionTime": 25.2299,
					"clarifications": [
						{
							"clarificationId": "a59b28f4-c7e8-4006-be4b-d24225ea85de",
							"brand": "Febi",
							"article": "01244",
							"title": "Шайба колеса (C20.5/74361) L=8mm d(внутр)=20.5mm d(нар)=34mm BPW. Iveco. Mercedes. MAN. Evobus",
							"photo": "",
							"notes": ""
						},
						{
							"clarificationId": "9c84c417-3f2c-416d-bbf6-f5ea7f4f6b3d",
							"brand": "Metalcaucho",
							"article": "01244",
							"title": "К-КТ ПЫЛЬНИКА РУЛЕВОЙ SMART",
							"photo": "",
							"notes": ""
						},
						{
							"clarificationId": "c4592458-2c59-46e9-8d13-d95fe96f4206",
							"brand": "Walker",
							"article": "01244",
							"title": "",
							"photo": "",
							"notes": ""
						}
					],
					"items": [],
					"errors": [],
					"stats": {
						"timings": {
							"vendor": {
								"venMin": "0.1659",
								"venMax": "0.1659",
								"venAvg": "0.1659",
								"venCount": "1"
							},
							"api": {
								"apiMin": "0.6079",
								"apiMax": "0.6079",
								"apiAvg": "0.6079",
								"apiCount": "1"
							}
						},
						"counts": {
							"clarifications": 30,
							"items": 0,
							"errors": 0
						}
					}
				}
			],
			"type": 0
		},
		"errors": [],
		"warnings": []
	}
}