/api/lite/orders
Внимание! Не путать с методами /api/lite/order - это старые методы, которые будут удалены.
Запрос списка заказов
/api/lite/orders
Метод возвращает список заказов с заданной фильтрацией.
Можно использовать как для получения списка, так и единичного заказа.
Полный комплект данных по заказам будет передан только если в запросе будет параметр full_info=true
{
"success": true,
"recordsTotal": 1,
"orders": [
{
"id": "4249-756",
"externalId": "extId",
"externalId2": "extId2",
"externalId3": "extId3",
"externalId4": "extId4",
"externalId5": "extId5",
"date": "2020-02-24 00:06:09",
"needReserve": true,
"createTs": "2020-02-24 06:06:14.078",
"updateTs": "2020-02-25 06:06:14.078",
"status": "ORDER_INFO_COURIER",
"totalOrderSum": 2687,
"insuranceSum": 2687,
"insuranceSumAutoCalculation":true,
"paymentStatus": "NOT_PAID",
"paymentMethodCode": "online",
"paymentMethodType": "ONLINE",
"paymentMethodName": "Предоплата картой на сайте",
"customerPaymentExternalId": "26a11eef-000f-5000-8000-195192d6e83d",
"needCustomerPayment": false,
"confirmStatus": "APPROVED",
"comment": "",
"promocode": "hibro",
"promocodeAppliedDiscount": 424,
"shortUrl": "http://r.kak2c.ru/yeq2h4r",
"tags": [],
"isMarketplaceOrder": false,
"plannedTakeOutDate": "2020-02-26 13:00:00",
"readyForFFExport": true,
"delivery": {
"code": "3321cd66-6605-aba4-d4d3-e14d1257562f",
"deliveryCode": "29019c97-02b2-387c-fa85-875bd13e8b11",
"type": "COURIER",
"title": "DPD",
"pickupPointId": "",
"logoUrl": "https://storage.yandexcloud.net/lk-kak2c/delivery_dpd_left.svg",
"trackingNumber": null,
"trackingURL": null,
"desiredDeliveryDate": null,
"deliverySumBelowLimitAmount": 1000.00,
"deliverySumLimitAmount": 5000.00,
"desiredDeliveryTimeFrom": "09:00",
"desiredDeliveryTimeTo": "18:00",
"isDeliverySumLimitActive": true,
"deliveryComment": "",
"pvzComment": "",
"actualDeliveryDate": "2020-11-19 17:07",
"courierPlanDeliveryDate": "2020-11-19 00:00",
"courierPlanDeliveryDateChangeReason": "Недозвон до покупателя",
"address": {
"country": "Россия",
"countryCode": "RU",
"region": "Москва",
"area": "Сосенское",
"city": "Москва",
"settlement": null,
"street": "ул Александры Монаховой",
"house": "94",
"block": "5",
"building": "",
"flat": "21",
"fullAddress": "108801, г Москва, поселение Сосенское, Новомосковский округ, ул Александры Монаховой, д 94 к 5, кв 21",
"fullCity": null,
"rawData": "Москва, ул Александры Монаховой, д 94, корп.5, кв 21.",
"zip": "108801",
"regionFias": "0c5b2444-70a0-4932-980c-b4dc0d3f02b5",
"areaFias": "90648b5c-d6e7-4bb0-9782-7908808325cf",
"cityFias": "0c5b2444-70a0-4932-980c-b4dc0d3f02b5",
"settlementFias": null
},
"receiver": {
"name": "Диана",
"surname": "Шалиева",
"patronymic": "Аликовна",
"phone": "89050250111",
"rawPhone": "89050250111",
"alternativePhone": "",
"email": "morisen777@yandex.ru",
"post": null,
"personType": null
},
"pvzInfo": {
"address": {
"country": "Россия",
"countryCode": "RU",
"region": "Москва",
"area": null,
"city": "Москва",
"settlement": null,
"street": null,
"house": null,
"block": null,
"building": null,
"flat": null,
"fullAddress": "Таганская ул., д. 1, стр. 1",
"fullCity": null,
"rawData": null,
"zip": "109147",
"regionFias": "0c5b2444-70a0-4932-980c-b4dc0d3f02b5",
"areaFias": null,
"cityFias": "0c5b2444-70a0-4932-980c-b4dc0d3f02b5",
"settlementFias": null
},
"metroStation": "метро Таганская, Марксистская",
"latitude": "55.741772",
"longitude": "37.655975",
"code": "7702-015",
"courier": "PickPoint",
"courierCode": "PICKPOINT",
"description": "Пункт выдачи заказов находится в ТЦ Звездочка, в фотосалоне Мультифото. Пешком: м. Марксистская, последний вагон из центра, выход в сторону ул. Таганской. Транспортом: автобус № 106, 74в, 74, 51, 567; троллейбус № 26, 63, м7, м7к, 27 до ост. м. Марксистск",
"maxSize": "90",
"maxWeight": 15,
"workTime": "Пн-Вс 10:00-22:00",
"postOfficeNumber": null,
"paymentMethods": [
"COD_CASH",
"COD_CARD"
],
"type": "PVZ",
"courierPostamatType": "ПВЗ"
},
"deliveryServices": [
"CHECK_CONTENT"
],
"isDeliverySumLimitActive": true,
"deliverySumLimitAmount": 324234,
"deliverySumBelowLimitAmount": 23432432
},
"excludeFromSummary": true,
"legalEntity": {
"id": "3c0a3ad3-b10f-4299-5b1b-a3d90b0c198a",
"type": "PERSON",
"name": " Розничный покупатель"
},
"items": [
{
"num": 1,
"productId": "1001",
"productExtId": null,
"variantId": "1001",
"variantExtId": null,
"name": "Расческа в чехле Bro Cosmetics, Цвет: коричневый ",
"article": "BR00T-000140-2",
"quantity": 1,
"vatRate": "NO_VAT",
"vatSkuProduct": "NO_VAT",
"price": 332,
"img": "https://img.kak2c.ru/i/L/U/xgzFMUqK_c.jpg?1576164677",
"itemAmountState": {
"amountORDERED": 1,
"amountRESERVED": 1,
"amountPACKED": 1,
"amountSHIPPED": 1,
"amountDELIVERED": 0,
"amountLOST": 0,
"amountRETURNED": 0,
"amountRETURNED_DEFECTIVE": 0,
"amountRETURNED_TO_CLIENT": 0
},
"skuType": "SKU",
"itemDimensions": {
"height": 8,
"width": 25,
"depth": 33
},
"itemWeight": 1000
},
{
"num": 2,
"productId": "1002",
"productExtId": null,
"variantId": "1002",
"variantExtId": null,
"name": "Набор для Бро №4: помада для волос, бальзам для бороды, гель для душа + шампунь",
"article": "BR00T-000117",
"quantity": 1,
"vatRate": "NO_VAT",
"vatSkuProduct": "NO_VAT",
"price": 2074,
"img": "https://img.kak2c.ru/i/L/s/qck3mEGu_c.jpg?1578310573",
"itemAmountState": {
"amountORDERED": 1,
"amountRESERVED": 1,
"amountPACKED": 1,
"amountSHIPPED": 1,
"amountDELIVERED": 0,
"amountLOST": 0,
"amountRETURNED": 0,
"amountRETURNED_DEFECTIVE": 0
},
"skuType": "SKU",
"itemDimensions": {
"height": 8,
"width": 25,
"depth": 33
},
"itemWeight": 1000
},
{
"num": 3,
"productId": null,
"variantId": "delivery",
"name": "Доставка",
"quantity": 1,
"vatRate": "NO_VAT",
"vatSkuProduct": "NO_VAT",
"price": 281,
"skuType": "SERVICE"
}
],
"packings": [
{
"barcode": "7878000138251",
"fbmStickerBarcode": "WB_0032345",
"palletBarcode": "pl705970976005-1",
"measurements": {
"success": true,
"weight": 790,
"dimensions": {
"height": 130,
"width": 280,
"depth": 130
}
},
"items": [
{
"num": 1,
"productId": "1001",
"productExtId": null,
"variantId": "1001",
"variantExtId": null,
"name": "Расческа в чехле Bro Cosmetics, Цвет: коричневый ",
"article": "BR00T-000140-2",
"quantity": 1,
"vatRate": "NO_VAT",
"price": 332,
"img": "https://img.kak2c.ru/i/L/U/xgzFMUqK_c.jpg?1576164677",
"skuType": "SKU",
"accountingAttributes": [
{
"code": "chestnyznak",
"stringValue": "11111",
"n": 1
}
],
"specials": true
},
{
"num": 2,
"productId": "1002",
"productExtId": null,
"variantId": "1002",
"variantExtId": null,
"name": "Набор для Бро №4: помада для волос, бальзам для бороды, гель для душа + шампунь",
"article": "BR00T-000117",
"quantity": 1,
"vatRate": "NO_VAT",
"price": 2074,
"img": "https://img.kak2c.ru/i/L/s/qck3mEGu_c.jpg?1578310573",
"skuType": "SKU",
"accountingAttributes": [
{
"code": "chestnyznak",
"stringValue": "22222",
"n": 2
}
]
}
]
}
],
"pallets": [
{
"barcode": "pl705970976005-1",
"fbmStickerBarcode": "WB_PL_0032345",
"files": [
{
"copiesQty": 1,
"fileExt": "pdf",
"fileName": "ИП Ozon Хоругвино Шк на палету",
"fileSize": 22535,
"fileSource": "USER",
"fileType": "PDF",
"id": "aa22d7fa-65a2-6be0-8e0d-430ec6c874d3",
"printWhenPacking": false,
"success": true,
"url": "https://storage.yandexcloud.net/order-files-kak2c/b42eebd1-eb7e-4603-a781-5240699288d9.pdf"
}
],
"measurements": {
"dimensions": {
"depth": 120,
"height": 100,
"width": 120
},
"success": true,
"weight": 200
},
"num": 1,
"packings": [
{
"barcode": "7878000138251",
"measurements": {
"success": true,
"weight": 790,
"dimensions": {
"height": 130,
"width": 280,
"depth": 130
}
},
"palletBarcode": "pl705970976005-1"
}
]
}
],
"rawDeliveryStatuses": [
{
"courierStatusDate": "2019-12-18 14:43:05",
"statusCode": "SENDER",
"statusMessage": "Заявка принята",
"statusCity": "Чехов"
},
{
"courierStatusDate": "2019-12-18 14:43:05",
"statusCode": "SENDER",
"statusMessage": "Заявка принята",
"statusCity": "Чехов"
}
],
"expenses": [
{
"id": "1231",
"status": "PLAN",
"type": "GENERAL",
"items": [
{
"type": "COD",
"sum": 60
},
{
"type": "DELIVERY",
"sum": 330
},
{
"type": "INSURANCE",
"sum": 6
}
]
}
],
"files": [
{
"id": "43f79bac-0d82-2d82-f11d-abd1a53b26a0",
"fileType": "DOC",
"fileSource": "USER", //ESHOP | FULFILLMENT
"fileName": "Документ",
"fileExt": "doc",
"url": "https://storage.yandexcloud.net/order-files-kak2c/e7cf604e-7092-4243-97ba-13b3f7bb4b68.doc",
"printWhenPacking": true,
"copiesQty": 1
}
],
"customerPaymentInProcess": false,
"warehouseName": "Tempoline",
"warehouseCode": "6805bc64-270f-ae7d-1231-773ff181e446",
"permissionList": {
"fieldPermissions": [
{
"type": "ITEMS_EDITABLE",
"value": true,
"reason": null
},
{
"type": "PAYMENT_EDITABLE",
"value": true,
"reason": null
},
{
"type": "IS_PAID_EDITABLE",
"value": false,
"reason": "Для способа оплаты наложенным платежом - статус оплаты вручную изменять нельзя."
},
{
"type": "RECEIVER_EDITABLE",
"value": true,
"reason": null
},
{
"type": "DELIVERY_EDITABLE",
"value": true,
"reason": null
},
{
"type": "WAREHOUSE_EDITABLE",
"value": true,
"reason": null
},
{
"type": "COMMENTS_EDITABLE",
"value": true,
"reason": null
}
],
"actionPermissions": [
{
"type": "CANCEL",
"value": true,
"reason": null
},
{
"type": "CONFIRM",
"value": false,
"reason": null
},
{
"type": "NEED_CONFIRM",
"value": false,
"reason": null
},
{
"type": "PACK",
"value": false,
"reason": null
},
{
"type": "COPY",
"value": false,
"reason": null
},
{
"type": "PACK_CONTROL",
"value": false,
"reason": null
},
{
"type": "UNPACK",
"value": false,
"reason": null
},
{
"type": "SHIPPING",
"value": false,
"reason": null
},
{
"type": "UNSHIPPING",
"value": false,
"reason": null
},
{
"type": "REFRESH_RESERVE",
"value": true,
"reason": null
},
{
"type": "RETURN_TO_DELIVERY",
"value": false,
"reason": null
},
{
"type": "REVERT_RETURNS",
"value": false,
"reason": null
}
]
},
"packingVideos": [
"http://123.123.123.123:1111/video/2021-04-21/dabca048-7cfb-4e65-92a2-fce40f5ee9c2.mp4"
],
"returnUnpackingVideos": [
"http://123.123.123.123:1111/video/2021-04-21/dabca048-7cfb-4e65-92a2-fce40f5ee9c2.mp4"
],
"returns":[
{
"type": "RETURN", // RECLAMATION
"date": "2021-01-15 17:47:13",
"number": "123",
"externalNumber": "456",
"items": [
{
"num": 1,
"productId": "1001",
"productExtId": null,
"variantId": "1001",
"variantExtId": null,
"name": "Расческа в чехле Bro Cosmetics, Цвет: коричневый ",
"article": "BR00T-000140-2",
"quantity": 1,
"accountingAttributes": [
{
"code": "chestnyznak",
"stringValue": "12345"
}
],
}],
"returnUnpackingVideos": [
"http://123.123.123.123:1111/video/2021-04-21/dabca048-7cfb-4e65-92a2-fce40f5ee9c2.mp4"
],
"files": [
{
"fileName": "Скан заявления",
"url": "https://storage.yandexcloud.net/order-files-kak2c/e7cf604e-7092-4243-97ba-13b3f7bb4b68.doc"
},
{
"fileName": "Скан документов",
"url": "https://storage.yandexcloud.net/order-files-kak2c/e7cf604e-7092-4243-97ba-13b3f7bb4b68.doc"
}
]
}
]
"summaryItemAmountState": {
"amountORDERED": 2,
"amountRESERVED": 2,
"amountPACKED": 2,
"amountSHIPPED": 2,
"amountDELIVERED": 0,
"amountLOST": 0,
"amountRETURNED": 0,
"amountRETURNED_DEFECTIVE": 0,
"amountRETURNED_TO_CLIENT": 0
},
"codPayments": [
{
"sum": 2225,
"date": "2021-01-15 17:47:13",
"paymentDocumentId": "1000"
}
],
"packingOptions": [
{
"packSpecialsToSeparatePackingPlace": true
}
],
"c": "8089832f-633a-b417-a72b-7e685e114151",
"initialOrder" : null,
"onlinePaymentType": "FULL",
"warehouseShippingOptions": {
"monopackingsOnly": true
}
}
]
}
Фильтрация
Для фильтрации есть следующие возможности:
- id - по номеру заказа
- filter_multi - по номеру заказа или по ФИО покупателя
- filter_phone - по телефону покупателя
- filter_email - по email покупателя
- filter_promocode - по промокоду
- filter_tracking_number - по трек-номеру заказа
- filter_tags - по меткам заказов (можно указывать несколько через запятую)
- filter_states - по статусам заказов (можно указывать несколько через запятую)
- filter_external_id, filter_external_id_2, filter_external_id_3, filter_external_id_4, filter_external_id_5 - по внешним идентификаторам
- date_from - по дате заказа, от. формат: 2020-02-19T12:35:31
- date_to - по дате заказа, до
- updated_from - по дате/времени изменения. формат: 2020-02-19T12:35:31.
- delivery_code - по кодам службы доставки (можно указывать несколько через запятую) код получать в справочнике доступных служб доставки клиента
- city - по городу/населенному пункту покупателя. Значения лучше получать из подсказок адресов
- reserved_variant_id - по зарезервированному товару
- warehouse_code - дополнительная фильтрация по складу (используется вместе с reserved_variant_id)
- product_id - по коду продукта в заказе.
- problemOrders - true - для вывода заказов с ошибками (согласовано с количеством в поле problemOrders в методе /api/lite/orders/statuses)
- order_types - подтипы заказов с типом CUSTOM. Если не задано, то отображены будут только заказы с типом STANDARD
Пейджинация
Для пейджинации используются параметры page и size: size - записей на странице, page - номер страницы.
Пример: /api/lite/orders?page=0&size=100
Если параметры не переданы, то дефолтные значения page=0&size=10
Максимальное количество записей на странице - 100
Также, для отображение пейджинации следует анализировать параметр recordsTotal, возвращающий общее количество записей (с учетом примененной фильтрации, если она есть).
Сортировка
Для сортировки задается параметр order, принимающий код поля для сортировки и направление сортировки (asc, desc), отделенное символом плюса.
Пример сортировки по дате (возрастание): /api/lite/orders?order=date+asc
Пример сортировки по дате (убывание): /api/lite/orders?order=date+desc
Доступные коды сортировки:
- date (дата заказа)
- id (номер заказа)
По умолчанию используется сортировка по дате заказа по убыванию.
Описание результата запроса
| Поле | Тип | Редактируемое |
обязательное |
Описание |
| id | string | да* | нет |
Номер заказа. * Можно задать только в момент создания заказа |
| externalId | string | да | нет |
Внешний номер заказа – дополнительный номер заказа, например в сторонней CRM системе. |
| externalId2 | string | да | нет | Внешний номер заказа |
| externalId3 | string | да | нет | Внешний номер заказа |
| externalId4 | string | да | нет | Внешний номер заказа |
| externalId5 | string | да | нет | Внешний номер заказа |
| date | datetime | да* | нет |
Дата заказа * Можно задать только в момент создания заказа |
| needReserve | boolean | да | нет | Нужно ли брать резерв |
| createTs | datetime | нет | - | Дата создания заказа в системе (техническая) |
| updateTs | datetime | нет | - | Дата последнего обновления заказа. |
| status | enum | нет | - |
Основной статус заказа. Описывает жизненный цикл заказа.
|
| confirmStatus | enum | да | нет |
Статус подтверждения заказа
|
| totalOrderSum | decimal | нет | - | Общая сумма заказа |
| insuranceSum | decimal | да | нет |
Размер оценочной стоимости / страховки заказа. По умолчанию равен общей сумме заказа или рассчитывается, исходя из процента расчёта страховки, указанного в аккаунте. |
| insuranceSumAutoCalculation | boolean | да | нет | Если не передаётся, то по умолчанию true. Если нужно указать произвольную сумму страховки, необходимо передать insuranceSumAutoCalculation = false |
| paymentStatus | enum | да | нет |
Статус оплаты заказа покупателем.
Имеет смысл только для заказов с предоплатой (например, оплата картой на сайте). Заказы с оплатой ONLINE, и NOT_PAID - не передаются на комплектацию. |
| paymentMethodType | enum | да | нет |
Тип оплаты заказа.
|
| paymentMethodCode | string | да | нет |
Код и наименование способа оплаты заказа. Базовые способы оплаты (по умолчанию), в формате
|
| paymentMethodName | string | нет | - | Наименование способа оплаты |
| needCustomerPayment | boolean | нет | - |
Флаг, указывающий на необходимость оплаты заказа покупателем перед отгрузкой. Например, если paymentMethodType = ONLINE и paymentStatus = NOT_PAID, тогда needCustomerPayment = true |
| customerPaymentExternalId | string | нет | - | Id оплаты у экваера (для онлайн оплаты) |
| warehouseName | string | да | нет | Название склада |
| comment | string | да | нет | Комментарий покупателя к заказу |
| promocode | string | да | нет | Код примененного промокода к заказу |
| promocodeAppliedDiscount | decimal | нет | - | Общая сумма скидки, примененная к заказу |
| urlParams | string | да | нет |
Сырые данные URL запроса, с которыми покупатель пришел на сайт. В формате JSON. Как правило, в основном это UTM метки, для понимания рекламного канала, с которого пришел покупатель. |
| shortUrl | string | нет | - |
Сокращенная ссылка на заказ. Используется для предоставления покупателю, например в SMS. Например http://r.kak2c.ru/i806zlu |
| b2bFlag | boolean | да | нет |
B2B заказ. Если true, то биллинг по такому заказу будет считаться как для B2B. *Настройка для B2B включается по запросу клиента; по умолчанию не используется. |
| c | string | нет | - |
Секретный ключ для доступа к заказу через публичный метод получения заказа. Пример значения: 94ccc02a-2379-0eac-e5cf-260485cc35bd |
| customData | string | да | нет | Дополнительная информация по заказу, возможно сохранить и получить, для передачи в другие системы. Например, сохранить произвольный json. |
| tags | Array | нет | - | Массив идентификаторов меток (возможные метки получаются отдельным запросом) - для чтения |
| orderTag | string | да | нет |
Метка для добавления заказу Предварительно необходимо создать метку с таким названием |
|
excludeFromSummary
|
Признак true исключит заказ из статистики. Меняется запросом /api/lite/order-exclude-change
orderType enum нет -Тип заказа
- STANDARD – стандартный заказ интернет-магазина. Бизнес-логика для такого заказа отрабатывает стандартным образом.
- CUSTOM – заказ с нестандартной логикой. Заказ с подобным типом возможно оплатить и возможно подтвердить. Но он никогда не будет брать резервов, упаковываться и отгружаться. Используется для разработки нестандартных решений.
Подтип заказа, в случае orderType = CUSTOM.
summaryItemAmountState Object нет -
вывод суммарных оборотных данных по заказу
например:
"amountORDERED": 3,
"amountRESERVED": 0,
"amountPACKED": 0,
"amountSHIPPED": 0,
"amountLOST": 0,
"amountDELIVERED": 0,
"amountRETURNED": 0,
"amountRETURNED_DEFECTIVE": 0
isMarketplaceOrder boolean нет -Флаг, определяющий заказы маркетплейсов
plannedTakeOutDate datetime нет -Дата планируемой отгрузки
readyForFFExport boolean нет -Флаг, определяющий готовность заказа к выгрузке в Темполайн
delivery Object да даОбъект, описывающий доставку
code - технический код службы доставки
title - название доставки
type - тип доставки
actualDeliveryDate - фактическая дата доставки
(пример: 2020-11-19 17:07)
address - объект, описывающий адрес доставки
courierPlanDeliveryDate - планируемя дата доставка
(пример: 2020-11-19 00:00)
courierPlanDeliveryDateChangeReason - причина изменения даты доставки
deliveryServices - доп. опции доставки:
- CHECK_CONTENT - осмотр вложения
- CONTACTLESS_DELIVERY - бесконтактная доставка
- DANGEROUS_CARGO - опасный груз
- DAY_OFF_DELIVERY - проверка состояния
- DELIVERY_DATE_APPROVE - согласование даты и времени доставки
- LIFT_TO_DOOR - погрузо-разгрузочные работы на лифте
- LIFT_TO_DOOR_MANUAL - погрузо-разгрузочные работы на руках
- PARTIAL_DELIVERY - частичная доставка
- PERSONALLY_IN_HANDS - лично в руки
- REVERSE - возврат сопроводительных документов
- TEMPERATURE_REGIME - температурный режим
- TRYING - примерка
- VERIFY - проверка состояния
- WAITING_ON_ADDRESS - Ожидание на адресе
deliveryComment - комментарий к доставке
deliverySumBelowLimitAmount - нижняя граница ограничения стоимости доставки
deliverySumLimitAmount - верхняя граница ограничения стоимости доставки
isDeliverySumLimitActive - флаг включения ограничения стоимости доставки
desiredDeliveryTimeFrom - желаемое время доставки, с
(пример: 09:00)
desiredDeliveryTimeTo - желаемое время доставки, до
(пример: 18:00)
desiredDeliveryDate - желаемая дата доставка
isDeliverySumLimitActive - активировано ограничение суммы доставки
logoUrl - ссылка на логотип службы доставки
pickupPointId - идентификатор ПВЗ
pvzComment - комментарий для ПВЗ
receiver - объект, описывающий получателя доставки
trackingNumber - трэк-номер доставки
trackingURL - ссылка на страницу отслеживания доставки
savedAddressId - id адреса, сохранённого с помощью запроса /api/lite/pub/save_dadata_address (используется для интеграции с 1С-Битрикс)
code
ранее deliveryCode
string да даТехнический идентификатор способа доставки (договора доставки).
Пример: 258296e9-acee-4361-a55b-bd4c3f3913af
deliveryCode
string нет -
Код способа доставки из тарификатора
Пример: 258296e9-acee-4361-a55b-bd4c3f3913af
type
enum нет -Тип доставки:
- COURIER - курьером до двери
- PVZ - в пункт выдачи заказов
- RUSSIAN_POST - в отделение Почты России
title
ранее courier
string нет -Наименование курьерской службы
Пример: Boxberry
pickupPointId string да да*Идентификатор пункта выдачи заказов (в рамках выбранной курьерской службы)
* Если доставка в ПВЗ / постамат
logoURL string нет - Прямая ссылка на логотип службы доставки.trackingNumber
ранее был вне delivery
string нет - Как правило, заполняется в момент получения данных от курьерской компании.trackingURL
ранее trackingLink
string нет -Полная ссылка на трекинг.
Пример: https://boxberry.ru/tracking/11122233.
UPD: 2023-07-05
desiredDeliveryDate date да нетЖелаемая покупателем дата доставки.
Кактус передает эту информацию в курьерские службы как рекомендательный параметр. Не все курьерские службы учитывают эту информацию.
desiredDeliveryTimeFrom": "09:00",
ранее timeFrom
HH:ss да нетЖелаемое время доставки "от". С лидирующими нулями.
Пример "09:00".
"desiredDeliveryTimeTo": "20:00",
ранее timeTo
HH:ss да нетЖелаемое время доставки "по". С лидирующими нулями.
Пример "20:00".
deliveryComment string да нетКомментарий для целей доставки.
Поле устарело. Рекомендуется использовать поле comment.
pvzComment string нет -В случае способа доставки через ПВЗ, содержит адрес и время работы ПВЗ.
actualDeliveryDate string нет -Дата фактической доставки от курьерской службы
courierPlanDeliveryDate date нет -Плановая дата доставки от курьерской службы
courierPlanDeliveryDateChangeReason string нет -Причина переноса плановой даты доставки от курьерской службы
address Object да даОбъект, описывающий адрес доставки
ВАЖНО: в случае передачи адреса в компонентах адреса строковое поле fullAddress игнорируется (будьте внимательны при заполнении значений, пожалуйста, не путайте поля building и block)
Для проверки парсинга компонентов адреса, можно передавать ожидаемый адрес в поле rawData и после обработки сравнивать его с итоговым полем fullAddress. Если поле rawData не было передано, то оно заполнится автоматически из переданного поля fullAddress перед парсингом компонентов, а в поле fullAddress запишется результат парсинга.
countryCode string да нетДвухбуквенный код страны по стандарту ISO 3166-1 (Alpha 2).
https://ru.wikipedia.org/wiki/ISO_3166-1
country string да нет Страна прописью region string да нет Регион. Для РФ - по ФИАС. area string да нет Район. Для РФ - по ФИАС. city string да да*Город. Для РФ - по ФИАС.
* если не задан населенный пункт
settlement string да да*Населенный пункт. Для РФ - по ФИАС.
* если не задан город
street string да да*Улица (в т.ч. проспект/проезд/и т.п. - пример: "проспект Победы")
* если курьерская доставка и не задан дом
house string да да*Дом
* если курьерская доставка и не задана улица
block string да нет Корпус building string да нет Строение flat string да нет Квартира/Офис fullAddress string да нет Полный адрес (адрес одной строкой) floor integer да нет*Этаж
*при передаче в deliveryServices LIFT_TO_DOOR_MANUAL этаж -- обязателен для заполнения
fullCity string да нет Полное наименование города (вместе с типом) rawData string да нет Адрес в "сыром" виде - как он изначально был загружен вместе с заказом. zip string да нет Почтовый индекс regionFias string да даКод региона по ФИАС
(поле обязательно, кроме доставки самовывозом)
areaFias string да да*Код района по ФИАС
* должен быть задан хотя бы 1 фиас из 3х (areaFias, cityFias, settlementFias), если поле присутствует в классификаторе фиас
(поле обязательно, кроме доставки самовывозом)
cityFias string да да*Код города по ФИАС
* должен быть задан хотя бы 1 фиас из 3х (areaFias, cityFias, settlementFias)
(поле обязательно, кроме доставки самовывозом)
settlementFias string да да*Код населенного пункта по ФИАС
* должен быть задан хотя бы 1 фиас из 3х (areaFias, cityFias, settlementFias)
(поле обязательно, кроме доставки самовывозом)
receiver Object да да Объект, описывающий получателя заказа name string да да Имя surname string да нет Фамилия patronymic string да нет Отчество phone string да да Телефон alternativePhone string да нет Альтернативный телефон email string да нет Почтовый адрес pvzInfo Object нет - Объект с информацией о пункте выдачи address Object нет - Объект с адресом пункта выдачиМаксимальные габариты в см
Либо 1 число - сумма 3х измерений
Либо в формате 36x36x60
- Postamat
- PVZ
- CASHIER_ISSUE_POINT
Контрагент покупатель, с юридической точки зрения.
Если покупатель - обычное физическое лицо, type = PERSON, если юридическое лицо (ИП, ООО и т.п.), type = COMPANY
id string да нет Идентификатор контрагента type enum да нетТип контрагента:
- PERSON - физическое лицо
- COMPANY - юридическое
ВАЖНО: Доставку необходимо передавать всегда последним элементом списка num integer да да Номер строки
variantId
ранее skuId
string да даИдентификатор варианта - основной идентификатор позиции заказа. У продукта всегда есть один вариант.
В случае строки "Доставка", содержит "delivery".
productId string нет -Идентификатор продукта. Общий идентификатор (один продукт может иметь несколько вариантов).
В случае строки "Доставка", содержит "delivery".
name string нет - Наименовании позиции заказаarticle
ранее skuArticle
string да нет Артикул quantity decimal да даКоличество заказанного товара
quantityReserved decimal нет - Количество зарезервированного товара. Для начала комплектации, оно должно совпадать с количеством заказанного (все товары должны быть зарезервированы). quantityAvailable decimal нет - Количество доступного данного товара к продаже (за минусом зарезервированного). vatRate enum да нетСтавка НДС для строки заказа:
- NO_VAT – без НДС (например, для компаний на УСН)
- VAT_0
- VAT_10
- VAT_18
- VAT_20
Ставка НДС в карточке данного продукта
- NO_VAT – без НДС (например, для компаний на УСН)
- VAT_0
- VAT_10
- VAT_18
- VAT_20
для товаров - вывод оборотных данных по заказу по каждой позиции
например:
"amountORDERED": 3,
"amountRESERVED": 0,
"amountPACKED": 0,
"amountSHIPPED": 0,
"amountLOST": 0,
"amountDELIVERED": 0,
"amountRETURNED": 0,
"amountRETURNED_DEFECTIVE": 0
"amountRETURNED_TO_CLIENT": 0
skuType enum нет -Тип позиции:
- SKU – Товар
- SKUSET – Набор (виртуальный товар, содержащий реальные SKU)
- SERVICE – Услуга, например "Доставка"
Атрибуты учёта, например, ЧЗ или серийный номер
code enum нет -Тип атрибута учёта::
- chestnyznak - ЧЗ
- uniquenumber - уникальный номер
Значение атрибута учёта
n integer нет -Порядковый номер атрибута учёта
optionsUsed Object нет -Используемые свойства, характеризующие данный вариант (если используются варианты для данного продукта).
code string нет - Код свойства, например "size" value string нет - Значение свойства, например "XL" packings Object нет -Упаковки (транспортные места) заказа. Содержит информацию только после упаковки заказа (в том числе частичной упаковке).
barcode string нет - Штрихкод места (упаковки) measurements Object нет - Габариты и вес упаковки при упаковке на складе weight decimal нет - Вес упаковки в граммах dimensions Object нет -
Содержит размеры упаковки в миллиметрах
Пример
{
"height": 120,
"width": 120,
"depth": 120
}
measurementsOnSort Object нет - Габариты и вес упаковки, измеренные в процессе сортировки (если измерения проводились) weight decimal нет - Вес упаковки в граммах dimensions Object нет - Содержит размеры упаковки в сантиметрах items Object нет - Содержимое упаковки (структура аналогична items заказа) expenses Array нет - Расходы по данному заказу. Например, расходы на доставку, на страховку, на наложенный платеж, на фулфилмент операции - и т.д.string нет - Город permissionList Object нет - Список разрешений для заказа (только для fullInfo=true) fieldPermissions Array нет -
Список разрешений на внесение изменений в группы полей заказа
- type = одно из значений групп полей заказа:
ITEMS_EDITABLE, PAYMENT_EDITABLE, IS_PAID_EDITABLE, RECEIVER_EDITABLE, DELIVERY_EDITABLE, WAREHOUSE_EDITABLE), COMMENTS_EDITABLE
- value - флаг, разрешены ли изменения
- reason - причина запрета, если value = false
actionPermissions Array нет -Список разрешений на действия с заказом (кнопки)
- type = одно из значений действий с заказом:
CANCEL, CONFIRM, NEED_CONFIRM, PACK, COPY, PACK_CONTROL, UNPACK, SHIPPING, UNSHIPPING, REFRESH_RESERVE, RETURN_TO_DELIVERY, REVERT_RETURNS
- value - флаг, разрешены ли изменения
- reason - причина запрета, если value = false
codPayments Array нет -Список переводов наложенных платежей по данному заказу
packingVideos Array нет - Ссылки не видео упаковки заказа returnUnpackingVideos Array нет - Ссылки не видео приемки возврата заказа initialOrder string да нетТехнический id изначального заказа (заказ-подписка например)
packingOptions Array да нетСписок опций упаковки
onlinePaymentType enum да нетТип онлайн оплаты:
- FULL
- RECURRENT
Настройки отгрузки
-
MIX_PACKINGS - смешанная упаковка
-
MONO_PACKINGS - монокороба
-
MONO_PALLETS - монопаллеты
Пример запроса по одному заказу и полными данными:/api/lite/orders?id=4249-756&full_info=true
Пример результата запроса
Пример запроса по списку заказов:/api/lite/orders?order=id+desc
Пример результата запроса
{
"success": true,
"recordsTotal": 2,
"orders": [
{
"id": "7277-1002",
"externalId": "extId",
"externalId2": "extId2",
"externalId3": "extId3",
"externalId4": "extId4",
"externalId5": "extId5",
"date": "2020-01-22 16:37:56",
"needReserve": true,
"createTs": "2020-01-22 16:37:57.528",
"updateTs": "2020-01-22 16:37:57.528",
"status": "ORDER_INFO_DRAFT",
"totalOrderSum": 999,
"insuranceSum": 999,
"insuranceSumAutoCalculation":true,
"paymentStatus": "NOT_PAID",
"paymentMethodCode": "online",
"needCustomerPayment": false,
"confirmStatus": "APPROVED",
"comment": "",
"tags": [],
"delivery": {
"code": "PICKPOINT",
"type": "PVZ",
"title": "PickPoint",
"pickupPointId": "12345",
"logoUrl": null,
"trackingNumber": null,
"trackingURL": null,
"desiredDeliveryDate": "2020-02-14",
"desiredDeliveryTimeFrom": "09:00",
"desiredDeliveryTimeTo": "20:00",
"deliveryComment": "Поскорее",
"address": {
"country": "Россия",
"countryCode": "RU",
"region": "Алтайский",
"area": null,
"city": "Барнаул",
"settlement": null,
"street": "",
"house": "",
"block": "",
"building": "",
"flat": "",
"fullAddress": "Алтайский, Барнаул",
"fullCity": null,
"rawData": null,
"zip": "",
"regionFias": "8276c6a1-1a86-4f0d-8920-aba34d4cc34a",
"areaFias": null,
"cityFias": "d13945a8-7017-46ab-b1e6-ede1e89317ad",
"settlementFias": null
},
"receiver": {
"name": "Петр",
"surname": "толстой",
"patronymic": "",
"phone": "89011111111",
"alternativePhone": "",
"email": "petr@petr.net",
"post": null,
"personType": null
}
},
"legalEntity": {
"id": "09684293-9e6d-a9c2-d114-28d25b5914dc",
"type": "PERSON",
"name": " Розничный покупатель"
},
"items": [
{
"num": 1,
"productId": "1001",
"productExtId": null,
"variantId": "1001",
"variantExtId": null,
"name": "Кактус Цереус",
"quantity": 1,
"price": 999,
"img": "https://img.kak2c.ru/i/j/j/tYqAVdh1_c.jpg?1579689505",
"skuType": "SKU",
"itemAmountState": {
"amountORDERED": 3,
"amountRESERVED": 0,
"amountPACKED": 0,
"amountSHIPPED": 0,
"amountDELIVERED": 0,
"amountLOST": 0,
"amountRETURNED": 0,
"amountRETURNED_DEFECTIVE": 0
}
},
{
"num": 2,
"variantId": "delivery",
"name": "Доставка",
"quantity": 1,
"price": 0,
"skuType": "SERVICE"
}
],
"customerPaymentInProcess": false,
"c": "f300ae30-507c-2d36-d37c-e6397084b6e2"
},
{
"id": "7277-1001",
"date": "2020-01-22 11:17:35",
"updateTs": "2020-01-22 11:17:47.399",
"status": "ORDER_INFO_REQUIRE_PAYMENT",
"totalOrderSum": 1232,
"insuranceSum": 1232,
"insuranceSumAutoCalculation":true,
"paymentStatus": "NOT_PAID",
"paymentMethodCode": "online",
"needCustomerPayment": false,
"comment": "",
"tags": [],
"delivery": {
"code": "PICKPOINT",
"type": "PVZ",
"title": "PickPoint",
"pickupPointId": "12345",
"logoUrl": null,
"trackingNumber": null,
"trackingURL": null,
"desiredDeliveryDate": "2020-02-14",
"desiredDeliveryTimeFrom": "09:00",
"desiredDeliveryTimeTo": "20:00",
"deliveryComment": "Поскорее",
"address": {
"country": "Россия",
"countryCode": "RU",
"region": "Алтайский",
"area": null,
"city": "Барнаул",
"settlement": null,
"street": "",
"house": "",
"block": "",
"building": "",
"flat": "",
"fullAddress": "Алтайский, Барнаул",
"fullCity": null,
"rawData": null,
"zip": "",
"regionFias": "8276c6a1-1a86-4f0d-8920-aba34d4cc34a",
"areaFias": null,
"cityFias": "d13945a8-7017-46ab-b1e6-ede1e89317ad",
"settlementFias": null
},
"receiver": {
"name": "Петр",
"surname": "толстой",
"patronymic": "",
"phone": "89011111111",
"alternativePhone": "",
"email": "petr@petr.net",
"post": null,
"personType": null
}
},
"legalEntity": {
"id": "09684293-9e6d-a9c2-d114-28d25b5914dc",
"type": "PERSON",
"name": " Розничный покупатель"
},
"items": [
{
"num": 1,
"productId": "1001",
"productExtId": null,
"variantId": "1001",
"variantExtId": null,
"name": "Кактус Цереус",
"quantity": 1,
"price": 999,
"img": "https://img.kak2c.ru/i/j/j/tYqAVdh1_c.jpg?1579689505",
"skuType": "SKU",
"itemAmountState": {
"amountORDERED": 0,
"amountRESERVED": 0,
"amountPACKED": 0,
"amountSHIPPED": 0,
"amountDELIVERED": 0,
"amountLOST": 0,
"amountRETURNED": 0,
"amountRETURNED_DEFECTIVE": 0
}
},
{
"num": 2,
"variantId": "delivery",
"name": "Доставка",
"quantity": 1,
"price": 233,
"skuType": "SERVICE"
}
],
"customerPaymentInProcess": false,
"c": "ce7b72b3-effb-4f57-56d7-b025b968cff0"
}
]
} Создание/редактирование заказа
/api/lite/orders
Создание/редактирование заказа для кабинета.
Если указан параметр id - то система будет пробовать найти заказ с указанным номером и отредактировать его, иначе - создаст новый с указанным id.
Если параметр id не указан - система создаст новый заказ и присвоит внутренний номер.
Пример запроса
{
"id": "111",
"externalId": "extId",
"externalId2": "extId2",
"externalId3": "extId3",
"externalId4": "extId4",
"externalId5": "extId5",
"date": "2020-02-22 16:37:56",
"needReserve": true,
"totalOrderSum": 999,
"insuranceSum": 999,
"insuranceSumAutoCalculation":true,
"paymentStatus": "NOT_PAID",
"paymentMethodCode": "online",
"needCustomerPayment": false,
"confirmStatus": "APPROVED",
"comment": "",
"promocode":"covid1984",
"tags": [],
"orderTag": "tag1",
"delivery": {
"code": "PICKPOINT",
"type": "PVZ",
"title": "PickPoint",
"pickupPointId": "12345",
"logoUrl": null,
"trackingNumber": null,
"trackingURL": null,
"desiredDeliveryDate": "2020-02-14",
"desiredDeliveryTimeFrom": "09:00",
"desiredDeliveryTimeTo": "20:00",
"deliveryComment": "Поскорее",
"address": {
"country": "Россия",
"countryCode": "RU",
"region": "Алтайский",
"area": null,
"city": "Барнаул",
"settlement": null,
"street": "",
"house": "",
"block": "",
"building": "",
"flat": "",
"fullAddress": "Алтайский, Барнаул",
"fullCity": null,
"rawData": null,
"zip": "",
"regionFias": "8276c6a1-1a86-4f0d-8920-aba34d4cc34a",
"areaFias": null,
"cityFias": "d13945a8-7017-46ab-b1e6-ede1e89317ad",
"settlementFias": null
},
"receiver": {
"name": "Петр",
"surname": "толстой 2",
"patronymic": "",
"phone": "89011111111",
"alternativePhone": "",
"email": "petr@petr.net",
"post": null,
"personType": null
},
"deliveryServices": [
"CHECK_CONTENT"
]
},
"legalEntity": {
"id": "09684293-9e6d-a9c2-d114-28d25b5914dc",
"type": "PERSON",
"name": " Розничный покупатель"
},
"items": [
{
"num": 1,
"variantId": "1001",
"variantExtId": null,
"name": "Кактус Цереус",
"quantity": 2,
"price": 522,
"vatRate": "VAT_20",
"bundleOptionalVariants": [
"1012"
]
},
{
"num": 2,
"variantId": "delivery",
"name": "Доставка",
"quantity": 1,
"price": 35,
"vatRate": "VAT_20"
}
],
"warehouseName": "Свой склад",
"initialOrder" : "5dgasfwe-7f1b-c54-897e-30bc628f45e8",
"onlinePaymentType": "RECURRENT",
"warehouseShippingOptions": {
"packingType": "MIX_PACKINGS"
}
}В ответ возвращается
Успех:
{
"c": "e172df57-f217-6091-b7fd-d668a67b6df4",
"orderId": "1222-1005",
"shortUrl": "http://r.kak2c.ru/ocq0kmf",
"status": "ORDER_INFO_NEED_CONFIRM",
"success": true
}Ошибка:
{
"success": false,
"errors": [
{
"code": 0,
"message": "Текст ошибки"
}
]
}
Пример минимального набора данных по заказу, которые надо передать, чтобы он успешно создался:
* значения полей "code" и "variantId" - должны соответствовать значениям, существующим на данном аккаунте
{
"delivery": {
"address": {
"city": "Москва",
"cityFias":"0c5b2444-70a0-4932-980c-b4dc0d3f02b5",
"regionFias":"0c5b2444-70a0-4932-980c-b4dc0d3f02b5"
},
"code": "ad5f7e6f-0ecb-45bf-3f6e-e3d21d2129be",
"receiver": {
"name": "Иван",
"phone": "79688876655"
}
},
"items": [
{
"num": 1,
"variantId": "1130659",
"quantity": 1,
"price": 100
},
{
"num": 2,
"price": 0,
"quantity": 1,
"variantId": "delivery"
}
]
}