/api/lite/export/order

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

/api/lite/export/order

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

{

 	"success": true,

 	"recordsTotal": 2

 "exportResults": [

 {

 "success": true,

 "id": "1001",

 "fileUrl": "https://storage.yandexcloud.net/images-k2c/fd5d5bc5-9792-4fee-be5e-51dd93e853ea.xls",

 "fileID": "fd5d5bc5-9792-4fee-be5e-51dd93e853ea.xls",

 "fileSize": "122 KB",

 "rowsCount": 296,

 "startTime": "2020-08-27 15:48:25",

 "finishTime": "2020-08-27 15:48:26",

 "cloudUploadFinishTime": "2020-08-27 15:48:27"

 			"requestJson":"{\"fromDate\":\"2020-09-25 20:31:00\",\"exportTechData\":false,\"orderType\":\"CUSTOM\",\"orderSubType\":\"KAK2C_SUBSCRIPTION\",\"exportItems\":false,\"searchDateType\":\"CREATE_DATE\",\"toDate\":\"2020-12-01 20:31:07\",\"exportTags\":true,\"extendedAddress\":false,\"exportPackages\":false}",

 			"processed":true,

 			"rowsTotal":987,

 			"itemsProcessedCount":987,

 			"itemsFailedCount":0,

 			"processingLog":[]

 },

 {

 "success": true,

 "id": "1000",

 "fileUrl": "https://storage.yandexcloud.net/images-k2c/452e74b0-3660-4c80-bfcb-78034097b720.xls",

 "fileID": "452e74b0-3660-4c80-bfcb-78034097b720.xls",

 "fileSize": "122 KB",

 "rowsCount": 296,

 "startTime": "2020-08-27 15:27:53",

 "finishTime": "2020-08-27 15:27:54",

 "cloudUploadFinishTime": "2020-08-27 15:27:55"

 "processed":true,

 			"rowsTotal":987,

 			"itemsProcessedCount":987,

 			"itemsFailedCount":0,

 			"processingLog":[]

 }

 ]

}

Пейджинация

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

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

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

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

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

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

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

{

 "success": true,

 "id": "1001",

 "fileUrl": "https://storage.yandexcloud.net/images-k2c/fd5d5bc5-9792-4fee-be5e-51dd93e853ea.xls",

 "fileID": "fd5d5bc5-9792-4fee-be5e-51dd93e853ea.xls",

 "fileSize": "122 KB",

 "rowsCount": 296,

 "startTime": "2020-08-27 15:48:25",

 "finishTime": "2020-08-27 15:48:26",

 "cloudUploadFinishTime": "2020-08-27 15:48:27"

 "processed":true,

 	"rowsTotal":987,

 	"itemsProcessedCount":987,

 	"itemsFailedCount":0,

 	"processingLog":[]

}

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

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

{

 "success": false,

 "errors": [

 {

 "code": 0,

 "message": "текст ошибки"

 }

 ]

}

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

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

/api/lite/export/order

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

{

 "searchDateType":"CREATE_DATE", //TAKEOUT_DATE, DELIVERY_DATE, RETURN_DATE - Метод отбора (по дате создания/отгрузки/доставки/возврата)

 "fromDate":"2020-08-01 00:00:00", //Дата от

 "toDate":"2020-10-01 00:00:00", //Дата до

 "extendedAddress":true, //Выгрузить адрес по частям

 "exportTags":true, //Выгрузить метки

 "exportItems":true, //Данные по товарам (Может значительно замедлить экспорт, выполняется запрос регистров, ограничение в 1000 записей)

 "exportPackages":true, //Данные по транспортным местам

 	"exportPackedItems": true, //Данные по упакованным товарам

 "exportTechData":true, //Технические данные

 	"orderType":"CUSTOM", //STANDARD | KAKTUS_DOSTAVKA_V2 У обычных заказов - STANDARD

 	"orderSubType":"KAK2C_SUBSCRIPTION", //У обычных заказов он null. 

 "ids":["49379964-0003-2", "49379964-0003-3"], //Если требуется выгрузить заказы с указанными HumanId

 	"city":"Новосибирск",

	"deliveryInfos":["f7c887bc-2161-a53e-0c98-8180f458b79d"], //Список служб доставки

	"orderTags":["Метка"], //список ИМЁН меток (не гуидов!)

	"promocode":"ajaton3000",

	"statuses":["ORDER_INFO_REQUIRE_PAYMENT"], //Список статусов заказа

	"variantId":"982880" //sku humanId

}

"orderType" -  отбор по типу заказа. Если не передан, то возвращаются все типы."orderSubType" - Отбор по подтипу заказа. У обычных заказов он null.  Отбор моно проводить как по совокупности (тип + подтип), так и по отдельности (тип или подтип). Если тип и подтип не заданы, возвращаются все заказы в заданном промежутке дат (fromDate, toDate). Если задан orderSubType == "KAK2C_SUBSCRIPTION", название и количество колонок xls документа может изменится, для отображения данных по подпискам.

Для экспорта обычных заказов, orderType должен быть передан "STANDARD", а orderSubType можно не передавать, либо передать null.

Для экспорта подписок, "orderSubType": "KAK2C_SUBSCRIPTION", а "orderType": "CUSTOM".

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

Пример

{

 "id": "1000",

 "itemsFailedCount": 0,

 "itemsProcessedCount": 0,

 "processed": false,

 "processingLog": [],

 "requestJson": "{\"fromDate\":\"2023-07-04 16:17:46\",\"searchDateType\":\"TAKEOUT_DATE\",\"toDate\":\"2023-07-05 16:17:46\",\"exportTags\":true}",

 "success": true

}

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

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

{

 "success": false,

 "errors": [

 {

 "code": 0,

 "message": "текст ошибки"

 }

 ]

}