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

Назначение

Используется для создания новых или обновления существующих товаров на торговой площадке.

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

Пример демонстрирует вызов метода /v3/product/create.

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

POST /ExternalExchange/v3/product/create HTTP/1.1 
Content-Type: application/json; 

{
	"externalSystemId": "000000001",
	"nomenclatureSearchAttribute": "article",
	"products": [
		{
			"externalSystemProductId": "00-07030193",
			"updateExistingProduct": true,
			"productName": "Шкаф для посуды",
			"productPrintName": "Шкаф для посуды",
			"productArticle": "00-00011111",
			"productFullDescription": "Очень красивый шкаф для посуды",
			"productGroups": "Корпусная мебель",
			"productGuid": "b0d4ce5d-2757-4699-948c-cfa72ba94f87",
			"productCharacteristicGuid": "b0d4ce5d-2757-4699-948c-cfa72ba94f84",
			"productCharacteristicName": "Размер 10",
			"kindName": "Товары",
			"unit": {
				"code": "796",
				"name": "шт",
				"type": "NumberOfPieces"
			},
			"vat": "20",
			"barcodes": [
				{
					"barcode": "2000000049427"
				}
			],
			"additionalProperties": [
				{
					"name": "Ссылка на фото",
					"value": "http://myserver.com/picture1.png"
				}
			]
		}
	]
}

JS

Пример успешного ответа

{
  "message": "All products were successfully processed",
  "externalSystemId": "000000002",
  "success": true,
  "successInAllSubrequests": true
  "resultList": [
    {
      "message": "",
      "updated": true,
      "externalSystemProductId": "00-00011111",
      "success": true
    }
  ]
}

JS

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

Пример 1 
{
  "resultList": [],
  "message": "External system wan not found by externalSystemId",
  "externalSystemId": "000000001",
  "success": false,
  "successInAllSubrequests": false
}

Пример 2
{
  "message": "All products were successfully processed",
  "resultList": [
    {
      "message": "Product already created for externalSystemId = 00-07030193",
      "updated": false,
      "externalSystemProductId": "00-07030193",
      "success": true
    }
  ],
  "externalSystemId": "123",
  "success": true,
  "successInAllSubrequests": true
}

JS

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

	Параметр	Тип	Обязателен	Описание
1	externalSystemId	string	Нет	Код внешней системы откуда идет подключение к базе маркета
2	nomenclatureSearchAttribute	string	Да	Код параметра поиска товара: name - поиск по наименование article - поиск по артикулу code - поиск по коду none - не определено. Поиск товаров не будет выполняться.
	products	Массив	Да	Массив товаров для создания или обновления
3	externalSystemProductId	string	Да	Идентификатор товара во внешней системы. Например, код справочника "Номенклатура" во внешней системе 1С. В общем случае является идентификатором комбинации *Номенклатура + Характеристика*.
4	updateExistingProduct	boolean	Да	Признак, разрешающий или запрещающий обновлять существующий товар
5	productCode	string	Нет	Код товара
6	productGuid	string	Да	Идентификатор номенклатуры (без характеристики) внешней системы для однозначной идентификации элементов во время загрузки
7	productName	string	Да	Краткое наименование товара
8	productPrintName	string	Нет	Полное наименование товара
9	productCharacteristicGuid	string	Нет	Идентификатор характеристики внешней системы для однозначной идентификации элементов во время загрузки Является обязательным, если заполнено поле "productCharacteristicName"
10	productCharacteristicName	string	Нет	Наименование характеристики товара Является обязательным, если заполнено поле "productCharacteristicGuid"
11	productArticle	string	Нет	Артикул товара
12	productFullDescription	string	Нет	Описание товара
13	productGroups	string	Нет	Строка иерархии групп, уровни групп разделяются символом "$$", например: Спортивные товары$$Велосипеды$$Горные
14	kindName	string	Нет	Наименование вида товара
15	vat	string	Да	Код ставки НДС: "10" - НДС10 "18"- НДС18 "20"- НДС20 "NoVat"- БезНДС
16	featureOfCis	string	Нет	Особенность учета номенклатуры (Идентификатор соответствующего значения перечисления) Для никакой особенности использовать "none"
	unit	object	Да	Описание единицы измерения товара.
17	code	string	Да	Код единицы измерения по ОКЕИ, может быть пустым (в v1 - measureUnitCode, в v2 - unitCode)
18	name	string	Да	Наименование единицы измерения.
19	type	string	Да	Тип измеряемой величины: "Weight" - вес "Volume" - объем "Area" - площадь "Length" - длина "NumberOfPieces" - количество штук "Capacity" - мощность "Energy" - энергия "ElectricСharge" - электрический заряд "Time" - время "Undefined" - значение типа не задано
	barcodes	array	Нет	Массив штрихкодов номенклатуры для добавления, существующие штрихкоды не удаляются (добавлено в v2)
20	barcode	string	Да	Добавляемый штрихкод номенклатуры. Если используется для другой номенклатуру, то он переназначается на текущую
21	packageName	string	Нет	Наименование упаковки товара. Выполняется поиск по полям: Наименование + Владелец (номенклатура или набор упаковок)
	additionalProperties	array	Нет	Массив дополнительных свойств товара
22	name	string	Да	Строковый идентификатор свойства товара. Может содержать любые символы, в т.ч. и пробельные.
23	value	string, float, boolean, dateTime	Нет	Значение свойства товара.
	marketplacesData	array	Нет	Массив идентификаторов площадок для привязки товара
24	merchantId	string	Да	Идентификатор личного кабинета (код элемента справочника)
25	marketplaceProductId	string	Нет	Идентификатор товара на площадке

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

	Параметр	Тип	Обязателен	Описание
	Параметры
1	externalSystemId	string	Да	Код внешней системы
2	message	string	Да	Описание результата запроса: "Request was valid but all products have errors" - все товары не удалось создать или обновить "Request was valid but some products have errors" - некоторые товары не удалось создать или обновить "All products were successfully processed" - все товары успешно созданы или обновлены
3	successInAllSubrequests	boolean	Да	Статус выполнения подзапросов метода true - все подзапросы метода выполнены успешно false - подзапрос выполнен с ошибкой. Описание ошибки см. в параметре message
4	success	boolean	Да	Общий статус запроса true - запрос успешный false - выполнен с ошибкой
	resultList	Массив	Нет	Массив созданных или обновленных товаров
5	message	string	Да	Описание результата запроса по позиции товара "Product already created for externalSystemId" - Попытка обновить существующий товар, где updateExistingProduct=false "For externalSystemId = 111 there are more than one entry with externalSystemProductId = 111 in request" - передан неуникальный идентификатор товара во внешней системе (externalSystemProductId) "Empty externalSystemProductId is not permitted" - пустой идентификатор товара во внешней системе (externalSystemProductId)
6	updated	boolean	Да	Признак обновления товара true - товар создан или обновлен false - не удалось создать или обновить (описание ошибки в параметре message)
7	externalSystemProductId	string	Да	Идентификатор товара во внешней системы. Например, код справочника "Номенклатура" во внешней системе 1С.
8	success	boolean	Да	Статус выполнения изменений по позиции товара true - запрос успешный false - выполнен с ошибкой

Создание товара (v3/product/create)

Назначение

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

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

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

Сбор данных cookies