Skip to main content

api/lite/export/supply

Список результатов экспорта поставок (подробная информация по экспорту) (/api/lite/export/supply)

api/lite/export/supply

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

{
    "exportResults": [
        {
            "id": "1136",
            "itemsFailedCount": 0,
            "itemsProcessedCount": 0,
            "processed": false,
            "processingLog": [],
            "requestJson": "{\"fromDate\":\"2023-06-03 15:29:54\",\"exportItems\":\"true\",\"suppliers\":[\"8a65065d-7b68-57a7-692d-8d8db78b38cc\"],\"toDate\":\"2023-06-03 15:29:54\",\"statuses\":[\"NEW\"],\"ids\":[]}",
            "success": true
        },
        {
            "cloudUploadFinishTime": "2023-06-03 19:01:57",
            "fileID": "d39741e3-2338-4875-9309-75f7aeceb121.xls",
            "fileSize": "32 KB",
            "fileUrl": "https://storage.yandexcloud.net/items-export-kak2c/d39741e3-2338-4875-9309-75f7aeceb121.xls",
            "finishTime": "2023-06-03 19:01:41",
            "id": "1135",
            "itemsFailedCount": 0,
            "itemsProcessedCount": 46,
            "processed": true,
            "processingLog": [],
            "requestJson": "{\"exportItems\":true,\"suppliers\":[\"b1b74b49-dd24-999d-c1f7-31a7d3afa6e7\",\"11430b37-7f78-1202-f6cf-e4b460d81aca\"],\"statuses\":[]}",
            "rowsCount": 46,
            "rowsTotal": 46,
            "startTime": "2023-06-03 19:01:36",
            "success": true
        }

     ]
}

 

Пейджинация

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

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

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

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

 

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

например /api/lite/export/supply?id=1001

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

{
    "cloudUploadFinishTime": "2023-06-05 11:07:00",
    "fileID": "4b205bee-cff2-43e4-adf6-8b44da45ed83.xls",
    "fileSize": "10 KB",
    "fileUrl": "https://storage.yandexcloud.net/items-export-kak2c/4b205bee-cff2-43e4-adf6-8b44da45ed83.xls",
    "finishTime": "2023-06-05 11:07:00",
    "id": "1001",
    "itemsFailedCount": 0,
    "itemsProcessedCount": 11,
    "processed": true,
    "processingLog": [],
    "requestJson": "{\"fromDate\":\"2022-06-03 15:29:54\",\"exportItems\":\"true\",\"suppliers\":[],\"toDate\":\"2023-06-03 15:29:54\",\"statuses\":[\"NEW\"],\"ids\":[]}",
    "rowsCount": 11,
    "rowsTotal": 11,
    "startTime": "2023-06-05 11:06:57",
    "success": true
}

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

Пример ошибки: 

 

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

Инициировать экспорт поставок (/api/lite/export/supply)

(асинхронный запрос)

/api/lite/export/supply

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

{
    "exportItems": "true",  //Данные по товарам (Может значительно замедлить экспорт, выполняется запрос регистров, ограничение в 1000 записей)
    "statuses": ["NEW"], //InfoStatus поставки
    "suppliers": ["8a65065d-7b68-57a7-692d-8d8db78b38cc"], //Id поставщика
    "fromDate": "2022-06-03 15:29:54",  //Дата от
    "toDate": "2023-06-03 15:29:54",  //Дата до
    "ids": []  //Если требуется выгрузить заказы с указанными HumanId
}

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

Пример

{
    "success": true,
    "id": "1001",
    "fileUrl": null,
    "fileID": null,
    "fileSize": null,
    "rowsCount": null,
    "startTime": null,
    "finishTime": null,
    "cloudUploadFinishTime": null
}

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

Пример ошибки

{
  "success": false,
  "errors": [
    {
      "code": 0,
      "message": "текст ошибки"
    }
  ]
}
Наверх