Skip to main content

/api/lite/import/task

Список заданий(подробная информация по заданию) (/api/lite/import/task)

/api/lite/import/task

 

Положительный результат запроса: 

{
    "success": true,
    "recordsTotal": 2,
    "tasks": [
        {
            "success": true,
            "date": "2020-07-13 18:58:57",
            "id": "1002",
            "processed": false,
            "enqueued": false,
            "rowsTotal": 9,
          	"emptyRowsCount":0,
            "lastProcessedRow": 0,
            "itemsProcessedCount": 0,
            "itemsFailedCount": 0,
            "progressPercentage": 0,
            "failedRowsNum": "",
            "itemsCreatedCount": null,
            "itemsUpdatedCount": null,
            "startTime": "2020-07-13 18:58:57",
            "finishTime": null
        },
        {
            "success": true,
            "date": "2020-07-12 17:45:00",
            "id": "1001",
            "processed": true,
            "enqueued": true,
            "rowsTotal": 9,
          	"emptyRowsCount":0,
            "lastProcessedRow": 9,
            "itemsProcessedCount": 9,
            "itemsFailedCount": 0,
            "progressPercentage": 100,
            "failedRowsNum": "",
            "itemsCreatedCount": 0,
            "itemsUpdatedCount": 9,
            "startTime": "2020-07-13 16:44:12,
            "finishTime": "2020-07-13 16:45:22
        }
    ]
}

Пейджинация

Для пейджинации используются параметры page и size: size - заказов на странице, page - номер страницы.

Пример: /api/lite/import/task?page=0&size=200

Если параметры не переданы, то дефолтные значения page=0&size=100

Также, для отображение пейджинации следует анализировать параметр recordsTotal, возвращающий общее количество записей (с учетом примененной фильтрации, если она есть).

параметр: templateType=SKU тип заданий для отображения. Возможные варианты: [SKU, ORDER] Если не передан, то по умолчанию - SKU

параметр: id (Идентификатор задания, если передан, возвращается подробная информация по заданию)

например api/lite/import/task?id=1001

Положительный результат запроса: 

{
    "success": true,
    "date": "2020-07-13 18:58:57",
    "id": "1002",
    "processed": false,
    "enqueued": false,
    "rowsTotal": 9,
  	"emptyRowsCount":0,
    "lastProcessedRow": 0,
    "itemsProcessedCount": 0,
    "itemsFailedCount": 0,
    "progressPercentage": 11,
    "failedRowsNum": "",
    "itemsCreatedCount": null,
    "itemsUpdatedCount": null,
    "startTime": null,
    "finishTime": null,
    "warehouseName": "Свой склад",
    "fileUrl": "https://storage.yandexcloud.net/images-k2c/f328ff56-ec93-4663-b747-7ee96957ca8e.xls",
    "fieldMatching": {
        "isNovelty": "новинка",
        "brandName": "бренд",
        "stockReserved": "резерв",
        "productId": "ид продукта",
        "oldPrice": "старая цена",
        "available": "доступен",
        "VAT": "ставка ндс",
        "description": "описание",
        "weight": "вес",
        "isBestseller": "хит",
        "stockAvailable": "остаток",
        "article": "артикул",
        "deleted": "удален",
        "depth": "глубина",
        "price": "розничная цена",
        "width": "ширина",
        "id": "код в kak2c",
        "extId": "внешний код",
        "countryOfOrigin": "страна производитель",
        "variantId": "ид варианта",
        "shortName": "наименование",
        "barcode": "штрихкод",
        "defaultImage": "url картинки",
        "height": "высота"
    },
     "processingLog": [
      	{
      		"time":"2020-07-30 11:25:14",
      		"strNum":1,
      		"event":"Строка успешно обработана",
      		"level":"INFO"
   		},
        {
            "time": "2020-08-05 16:15:53",
            "strNum": 2,
            "event": "Обнаружена пустая строка",
            "level": "WARNING"
        },
        {
            "time": "2020-08-05 16:15:53",
            "strNum": 3,
            "event": "Не задано наименование для нового продукта.",
            "level": "ERROR"
        }
    ],
    "importType" : "UPDATE", //"CREATE" Режим загрузки номенклатуры
	"searchField" : "ID", //"EXTID" | "ARTICLE" | "BARCODE" Сопоставление номенклатуры
	"replacePictures" : false, //Заменять изображения
	"updateRests", : false //Загружать остатки
  	"clearEmptyValues" : false //Стирать значения, если они пустые
}

 

 

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

Пример ошибки
{
  "success": false,
  "errors": [
    {
      "code": 0,
      "message": "текст ошибки"
    }
  ]
}

Обновить настройки задания  (/api/lite/import/task)

/api/lite/import/task

параметр: id (идентификатор задания)

например api/lite/import/task?id=1001

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

{
	"id": "ed83074b-0072-43b0-a3fb-3f741cc8dc21", //Идентификатор загруженного файла
	"warehouseName": "Свой склад", //Наименование склада
    "fieldMatching" : {
			"id":"Код в Kak2c",
			"article":"Артикул",
			"extId":"Внешний ИД",
			"barcode":"Штрихкоды",
			"shortName":"Наименование",
    		"description":"Полное наименование",
			"vat":"Ставка НДС",
			"stockAvailable":"Количество",
			"price":"Цена",
			"currency":"Валюта",
			"picture":"URL картинки"
	}, //Сопоставление полей
	"importType" : "UPDATE", //"CREATE" Режим загрузки номенклатуры
	"searchField" : "ID", //"EXTID" | "ARTICLE" | "BARCODE" Сопоставление номенклатуры
	"replacePictures" : false, //Заменять изображения
	"updateRests", : false //Загружать остатки
  	"clearEmptyValues" : false //Стирать значения, если они пустые
}

Положительный результат запроса: 

Пример
{
    "success": true,	
}

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

Пример ошибки
{
  "success": false,
  "errors": [
    {
      "code": 0,
      "message": "текст ошибки"
    }
  ]
}