Назначение

Используется для установки остатков товаров.

Пример запроса JSON (v1)

Пример демонстрирует вызов метода /stock/set.

Пример запроса (версия апи до 11)

POST /ExternalExchange/v1/stock/set HTTP/1.1 
Content-Type: application/json; 

{
	"externalSystemId": "000000002",
	"merchantId": "000000006",
	"productStockList": [
		{
			"externalSystemProductId": "00-07019717",
			"stock": 2
		},
		{
			"externalSystemProductId": "00-07020795",
			"stock": 0
		}
	]
}
JS

Пример запроса

POST /ExternalExchange/v1/stock/set HTTP/1.1 
Content-Type: application/json; 

{
	"externalSystemId": "000000002",
	"merchantId": "000000006",
	"productStockList": [
		{
			"externalSystemProductId": "00-07019717",
			"stock": 2,
			"stockId": "f34a28a5-ea38-40f0-9612-1ef4915aceea"
		},
		{
			"externalSystemProductId": "00-07020795",
			"stock": 0,
 			"stockId": "f34a28a5-ea38-40f0-9612-1ef4915aceea"
	    }
	]
}
JS

Пример успешного ответа (версия апи до 11)

{
	"message": "Stocks were successfully updated",
	"success": true,
	"successInAllSubrequests": true,
	"merchantId": "000000006",
	"resultList": [
		{
			"message": "",
			"success": true,
			"marketplaceProductId": "",
			"externalSystemProductId": "00-07019717"
		},
		{
			"message": "",
			"success": true,
			"marketplaceProductId": "",
			"externalSystemProductId": "00-07020795"
		}
	]
}
JS

Пример ответа c ошибками

{
	"message": "Request was valid but all products have errors",
	"success": false,
	"successInAllSubrequests": false,
	"merchantId": "000000006",
	"resultList": [
		{
			"message": "Product not found by merchantId = 000000006, externalSystemId = 123, \
						marketplaceProductId = and externalSystemProductId = 00-07019717",
			"success": false,
			"marketplaceProductId": "",
			"externalSystemProductId": "00-07019717",
		 "stockId": "f34a28a5-ea38-40f0-9612-1ef4915aceea"
		},
		{
			"message": "Product not found by merchantId = 000000006, externalSystemId = 123, \
						marketplaceProductId = and externalSystemProductId = 00-07020795",
			"success": false,
			"marketplaceProductId": "",
			"externalSystemProductId": "00-07020795",
 			"stockId": "f34a28a5-ea38-40f0-9612-1ef4915aceea" 
		}
	]
}
JS

Описание параметров запроса


ПараметрТипОбязателенОписание
1externalSystemIdstringНет

Код внешней системы откуда идет подключение к базе маркета

2merchantIdstringДа

Внутренний идентификатор личного кабинета торговой площадки (Справочник "Подключения к личным кабинетам"). Используется для поиска "Подключения к личному кабинету". В найденном подключении используется настроенный "Склад хранения" для установки полученных в запросе остатков.


productStockListМассивДаМассив остатков товаров
3externalSystemProductIdstringНетИдентификатор товара во внешней системы. Например, код справочника "Номенклатура" во внешней системе 1С.
4marketplaceProductIdstringНетИдентификатор товара торговой площадки
5stockdecimalДаОстаток товара, если нет остатка по товару, то отправляется значение 0.
6stockIdstringТолько для торговой площадки у которой включен многоскладской учетИдентификатор склада, используется начиная с 11 версии апи маркета

Описание параметров ответа


ПараметрТипОбязателенОписание
1merchantIdstringДа

Внутренний идентификатор личного кабинета торговой площадки

2messagestringДа

Описание результата запроса:

  • "Stocks were successfully updated"- все остатки установлены успешно
  • "Stocks for some products was not updated" - на некоторые товары не удалось установить остаток
  • "Some product entries contain empty marketplaceProductId and empty externalSystemProductId" - не заполнен хотя бы один идентификатор товара
3successInAllSubrequestsbooleanДа

Статус выполнения подзапросов метода

  • true - все подзапросы метода выполнены успешно
  • false - подзапрос выполнен с ошибкой. Описание ошибки см. в параметре message
4successbooleanДа

Общий статус запроса

  • true - запрос успешный
  • false - выполнен с ошибкой

resultListМассивНет

Массив с результатами установки остатков по товарам

5externalSystemProductIdstringНетИдентификатор товара во внешней системы. Например, код справочника "Номенклатура" во внешней системе 1С.
6marketplaceProductIdstringНетИдентификатор товара торговой площадки
7stockIdstringНетИдентификатор склада, используется начиная с 11 версии апи маркета
8messagestringДа

Описание результата запроса по позиции товара

  • (Пусто) - ошибок нет
  • "For merchantId = %1 and externalSystemId = %2 there are more than one entry with marketplaceProductId = %3 and externalSystemProductId = %4 in request" - передан неуникальный идентификатор товара
  • "Product not found by merchantId = %1, externalSystemId = %2, marketplaceProductId = %3 and externalSystemProductId = %4" - товар не найден по идентификатору
  • "Internal error" - внутренняя ошибка сервиса
9successbooleanДа

Статус выполнения изменений по позиции товара

  • true - запрос успешный
  • false - выполнен с ошибкой