Заказы

Комментарии по выгрузке заказов в Кактус

Для передачи заказов в Кактус, используется метод:

 

POST /api/lite/orders

Важно передать корректный адрес (вместе с ФИАС кодами), корректный телефон, правильный код способа доставки (и если выбран ПВЗ, то номер ПВЗ).

! Если обработка заказа Кактуса осуществляется на фулфилмент центре, тогда если заказ автоматически выгружается на фулфилмент центр, и любое изменение заказа по API (или через интерфейс) должно быть обязательно синхронизировано с системой фулфилмент - это происходит автоматически, а там в свою очередь осуществляется ряд проверок через систему интеграции с курьерскими службами.

Поэтому изменение заказа в Кактус может занимать относительно продолжительное время (10-15 секунд), пока вся синхронизация и проверки будут пройдены.

Изменение заказа возможно до момента взятия в работу (до статуса начала сборки заказа). Отмена заказа возможна до момента упаковки.

Для мониторинга состояния заказов, метод:

 

GET /api/lite/orders

Правильнее всего, получать только заказы, которые изменились с последней отметки времени. Это максимально экономит трафик.

Запрос заказов с фильтрацией по метке времени: updated_from

/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,
                  	"expirationMode": "USE_EXPIRATION",
                  	"expirationDays": 100
                },
                {
                    "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
            }
        }
    ]
}

 

Фильтрация

Для фильтрации есть следующие возможности:

 

Пейджинация

Для пейджинации используются параметры 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

Доступные коды сортировки:

По умолчанию используется сортировка по дате заказа по убыванию.

 

Описание результата запроса

Поле Тип Редактируемое

обязательное

Описание
id string да* нет

Номер заказа.
Основной идентификатор заказа.

* Можно задать только в момент создания заказа

externalId string да нет

Внешний номер заказа – дополнительный номер заказа, например в сторонней CRM системе.

externalId2 string да нет Внешний номер заказа
externalId3 string да нет Внешний номер заказа
externalId4 string да нет Внешний номер заказа
externalId5 string да нет Внешний номер заказа
date datetime да* нет

Дата заказа

* Можно задать только в момент создания заказа

needReserve boolean да нет Нужно ли брать резерв 
createTs datetime нет - Дата создания заказа в системе (техническая)
updateTs datetime нет - Дата последнего обновления заказа.
status enum нет -

Основной статус заказа. Описывает жизненный цикл заказа.

  • ORDER_INFO_DRAFT – Черновик. Заказ свободно редактируется, может быть не полностью заполнен, обязательность полей не контролируется.
  • ORDER_INFO_NEW - Статус заказа при ошибке создания. Необходима доп проверка таких заказов. Статус Новый похож на Черновик
  • ORDER_INFO_NEED_CONFIRM – Не подтвержден. Заказ взял на себя резервы и ожидает подтверждения сотрудника интернет-магазина.
  • ORDER_INFO_INSUFFICIENT_RESERVE –  Не хватает товара. Заказ подтвержден, но не взяты резервы, без резервов нет возможности отгрузить заказ (резервы не учитываются, если стоит соответствующая настройка на складе, на который оформлен заказ).
  • ORDER_INFO_REQUIRE_PAYMENT – Ожидает оплаты. Заказ ожидает оплаты покупателем, актуально для заказов с типом оплаты paymentMethodType = ONLINE (онлайн оплата на сайте).
  • ORDER_INFO_READY_TO_PACK – Готов к комплектации. Заказ подтвержден, товар полностью зарезервирован, оплачен - все готово для начала комплектации.
  • ORDER_INFO_CONFIRM_HOLD – Перезвон. Согласование заказа приостановлено, например, покупатель не снимает трубку.
  • ORDER_INFO_PACKED_DOCUMENTS_UPLOADED - Заказ по системе FBO. После того, как все ШК/файлы будут приложены, а также внесены данные по ШК поставки, в карточке заказа появится кнопка «Документы загружены».
    Нажмите на эту кнопку, и обновлённые данные передадутся в складскую систему. Статус заказа изменится на «Упаковано, ожидает сборки».
  • ORDER_INFO_PACKED_DOCUMENTS_REQUIRED - Заказ по системе FBO. На этом этапе заказ предварительно упакован складом. На этом этапе клиенту нужно своевременно загрузить необходимые документы по FBO отгрузке.
  • ORDER_INFO_IN_PACKING – На комплектации. Комплектация (процесс упаковки) заказа начат.
  • ORDER_INFO_PACKED – Упакован. Заказ успешно упакован.
  • ORDER_INFO_SHIPPED – Отгружен. Заказ отгружен в службу доставки.
  • ORDER_INFO_COURIER – На доставке. Курьерская служба подтвердила начало доставки.
  • ORDER_INFO_DELIVERED – Доставлен. Заказ доставлен. Финальный статус.
  • ORDER_INFO_PARTIALLY_DELIVERED_NOT_RETURNED – Доставлен частично *. Заказ доставлен частично, возврат не поступал.
  • ORDER_INFO_PARTIALLY_DELIVERED_RETURNED – Доставлен частично. Заказ доставлен частично, возврат принят. Финальный статус.
  • ORDER_INFO_RETURNING – Отказ *. Заказ возвращается. Покупатель отказался от заказа (в процессе доставки), и заказ возвращается курьерской компанией обратно отправителю. Остается крайне небольшой шанс, что покупатель передумает, и заказ все же будет доставлен.
  • ORDER_INFO_RETURNED – Отказ. Покупатель отказался от заказа, заказ возвращен на склад. Финальный статус.
  • ORDER_INFO_LOST – Утерян. Заказ утерян службой доставки. Финальный статус.
  • ORDER_INFO_AT_TAKEOUT_POINT – В пункте выдачи. Заказ доставлен в пункт выдачи заказов\постамат и ожидает покупателя.
  • ORDER_INFO_CANCELED – Отменен. Заказ отменен до момента отгрузки. После момента отгрузки, этот статус не актуален. Финальный статус.
  • ORDER_INFO_WAIT_UNPACKОжидает распаковки. Упакованный заказ отменен, но не распакован.
  • ORDER_INFO_RETURNED_TO_CLIENT - Используется при работе с МП Вайлдбериз. По заказу был невыкуп и товар поступил на склад WB для последующей продажи. В этом статусе заказ пропадает из вкладки "Возвраты", его можно найти поиском по номеру заказа. Финальный статус.
  • ORDER_INFO_DONE – устаревший статус, "Выполнен". Используется для обратной совместимости, и более не используется. Аналогичен ORDER_INFO_DELIVERED.
confirmStatus enum да нет

Статус подтверждения заказа

  • NEED_CONFIRM
  • APPROVED
  • CANCELED
totalOrderSum decimal нет - Общая сумма заказа
insuranceSum decimal да нет

Размер оценочной стоимости / страховки заказа.

По умолчанию равен общей сумме заказа или рассчитывается, исходя из процента расчёта страховки, указанного в аккаунте.

insuranceSumAutoCalculation boolean да нет Если не передаётся, то по умолчанию true. Если нужно указать произвольную сумму страховки, необходимо передать insuranceSumAutoCalculation = false
paymentStatus enum да нет

Статус оплаты заказа покупателем.

  • NOT_PAID
  • PAID

Имеет смысл только для заказов с предоплатой (например, оплата картой на сайте).

Заказы с оплатой ONLINE, и NOT_PAID - не передаются на комплектацию.

paymentMethodType enum да нет

Тип оплаты заказа.

  • COD_CASH – наложенный платеж (наличными). Оплата при вручении.
  • COD_CARD – наложенный платеж (картой). Оплата при вручении. С точки зрения многих курьерских служб COD_CASH и COD_CARD никак не отличаются, так как курьеры как правило готовы принять оплату на терминал. Тем не менее, рекомендуется в случае необходимости наложенного платежа передавать именно COD_CARD (так как наличные всегда принимаются курьерами по умолчанию).
  • ONLINE – предоплата заказа (картой на сайте).
  • NO_COD – особая разновидность предоплаты. Используется, например, для предоплаты заказа по счету для B2B клиентов. Заказ передается на отгрузку, только если paymentStatus=PAID.
  • NO_COD_NO_CONTROL – аналогично NO_COD, только параметр paymentStatus не контролируется (на комплектацию и отгрузку заказ передается в любом случае).
paymentMethodCode string да нет

Код и наименование способа оплаты заказа. 

Базовые способы оплаты (по умолчанию), в формате
paymentMethodCode (paymentMethodType) "paymentMethodName":

  • cod-cash (COD_CASH) "Оплата наличными при получении"
  • cod-card (COD_CARD) "Оплата картой при получении"
  • online (ONLINE) "Предоплата картой на сайте"
  • no-cod (NO_COD) "Без наложенного платежа"
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 да нет

Метка для добавления заказу
Необходимо передавать название метки (name)

Предварительно необходимо создать метку с таким названием

excludeFromSummary
boolean да нет

Признак true исключит заказ из статистики. Меняется запросом /api/lite/order-exclude-change

orderType enum нет -

Тип заказа

  • STANDARD – стандартный заказ интернет-магазина. Бизнес-логика для такого заказа отрабатывает стандартным образом.
  • CUSTOM – заказ с нестандартной логикой. Заказ с подобным типом возможно оплатить и возможно подтвердить. Но он никогда не будет брать резервов, упаковываться и отгружаться. Используется для разработки нестандартных решений.
orderSubType string да нет

Подтип заказа, в случае 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 нет - Объект с адресом пункта выдачи
metroStation
string нет - Ближайшая станция метро
latitude
string нет - Широта
longitude
string нет - Долгота
code
string нет - Код пункта выдачи
courier
string нет - КС
courierCode
string нет - Код КС
description
string нет - Описание
maxSize
string нет -

Максимальные габариты в см

Либо 1 число - сумма 3х измерений

Либо в формате 36x36x60

maxWeight
integer нет - Максимальный вес в кг
workTime
string нет - Время работы
paymentMethods
Array of enum нет - Доступные способы оплаты. (COD_CASH, COD_CARD)
type
enum нет - Тип пункта выдачи:
  • Postamat
  • PVZ
  • CASHIER_ISSUE_POINT
courierPostamatType
string нет - Тип пункта выдачи по версии КС
legalEntity Object да нет

Контрагент покупатель, с юридической точки зрения.

Если покупатель - обычное физическое лицо, type = PERSON, если юридическое лицо (ИП, ООО и т.п.), type = COMPANY

id string да нет Идентификатор контрагента
type enum да нет

Тип контрагента:

  • PERSON - физическое лицо
  • COMPANY - юридическое
name string да нет Наименование контрагента
items Array of Objects да да Массив объектов - позиции заказа.

ВАЖНО: Доставку необходимо передавать всегда последним элементом списка
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
vatSkuProduct enum нет -

Ставка НДС в карточке данного продукта

  • NO_VAT – без НДС (например, для компаний на УСН)
  • VAT_0
  • VAT_10
  • VAT_18
  • VAT_20
price decimal да да Стоимость единицы позиции
img string нет - Полная ссылка на картинку с товаром
sum decimal нет - Итоговая сумма по строке
itemAmountState Object нет -

для товаров - вывод оборотных данных по заказу по каждой позиции

например: 
"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 – Услуга, например "Доставка"
expirationMode enum да нет

Режим работы по срокам годности

  • USE_EXPIRATION
  • NO_EXPIRATION
expirationDays integer да нет

Желаемое допустимое максимальное число дней до окончания срока годности к отгрузке. Например, при значении 100 - склад сможет подбирать в заказ товары где минимальный остаточный срок годности - не менее 100 суток.

accountingAttributes Object нет -

Атрибуты учёта, например, ЧЗ или серийный номер

code enum нет -

Тип атрибута учёта::

  • chestnyznak - ЧЗ
  • uniquenumber - уникальный номер
stringValue string нет -

Значение атрибута учёта

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 нет - Расходы по данному заказу. Например, расходы на доставку, на страховку, на наложенный платеж, на фулфилмент операции - и т.д.
files
Array нет - Прикрепленные к заказу файлы
rawDeliveryStatuses Object нет - Статусы от курьерской компании
courierStatusDate date нет - Дата статуса от курьерской компании
statusCode string нет - Код статуса
statusMessage string нет - Сообщение к статусу
statusCity
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
crossdockEditable boolean нет - флаг, что заказ еще доступен для редактирования (только для аккаунтов в выключенным резервированием по умолчанию и только при запросе по id заказа). Редактировать заказ можно только при значении true
warehouseShippingOptions Object да нет

Настройки отгрузки

monopackingsOnly - флаг использования монокоробов (устаревший)
packingType - тип упаковки:
  • 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"
		}
	]
}

 

 

 

 

 

/api/lite/orders/cancelled

Заказ → отменить

/api/lite/orders/cancelled

Производит отмену заказа. 

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

{ 
"orderId":"1029" 
}

В ответ возвращается

успех:

{
"success": true

}

ошибка: 

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

/api/lite/orders/confirm

Заказ - подтверждение

/api/lite/orders/confirm

Проставление статуса Подтверждения у заказа.

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

{ 
    "id":"1234",
    "confirmStatus": "APPROVED", // HOLD/CANCELED
  	"repeatConfirmationDate": "2021-01-01 12:00:00"  // для статуса HOLD
}        

В ответ возвращается

успех:

{
    "success": true,
    "confirmStatus": "APPROVED" // HOLD/CANCELED 
}

ошибка: 

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

 

Заказ - подтверждение массовое

/api/lite/orders/confirm/batch

Проставление статуса Подтверждения у списка заказов.

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

{ 
    "orders":["1234", "5678"],
    "confirmStatus": "APPROVED" // HOLD/CANCELED
}        

В ответ возвращается

успех:

{
    "success": true,
    "confirmStatus": "APPROVED" // HOLD/CANCELED 
    "orders": [
        {
            "id": "1234",
            "success": true,
            "confirmStatus": "APPROVED",
            "errors": null
        },
        {
            "id": "5678",
            "success": false,
            "confirmStatus": "NEED_CONFIRM",
            "errors": [
             {
               "code": 0,
               "message": "Текст ошибки"
            }         
        }
    ]
}

ошибка: 

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

/api/lite/orders/payment

Проставить статус оплаты заказа

/api/lite/orders/payment

Проставление статуса оплаты у заказа.

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

{ 
    "id":"1234",
    "paymentStatus": "PAID" // NOT_PAID
}        

В ответ возвращается

успех:

{
    "success": true,
    "paymentStatus": "PAID" // NOT_PAID
}

ошибка: 

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

/api/lite/orders/delivery_result

Заказ - отметить доставку

/api/lite/orders/delivery_result

Для доставки своими курьерами - простановка результата доставки: доставлен/отказ/утеря

 

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

{
  "orderId": "123456abc",
  "result": "DELIVERED", //LOST,RETURNING,RETURNED
  "comment": "abcd"
}

 

Ошибка

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

/api/lite/orders/history

Получение истории по заказу

/api/lite/orders/history

Возвращает историю событий по указанному заказу

Обязательный параметр: id заказа

 

Пример ответа:

{
    "success": true,
    "events": [
        {
            "id": "2ebbb234-156e-2362-2dad-79556ea3ee14",
            "level": "INFO",
            "type": "Документы",
            "subType": "Изменения заказа",
            "orderDocStage": "Новый",
            "eventDate": "2020-01-15 11:57:05.159",
            "description": "Заказ 1285-1000. Покупатель: Ываыва; тел.: +7 (900) 111-11-14\n\nДобавлена строка: #2. [1002] Кактус Рипсалис, 3 шт., Цена с НДС: 22 RUB, НДС: 20%, Сумма с НДС: 66 RUB. \n\nСпособ оплаты: Без наложенного платежа; Статус оплаты: Оплачен\nАдрес доставки: Москва, ул Озёрная, д 31 Канал доставки: CUSTOM\n",
            "changeSource": "USER",
            "userLogin": "test@test.ru",
            "eventParameters": {              
                "apiUrl": "http://myshop-xb527.myinsales.ru",
                "login": "kak2c-delivery"
            }
        },
        {
            "id": "bf6e88a8-98bc-2f28-9973-bc870e8f1b67",
            "level": "INFO",
            "type": "Документы",
            "subType": "Заказ ожидает подтверждения",
            "orderDocStage": "Не подтвержден",
            "eventDate": "2020-01-15 11:57:05.298",
            "description": "Заказ 1285-1000. ",
            "changeSource": "USER",
            "userLogin": "test@test.ru",
            "eventParameters": null
        }
    ]       
}

 

/api/lite/orders/invoice_and_stiсker

Заказ → получить инвойс + стикер к заказу

/api/lite/orders/invoice_and_stiсker

Получение комбинированной печатной формы инвойс + стикер, в формате PDF + base64

номер заказа передается в параметре id, например

?id=1025

 

Успех:

{
  "success": true, 
  "content" : "base64data"
     
}

 

Ошибка:

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

/api/lite/orders/items

Заказ → обновление товарной части

/api/lite/orders/items

Возможность обновить только табличную часть заказа

Необходимо в запросе передать новое желаемое состояние табличной части в виде непустого перечня позиций

 

Запрос:

{
    "id": "1234",  
    "items": [
            {
               "num": 1,
                "variantId": "1001",
                "productId": "1001",
                "name": "Кактус Цереус",
                "quantity": 2,
                "price": 522,
                "vatRate": "VAT_20"         
            }
        ],
  		"searchColumnType": "HUMANID" //"EXTID"|"ARTICLE"|"BARCODE" Поле для поиска номенклатуры. Если не задано, то поиск идёт по HUMANID
            
}

 

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

{
    "success": true  
}

 

В случае ошибки:

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

 

_________________________________________________________________________________________________________________________________________

Если orderType = KAKTUS_CONSOLIDATION, то если передаются итемы, которых нет в Кактусе, то будет происходить автосоздание номенклатуры (задача 11972):  Sku + SkuProduct + их настройки *liteApiSettings. Также есть возможность проставить признаки учета по уникальным номерам (например, Честный знак).

/api/lite/orders/nearest

Получение ближайших заказов к заданному

/api/lite/orders/nearest

Возвращает по 10 заказов до и после указанного (включая заданный), считая по дате заказа

Обязательный параметр: id заказа. Например:

api/lite/orders/nearest?id=1285-1001

Формат ответа аналогичен списку заказов

Пример ответа:

{ 
    "success": true,
    "recordsTotal": 8,
    "orders": [
        {
            "id": "1285-1000",
            "date": "2020-01-15 11:56:21",
            "updateTs": "2020-01-15 11:57:23.169",
            "status": "ORDER_INFO_READY_TO_PACK",
            "totalOrderSum": 66,
            "paymentStatus": "PAID",
            "paymentMethodCode": "no-cod",
            "needCustomerPayment": false,
            "tags": [],
            "delivery": {
                "code": "eefbe980-1e3b-d973-ef24-6e92399ca702",
                "type": "COURIER",
                "title": "CUSTOM",
                "pickupPointId": null,
                "logoUrl": null,
                "trackingNumber": null,
                "trackingURL": null,
                "desiredDeliveryDate": null,
                "desiredDeliveryTimeFrom": "09:00",
                "desiredDeliveryTimeTo": "18:00",
                "deliveryComment": null,
                "address": {
                    "country": "Россия",
                    "countryCode": "RU",
                    "region": "Москва",
                    "area": null,
                    "city": "Москва",
                    "settlement": null,
                    "street": "ул Озёрная",
                    "house": "31",
                    "block": "",
                    "building": "",
                    "flat": null,
                    "fullAddress": "119361, г Москва, ул Озёрная, д 31",
                    "fullCity": null,
                    "rawData": null,
                    "zip": "119361",
                    "regionFias": "0c5b2444-70a0-4932-980c-b4dc0d3f02b5",
                    "areaFias": null,
                    "cityFias": "0c5b2444-70a0-4932-980c-b4dc0d3f02b5",
                    "settlementFias": null
                },
                "receiver": {
                    "name": null,
                    "surname": "Ываыва",
                    "patronymic": null,
                    "phone": "+79001111114",
                    "alternativePhone": "",
                    "email": null,
                    "post": null,
                    "personType": null
                }
            },
            "legalEntity": {
                "id": "4b51fdb9-3c57-5cce-29aa-da9bb35d778d",
                "type": "PERSON",
                "name": " Розничный покупатель"
            },
            "items": [
                {
                    "num": 1,
                    "variantId": "delivery",
                    "name": "Доставка",
                    "quantity": 1,
                    "price": 0,
                    "skuType": "SERVICE"
                },
                {
                    "num": 2,
                    "variantId": "1002",
                    "productId": "1002",
                    "name": "Кактус Рипсалис",
                    "quantity": 3,
                    "price": 22,
                    "img": "https://img.kak2c.ru/i/P/o/1X8eNZVj_c.jpg?1579013978",
                    "skuType": "SKU"
                }
            ],
            "customerPaymentInProcess": false,
            "warehouseName": "Свой склад",
            "c": "59b34def-1077-9050-541b-b7c3290c9fd8"
        },
        ...
    ]
}

/api/lite/orders/receiver

Заказ → обновление контактной информации получателя

/api/lite/orders/receiver

Возможность обновить только контактную информацию

id - номер заказа

 

Запрос

{
     "id": "1234",
     "name": "Олег",
     "surname": "Коробов",
     "patronymic": "",
     "phone": "9153112255",
     "alternativePhone": "",
     "email": "korobov.oleg@gmail.com",
     "passport": {
         "series": "1234",
         "number": "123123"
         "date": "2022-01-24"
	 }
}

 

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

{
    "success": true  
}

В случае ошибки:

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

/api/lite/orders/refresh-reserve

Обновление резервов по заказу

/api/lite/orders/refresh-reserve

Обновляет резервы по заказу, основываясь на версии заказа в бэкенде на момент вызова команды.

Обязательный параметр: id заказа.  Например:

api/lite/orders/refresh-reserve?id=1285-1001

В случае получения положительного ответа ("success": true) - нужно повторно загрузить заказ с бэкенда, данные по товарам и резервам могут быть обновлены. 

Пример ответа:

{ 
    "success": true  
}

 

Заказ - обновление резервов массовое

/api/lite/orders/refresh-reserve/batch

Обновление резервов у списка заказов.

В случае неуспеха - в ответе в списке errors будут ошибки обновления. Успешно обновленные резервы при этом сохраняются в системе.

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

{ 
    "orders":["8057-1033", "5678"] 
}        

В ответ возвращается:

{
    "success": true  
}

Ошибка по любому заказу списка: 

{
 
    "success": false,
    "errors": [
        {
            "code": 0,
            "message": "Ошибка обработки заказа 8057-1033: Ошибка при проведении: Не задан канал доставки для заказа 8057-1033; Не заданы ФИО получателя."
        },
        {
            "code": 0,
            "message": "Заказ 5678 не найден."
        }
    ]
}

 

Заказ - обновление всех резервов

/api/lite/orders/refresh-reserve/all

Обновление резервов у всех заказов, которые зарезервированы не полностью.

Запрос выполняется без параметров.
В ответ будет возвращено кол-во запланированных к обновлению заказов, обработанных без ошибок и полностью зарезервированных.

В ответ возвращается:

{
    "success": true,
    "errors": [
        {
            "code": 0,
            "message": "Заказ 1427 не был полностью зарезервирован"
        },
        {
            "code": 0,
            "message": "Ошибка обработки заказа 8057-1033: Ошибка при проведении: Не задан канал доставки для заказа 8057-1033; Не заданы ФИО получателя."
        }
    ],
    "planned": 3,
    "processed": 2,
    "reserved": 1
}

 

 

/api/lite/orders/statuses

Получение сводки по статусам заказов

/api/lite/orders/statuses

Возвращает сводные данные по количеству заказов в различных статусах, а также о количестве проблемных заказов

По умолчанию содержит только сводку без заказов с типом CUSTOM.
Для получения сводки по CUSTOM заказам с нужным подтипом - передать список подтипов в параметре  order_types, аналогично получению заказов в /api/lite/orders?order_types=my_types

Пример ответа:

{
    "success": true,
    "statuses": {
        "ORDER_INFO_DRAFT": 6,
        "ORDER_INFO_NEED_CONFIRM": 1,
        "ORDER_INFO_READY_TO_PACK": 1
    },
    "problemOrders": 0
}

/api/lite/orders/packing

Заказ → упаковать

/api/lite/orders/packing

Производит упаковку указанного подтвержденного заказа в одно упакованное место, содержащее все товары заказа, имеющее суммарные массу и объем товаров из данных их упаковок (с небольшой поправкой в сторону увеличения).

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

{ 
"id":"1019" 
}

В ответ возвращается:

{
"success": true

}

Ошибка: 

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

 

Заказ → упаковать массовый

/api/lite/orders/packing/batch

Производит упаковку по списку переданных заказов (все неупакованные), аналогично штучной упаковке /api/lite/orders/packing и возвращает для упакованных заказов общую печатную форму.

Метод можно вызывать повторно для упакованных заказов  - в этом случае упаковка повторно не производится, а только заказ включается в перечень для генерации печатной формы. 

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

{ 
    "orders":["1234", "5678"]  
}

В ответ возвращается:

{
    "success": true,   
    "orders": [
        {
            "id": "1234",
            "success": true,           
            "errors": null
        },
        {
            "id": "5678",
            "success": false,      
            "errors": [
             {
               "code": 0,
               "message": "Текст ошибки"
            }         
        }
    ],
    "content" : "base64data"   // pdf печатной формы упакованных заказов из списка переданных
}

Ошибка: 

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

 

Заказ → распаковать

/api/lite/orders/packing

Производит полную распаковку указанного упакованного заказа

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

{ 
"id":"1018" 
}

В ответ возвращается:

{
"success": true

}

Ошибка: 

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

/api/lite/orders/packing_control

Заказ → контроль упаковки

/api/lite/orders/packing_control

Производит контроль упаковки по ШК, если склад с настройкой контроля упаковки.

 

В успешном ответе будет присутствовать проверенный ШК и номер заказа.

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

{
"id": "202233856366"
}

В ответ возвращается:

{
    "success": true,
    "id": "202228134882",
    "orderId": "8057-1048"
}

Ошибка: 

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

 

Заказ → контроль упаковки

/api/lite/orders/packing_control

Возвращает последние проконтролированные упакованные места.

 

Пейджинация

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

Пример: /api/lite/orders/packing_control?page=0&size=20

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

 

Описание результата запроса

Поле Тип Описание
stickerBarcode string Штрих код
packingControlDate datetime Время проверки упакованного места
orderId string Номер заказа
deliveryCompany string Наименование курьерской службы
receiver Object Объект, описывающий получателя заказа
name string Имя
surname string Фамилия
patronymic string Отчество
fullName string ФИО
phone string Телефон (отформатированный)
rawPhone string Телефон (в чистом виде)
alternativePhone string Альтернативный телефон
email string Почтовый адрес
post string Должность
personType string Тип пользователя

 

Пример ответа:

{ 
    "success": true,
    "recordsTotal": 8,
    "takeOutPackings": [
        {
            "stickerBarcode": "202233856366",
            "packingControlDate": "2020-05-08 20:38:08.353",
            "orderId": "3248-1005",
            "deliveryCompany": "PickPoint",
            "receiver": {
                "name": "Петр",
                "surname": "толстой",
                "patronymic": "",
                "fullName": "Толстой Петр",
                "phone": "89011111111",
                "rawPhone": "89011111111",
                "alternativePhone": "",
                "email": "petr@petr.net",
                "post": null,
                "personType": "CUSTOMER"
            }
        },
        ...
    ]
}

 

/api/lite/orders/tag

Заказ → установить метку на заказе

/api/lite/orders/tag

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

{
  "id": "1000",
  "tagId": "1001"
}

Успех:

{
  "success": true
}

Ошибка:

{
  "success": false,
  "errors": [
    {
      "code": 0,
      "message": "Метки с указанным id не существует"
    }
  ]
}

 

Заказ → снять метку с заказа

/api/lite/order/tag

Снимает метку с заказа.

Запрос:

{
  "id": "1000",
  "tagId": "1001"
}

Успешный ответ:

{
  "success": true
}

/api/lite/orders/calc_insurance_sum

Расчет страховой стоимости заказа

/api/lite/orders/calc_insurance_sum

Расчет страховой стоимости заказа исходяиз переданных товаров и с учетом настроек процента страховой суммы на данный канал доставки.

Заказ анализируется только из переданных данных, без поиска заказа в БД.

В качестве dto используется dto заказа из /orders.

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

{
              
          "totalOrderSum": 15,
          "paymentStatus": "NOT_PAID",
          "confirmStatus": "NEED_CONFIRM",
          "paymentMethodCode": "cod-cash",
          "paymentMethodType": "COD_CASH",
          "needCustomerPayment": false,
          "tags": [],
          "delivery": {
              "code": "1a625a2c-c121-617c-23b9-5bbfbfb22eec",
              "type": "PVZ",
              "title": "PickPoint",
              "pickupPointId": "3",
              "logoUrl": "https://storage.yandexcloud.net/lk-kak2c/delivery_pickpoint_left.svg",
              "trackingNumber": null,
              "trackingURL": null,
              "desiredDeliveryDate": null,
              "desiredDeliveryTimeFrom": "09:00",
              "desiredDeliveryTimeTo": "18:00",
              "deliveryComment": null,
              "address": {
                  "country": "Россия",
                  "countryCode": "RU",
                  "region": "Москва",
                  "area": null,
                  "city": "Москва",
                  "settlement": null,
                  "street": "ул Озёрная",
                  "house": "33",
                  "block": "",
                  "building": "",
                  "flat": null,
                  "fullAddress": "119361, г Москва, ул Озёрная, д 33",
                  "fullCity": null,
                  "rawData": null,
                  "zip": "119361",
                  "regionFias": "0c5b2444-70a0-4932-980c-b4dc0d3f02b5",
                  "areaFias": null,
                  "cityFias": "0c5b2444-70a0-4932-980c-b4dc0d3f02b5",
                  "settlementFias": null
              },
              "receiver": {
                  "name": "Валерьевна",
                  "surname": "Ирина",
                  "patronymic": null,
                  "fullName": "Ирина Валерьевна",
                  "phone": "89011111111",
                  "rawPhone": null,
                  "alternativePhone": "",
                  "email": "i-fomina@yandedx.ru",
                  "post": null,
                  "personType": "CUSTOMER"
              },
              "deliveryServices": []
          },
          "legalEntity": {
              "id": "3c0a3ad3-b10f-4299-5b1b-a3d90b0c198a",
              "type": "PERSON",
              "name": " Розничный покупатель",
              "organization": null,
              "person": null
          },
          "items": [
              {
                  "num": 1,
                  "variantId": "delivery",
                  "name": "Доставка",
                  "quantity": 1,
                  "vatRate": "NO_VAT",
                  "price": 0,
                  "skuType": "SERVICE"
              },
              {
                  "num": 2,
                  "variantId": "BR00T-000116",
                  "productId": "BR00T-000116",
                  "productExtId": "BR00T-000116",
                  "name": "Набор для Бро №3: помада для волос, гель для душа + шампунь",
                  "article": "BR00T-000116",
                  "quantity": 5,
                  "quantityAvailable": 38,
                  "vatRate": "NO_VAT",
                  "price": 30,
                  "img": "https://storage.yandexcloud.net/images-k2c/90960e52-86cf-4342-9ecc-497bb91f0af0.jpg",
                  "itemAmountState": {
                      "amountORDERED": 5,
                      "amountRESERVED": 5,
                      "amountPACKED": 0,
                      "amountSHIPPED": 0,
                      "amountDELIVERED": 0,
                      "amountLOST": 0,
                      "amountFACT_DELIVERED": 0,
                      "amountRETURNED": 0
                  },
                  "skuType": "SKU",    
                  "itemDimensions": {
                      "height": 20,
                      "width": 20,
                      "depth": 10
                  },
                  "itemWeight": 500
              },
              {
                  "num": 3,
                  "variantId": "BR00T-000133",
                  "productId": "BR00T-000133",
                  "productExtId": "BR00T-000133",
                  "name": "Брелок для ключей/рюкзака Bro Cosmetics Crew",
                  "article": "BR00T-000133",
                  "quantity": 22,
                  "quantityAvailable": 1,
                  "vatRate": "NO_VAT",
                  "price": 15,
                  "img": "https://storage.yandexcloud.net/images-k2c/b99569d2-be64-4a41-9cfa-e9eb5c339485.jpg",
                  "itemAmountState": {
                      "amountORDERED": 22,
                      "amountRESERVED": 22,
                      "amountPACKED": 0,
                      "amountSHIPPED": 0,
                      "amountDELIVERED": 0,
                      "amountLOST": 0,
                      "amountFACT_DELIVERED": 0,
                      "amountRETURNED": 0
                  },
                  "skuType": "SKU",
                  "itemDimensions": {
                      "height": 2,
                      "width": 1,
                      "depth": 1
                  },
                  "itemWeight": 50
              }
          ],
          "expenses": [],
          "customerPaymentInProcess": false,
          "warehouseName": "Tempoline",
          "warehouseCode": "6805bc64-270f-ae7d-1231-773ff181e446",
          "c": "4f794476-a895-897d-d4a4-119924305917"
      }

В ответ возвращается

Успех:

{
    "success": true,
    "insuranceSum": 240.2
}

Ошибка: 

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

/api/lite/tag

Создание/редактирование/удаление метки

Для создания / редактирования

/api/lite/tag

Для создания или редактирования метки, выполняется следующий POST запрос.

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

{ 
    "id": "идентификатор метки",
    "name": "На производстве",
    "color_id": "color1"
   
}

Если id не указан, тогда выполняется создание новой метки, если id указан – метка обновляется.

В ответ возвращается результат операции и id созданной/отредактированной метки.

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

{
  "success": true,
  "id": "1000"
}

В случае ошибки:

{
  "success": false,
  "errors": [
    {
      "code": 0,
      "message": "Метки с указанным id не существует"
    }
  ]
}

Для удаления:

/api/lite/tag

Для удаления метки, выполняется следующий POST запрос с указанием идентификатора метки.

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

{ 
   "id": "1000" 
}

В ответ возвращается результат операции и id удаленной метки.

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

{
  "success": true,
  "id": "1000"
}

В случае ошибки:

{
  "success": false,
  "errors": [
    {
      "code": 0,
      "message": "Метки с указанным id не существует"
    }
  ]
}

Получение списка меток 

/api/lite/tag

В ответ возвращается список всех созданных меток, а также набор доступных цветов для меток.

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

{
  "tags": [
    {
      "id": "1000",
      "name": "В производстве",
      "color": "color1"
    },
    {
      "id": "1001",
      "name": "VIP",
      "color": "color2"
    }
  ],
  "colors": [
    {
      "id": "color1",
      "code": "#FF0000"
    },
    {
      "id": "color2",
      "code": "#FFDD00"
    }
  ]
}

/api/lite/report/order

XLS Отчёт по заказам

/api/lite/report/order

Возвращает отчёт по всем заказам в формате XLS.

По умолчанию, если доп. параметры не переданы, возвращает список ВСЕХ заказов за всё время.

Для запроса списка заказов за определённый интервал, необходимо передать доп. параметры:

from=yyyy-MM-ddTHH:mm:ss и to=yyyy-MM-ddTHH:mm:ss

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

/api/lite/report/order?from=2019-10-29T12:00:45&to=2019-10-31T11:02:37

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

{
    "success": true,
    "fileName": "OrderReport(17233597)13556330559279078228.xls",
    "content": "0M8R4K(...)AAAAAAAAAAAAAAAAAAAAAA==" //Файл в формате excel, закодированный в BASE64 строке
}

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

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

/api/lite/pub/orders

Создание заказа для виджета

/api/lite/pub/orders

(метод требует авторизации по домену)

Создание заказа для корзины и других клиентов по АПИ

Создает новый заказ в системе Кактус.

Цены задавать нельзя, они подставятся в бэкенде из актуальных

Доставка перерасчитается в бэкенде по указанным данным заказа


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

{
  "comment": "",
  "paymentMethodCode": "cod-cash",
  "orderTag": "tag1",
  "totalOrderSum": 5490,
  "delivery": {
    "code": "PICKPOINT",
    "pickupPointId": "2201-001",
    "desiredDeliveryDate": "2020-02-14",
    "desiredDeliveryTimeFrom": "09:00",
    "desiredDeliveryTimeTo": "20:00",
    "deliveryComment": "Поскорее",
    "receiver": {
      "name": "петр",
      "surname": "толстой",
      "patronymic": "",
      "fullName": "",
      "phone": "89011111111",
      "alternativePhone": "",
      "email": "petr@petr.net"
    },
    "address": {
    "region": "Алтайский",
    "area": null,
    "city": "Барнаул",
    "settlement": null,
    "street": "Барнаульская",
    "house": "1",
    "block": "",
    "building": "",
    "flat": "",
    "fullAddress": "",
    "zip": "",
    "regionFias": "8276c6a1-1a86-4f0d-8920-aba34d4cc34a",
    "areaFias": null,
    "cityFias": "d13945a8-7017-46ab-b1e6-ede1e89317ad",
    "settlementFias": null,
    "country": "RU"
    }
  },
  "items": [
    {
      "num": 1,
      "variantId": "1001", 
      "variantExtId": null,     
      "quantity": 1,
      "bundleOptionalVariants": [
        "1012"
      ]
    },
    {
      "num": 2,
      "variantId": "delivery",
      "variantExtId": null
    }
  ],
  "promocode":null,
  "customData":"some data",
  "urlParams":[
  {
    "name":"name1",
    "value":"value1"
  }
 ],
  "deliveryServiceOptions": {
        "PICKPOINT_DELIVERY": "TRYING;PARTIAL_DELIVERY"
   },
  "consentToNewsletter": true
}

В ответ возвращается:

{
    "success": true,
    "orderId": "1285-1002",
    "c": "2b92b631-7f1b-c52a-897e-30bc628f87e5"
}

Ошибка: 

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

 

Запрос списка заказов

/api/lite/pub/orders

Метод возвращает запрошенный заказ по его номеру (id) и проверочному коду (с)

Пример запроса: api/lite/pub/orders?id=7277-1002&c=f300ae30-507c-2d36-d37c-e6397084b6e2

Описание полей смотреть для метода:

/api/lite/orders

Примечание: Возвращается неполный список полей по сравнению с GET /api/lite/orders.

 

Пример результата запроса:

{
    "success": true,
    "orders": [
        {
            "id": "7277-1002",
            "date": "2020-01-22 16:37:56",
            "updateTs": "2020-01-22 16:37:57.528",
            "status": "ORDER_INFO_DRAFT",
            "totalOrderSum": 999,
            "paymentStatus": "NOT_PAID",
            "paymentMethodCode": "online",
            "needCustomerPayment": false,
            "comment": "",
            "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
                }
            },
            "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"
                },
                {
                    "num": 2,
                    "productId": null,
                    "variantId": "delivery",
                    "name": "Доставка",
                    "quantity": 1,
                    "price": 0,
                    "skuType": "SERVICE"
                }
            ],
            "customerPaymentInProcess": false,
          	"shopUrl": "https://shop6750043.kak2c.ru",
            "c": "f300ae30-507c-2d36-d37c-e6397084b6e2"
        }
    ]
}

Ошибка:

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

 

Расчет скидки по заказу

/api/lite/pub/orders/discount

Запрос расчета скидки по заказу, по указанному промокоду. Структура запроса такая же как в создании заказа.

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

{
  "comment": "",
  "paymentMethodCode": "online",
  "totalOrderSum": 5490,
  "delivery": {
    "сode": "PICKPOINT",
    "pickupPointId": "12345",
    "desiredDeliveryDate": "22.02.2020",
    "desiredDeliveryTimeFrom": "09:00",
    "desiredDeliveryTimeTo": "20:00",
    "deliveryComment": "Поскорее",
    "receiver": {
      "name": "петр",
      "surname": "толстой",
      "patronymic": "",
      "fullName": "",
      "phone": "23232323",
      "alternativePhone": "",
      "email": "petr@petr.net"
    },
    "address": {
    "region": "Алтайский",
    "area": null,
    "city": "Барнаул",
    "settlement": null,
    "street": "",
    "house": "",
    "block": "",
    "building": "",
    "flat": "",
    "fullAddress": "",
    "zip": "",
    "regionFias": "8276c6a1-1a86-4f0d-8920-aba34d4cc34a",
    "areaFias": null,
    "cityFias": "d13945a8-7017-46ab-b1e6-ede1e89317ad",
    "settlementFias": null,
    "country": "RU"
    }
  },
  "items": [
    {
      "num": 1,
      "variantId": "1001",
      "productId":"1001",
      "quantity": 1
    },
    {
      "num": 2,
      "variantId": "delivery",
      "productId":"delivery"
    }
  ],
  "promocode":"PROMO",
  "customData":"some data",
  "urlParams":[
  {
    "name":"name1",
    "value":"value1"
  }
 ],
  "deliveryServiceOptions": {
        "PICKPOINT_DELIVERY": "TRYING;PARTIAL_DELIVERY"
   }
}

В ответ возвращается:

{
    "success": true,
    "discounts": [
        {
            "discountValue": 123.45,
            "deliveryDiscountValue": 123.45,
            "discountType": "PROMOCODE"  // PAYMENT_TYPE
        }
    ]
   
}

Ошибка: 

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

 

Проверка промокодов

/api/lite/pub/promocode/conditions/check

Для валидации условий промокода, необходимо передать весь заказ целиком, с заполненным промокодом (аналогично /api/lite/pub/orders)

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

{
  "comment": "",
  "paymentMethodCode": "online",
  "totalOrderSum": 5490,
  "delivery": {
    "сode": "PICKPOINT",
    "pickupPointId": "12345",
    "desiredDeliveryDate": "22.02.2020",
    "desiredDeliveryTimeFrom": "09:00",
    "desiredDeliveryTimeTo": "20:00",
    "deliveryComment": "Поскорее",
    "receiver": {
      "name": "петр",
      "surname": "толстой",
      "patronymic": "",
      "fullName": "",
      "phone": "23232323",
      "alternativePhone": "",
      "email": "petr@petr.net"
    },
    "address": {
    "region": "Алтайский",
    "area": null,
    "city": "Барнаул",
    "settlement": null,
    "street": "",
    "house": "",
    "block": "",
    "building": "",
    "flat": "",
    "fullAddress": "",
    "zip": "",
    "regionFias": "8276c6a1-1a86-4f0d-8920-aba34d4cc34a",
    "areaFias": null,
    "cityFias": "d13945a8-7017-46ab-b1e6-ede1e89317ad",
    "settlementFias": null,
    "country": "RU"
    }
  },
  "items": [
    {
      "num": 1,
      "variantId": "1001",
      "productId":"1001",
      "quantity": 1
    },
    {
      "num": 2,
      "variantId": "delivery",
      "productId":"delivery"
    }
  ],
  "promocode":"TEST",
  "customData":"some data",
  "urlParams":[
  {
    "name":"name1",
    "value":"value1"
  }
 ],
  "deliveryServiceOptions": {
        "PICKPOINT_DELIVERY": "TRYING;PARTIAL_DELIVERY"
   }
}

Результат запроса: 

{
   "success":true,
   "code":"code",
   "isActive":true,
   "discountType":"FIX",
   "discountValue":836,
   "hasConditions":true,
   "deliveryDiscountValue":50, //Скидка на доставку в %
   "bonusSkus":[
    {

      "productId":"123",

      "variantId":"456",

      "quantity": 2
    }  
   ]
}

Ошибка:

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

/api/lite/pub/order-discount

Запросить размер скидок по заказу (публичный) -(V1)

(метод требует авторизации по домену)

Проверка переданного промокода на активность

/api/lite/pub/order-discount

По отправленным данным заказа (с опциональным указанием промокода) - возвращает размер скидки в рублях для чекаута.

Формат передаваемых данных всегда аналогичен dto заказа в методе создания заказа (публичный):

/api/lite/pub/order

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

{
  "comment": "",
  "confirmStatus": "APPROVED",
  "paymentStatus": "NOT_PAID",
  "paymentMethodCode": "cod-card",
  "totalOrderSum": "1330.00",
  "promocode":"testPercent",
  "delivery": {
    "receiver": {
      "name": "тест4",
      "phone": "9151321211",
      "alternativePhone": "",
      "email": ""
    },
    "deliveryCode": "GLOBAL_DELIVERY",
    "timeFrom": "09:00",
    "timeTo": "20:00",
    "desiredDeliveryDate": null,
    "deliveryComment": "",
    "address": {
      "regionFias": "0c5b2444-70a0-4932-980c-b4dc0d3f02b5",
      "areaFias": null,
      "cityFias": "0c5b2444-70a0-4932-980c-b4dc0d3f02b5",
      "settlementFias": null,
      "country": "RU",
      "region": "Москва",
      "area": null,
      "city": "Москва",
      "settlement": null,
      "street": "",
      "house": "",
      "block": "",
      "building": "",
      "flat": "",
      "fullAddress": "",
      "zip": ""
    },
    "pickupPointId": ""
     
  },
  "items": [
    {
      "num": 1,
      "id": "1001",
      "quantity": 3,
      "variants": [
         
      ]
    },
     {
      "num": 2,
      "id": "1002",
      "quantity": 2,
      "variants": [
         
      ]
    },
    {
      "num": 3,
      "id": "delivery"
    }
  ]
}

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

{
    "success": true,
    "discounts": [
        {
            "discountType": "PROMOCODE", //   PROMOCODE | PAYMENT_TYPE
            "discountValue": 123.45,
            "deliveryDiscountValue" : 50 //Скидка на доставку в %
        },
        {
            "discountType": "PAYMENT_TYPE", //   PROMOCODE | PAYMENT_TYPE
            "discountValue": 20
        }
    ]   
}

/api/lite/pub/payment

Оплата заказа покупателем

/api/lite/pub/payment?orderId=humanId

Параметр: humanId заказа покупателя.

В ответе данные для формирования html-формы отсылки на оплату.

Ответ:

{
    "success": true,
    "errors": [],
    "redirectData": {
        "data": {
            "entries": [
                {
                    "num": 0,
                    "name": "MERCHANT",
                    "value": "kaktwocr"
                },
                {
                    "num": 1,
                    "name": "ORDER_REF",
                    "value": "25567175-8d84-e371-90fa-8a6e86a69aa4"
                },
                {
                    "num": 2,
                    "name": "ORDER_DATE",
                    "value": "2019-03-11 17:09:35"
                },
                {
                    "num": 3,
                    "name": "ORDER_PNAME[]",
                    "value": "Пополнение баланса аккаунта №6419855"
                },
                {
                    "num": 4,
                    "name": "ORDER_PCODE[]",
                    "value": "balance"
                },
                {
                    "num": 5,
                    "name": "ORDER_PRICE[]",
                    "value": "222.00"
                },
                {
                    "num": 6,
                    "name": "ORDER_QTY[]",
                    "value": "1"
                },
                {
                    "num": 7,
                    "name": "ORDER_VAT[]",
                    "value": "0"
                },
                {
                    "num": 8,
                    "name": "PRICES_CURRENCY",
                    "value": "RUB"
                },
                {
                    "num": 9,
                    "name": "DESTINATION_CITY",
                    "value": ""
                },
                {
                    "num": 10,
                    "name": "DESTINATION_STATE",
                    "value": ""
                },
                {
                    "num": 11,
                    "name": "DESTINATION_COUNTRY",
                    "value": ""
                },
                {
                    "num": 12,
                    "name": "PAY_METHOD",
                    "value": "CCVISAMC"
                },
                {
                    "num": 13,
                    "name": "ORDER_PRICE_TYPE[]",
                    "value": "GROSS"
                },
                {
                    "num": 14,
                    "name": "ORDER_HASH",
                    "value": "6fe466d056fcc82836a861c322070381"
                },
                {
                    "num": 15,
                    "name": "BILL_FNAME",
                    "value": "Петр"
                },
                {
                    "num": 16,
                    "name": "BILL_LNAME",
                    "value": "Петров"
                },
                {
                    "num": 17,
                    "name": "BILL_EMAIL",
                    "value": "abc3@abc.ru"
                },
                {
                    "num": 18,
                    "name": "BILL_PHONE",
                    "value": "111111"
                },
                {
                    "num": 19,
                    "name": "BILL_COUNTRYCODE",
                    "value": "RU"
                },
                {
                    "num": 20,
                    "name": "BACK_REF",
                    "value": ""
                },
                {
                    "num": 21,
                    "name": "LANGUAGE",
                    "value": "RU"
                },
                {
                    "num": 22,
                    "name": "CURRENCY",
                    "value": "RUB"
                }
            ],
            "url": "https://sandbox.payu.ru/order/lu.php"
        },
        "paymentProvider": "PAYU"
    }
}

 

/api/lite/pub/orders/discount

Запросить размер скидок по заказу (публичный)

 

/api/lite/pub/orders/discount

По отправленным данным заказа (с опциональным указанием промокода) - возвращает размер скидки в рублях для чекаута.

Формат передаваемых данных всегда аналогичен dto заказа в методе создания заказа (публичный):

/api/lite/pub/orders

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

{
  	"promocode":"testPercent",
    "comment": "",
    "confirmStatus": "APPROVED",
    "delivery": {
        "address": {
            "area": null,
            "areaFias": null,
            "block": "",
            "building": "",
            "city": "Урюпинск",
            "cityFias": "2e5879fc-35c2-4354-816b-f1fce74ece87",
            "country": "RU",
            "flat": "",
            "fullAddress": "",
            "house": "",
            "region": "Волгоградская",
            "regionFias": "da051ec8-da2e-4a66-b542-473b8d221ab4",
            "settlement": null,
            "settlementFias": null,
            "street": "",
            "zip": ""
        },
        "code": "bb60d72c-2a25-11e9-8989-002590923634",
        "deliveryComment": "",
        "desiredDeliveryDate": null,
        "pickupPointId": "",
        "receiver": {
            "alternativePhone": "",
            "email": "",
            "name": "",
            "phone": ""
        },
        "timeFrom": "09:00",
        "timeTo": "20:00"
    },
    "forOrderDiscount": true,
    "items": [
        {
            "num": 1,
            "productId": "BR00T-000132",
            "quantity": 1,
            "variantId": "BR00T-000132"
        }
    ],
    "paymentMethodCode": "disk1",
    "paymentStatus": "NOT_PAID",
    "totalOrderSum": 690
}

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

{
    "success": true,
    "discounts": [
      	{
            "discountValue": 2813.00, //общая применяемая скидка
            "orderSumDiscountValue": 1541.00, //скидка на итоговую сумму заказа (общая сумма заказа за вычетом потоварной скидки)(discountValue - skusDiscountValue)
            "skusDiscountValue": 1272.00, //Суммарная потоварная скидка
            "deliveryDiscountValue": 50, //Скидка на доставку в %
            "discountType": "PROMOCODE", //   PROMOCODE | PAYMENT_TYPE
            "discountFormula": "250.00 * 2 + (636.00 - 636.00) * 2 + 1030.00 + 636.00 * 2 - 1000 - (20% + 10%) = 1261", //формула расчёта скидки на сумму заказа
            "promocodeSkuDiscounts": [ //потоварные скидки
                {
                    "skuId": "1066", //ID товара
                    "quantity": 2, //Кол-во товара
                    "fixDiscountAmount": 1000, //Суммарная величина фикс скидки на товар
                    "percentDiscountAmount": 0, //Суммарная величина процента скидки на товар
                    "oldPrice": 636.00, //старая цена товара
                    "newPrice": 0, //цена товара после применения скидки
                    "formula": "(636.00 - 636.00) * 2" //формула расчёта скидки на товар
                }
            ]
        }
        {
            "discountType": "PAYMENT_TYPE", //   PROMOCODE | PAYMENT_TYPE
            "discountValue": 20
        }
    ]   
}

/api/lite/orders/copy

Копирование заказа

/api/lite/orders/copy

 

Копирует указанный заказ черновиком и возвращает номер созданного заказа

Обязательный параметр: id заказа. Например:

{
    "id": "1001"
}

Формат ответа аналогичен списку заказов

Пример ответа:

{
    "success": true,
    "orderId": "8057-1057",
    "c": "7ed78ba9-310f-e681-756c-71beb95853f6"
}

/api/lite/pub/promocode/conditions/check

Запросить проверку применения промокода по заказу (публичный)

 

/api/lite/pub/promocode/conditions/check

По отправленным данным заказа (с обязательным указанием промокода) - возвращает размер скидки в рублях для чекаута, а также возможные промотовары 

Формат передаваемых данных всегда аналогичен dto заказа в методе создания заказа (публичный):

/api/lite/pub/orders

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

{
  	"promocode":"testFix",
    "comment": "",
    "confirmStatus": "APPROVED",
    "delivery": {
        "address": {
            "area": null,
            "areaFias": null,
            "block": "",
            "building": "",
            "city": "Урюпинск",
            "cityFias": "2e5879fc-35c2-4354-816b-f1fce74ece87",
            "country": "RU",
            "flat": "",
            "fullAddress": "",
            "house": "",
            "region": "Волгоградская",
            "regionFias": "da051ec8-da2e-4a66-b542-473b8d221ab4",
            "settlement": null,
            "settlementFias": null,
            "street": "",
            "zip": ""
        },
        "code": "bb60d72c-2a25-11e9-8989-002590923634",
        "deliveryComment": "",
        "desiredDeliveryDate": null,
        "pickupPointId": "",
        "receiver": {
            "alternativePhone": "",
            "email": "",
            "name": "",
            "phone": ""
        },
        "timeFrom": "09:00",
        "timeTo": "20:00"
    },
    "items": [
        {
            "num": 1,
            "productId": "BR00T-000132",
            "quantity": 1,
            "variantId": "BR00T-000132"
        }
    ],
    "paymentMethodCode": "disk1",
    "paymentStatus": "NOT_PAID",
    "totalOrderSum": 690
}

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

{
    "success": true,
    "code": "testFix",
    "isActive": true,
    "discountType": "FIX",
    "discountValue": 990,
    "hasConditions": true,
    "deliveryDiscountValue": 0,
    "bonusSkus": {
        "1002": 1
    }
}

/api/lite/orders/receiver/address

Заказ → обновление адреса доставки получателю

/api/lite/orders/receiver/address

Возможность обновить только адрес доставки

id - номер заказа

Запрос

{
    "id": "8057-1102",
    "address": {
                    "country": "Россия",
                    "countryCode": "RU",
                    "region": "Москва",
                    "area": null,
                    "city": "Москва",
                    "settlement": null,
                    "street": "Лубянка",
                    "house": "3",
                    "block": "",
                    "building": "",
                    "flat": "",
                    "fullAddress": "Алтайский, Барнаул, Барнаульская, д 1",
                    "fullCity": null,
                    "rawData": "Алтайский, Барнаул, Барнаульская, д 1",
                    "zip": "",
                    "regionFias": "8276c6a1-1a86-4f0d-8920-aba34d4cc34a",
                    "areaFias": null,
                    "cityFias": "d13945a8-7017-46ab-b1e6-ede1e89317ad",
                    "settlementFias": null
                }
}

 

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

{
    "success": true  
}

В случае ошибки:

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

/api/lite/orders/file

/api/lite/orders/file

Добавляет файл к заказу.

Параметры передаются как form-data:

upfile Файл для загрузки
id Идентификатор заказа (humanId)
print_when_packing Печатать при упаковке
copies_qty Кол-во копий

Пример ответа:

{
    "success": true,
    "id": "b233372d-cf7b-f07b-446b-128912be7c8a",
    "fileType": "JPG",
    "fileName": "IMG_20200822_101244",
  	"fileSource": "USER", //ESHOP | FULFILLMENT
    "fileExt": "jpg",
    "url": "https://storage.yandexcloud.net/order-files-kak2c/d0f03942-8d75-4456-93af-42ec518ef0a9.jpg",
    "printWhenPacking": false,
    "copiesQty": 1
}

 

/api/lite/orders/file

Удаляет файл

В параметре id передается идентификатор файла.

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

DELETE https://app.kak2c.ru/api/lite/orders/file?id=b233372d-cf7b-f07b-446b-128912be7c8a

Пример ответа:

{
  "success": true
}

/api/lite/orders/file/edit

/api/lite/orders/file/edit

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

{
    "id": "b9e3efdd-455e-af10-996f-2cf6f03d9775",
    "copiesQty": 2,
    "printWhenPacking": true
}

Пример ответа:

{
    "success": true
}

/api/lite/orders/discounts

Применение промокода и скидки

/api/lite/orders/discounts

Позволяет применить или удалить промокод и скидку

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

{
    "id": "4249-1647",
    "promocode": "promocode",
    "manualDiscount": {
        "isActive": true,
        "discountType": "PERCENT",   // PERCENT,FIX
        "discountValue": 10
    }
}

 

Успех:

{
    "success": true
}

 

Ошибка:

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

/api/lite/orders/email/repeat

Заказ - повторить отправку email покупателю

/api/lite/orders/email/repeat

Отправляет email покупателю о создании заказа.

Параметры - humanId заказа и код "c"

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

{  
 "id": "8202-1051",
 "c":"224f9149-a6c3-e408-5193-42cc55fe5749"	
}   

В ответ возвращается

успех:

{
    "success": true  
}

ошибка: 

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

/api/lite/orders/sync_ff

Заказ - синхронизация с Фулфилмент складом

/api/lite/orders/sync_ff

Выгрузка текущего состояния заказа на склад Фулфилмент (если в заказе проставлен склад такого типа).

 

В случае успеха выполнения - нужно перезакачать данные о заказе.

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

{ 
    "id":"1234"  
}        

В ответ возвращается

успех:

{
    "success": true   
}

ошибка: 

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

/api/lite/orders/delivery

Заказ → обновление данных доставки

/api/lite/orders/delivery

Возможность обновить все данные по доставке заказа

id - номер заказа

Формат аналогичный секции delivery в GET /orders

 

Запрос

{
 
            "id": "8202-1051",
          
            "delivery": {
                "code": "624f1b23-049f-a1aa-ee21-b6b1523a88b1",               
                "pickupPointId": "2201-002",   
                "deliveryComment": "Поскорее",
                "desiredDeliveryDate": "2020-08-13",
                "desiredDeliveryTimeFrom": "09:00",
                "desiredDeliveryTimeTo": "20:00", 
                "isDeliverySumLimitActive": true,
                "deliverySumLimitAmount": 5000, 
                "deliverySumBelowLimitAmount": 1000,
                "address": {
                    "country": "Россия",
                    "countryCode": "RU",
                    "region": "Алтайский",
                    "area": null,
                    "city": "Томск",
                    "settlement": null,
                    "street": "Барнаульская",
                    "house": "1",
                    "block": "",
                    "building": "",
                    "flat": "",
                    "fullAddress": "Алтайский, Барнаул, Барнаульская, д 1",
                    "fullCity": null,
                    "rawData": "Алтайский, Барнаул, Барнаульская, д 1",
                    "zip": "",
                    "regionFias": "8276c6a1-1a86-4f0d-8920-aba34d4cc34a",
                    "areaFias": null,
                    "cityFias": "d13945a8-7017-46ab-b1e6-ede1e89317ad",
                    "settlementFias": null
                },
                "receiver": {
                    "name": "Сергей",
                    "surname": "Сергеев",
                    "patronymic": "",
                    "fullName": "Толстой Петр",
                    "phone": "89011111111",
                    "rawPhone": "89011111111",
                    "alternativePhone": "",
                    "email": "exhila.rate1111111@mail.ru",
                    "post": null,
                    "personType": "CUSTOMER"                  
                },
                "deliveryServices": null,
                "deliveryPayerType": "RECEIVER", // SENDER              
                "isDeliverySumLimitActive": true,
                "deliverySumLimitAmount": 324234,
                "deliverySumBelowLimitAmount": 23432432
            }      
    
}

 

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

{
    "success": true  
}

В случае ошибки:

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

/api/lite/orders/comments

Заказ → обновление комментариев

/api/lite/orders/comments

Возможность обновить комментарии по заказу

id - номер заказа

 

 

Запрос

{ 
     "id": "8202-1051",
     "comment": "Комментарий покупателя",
  	 "operatorComment": "Комментарий оператора"  
}

 

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

{
    "success": true  
}

В случае ошибки:

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

/api/lite/orders/diff_history

Запрос истории состояний заказа

/api/lite/orders/diff_history

На данный момент возвращает только начальное состояние заказа.

Номер заказа передается в параметре order_id.

Пример результата запроса

{
    "success": true,
    "history": [
        {
            "createTs": "2021-01-20 15:03:28.065",
            "component": "ESHOP",
            "diffData": "{\"id\":\"34575570\",\"date\":\"2021-01-20 15:03:08\",\"updateTs\":\"2021-01-20 15:03:25.990\",\"status\":\"ORDER_INFO_DRAFT\",\"totalOrderSum\":215.0,\"insuranceSum\":215.00,\"insuranceSumAutoCalculation\":true,\"paymentStatus\":\"NOT_PAID\",\"confirmStatus\":\"NEED_CONFIRM\",\"paymentMethodCode\":\"cod-card\",\"paymentMethodType\":\"COD_CARD\",\"needCustomerPayment\":false,\"customData\":\"{\\r\\n  \\\"beruDeliveryServiceName\\\" : \\\"DPD\\\",\\r\\n  \\\"beruDeliveryName\\\" : \\\"Самовывоз\\\"\\r\\n}\",\"orderType\":\"STANDARD\",\"delivery\":{\"code\":\"4166d5f0-5449-2827-d4e9-256526cb52f8\",\"type\":\"COURIER\",\"title\":\"BERU\",\"pickupPointId\":null,\"logoUrl\":\"https://storage.yandexcloud.net/lk-kak2c/delivery_beru_left.svg\",\"trackingNumber\":null,\"trackingURL\":null,\"desiredDeliveryDate\":null,\"desiredDeliveryTimeFrom\":\"09:00\",\"desiredDeliveryTimeTo\":\"18:00\",\"actualDeliveryDate\":null,\"pvzComment\":null,\"deliveryComment\":null,\"address\":{\"country\":null,\"countryCode\":null,\"region\":\"Москва\",\"area\":null,\"city\":\"Москва\",\"settlement\":null,\"street\":null,\"house\":null,\"block\":null,\"building\":null,\"flat\":null,\"fullAddress\":\"Москва\",\"fullCity\":null,\"rawData\":null,\"zip\":null,\"regionFias\":null,\"areaFias\":null,\"cityFias\":null,\"settlementFias\":null},\"receiver\":{\"name\":\"Покупатель на Беру\",\"surname\":null,\"patronymic\":null,\"phone\":\"+70000000000\",\"rawPhone\":\"+70000000000\",\"alternativePhone\":\"\",\"email\":null,\"post\":null,\"personType\":\"CUSTOMER\",\"address\":{\"country\":null,\"countryCode\":null,\"region\":\"Москва\",\"area\":null,\"city\":\"Москва\",\"settlement\":null,\"street\":null,\"house\":null,\"block\":null,\"building\":null,\"flat\":null,\"fullAddress\":\"Москва\",\"fullCity\":null,\"rawData\":null,\"zip\":null,\"regionFias\":null,\"areaFias\":null,\"cityFias\":null,\"settlementFias\":null}},\"deliveryServices\":null},\"legalEntity\":{\"id\":\"2446fe8b-4f98-dd1a-c7a4-757dafa9c8cb\",\"type\":\"PERSON\",\"role\":null,\"name\":\" Розничный покупатель\",\"organization\":null,\"person\":null},\"items\":[{\"num\":1,\"variantId\":\"1110\",\"variantExtId\":\"ЦБ-00035890\",\"productId\":\"1109\",\"productVariantCount\":1,\"name\":\"AVON Naturals \\\"Цветущая сакура\\\" Спрей для тела, 100мл\",\"article\":\"ЦБ-00035890\",\"quantity\":1,\"quantityAvailable\":1,\"vatRate\":\"NO_VAT\",\"vatSkuProduct\":\"NO_VAT\",\"price\":215.0,\"img\":\"https://storage.yandexcloud.net/images-k2c/6dcbbe98-da4a-4de3-9f99-91b9d1399f84.jpg\",\"itemAmountState\":{\"amountORDERED\":0,\"amountRESERVED\":0,\"amountPACKED\":0,\"amountSHIPPED\":0,\"amountDELIVERED\":0,\"amountLOST\":0,\"amountRETURNED\":0,\"amountRETURNED_DEFECTIVE\":0},\"skuType\":\"SKU\",\"itemDimensions\":{\"height\":15,\"width\":3,\"depth\":3},\"itemWeight\":107,\"barcode\":\"5050136478292\"},{\"num\":2,\"variantId\":\"delivery\",\"name\":\"Доставка\",\"quantity\":1,\"vatRate\":\"NO_VAT\",\"price\":0.0,\"skuType\":\"SERVICE\",\"barcode\":\"\"}],\"expenses\":[],\"files\":[],\"customerPaymentInProcess\":false,\"warehouseName\":\"Tempoline\",\"warehouseCode\":\"6864ba99-f13c-87c0-3f67-f4c7889718a5\",\"warehouseFFExported\":false,\"warehouseFFSync\":false,\"warehouseFFExportError\":false,\"permissionList\":{\"fieldPermissions\":[{\"type\":\"ITEMS_EDITABLE\",\"value\":true,\"reason\":null},{\"type\":\"PAYMENT_EDITABLE\",\"value\":true,\"reason\":null},{\"type\":\"IS_PAID_EDITABLE\",\"value\":true,\"reason\":null},{\"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\":true,\"reason\":null},{\"type\":\"NEED_CONFIRM\",\"value\":true,\"reason\":null},{\"type\":\"PACK\",\"value\":true,\"reason\":null},{\"type\":\"COPY\",\"value\":true,\"reason\":null},{\"type\":\"PACK_CONTROL\",\"value\":true,\"reason\":null},{\"type\":\"UNPACK\",\"value\":true,\"reason\":null},{\"type\":\"SHIPPING\",\"value\":true,\"reason\":null},{\"type\":\"UNSHIPPING\",\"value\":true,\"reason\":null},{\"type\":\"REFRESH_RESERVE\",\"value\":true,\"reason\":null},{\"type\":\"RETURN_TO_DELIVERY\",\"value\":true,\"reason\":null},{\"type\":\"REVERT_RETURNS\",\"value\":true,\"reason\":null},{\"type\":\"DELIVER_SELF_PICKUP\",\"value\":true,\"reason\":null},{\"type\":\"DELIVER_COURIER\",\"value\":true,\"reason\":null},{\"type\":\"ACCEPT_RETURN\",\"value\":true,\"reason\":null}]},\"currency\":\"RUB\",\"summaryItemAmountState\":{\"amountORDERED\":0,\"amountRESERVED\":0,\"amountPACKED\":0,\"amountSHIPPED\":0,\"amountDELIVERED\":0,\"amountLOST\":0,\"amountRETURNED\":0,\"amountRETURNED_DEFECTIVE\":0},\"c\":\"5eee7ab1-70c4-1d31-4b21-90df1c522c00\"}"
        }
    ]
}

/api/lite/orders/packing_export

Выгрузка файла для загрузки ШК Wildberries по схеме FBW

/api/lite/orders/packing_export

Возвращает файл с текущими ШК мест в заказе.

Формат файла соответствует необходимому для загрузки методом /api/lite/orders/add_wb_barcodes

Номер заказа передается в параметре id.

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

{
    "success": true,
    "fileName": "packings_1234-1234.xls",
    "content": "0M8R4K(...)AAAAAAAAAAAAAAAAAAAAAA==" //Файл в формате excel, закодированный в BASE64 строке
}

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

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

 

/api/lite/orders/add_wb_barcodes

Загрузка файла с ШК Wildberries по схеме FBW

/api/lite/orders/add_wb_barcodes

Заменяет текущие ШК на ШК от Wildberries.

Параметры передаются в формате form-data

order_id Идентификатор заказа
file Файл с ШК от Wildberries

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

{
    "success": true
}

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

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

 

Комментарии по анализу возвратов от фулфилмента

/api/lite/pub/save_dadata_address

Сохранить сырой адрес, возвращаемый из dadata

/api/lite/pub/save_dadata_address

(метод требует авторизации по домену)

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

{
  "address_id": "1d729d23-0778-3399-36a6-e10cb53e0ab9", //необязательный параметр. Если такой ид уже есть, адрес обновляется. Если нет - создаётся новый
  "address": "{\"value\":\"г Москва, Варшавское шоссе, д 18 к 1\",\"unrestricted_value\":\"117105, г Москва, Донской р-н, Варшавское шоссе, д 18 к 1\",\"data\":{\"postal_code\":\"117105\",\"country\":\"Россия\",\"country_iso_code\":\"RU\",\"federal_district\":\"Центральный\",\"region_fias_id\":\"0c5b2444-70a0-4932-980c-b4dc0d3f02b5\",\"region_kladr_id\":\"7700000000000\",\"region_iso_code\":\"RU-MOW\",\"region_with_type\":\"г Москва\",\"region_type\":\"г\",\"region_type_full\":\"город\",\"region\":\"Москва\",\"area_fias_id\":null,\"area_kladr_id\":null,\"area_with_type\":null,\"area_type\":null,\"area_type_full\":null,\"area\":null,\"city_fias_id\":\"0c5b2444-70a0-4932-980c-b4dc0d3f02b5\",\"city_kladr_id\":\"7700000000000\",\"city_with_type\":\"г Москва\",\"city_type\":\"г\",\"city_type_full\":\"город\",\"city\":\"Москва\",\"city_area\":\"Южный\",\"city_district_fias_id\":null,\"city_district_kladr_id\":null,\"city_district_with_type\":\"Донской р-н\",\"city_district_type\":\"р-н\",\"city_district_type_full\":\"район\",\"city_district\":\"Донской\",\"settlement_fias_id\":null,\"settlement_kladr_id\":null,\"settlement_with_type\":null,\"settlement_type\":null,\"settlement_type_full\":null,\"settlement\":null,\"street_fias_id\":\"8fc06b0b-5de3-4a72-9e6f-9e0647a37a66\",\"street_kladr_id\":\"77000000000047600\",\"street_with_type\":\"Варшавское шоссе\",\"street_type\":\"ш\",\"street_type_full\":\"шоссе\",\"street\":\"Варшавское\",\"house_fias_id\":\"a41c0f52-7874-4b08-9f91-1067b87ddc6b\",\"house_kladr_id\":\"7700000000004760341\",\"house_cadnum\":null,\"house_type\":\"д\",\"house_type_full\":\"дом\",\"house\":\"18\",\"block_type\":\"к\",\"block_type_full\":\"корпус\",\"block\":\"1\",\"entrance\":null,\"floor\":null,\"flat_fias_id\":null,\"flat_cadnum\":null,\"flat_type\":null,\"flat_type_full\":null,\"flat\":null,\"flat_area\":null,\"square_meter_price\":\"194999\",\"flat_price\":null,\"postal_box\":null,\"fias_id\":\"a41c0f52-7874-4b08-9f91-1067b87ddc6b\",\"fias_code\":\"77000000000000004760341\",\"fias_level\":\"8\",\"fias_actuality_state\":\"0\",\"kladr_id\":\"7700000000004760341\",\"geoname_id\":\"524894\",\"capital_marker\":\"0\",\"okato\":\"45296561000\",\"oktmo\":\"45915000\",\"tax_office\":\"7726\",\"tax_office_legal\":\"7726\",\"timezone\":\"UTC+3\",\"geo_lat\":\"55.691963\",\"geo_lon\":\"37.620833\",\"beltway_hit\":\"IN_MKAD\",\"beltway_distance\":null,\"metro\":[{\"name\":\"Верхние Котлы\",\"line\":\"МЦК\",\"distance\":0.2},{\"name\":\"Крымская\",\"line\":\"МЦК\",\"distance\":1.0},{\"name\":\"Нагатинская\",\"line\":\"Серпуховско-Тимирязевская\",\"distance\":1.1}],\"qc_geo\":\"0\",\"qc_complete\":null,\"qc_house\":null,\"history_values\":null,\"unparsed_parts\":null,\"source\":null,\"qc\":null}}"
}

Успех:

{
    "address_id": "1d729d23-0778-3399-36a6-e10cb53e0ab9",
    "success": true
}

Ошибка:

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

/api/lite/bitrix/address

Получить сырой адрес, сохранённый из dadata

/api/lite/bitrix/address

параметр id - идентификатор ранее сохранённого адреса в методе /api/lite/pub/save_dadata_address

пример: /lite/bitrix/address?id=f20da5a8-12eb-315d-684c-85c65aa5a713

Успех:

{
    "address": "{\"value\":\"г Москва, Варшавское шоссе, д 18 к 1\",\"unrestricted_value\":\"117105, г Москва, Донской р-н, Варшавское шоссе, д 18 к 1\",\"data\":{\"postal_code\":\"117105\",\"country\":\"Россия\",\"country_iso_code\":\"RU\",\"federal_district\":\"Центральный\",\"region_fias_id\":\"0c5b2444-70a0-4932-980c-b4dc0d3f02b5\",\"region_kladr_id\":\"7700000000000\",\"region_iso_code\":\"RU-MOW\",\"region_with_type\":\"г Москва\",\"region_type\":\"г\",\"region_type_full\":\"город\",\"region\":\"Москва\",\"area_fias_id\":null,\"area_kladr_id\":null,\"area_with_type\":null,\"area_type\":null,\"area_type_full\":null,\"area\":null,\"city_fias_id\":\"0c5b2444-70a0-4932-980c-b4dc0d3f02b5\",\"city_kladr_id\":\"7700000000000\",\"city_with_type\":\"г Москва\",\"city_type\":\"г\",\"city_type_full\":\"город\",\"city\":\"Москва\",\"city_area\":\"Южный\",\"city_district_fias_id\":null,\"city_district_kladr_id\":null,\"city_district_with_type\":\"Донской р-н\",\"city_district_type\":\"р-н\",\"city_district_type_full\":\"район\",\"city_district\":\"Донской\",\"settlement_fias_id\":null,\"settlement_kladr_id\":null,\"settlement_with_type\":null,\"settlement_type\":null,\"settlement_type_full\":null,\"settlement\":null,\"street_fias_id\":\"8fc06b0b-5de3-4a72-9e6f-9e0647a37a66\",\"street_kladr_id\":\"77000000000047600\",\"street_with_type\":\"Варшавское шоссе\",\"street_type\":\"ш\",\"street_type_full\":\"шоссе\",\"street\":\"Варшавское\",\"house_fias_id\":\"a41c0f52-7874-4b08-9f91-1067b87ddc6b\",\"house_kladr_id\":\"7700000000004760341\",\"house_cadnum\":null,\"house_type\":\"д\",\"house_type_full\":\"дом\",\"house\":\"18\",\"block_type\":\"к\",\"block_type_full\":\"корпус\",\"block\":\"1\",\"entrance\":null,\"floor\":null,\"flat_fias_id\":null,\"flat_cadnum\":null,\"flat_type\":null,\"flat_type_full\":null,\"flat\":null,\"flat_area\":null,\"square_meter_price\":\"194999\",\"flat_price\":null,\"postal_box\":null,\"fias_id\":\"a41c0f52-7874-4b08-9f91-1067b87ddc6b\",\"fias_code\":\"77000000000000004760341\",\"fias_level\":\"8\",\"fias_actuality_state\":\"0\",\"kladr_id\":\"7700000000004760341\",\"geoname_id\":\"524894\",\"capital_marker\":\"0\",\"okato\":\"45296561000\",\"oktmo\":\"45915000\",\"tax_office\":\"7726\",\"tax_office_legal\":\"7726\",\"timezone\":\"UTC+3\",\"geo_lat\":\"55.691963\",\"geo_lon\":\"37.620833\",\"beltway_hit\":\"IN_MKAD\",\"beltway_distance\":null,\"metro\":[{\"name\":\"Верхние Котлы\",\"line\":\"МЦК\",\"distance\":0.2},{\"name\":\"Крымская\",\"line\":\"МЦК\",\"distance\":1.0},{\"name\":\"Нагатинская\",\"line\":\"Серпуховско-Тимирязевская\",\"distance\":1.1}],\"qc_geo\":\"0\",\"qc_complete\":null,\"qc_house\":null,\"history_values\":null,\"unparsed_parts\":null,\"source\":null,\"qc\":null}}",
    "address_id": "f20da5a8-12eb-315d-684c-85c65aa5a713",
    "success": true
}

Ошибка:

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

/api/lite/orders/shipped/report

Получение сводки по отправленным заказам с информацией о уникальных номерах(например чз)

/api/lite/orders/shipped/report

Возвращает сводные данные по заказам с данными по уникальным номерам

Для выполнения запроса необходимо обязательно задать параметры: date_from и date_to(период должен быть не больше недели), delivery_code ид курьерок через запятую. Можно так же задать не обязательные параметры size(не больше 500) - порция получаемых данных, и page - страница. По умолчанию size= 20 и page=0. Пример полного запроса

/api/lite/orders/shipped/report?delivery_code=7d7365f2-5189-ab7b-ddf3-9d6b41cca901,7d7365f2-5189-ab7b-ddf3-9d6b41cca902&date_from=2023-01-07T00:00:00&date_to=2023-01-14T23:59:59&page=0&size=400

Пример ответа:

{
    "orders": [
        {
            "currency": "RUB",
            "date": "2023-01-14 12:30:17.180",
            "shippingDate": "2023-01-17 12:30:17.180",
            "delivery": {
                "code": "8826c198-0815-d4ad-b3ab-0681ca7defbb",
                "deliveryCode": "OZON",
                "title": "OZON"
            },
            "externalId": "64029298-0041-2",
            "id": "64029298-0041-2",
            "shippedItems": [
                {
                    "accountingAttributes": [
                        {
                            "code": "uniquenumber",
                            "n": 1,
                            "stringValue": "4601532004939"
                        }
                    ],
                    "article": "4000023504",
                    "name": "Контейнер для порошка, 5 л (Полимербыт):6/18",
                    "price": 199.00,
                    "quantity": 1,
                    "variantId": "b3d82d45-b383-414e-94dc-34f8c2cd3296"
                }
            ],
            "status": "ORDER_INFO_SHIPPED",
            "totalOrderSum": 199.00
        },
        {
            "currency": "RUB",
            "date": "2023-01-14 12:09:43.014",
            "delivery": {
                "code": "8826c198-0815-d4ad-b3ab-0681ca7defbb",
                "deliveryCode": "OZON",
                "title": "OZON"
            },
            "externalId": "43319845-0119-1",
            "id": "43319845-0119-1",
            "shippedItems": [
                {
                    "accountingAttributes": [
                        {
                            "code": "uniquenumber",
                            "n": 1,
                            "stringValue": "4640043100471"
                        }
                    ],
                    "article": "1000324110",
                    "name": "SOFFIONE Premio Туалетная бумага Лаванда 3сл 4рул(Арх):10",
                    "price": 118.00,
                    "quantity": 1,
                    "variantId": "cc50d935-8a6c-4f67-ad94-202ea1bd35e4"
                }
            ],
            "status": "ORDER_INFO_SHIPPED",
            "totalOrderSum": 118.00
        },
        {
            "currency": "RUB",
            "date": "2023-01-14 09:52:22.214",
            "delivery": {
                "code": "8826c198-0815-d4ad-b3ab-0681ca7defbb",
                "deliveryCode": "OZON",
                "title": "OZON"
            },
            "externalId": "39501623-0020-1",
            "id": "39501623-0020-1",
            "shippedItems": [
                {
                    "accountingAttributes": [
                        {
                            "code": "uniquenumber",
                            "n": 1,
                            "stringValue": "9000101031669"
                        }
                    ],
                    "article": "1000203568",
                    "name": "Е Кондиционер д/белья Свежий 2л(Хенкель):8",
                    "price": 209.00,
                    "quantity": 1,
                    "variantId": "1407d0d7-b532-4992-8383-f7500bae5b67"
                }
            ],
            "status": "ORDER_INFO_SHIPPED",
            "totalOrderSum": 209.00
        }
    ],
    "recordsTotal": 27673,
    "success": true
}

/api/lite/orders/history/status

Получение истории смены статусов по заказу

/api/lite/orders/history/status

Возвращает историю смены статуса по указанному заказу

Обязательный параметр: id заказа

 

Пример ответа:

{
    "items": [
        {
            "date": "2023-07-21 18:03:26.797",
            "infoStatus": "ORDER_INFO_SHIPPED"
        },
        {
            "date": "2023-07-21 18:03:08.270",
            "infoStatus": "ORDER_INFO_PACKED"
        },
        {
            "date": "2023-07-21 18:02:55.037",
            "infoStatus": "ORDER_INFO_IN_PACKING"
        },
        {
            "date": "2023-07-21 18:02:26.174",
            "infoStatus": "ORDER_INFO_READY_TO_PACK"
        },
        {
            "date": "2023-07-21 18:02:09.110",
            "infoStatus": "ORDER_INFO_REQUIRE_PAYMENT"
        },
        {
            "date": "2023-07-21 18:01:25.464",
            "infoStatus": "ORDER_INFO_NEED_CONFIRM"
        }
    ],
    "success": true
}

 

/api/lite/orders/shipped/report/packings

Получение списка заказов отгруженных по указанной службе доставки за интервал

/api/lite/orders/shipped/report/packings

Возвращает список заказов, отгруженных в указанный интервал по указанной службе доставки.

Если служба доставки не указана - возвращает по всем службам доставки.

Для выполнения запроса необходимо задать параметры:

date_from и date_to(необязательно, период должен быть не больше недели),

delivery_company - интересующая служба доставки по перечислению DeliveryCompany.


Можно так же задать не обязательные параметры size(не больше 500) - порция получаемых данных, и page - страница. По умолчанию size= 20 и page=0.

Ответ - в формате стандартного списка заказов /api/lite/orders

 

Пример полного запроса

GET /api/lite/orders/shipped/report/packings?date_from=2020-08-01T01:00:00&date_to=2020-08-07T00:00:00&delivery_company=CDEK

Пример ответа:

{
    "orders": [
        {
            "c": "d4a5e0a9-7ac7-5970-9682-633beb98c8ea",
            "confirmStatus": "APPROVED",
            "createTs": "2020-08-06 10:56:46.496",
            "crossdockEditable": false,
            "currency": "RUB",
            "customData": "{\n  \"ozonPostingNumber\" : \"07003190-0086-3\"\n}",
            "customerPaymentInProcess": false,
            "date": "2023-02-06 10:56:46",
            "delivery": {
                "address": {
                    "block": "3",
                    "building": "4",
                    "city": "Москва",
                    "country": "Россия",
                    "countryCode": "RU",
                    "fullAddress": "Москва",
                    "house": "2",
                    "region": "Москва",
                    "street": "1"
                },
                "code": "145088e0-b11e-d2c3-a066-02526f15ac4f",
                "deliveryCode": "OZON",
                "desiredDeliveryTimeFrom": "09:00",
                "desiredDeliveryTimeTo": "18:00",
                "logoUrl": "https://storage.yandexcloud.net/lk-kak2c/delivery_ozon_left.svg",
                "receiver": {
                    "address": {
                        "block": "3",
                        "building": "4",
                        "city": "Москва",
                        "country": "Россия",
                        "countryCode": "RU",
                        "fullAddress": "Москва",
                        "house": "2",
                        "region": "Москва",
                        "street": "1"
                    },
                    "alternativePhone": "",
                    "name": "Покупатель на Озоне",
                    "passport": {},
                    "personType": "CUSTOMER",
                    "phone": "+70000000000",
                    "rawPhone": "+70000000000"
                },
                "title": "OZON",
                "trackingNumber": "07003190-0086-3",
                "trackingURL": "https://www.ozon.ru/",
                "type": "COURIER"
            },
            "expenses": [],
            "externalId": "162092860",
            "files": [],
            "id": "07003190-0086-3",
            "insuranceSum": 624.00,
            "insuranceSumAutoCalculation": true,
            "isMarketplaceOrder": true,
            "items": [
                {
                    "article": "FAQ-D-000110",
                    "barcode": "4601811006951",
                    "customData": "{\"marketplaceSkuId\":179692054}",
                    "img": "https://img.kak2c.ru/i/T/8/kgMdAI9R_c.jpg",
                    "itemAmountState": {
                        "amountDELIVERED": 1,
                        "amountLOST": 0,
                        "amountORDERED": 1,
                        "amountPACKED": 1,
                        "amountRESERVED": 1,
                        "amountRETURNED": 0,
                        "amountRETURNED_AS_CLAIMS": 0,
                        "amountRETURNED_DEFECTIVE": 0,
                        "amountRETURNED_TO_CLIENT": 0,
                        "amountSHIPPED": 1
                    },
                    "itemDimensions": {
                        "depth": 10,
                        "height": 20,
                        "width": 10
                    },
                    "itemWeight": 350,
                    "name": "Шампунь-гель для душа 2 в 1 Bro Cosmetics, WASSUP, MAN // очищает и тонизирует, Цвет: серый ",
                    "num": 1,
                    "price": 624.00,
                    "productExtId": "FAQ-D-000110",
                    "productId": "FAQ-D-000110",
                    "productVariantCount": 3,
                    "quantity": 1,
                    "quantityAvailable": 47,
                    "skuType": "SKU",
                    "variantExtId": "FAQ-D-000110",
                    "variantId": "FAQ-D-000110",
                    "vatRate": "NO_VAT",
                    "vatSkuProduct": "NO_VAT"
                },
                {
                    "article": "",
                    "barcode": "",
                    "name": "Доставка",
                    "num": 2,
                    "price": 0.00,
                    "quantity": 1,
                    "skuType": "SERVICE",
                    "variantId": "delivery",
                    "vatRate": "NO_VAT"
                }
            ],
            "legalEntity": {
                "id": "3c0a3ad3-b10f-4299-5b1b-a3d90b0c198a",
                "name": " Розничный покупатель",
                "type": "PERSON"
            },
            "manualDiscount": {
                "appliedDiscountValue": 0,
                "discountType": "FIX",
                "discountValue": 0,
                "isActive": false
            },
            "needCustomerPayment": false,
            "needReserve": true,
            "onlinePaymentSum": 624.00,
            "operatorComment": "-",
            "orderType": "STANDARD",
            "packingOptions": [],
            "packingVideos": [
                "http://cvs-2.kak2c.ru:21080/videoserver/video/2021-05-26/1f742f52-be58-11eb-5081-002590357b68.mp4"
            ],
            "packings": [
                {
                    "barcode": "6660000034777",
                    "files": [],
                    "items": [
                        {
                            "accountingAttributes": [],
                            "article": "FAQ-D-000110",
                            "barcode": "4601811006951",
                            "customData": "",
                            "img": "https://img.kak2c.ru/i/T/8/kgMdAI9R_c.jpg",
                            "itemDimensions": {
                                "depth": 10,
                                "height": 20,
                                "width": 10
                            },
                            "itemWeight": 350,
                            "name": "Шампунь-гель для душа 2 в 1 Bro Cosmetics, WASSUP, MAN // очищает и тонизирует, Цвет: серый ",
                            "num": 1,
                            "price": 624.00,
                            "productExtId": "FAQ-D-000110",
                            "productId": "FAQ-D-000110",
                            "productVariantCount": 3,
                            "quantity": 1,
                            "skuType": "SKU",
                            "variantExtId": "FAQ-D-000110",
                            "variantId": "FAQ-D-000110",
                            "vatRate": "NO_VAT",
                            "vatSkuProduct": "NO_VAT"
                        }
                    ],
                    "measurements": {
                        "dimensions": {
                            "depth": 100,
                            "height": 100,
                            "width": 180
                        },
                        "success": true,
                        "weight": 452
                    }
                }
            ],
            "paymentMethodCode": "online",
            "paymentMethodName": "Предоплата картой на сайте",
            "paymentMethodType": "ONLINE",
            "paymentStatus": "PAID",
            "permissionList": {
                "actionPermissions": [
                    {
                        "type": "CANCEL",
                        "value": false
                    },
                    {
                        "type": "CONFIRM",
                        "value": false
                    },
                    {
                        "type": "NEED_CONFIRM",
                        "value": false
                    },
                    {
                        "type": "PACK",
                        "value": false
                    },
                    {
                        "type": "COPY",
                        "value": true
                    },
                    {
                        "type": "PACK_CONTROL",
                        "value": false
                    },
                    {
                        "type": "UNPACK",
                        "value": false
                    },
                    {
                        "type": "SHIPPING",
                        "value": false
                    },
                    {
                        "type": "UNSHIPPING",
                        "value": false
                    },
                    {
                        "type": "REFRESH_RESERVE",
                        "value": false
                    },
                    {
                        "type": "RETURN_TO_DELIVERY",
                        "value": false
                    },
                    {
                        "type": "REVERT_RETURNS",
                        "value": false
                    },
                    {
                        "type": "DELIVER_SELF_PICKUP",
                        "value": false
                    },
                    {
                        "type": "DELIVER_COURIER",
                        "value": false
                    },
                    {
                        "type": "ACCEPT_RETURN",
                        "value": false
                    }
                ],
                "fieldPermissions": [
                    {
                        "reason": "Склад уже упаковал заказ. Изменение заказа невозможно.",
                        "type": "ITEMS_EDITABLE",
                        "value": false
                    },
                    {
                        "reason": "Склад уже упаковал заказ. Изменение заказа невозможно.",
                        "type": "PAYMENT_EDITABLE",
                        "value": false
                    },
                    {
                        "reason": "Склад уже упаковал заказ. Изменение заказа невозможно.",
                        "type": "IS_PAID_EDITABLE",
                        "value": false
                    },
                    {
                        "reason": "Склад уже упаковал заказ. Изменение заказа невозможно.",
                        "type": "RECEIVER_EDITABLE",
                        "value": false
                    },
                    {
                        "reason": "Склад уже упаковал заказ. Изменение заказа невозможно.",
                        "type": "DELIVERY_EDITABLE",
                        "value": false
                    },
                    {
                        "reason": "Склад уже упаковал заказ. Изменение заказа невозможно.",
                        "type": "WAREHOUSE_EDITABLE",
                        "value": false
                    },
                    {
                        "reason": "Склад уже упаковал заказ. Изменение заказа невозможно.",
                        "type": "COMMENTS_EDITABLE",
                        "value": false
                    },
                    {
                        "type": "OPERATOR_COMMENTS_EDITABLE",
                        "value": true
                    }
                ],
                "infoStatus": "ORDER_INFO_DELIVERED"
            },
            "plannedTakeOutDate": "2020-08-07 13:00:00",
            "readyForFFExport": true,
            "shortUrl": "http://r.kak2c.ru/0700jhr",
            "status": "ORDER_INFO_DELIVERED",
            "summaryItemAmountState": {
                "amountDELIVERED": 1,
                "amountLOST": 0,
                "amountORDERED": 1,
                "amountPACKED": 1,
                "amountRESERVED": 1,
                "amountRETURNED": 0,
                "amountRETURNED_AS_CLAIMS": 0,
                "amountRETURNED_DEFECTIVE": 0,
                "amountRETURNED_TO_CLIENT": 0,
                "amountSHIPPED": 1
            },
            "totalOrderSum": 624.00,
            "updateTs": "2023-04-03 15:38:17.233",
            "warehouseCode": "6805bc64-270f-ae7d-1231-773ff181e446",
            "warehouseFFExportError": false,
            "warehouseFFExported": true,
            "warehouseFFSync": true,
            "warehouseFFSyncDate": "2020-08-06 11:00:35",
            "warehouseName": "Tempoline",
            "warehouseShippingOptions": {
                "packingType": "MIX_PACKINGS"
            }
        }
      }
     ],
    "recordsTotal": 1,
    "success": true
}

/api/lite/orders/shipped/report/cod

Получение списка заказов по которым были переведены наложенные платежи 

/api/lite/orders/shipped/report/cod

Возвращает список заказов, по которым с указанной в запросе даты были переводы наложенных платежей по бухгалтерии.

Для выполнения запроса необходимо задать параметры:

date_from  - дата для поиска даты перевода платежей (поле executionTime в codPayments заказов)

 


Можно так же задать не обязательные параметры size(не больше 500) - порция получаемых данных, и page - страница. По умолчанию size= 20 и page=0.

Ответ - в формате стандартного списка заказов /api/lite/orders

 

Пример полного запроса

GET https://app.kak2c.ru/api/lite/orders/shipped/report/cod?date_from=2020-01-01T00:00:00

Пример ответа:

{
    "orders": [
        {
            "c": "a0737972-c6bb-0759-35df-afd6bc2e6400",
            "codPayments": [
                {
                    "date": "2022-05-30 14:03:44",
                    "executionTime": "2022-05-30 14:30:00",
                    "paymentDocumentId": "BR0237-1",
                    "sum": 8857.00
                }
            ],
            "comment": "",
            "confirmStatus": "APPROVED",
            "createTs": "2022-05-30 14:04:18.900",
            "crossdockEditable": false,
            "currency": "RUB",
            "customerPaymentInProcess": false,
            "date": "2022-05-30 14:03:44",
            "delivery": {
                "address": {
                    "city": "Москва",
                    "cityFias": "0c5b2444-70a0-4932-980c-b4dc0d3f02b5",
                    "country": "Россия",
                    "countryCode": "RU",
                    "fullAddress": "Москва",
                    "rawData": "Москва",
                    "region": "Москва",
                    "regionFias": "0c5b2444-70a0-4932-980c-b4dc0d3f02b5",
                    "zip": "143582"
                },
                "code": "77e87a14-4e96-2ccb-3beb-4b1b33e466c8",
                "deliveryCode": "0ed6b628-288d-11e9-8989-002590923634",
                "deliveryComment": "",
                "desiredDeliveryDate": "2022-05-31",
                "desiredDeliveryTimeFrom": "09:00",
                "desiredDeliveryTimeTo": "18:00",
                "isDeliverySumLimitActive": false,
                "logoUrl": "https://storage.yandexcloud.net/lk-kak2c/delivery_pickpoint_left.svg",
                "pickupPointId": "5001-152",
                "pvzComment": "ПВЗ PickPoint, Код пункта выдачи: 5001-152, Адрес пункта выдачи: Невская ул., д. 704, График работы: Пн-Вс 10:00-22:00, Описание пункта выдачи: Постамат расположен в ТЦ Княжий двор. Перед ТЦ развязка общественного транспорта, остановка Памятник. От ж/д станции Нахабино - Транспорт: Автобус №20, 21. От метро Щукинская - Транспорт: Маршрутное такси №480\nВойти в ТЦ через центральный вход, подняться по лестнице на 2 этаж, повернуть направо, пройти прямо. С левой стороны вдоль стены расположен постамат.",
                "pvzInfo": {
                    "address": {
                        "city": "Москва",
                        "cityFias": "0c5b2444-70a0-4932-980c-b4dc0d3f02b5",
                        "country": "Россия",
                        "countryCode": "RU",
                        "fullAddress": "Невская ул., д. 704",
                        "region": "Москва",
                        "regionFias": "0c5b2444-70a0-4932-980c-b4dc0d3f02b5",
                        "zip": "143582"
                    },
                    "code": "5001-152",
                    "courier": "PickPoint",
                    "courierCode": "PICKPOINT",
                    "courierPostamatType": "АПТ",
                    "deliveryServices": [
                        "DAY_OFF_DELIVERY",
                        "CONTACTLESS_DELIVERY",
                        "TEMPERATURE_REGIME",
                        "TRYING",
                        "CHECK_CONTENT",
                        "DANGEROUS_CARGO",
                        "PARTIAL_DELIVERY",
                        "PERSONALLY_IN_HANDS",
                        "REVERSE"
                    ],
                    "description": "Постамат расположен в ТЦ Княжий двор. Перед ТЦ развязка общественного транспорта, остановка Памятник. От ж/д станции Нахабино - Транспорт: Автобус №20, 21. От метро Щукинская - Транспорт: Маршрутное такси №480\nВойти в ТЦ через центральный вход, подняться по лестнице на 2 этаж, повернуть направо, пройти прямо. С левой стороны вдоль стены расположен постамат.",
                    "latitude": "55.812358",
                    "longitude": "37.04213",
                    "maxSize": "64x40.5x35.8",
                    "maxWeight": 15,
                    "metroStation": "метро Щукинская",
                    "paymentMethods": [
                        "COD_CASH",
                        "COD_CARD"
                    ],
                    "type": "Postamat",
                    "workTime": "Пн-Вс 10:00-22:00"
                },
                "receiver": {
                    "address": {
                        "city": "Москва",
                        "cityFias": "0c5b2444-70a0-4932-980c-b4dc0d3f02b5",
                        "country": "Россия",
                        "countryCode": "RU",
                        "fullAddress": "Москва",
                        "rawData": "Москва",
                        "region": "Москва",
                        "regionFias": "0c5b2444-70a0-4932-980c-b4dc0d3f02b5",
                        "zip": "143582"
                    },
                    "alternativePhone": "",
                    "email": "mer@mer.mer",
                    "fullName": "Цу Йцу",
                    "name": "цу йцу",
                    "passport": {},
                    "personType": "CUSTOMER",
                    "phone": "74563464645",
                    "rawPhone": "74563464645"
                },
                "title": "PickPoint",
                "trackingNumber": "test333",
                "type": "PVZ"
            },
            "expenses": [],
            "externalId": "BR0237",
            "files": [],
            "id": "BR0237",
            "insuranceSum": 8857.00,
            "insuranceSumAutoCalculation": false,
            "isMarketplaceOrder": false,
            "items": [
                {
                    "barcode": "4211125637101",
                    "itemAmountState": {
                        "amountDELIVERED": 1,
                        "amountLOST": 0,
                        "amountORDERED": 1,
                        "amountPACKED": 1,
                        "amountRESERVED": 1,
                        "amountRETURNED": 0,
                        "amountRETURNED_AS_CLAIMS": 0,
                        "amountRETURNED_DEFECTIVE": 0,
                        "amountRETURNED_TO_CLIENT": 0,
                        "amountSHIPPED": 1
                    },
                    "itemDimensions": {
                        "depth": 26,
                        "height": 50,
                        "width": 42
                    },
                    "itemWeight": 5580,
                    "name": "Гидромассажная ванночка для ног Beurer FB50 белый",
                    "num": 1,
                    "price": 8000.00,
                    "productId": "1059034",
                    "productVariantCount": 1,
                    "quantity": 1,
                    "quantityAvailable": 0,
                    "skuType": "SKU",
                    "variantId": "1059034",
                    "vatRate": "VAT_20"
                },
                {
                    "barcode": "",
                    "name": "Доставка",
                    "num": 2,
                    "price": 857.00,
                    "quantity": 1,
                    "skuType": "SERVICE",
                    "variantId": "delivery",
                    "vatRate": "NO_VAT"
                }
            ],
            "legalEntity": {
                "id": "fa0d6c85-6e62-51fa-346e-e5433c92b2d8",
                "name": " Розничный покупатель",
                "type": "PERSON"
            },
            "manualDiscount": {
                "appliedDiscountValue": 0,
                "discountType": "FIX",
                "discountValue": 0,
                "isActive": false
            },
            "needCustomerPayment": false,
            "needReserve": true,
            "onlinePaymentSum": 8857.00,
            "operatorComment": "-",
            "orderType": "STANDARD",
            "packingOptions": [],
            "packings": [
                {
                    "barcode": "202749272704",
                    "files": [],
                    "items": [
                        {
                            "accountingAttributes": [],
                            "barcode": "4211125637101",
                            "itemDimensions": {
                                "depth": 26,
                                "height": 50,
                                "width": 42
                            },
                            "itemWeight": 5580,
                            "name": "Гидромассажная ванночка для ног Beurer FB50 белый",
                            "num": 1,
                            "price": 8000.00,
                            "productId": "1059034",
                            "productVariantCount": 1,
                            "quantity": 1,
                            "skuType": "SKU",
                            "variantId": "1059034",
                            "vatRate": "VAT_20"
                        }
                    ],
                    "measurements": {
                        "dimensions": {
                            "depth": 12,
                            "height": 12,
                            "width": 12
                        },
                        "success": true,
                        "weight": 5580
                    }
                }
            ],
            "paymentMethodCode": "cod-card",
            "paymentMethodName": "Оплата картой при получении",
            "paymentMethodType": "COD_CARD",
            "paymentStatus": "NOT_PAID",
            "permissionList": {
                "actionPermissions": [
                    {
                        "type": "CANCEL",
                        "value": false
                    },
                    {
                        "type": "CONFIRM",
                        "value": false
                    },
                    {
                        "type": "NEED_CONFIRM",
                        "value": false
                    },
                    {
                        "type": "PACK",
                        "value": false
                    },
                    {
                        "type": "COPY",
                        "value": true
                    },
                    {
                        "type": "PACK_CONTROL",
                        "value": false
                    },
                    {
                        "type": "UNPACK",
                        "value": false
                    },
                    {
                        "type": "SHIPPING",
                        "value": false
                    },
                    {
                        "type": "UNSHIPPING",
                        "value": false
                    },
                    {
                        "type": "REFRESH_RESERVE",
                        "value": false
                    },
                    {
                        "type": "RETURN_TO_DELIVERY",
                        "value": true
                    },
                    {
                        "type": "REVERT_RETURNS",
                        "value": false
                    },
                    {
                        "type": "DELIVER_SELF_PICKUP",
                        "value": false
                    },
                    {
                        "type": "DELIVER_COURIER",
                        "value": false
                    },
                    {
                        "type": "ACCEPT_RETURN",
                        "value": false
                    }
                ],
                "fieldPermissions": [
                    {
                        "reason": "Склад уже отгрузил заказ. Изменение заказа невозможно.",
                        "type": "ITEMS_EDITABLE",
                        "value": false
                    },
                    {
                        "reason": "Склад уже отгрузил заказ. Изменение заказа невозможно.",
                        "type": "PAYMENT_EDITABLE",
                        "value": false
                    },
                    {
                        "reason": "Склад уже отгрузил заказ. Изменение заказа невозможно.",
                        "type": "IS_PAID_EDITABLE",
                        "value": false
                    },
                    {
                        "reason": "Склад уже отгрузил заказ. Изменение заказа невозможно.",
                        "type": "RECEIVER_EDITABLE",
                        "value": false
                    },
                    {
                        "reason": "Склад уже отгрузил заказ. Изменение заказа невозможно.",
                        "type": "DELIVERY_EDITABLE",
                        "value": false
                    },
                    {
                        "reason": "Склад уже отгрузил заказ. Изменение заказа невозможно.",
                        "type": "WAREHOUSE_EDITABLE",
                        "value": false
                    },
                    {
                        "reason": "Склад уже отгрузил заказ. Изменение заказа невозможно.",
                        "type": "COMMENTS_EDITABLE",
                        "value": false
                    },
                    {
                        "type": "OPERATOR_COMMENTS_EDITABLE",
                        "value": true
                    }
                ],
                "infoStatus": "ORDER_INFO_DELIVERED"
            },
            "plannedTakeOutDate": "2022-05-31 09:00:00",
            "readyForFFExport": true,
            "shortUrl": "http://r.kak2c.ru/yr99em9",
            "status": "ORDER_INFO_DELIVERED",
            "summaryItemAmountState": {
                "amountDELIVERED": 1,
                "amountLOST": 0,
                "amountORDERED": 1,
                "amountPACKED": 1,
                "amountRESERVED": 1,
                "amountRETURNED": 0,
                "amountRETURNED_AS_CLAIMS": 0,
                "amountRETURNED_DEFECTIVE": 0,
                "amountRETURNED_TO_CLIENT": 0,
                "amountSHIPPED": 1
            },
            "totalOrderSum": 8857.00,
            "updateTs": "2022-05-30 14:29:35.964",
            "warehouseCode": "2b0cde46-043f-cdc9-e2e4-aed4ff5a7d4f",
            "warehouseFFExportError": false,
            "warehouseFFExported": false,
            "warehouseFFSync": false,
            "warehouseName": "BR_K",
            "warehouseShippingOptions": {}
        },
        {
            "c": "451dd9fc-9347-e7e4-c51d-e7842d870e40",
            "codPayments": [
                {
                    "date": "2022-05-31 12:22:16",
                    "executionTime": "2022-05-31 13:15:00",
                    "paymentDocumentId": "BR0255-1",
                    "sum": 5486.00
                }
            ],
            "comment": "",
            "confirmStatus": "APPROVED",
            "createTs": "2022-05-31 12:22:16.171",
            "crossdockEditable": false,
            "currency": "RUB",
            "customerPaymentInProcess": false,
            "date": "2022-05-31 12:21:38",
            "delivery": {
                "address": {
                    "city": "Краснодар",
                    "cityFias": "7dfa745e-aa19-4688-b121-b655c11e482f",
                    "country": "Россия",
                    "countryCode": "RU",
                    "fullAddress": "Краснодарский, Краснодар",
                    "rawData": "Краснодарский, Краснодар",
                    "region": "Краснодарский",
                    "regionFias": "d00e1013-16bd-4c09-b3d5-3cb09fc54bd8",
                    "zip": "350016"
                },
                "code": "77e87a14-4e96-2ccb-3beb-4b1b33e466c8",
                "deliveryCode": "0ed6b628-288d-11e9-8989-002590923634",
                "deliveryComment": "",
                "desiredDeliveryDate": "2022-06-02",
                "desiredDeliveryTimeFrom": "09:00",
                "desiredDeliveryTimeTo": "18:00",
                "isDeliverySumLimitActive": false,
                "logoUrl": "https://storage.yandexcloud.net/lk-kak2c/delivery_pickpoint_left.svg",
                "pickupPointId": "2302-060",
                "pvzComment": "ПВЗ PickPoint, Код пункта выдачи: 2302-060, Адрес пункта выдачи: Карякина ул, д.25, График работы: Пн-Пт 10:00-20:00, Сб 10:00-17:00, Описание пункта выдачи: Пункт выдачи заказов расположен в отдельно стоящем здании. Транспорт: Автобус №36, 58, 96. Маршрутное такси №48, 56, 85. Остановка Черкасская ул.\nВойти через отдельный вход справа, на цокольном этаже расположен пункт выдачи",
                "pvzInfo": {
                    "address": {
                        "city": "Краснодар",
                        "cityFias": "7dfa745e-aa19-4688-b121-b655c11e482f",
                        "country": "Россия",
                        "countryCode": "RU",
                        "fullAddress": "Карякина ул, д.25",
                        "region": "Краснодарский",
                        "regionFias": "d00e1013-16bd-4c09-b3d5-3cb09fc54bd8",
                        "zip": "350016"
                    },
                    "code": "2302-060",
                    "courier": "PickPoint",
                    "courierCode": "PICKPOINT",
                    "courierPostamatType": "ПВЗ",
                    "deliveryServices": [
                        "TRYING",
                        "DANGEROUS_CARGO",
                        "PARTIAL_DELIVERY",
                        "PERSONALLY_IN_HANDS",
                        "REVERSE",
                        "CHECK_CONTENT",
                        "DAY_OFF_DELIVERY",
                        "CONTACTLESS_DELIVERY",
                        "TEMPERATURE_REGIME"
                    ],
                    "description": "Пункт выдачи заказов расположен в отдельно стоящем здании. Транспорт: Автобус №36, 58, 96. Маршрутное такси №48, 56, 85. Остановка Черкасская ул.\nВойти через отдельный вход справа, на цокольном этаже расположен пункт выдачи",
                    "latitude": "45.065947",
                    "longitude": "39.010823",
                    "maxSize": "180",
                    "maxWeight": 15,
                    "metroStation": "",
                    "paymentMethods": [
                        "COD_CASH",
                        "COD_CARD"
                    ],
                    "type": "PVZ",
                    "workTime": "Пн-Пт 10:00-20:00, Сб 10:00-17:00"
                },
                "receiver": {
                    "address": {
                        "city": "Краснодар",
                        "cityFias": "7dfa745e-aa19-4688-b121-b655c11e482f",
                        "country": "Россия",
                        "countryCode": "RU",
                        "fullAddress": "Краснодарский, Краснодар",
                        "rawData": "Краснодарский, Краснодар",
                        "region": "Краснодарский",
                        "regionFias": "d00e1013-16bd-4c09-b3d5-3cb09fc54bd8",
                        "zip": "350016"
                    },
                    "alternativePhone": "",
                    "email": "mer@mer.mer",
                    "fullName": "Цу Йцу",
                    "name": "цу йцу",
                    "passport": {},
                    "personType": "CUSTOMER",
                    "phone": "74563464645",
                    "rawPhone": "74563464645"
                },
                "title": "PickPoint",
                "trackingNumber": "222",
                "type": "PVZ"
            },
            "expenses": [],
            "externalId": "BR0255",
            "files": [],
            "id": "BR0255",
            "insuranceSum": 548.60,
            "insuranceSumAutoCalculation": false,
            "isMarketplaceOrder": false,
            "items": [
                {
                    "barcode": "4211125570354",
                    "itemAmountState": {
                        "amountDELIVERED": 1,
                        "amountLOST": 0,
                        "amountORDERED": 1,
                        "amountPACKED": 1,
                        "amountRESERVED": 1,
                        "amountRETURNED": 0,
                        "amountRETURNED_AS_CLAIMS": 0,
                        "amountRETURNED_DEFECTIVE": 0,
                        "amountRETURNED_TO_CLIENT": 0,
                        "amountSHIPPED": 1
                    },
                    "itemDimensions": {
                        "depth": 17,
                        "height": 7,
                        "width": 23
                    },
                    "itemWeight": 167,
                    "name": "Маникюрно-педикюрный набор Beurer MP62 белый",
                    "num": 1,
                    "price": 5000.00,
                    "productId": "1047872",
                    "productVariantCount": 1,
                    "quantity": 1,
                    "quantityAvailable": 0,
                    "skuType": "SKU",
                    "variantId": "1047872",
                    "vatRate": "VAT_20"
                },
                {
                    "barcode": "",
                    "name": "Доставка",
                    "num": 2,
                    "price": 486.00,
                    "quantity": 1,
                    "skuType": "SERVICE",
                    "variantId": "delivery",
                    "vatRate": "NO_VAT"
                }
            ],
            "legalEntity": {
                "id": "fa0d6c85-6e62-51fa-346e-e5433c92b2d8",
                "name": " Розничный покупатель",
                "type": "PERSON"
            },
            "manualDiscount": {
                "appliedDiscountValue": 0,
                "discountType": "FIX",
                "discountValue": 0,
                "isActive": false
            },
            "needCustomerPayment": false,
            "needReserve": true,
            "onlinePaymentSum": 5486.00,
            "operatorComment": "",
            "orderType": "STANDARD",
            "packingOptions": [],
            "packings": [
                {
                    "barcode": "202749561679",
                    "files": [],
                    "items": [
                        {
                            "accountingAttributes": [],
                            "barcode": "4211125570354",
                            "itemDimensions": {
                                "depth": 17,
                                "height": 7,
                                "width": 23
                            },
                            "itemWeight": 167,
                            "name": "Маникюрно-педикюрный набор Beurer MP62 белый",
                            "num": 1,
                            "price": 5000.00,
                            "productId": "1047872",
                            "productVariantCount": 1,
                            "quantity": 1,
                            "skuType": "SKU",
                            "variantId": "1047872",
                            "vatRate": "VAT_20"
                        }
                    ],
                    "measurements": {
                        "dimensions": {
                            "depth": 12,
                            "height": 12,
                            "width": 12
                        },
                        "success": true,
                        "weight": 1000
                    }
                }
            ],
            "paymentMethodCode": "cod-card",
            "paymentMethodName": "Оплата картой при получении",
            "paymentMethodType": "COD_CARD",
            "paymentStatus": "NOT_PAID",
            "permissionList": {
                "actionPermissions": [
                    {
                        "type": "CANCEL",
                        "value": false
                    },
                    {
                        "type": "CONFIRM",
                        "value": false
                    },
                    {
                        "type": "NEED_CONFIRM",
                        "value": false
                    },
                    {
                        "type": "PACK",
                        "value": false
                    },
                    {
                        "type": "COPY",
                        "value": true
                    },
                    {
                        "type": "PACK_CONTROL",
                        "value": false
                    },
                    {
                        "type": "UNPACK",
                        "value": false
                    },
                    {
                        "type": "SHIPPING",
                        "value": false
                    },
                    {
                        "type": "UNSHIPPING",
                        "value": false
                    },
                    {
                        "type": "REFRESH_RESERVE",
                        "value": false
                    },
                    {
                        "type": "RETURN_TO_DELIVERY",
                        "value": true
                    },
                    {
                        "type": "REVERT_RETURNS",
                        "value": false
                    },
                    {
                        "type": "DELIVER_SELF_PICKUP",
                        "value": false
                    },
                    {
                        "type": "DELIVER_COURIER",
                        "value": false
                    },
                    {
                        "type": "ACCEPT_RETURN",
                        "value": false
                    }
                ],
                "fieldPermissions": [
                    {
                        "reason": "Склад уже отгрузил заказ. Изменение заказа невозможно.",
                        "type": "ITEMS_EDITABLE",
                        "value": false
                    },
                    {
                        "reason": "Склад уже отгрузил заказ. Изменение заказа невозможно.",
                        "type": "PAYMENT_EDITABLE",
                        "value": false
                    },
                    {
                        "reason": "Склад уже отгрузил заказ. Изменение заказа невозможно.",
                        "type": "IS_PAID_EDITABLE",
                        "value": false
                    },
                    {
                        "reason": "Склад уже отгрузил заказ. Изменение заказа невозможно.",
                        "type": "RECEIVER_EDITABLE",
                        "value": false
                    },
                    {
                        "reason": "Склад уже отгрузил заказ. Изменение заказа невозможно.",
                        "type": "DELIVERY_EDITABLE",
                        "value": false
                    },
                    {
                        "reason": "Склад уже отгрузил заказ. Изменение заказа невозможно.",
                        "type": "WAREHOUSE_EDITABLE",
                        "value": false
                    },
                    {
                        "reason": "Склад уже отгрузил заказ. Изменение заказа невозможно.",
                        "type": "COMMENTS_EDITABLE",
                        "value": false
                    },
                    {
                        "type": "OPERATOR_COMMENTS_EDITABLE",
                        "value": true
                    }
                ],
                "infoStatus": "ORDER_INFO_DELIVERED"
            },
            "plannedTakeOutDate": "2022-06-01 09:00:00",
            "readyForFFExport": true,
            "shortUrl": "http://r.kak2c.ru/h5llc00",
            "status": "ORDER_INFO_DELIVERED",
            "summaryItemAmountState": {
                "amountDELIVERED": 1,
                "amountLOST": 0,
                "amountORDERED": 1,
                "amountPACKED": 1,
                "amountRESERVED": 1,
                "amountRETURNED": 0,
                "amountRETURNED_AS_CLAIMS": 0,
                "amountRETURNED_DEFECTIVE": 0,
                "amountRETURNED_TO_CLIENT": 0,
                "amountSHIPPED": 1
            },
            "totalOrderSum": 5486.00,
            "updateTs": "2022-05-31 13:13:34.341",
            "warehouseCode": "2b0cde46-043f-cdc9-e2e4-aed4ff5a7d4f",
            "warehouseFFExportError": false,
            "warehouseFFExported": false,
            "warehouseFFSync": false,
            "warehouseName": "BR_K",
            "warehouseShippingOptions": {}
        }
    ],
    "recordsTotal": 2,
    "success": true
}

/api/lite/orders/shipped/report/no/delivery/statuses

Получение списка отгруженных заказов по которым не было статусов доставки  

/api/lite/orders/shipped/report/no/delivery/statuses

Возвращает список заказов, по которым с указанной в запросе даты была отгрузка но не было значимых статусов доставки более 24 часов (= заказ похоже не доехал до СЦ КС и проблемный)

Для выполнения запроса необходимо задать параметры:

date_from  - дата отгрузки заказов

 


Можно так же задать не обязательные параметры size(не больше 500) - порция получаемых данных, и page - страница. По умолчанию size= 20 и page=0.

Ответ - в формате стандартного списка заказов /api/lite/orders

 

Пример полного запроса

GET https://app.kak2c.ru/api/lite/orders/shipped/report/no/delivery/statuses?date_from=2020-01-01T00:00:00

Пример ответа:

{
    "orders": [
        {
            "c": "a0737972-c6bb-0759-35df-afd6bc2e6400",
            "codPayments": [
                {
                    "date": "2022-05-30 14:03:44",
                    "executionTime": "2022-05-30 14:30:00",
                    "paymentDocumentId": "BR0237-1",
                    "sum": 8857.00
                }
            ],
            "comment": "",
            "confirmStatus": "APPROVED",
            "createTs": "2022-05-30 14:04:18.900",
            "crossdockEditable": false,
            "currency": "RUB",
            "customerPaymentInProcess": false,
            "date": "2022-05-30 14:03:44",
            "delivery": {
                "address": {
                    "city": "Москва",
                    "cityFias": "0c5b2444-70a0-4932-980c-b4dc0d3f02b5",
                    "country": "Россия",
                    "countryCode": "RU",
                    "fullAddress": "Москва",
                    "rawData": "Москва",
                    "region": "Москва",
                    "regionFias": "0c5b2444-70a0-4932-980c-b4dc0d3f02b5",
                    "zip": "143582"
                },
                "code": "77e87a14-4e96-2ccb-3beb-4b1b33e466c8",
                "deliveryCode": "0ed6b628-288d-11e9-8989-002590923634",
                "deliveryComment": "",
                "desiredDeliveryDate": "2022-05-31",
                "desiredDeliveryTimeFrom": "09:00",
                "desiredDeliveryTimeTo": "18:00",
                "isDeliverySumLimitActive": false,
                "logoUrl": "https://storage.yandexcloud.net/lk-kak2c/delivery_pickpoint_left.svg",
                "pickupPointId": "5001-152",
                "pvzComment": "ПВЗ PickPoint, Код пункта выдачи: 5001-152, Адрес пункта выдачи: Невская ул., д. 704, График работы: Пн-Вс 10:00-22:00, Описание пункта выдачи: Постамат расположен в ТЦ Княжий двор. Перед ТЦ развязка общественного транспорта, остановка Памятник. От ж/д станции Нахабино - Транспорт: Автобус №20, 21. От метро Щукинская - Транспорт: Маршрутное такси №480\nВойти в ТЦ через центральный вход, подняться по лестнице на 2 этаж, повернуть направо, пройти прямо. С левой стороны вдоль стены расположен постамат.",
                "pvzInfo": {
                    "address": {
                        "city": "Москва",
                        "cityFias": "0c5b2444-70a0-4932-980c-b4dc0d3f02b5",
                        "country": "Россия",
                        "countryCode": "RU",
                        "fullAddress": "Невская ул., д. 704",
                        "region": "Москва",
                        "regionFias": "0c5b2444-70a0-4932-980c-b4dc0d3f02b5",
                        "zip": "143582"
                    },
                    "code": "5001-152",
                    "courier": "PickPoint",
                    "courierCode": "PICKPOINT",
                    "courierPostamatType": "АПТ",
                    "deliveryServices": [
                        "DAY_OFF_DELIVERY",
                        "CONTACTLESS_DELIVERY",
                        "TEMPERATURE_REGIME",
                        "TRYING",
                        "CHECK_CONTENT",
                        "DANGEROUS_CARGO",
                        "PARTIAL_DELIVERY",
                        "PERSONALLY_IN_HANDS",
                        "REVERSE"
                    ],
                    "description": "Постамат расположен в ТЦ Княжий двор. Перед ТЦ развязка общественного транспорта, остановка Памятник. От ж/д станции Нахабино - Транспорт: Автобус №20, 21. От метро Щукинская - Транспорт: Маршрутное такси №480\nВойти в ТЦ через центральный вход, подняться по лестнице на 2 этаж, повернуть направо, пройти прямо. С левой стороны вдоль стены расположен постамат.",
                    "latitude": "55.812358",
                    "longitude": "37.04213",
                    "maxSize": "64x40.5x35.8",
                    "maxWeight": 15,
                    "metroStation": "метро Щукинская",
                    "paymentMethods": [
                        "COD_CASH",
                        "COD_CARD"
                    ],
                    "type": "Postamat",
                    "workTime": "Пн-Вс 10:00-22:00"
                },
                "receiver": {
                    "address": {
                        "city": "Москва",
                        "cityFias": "0c5b2444-70a0-4932-980c-b4dc0d3f02b5",
                        "country": "Россия",
                        "countryCode": "RU",
                        "fullAddress": "Москва",
                        "rawData": "Москва",
                        "region": "Москва",
                        "regionFias": "0c5b2444-70a0-4932-980c-b4dc0d3f02b5",
                        "zip": "143582"
                    },
                    "alternativePhone": "",
                    "email": "mer@mer.mer",
                    "fullName": "Цу Йцу",
                    "name": "цу йцу",
                    "passport": {},
                    "personType": "CUSTOMER",
                    "phone": "74563464645",
                    "rawPhone": "74563464645"
                },
                "title": "PickPoint",
                "trackingNumber": "test333",
                "type": "PVZ"
            },
            "expenses": [],
            "externalId": "BR0237",
            "files": [],
            "id": "BR0237",
            "insuranceSum": 8857.00,
            "insuranceSumAutoCalculation": false,
            "isMarketplaceOrder": false,
            "items": [
                {
                    "barcode": "4211125637101",
                    "itemAmountState": {
                        "amountDELIVERED": 1,
                        "amountLOST": 0,
                        "amountORDERED": 1,
                        "amountPACKED": 1,
                        "amountRESERVED": 1,
                        "amountRETURNED": 0,
                        "amountRETURNED_AS_CLAIMS": 0,
                        "amountRETURNED_DEFECTIVE": 0,
                        "amountRETURNED_TO_CLIENT": 0,
                        "amountSHIPPED": 1
                    },
                    "itemDimensions": {
                        "depth": 26,
                        "height": 50,
                        "width": 42
                    },
                    "itemWeight": 5580,
                    "name": "Гидромассажная ванночка для ног Beurer FB50 белый",
                    "num": 1,
                    "price": 8000.00,
                    "productId": "1059034",
                    "productVariantCount": 1,
                    "quantity": 1,
                    "quantityAvailable": 0,
                    "skuType": "SKU",
                    "variantId": "1059034",
                    "vatRate": "VAT_20"
                },
                {
                    "barcode": "",
                    "name": "Доставка",
                    "num": 2,
                    "price": 857.00,
                    "quantity": 1,
                    "skuType": "SERVICE",
                    "variantId": "delivery",
                    "vatRate": "NO_VAT"
                }
            ],
            "legalEntity": {
                "id": "fa0d6c85-6e62-51fa-346e-e5433c92b2d8",
                "name": " Розничный покупатель",
                "type": "PERSON"
            },
            "manualDiscount": {
                "appliedDiscountValue": 0,
                "discountType": "FIX",
                "discountValue": 0,
                "isActive": false
            },
            "needCustomerPayment": false,
            "needReserve": true,
            "onlinePaymentSum": 8857.00,
            "operatorComment": "-",
            "orderType": "STANDARD",
            "packingOptions": [],
            "packings": [
                {
                    "barcode": "202749272704",
                    "files": [],
                    "items": [
                        {
                            "accountingAttributes": [],
                            "barcode": "4211125637101",
                            "itemDimensions": {
                                "depth": 26,
                                "height": 50,
                                "width": 42
                            },
                            "itemWeight": 5580,
                            "name": "Гидромассажная ванночка для ног Beurer FB50 белый",
                            "num": 1,
                            "price": 8000.00,
                            "productId": "1059034",
                            "productVariantCount": 1,
                            "quantity": 1,
                            "skuType": "SKU",
                            "variantId": "1059034",
                            "vatRate": "VAT_20"
                        }
                    ],
                    "measurements": {
                        "dimensions": {
                            "depth": 12,
                            "height": 12,
                            "width": 12
                        },
                        "success": true,
                        "weight": 5580
                    }
                }
            ],
            "paymentMethodCode": "cod-card",
            "paymentMethodName": "Оплата картой при получении",
            "paymentMethodType": "COD_CARD",
            "paymentStatus": "NOT_PAID",
            "permissionList": {
                "actionPermissions": [
                    {
                        "type": "CANCEL",
                        "value": false
                    },
                    {
                        "type": "CONFIRM",
                        "value": false
                    },
                    {
                        "type": "NEED_CONFIRM",
                        "value": false
                    },
                    {
                        "type": "PACK",
                        "value": false
                    },
                    {
                        "type": "COPY",
                        "value": true
                    },
                    {
                        "type": "PACK_CONTROL",
                        "value": false
                    },
                    {
                        "type": "UNPACK",
                        "value": false
                    },
                    {
                        "type": "SHIPPING",
                        "value": false
                    },
                    {
                        "type": "UNSHIPPING",
                        "value": false
                    },
                    {
                        "type": "REFRESH_RESERVE",
                        "value": false
                    },
                    {
                        "type": "RETURN_TO_DELIVERY",
                        "value": true
                    },
                    {
                        "type": "REVERT_RETURNS",
                        "value": false
                    },
                    {
                        "type": "DELIVER_SELF_PICKUP",
                        "value": false
                    },
                    {
                        "type": "DELIVER_COURIER",
                        "value": false
                    },
                    {
                        "type": "ACCEPT_RETURN",
                        "value": false
                    }
                ],
                "fieldPermissions": [
                    {
                        "reason": "Склад уже отгрузил заказ. Изменение заказа невозможно.",
                        "type": "ITEMS_EDITABLE",
                        "value": false
                    },
                    {
                        "reason": "Склад уже отгрузил заказ. Изменение заказа невозможно.",
                        "type": "PAYMENT_EDITABLE",
                        "value": false
                    },
                    {
                        "reason": "Склад уже отгрузил заказ. Изменение заказа невозможно.",
                        "type": "IS_PAID_EDITABLE",
                        "value": false
                    },
                    {
                        "reason": "Склад уже отгрузил заказ. Изменение заказа невозможно.",
                        "type": "RECEIVER_EDITABLE",
                        "value": false
                    },
                    {
                        "reason": "Склад уже отгрузил заказ. Изменение заказа невозможно.",
                        "type": "DELIVERY_EDITABLE",
                        "value": false
                    },
                    {
                        "reason": "Склад уже отгрузил заказ. Изменение заказа невозможно.",
                        "type": "WAREHOUSE_EDITABLE",
                        "value": false
                    },
                    {
                        "reason": "Склад уже отгрузил заказ. Изменение заказа невозможно.",
                        "type": "COMMENTS_EDITABLE",
                        "value": false
                    },
                    {
                        "type": "OPERATOR_COMMENTS_EDITABLE",
                        "value": true
                    }
                ],
                "infoStatus": "ORDER_INFO_DELIVERED"
            },
            "plannedTakeOutDate": "2022-05-31 09:00:00",
            "readyForFFExport": true,
            "shortUrl": "http://r.kak2c.ru/yr99em9",
            "status": "ORDER_INFO_DELIVERED",
            "summaryItemAmountState": {
                "amountDELIVERED": 1,
                "amountLOST": 0,
                "amountORDERED": 1,
                "amountPACKED": 1,
                "amountRESERVED": 1,
                "amountRETURNED": 0,
                "amountRETURNED_AS_CLAIMS": 0,
                "amountRETURNED_DEFECTIVE": 0,
                "amountRETURNED_TO_CLIENT": 0,
                "amountSHIPPED": 1
            },
            "totalOrderSum": 8857.00,
            "updateTs": "2022-05-30 14:29:35.964",
            "warehouseCode": "2b0cde46-043f-cdc9-e2e4-aed4ff5a7d4f",
            "warehouseFFExportError": false,
            "warehouseFFExported": false,
            "warehouseFFSync": false,
            "warehouseName": "BR_K",
            "warehouseShippingOptions": {}
        },
        {
            "c": "451dd9fc-9347-e7e4-c51d-e7842d870e40",
            "codPayments": [
                {
                    "date": "2022-05-31 12:22:16",
                    "executionTime": "2022-05-31 13:15:00",
                    "paymentDocumentId": "BR0255-1",
                    "sum": 5486.00
                }
            ],
            "comment": "",
            "confirmStatus": "APPROVED",
            "createTs": "2022-05-31 12:22:16.171",
            "crossdockEditable": false,
            "currency": "RUB",
            "customerPaymentInProcess": false,
            "date": "2022-05-31 12:21:38",
            "delivery": {
                "address": {
                    "city": "Краснодар",
                    "cityFias": "7dfa745e-aa19-4688-b121-b655c11e482f",
                    "country": "Россия",
                    "countryCode": "RU",
                    "fullAddress": "Краснодарский, Краснодар",
                    "rawData": "Краснодарский, Краснодар",
                    "region": "Краснодарский",
                    "regionFias": "d00e1013-16bd-4c09-b3d5-3cb09fc54bd8",
                    "zip": "350016"
                },
                "code": "77e87a14-4e96-2ccb-3beb-4b1b33e466c8",
                "deliveryCode": "0ed6b628-288d-11e9-8989-002590923634",
                "deliveryComment": "",
                "desiredDeliveryDate": "2022-06-02",
                "desiredDeliveryTimeFrom": "09:00",
                "desiredDeliveryTimeTo": "18:00",
                "isDeliverySumLimitActive": false,
                "logoUrl": "https://storage.yandexcloud.net/lk-kak2c/delivery_pickpoint_left.svg",
                "pickupPointId": "2302-060",
                "pvzComment": "ПВЗ PickPoint, Код пункта выдачи: 2302-060, Адрес пункта выдачи: Карякина ул, д.25, График работы: Пн-Пт 10:00-20:00, Сб 10:00-17:00, Описание пункта выдачи: Пункт выдачи заказов расположен в отдельно стоящем здании. Транспорт: Автобус №36, 58, 96. Маршрутное такси №48, 56, 85. Остановка Черкасская ул.\nВойти через отдельный вход справа, на цокольном этаже расположен пункт выдачи",
                "pvzInfo": {
                    "address": {
                        "city": "Краснодар",
                        "cityFias": "7dfa745e-aa19-4688-b121-b655c11e482f",
                        "country": "Россия",
                        "countryCode": "RU",
                        "fullAddress": "Карякина ул, д.25",
                        "region": "Краснодарский",
                        "regionFias": "d00e1013-16bd-4c09-b3d5-3cb09fc54bd8",
                        "zip": "350016"
                    },
                    "code": "2302-060",
                    "courier": "PickPoint",
                    "courierCode": "PICKPOINT",
                    "courierPostamatType": "ПВЗ",
                    "deliveryServices": [
                        "TRYING",
                        "DANGEROUS_CARGO",
                        "PARTIAL_DELIVERY",
                        "PERSONALLY_IN_HANDS",
                        "REVERSE",
                        "CHECK_CONTENT",
                        "DAY_OFF_DELIVERY",
                        "CONTACTLESS_DELIVERY",
                        "TEMPERATURE_REGIME"
                    ],
                    "description": "Пункт выдачи заказов расположен в отдельно стоящем здании. Транспорт: Автобус №36, 58, 96. Маршрутное такси №48, 56, 85. Остановка Черкасская ул.\nВойти через отдельный вход справа, на цокольном этаже расположен пункт выдачи",
                    "latitude": "45.065947",
                    "longitude": "39.010823",
                    "maxSize": "180",
                    "maxWeight": 15,
                    "metroStation": "",
                    "paymentMethods": [
                        "COD_CASH",
                        "COD_CARD"
                    ],
                    "type": "PVZ",
                    "workTime": "Пн-Пт 10:00-20:00, Сб 10:00-17:00"
                },
                "receiver": {
                    "address": {
                        "city": "Краснодар",
                        "cityFias": "7dfa745e-aa19-4688-b121-b655c11e482f",
                        "country": "Россия",
                        "countryCode": "RU",
                        "fullAddress": "Краснодарский, Краснодар",
                        "rawData": "Краснодарский, Краснодар",
                        "region": "Краснодарский",
                        "regionFias": "d00e1013-16bd-4c09-b3d5-3cb09fc54bd8",
                        "zip": "350016"
                    },
                    "alternativePhone": "",
                    "email": "mer@mer.mer",
                    "fullName": "Цу Йцу",
                    "name": "цу йцу",
                    "passport": {},
                    "personType": "CUSTOMER",
                    "phone": "74563464645",
                    "rawPhone": "74563464645"
                },
                "title": "PickPoint",
                "trackingNumber": "222",
                "type": "PVZ"
            },
            "expenses": [],
            "externalId": "BR0255",
            "files": [],
            "id": "BR0255",
            "insuranceSum": 548.60,
            "insuranceSumAutoCalculation": false,
            "isMarketplaceOrder": false,
            "items": [
                {
                    "barcode": "4211125570354",
                    "itemAmountState": {
                        "amountDELIVERED": 1,
                        "amountLOST": 0,
                        "amountORDERED": 1,
                        "amountPACKED": 1,
                        "amountRESERVED": 1,
                        "amountRETURNED": 0,
                        "amountRETURNED_AS_CLAIMS": 0,
                        "amountRETURNED_DEFECTIVE": 0,
                        "amountRETURNED_TO_CLIENT": 0,
                        "amountSHIPPED": 1
                    },
                    "itemDimensions": {
                        "depth": 17,
                        "height": 7,
                        "width": 23
                    },
                    "itemWeight": 167,
                    "name": "Маникюрно-педикюрный набор Beurer MP62 белый",
                    "num": 1,
                    "price": 5000.00,
                    "productId": "1047872",
                    "productVariantCount": 1,
                    "quantity": 1,
                    "quantityAvailable": 0,
                    "skuType": "SKU",
                    "variantId": "1047872",
                    "vatRate": "VAT_20"
                },
                {
                    "barcode": "",
                    "name": "Доставка",
                    "num": 2,
                    "price": 486.00,
                    "quantity": 1,
                    "skuType": "SERVICE",
                    "variantId": "delivery",
                    "vatRate": "NO_VAT"
                }
            ],
            "legalEntity": {
                "id": "fa0d6c85-6e62-51fa-346e-e5433c92b2d8",
                "name": " Розничный покупатель",
                "type": "PERSON"
            },
            "manualDiscount": {
                "appliedDiscountValue": 0,
                "discountType": "FIX",
                "discountValue": 0,
                "isActive": false
            },
            "needCustomerPayment": false,
            "needReserve": true,
            "onlinePaymentSum": 5486.00,
            "operatorComment": "",
            "orderType": "STANDARD",
            "packingOptions": [],
            "packings": [
                {
                    "barcode": "202749561679",
                    "files": [],
                    "items": [
                        {
                            "accountingAttributes": [],
                            "barcode": "4211125570354",
                            "itemDimensions": {
                                "depth": 17,
                                "height": 7,
                                "width": 23
                            },
                            "itemWeight": 167,
                            "name": "Маникюрно-педикюрный набор Beurer MP62 белый",
                            "num": 1,
                            "price": 5000.00,
                            "productId": "1047872",
                            "productVariantCount": 1,
                            "quantity": 1,
                            "skuType": "SKU",
                            "variantId": "1047872",
                            "vatRate": "VAT_20"
                        }
                    ],
                    "measurements": {
                        "dimensions": {
                            "depth": 12,
                            "height": 12,
                            "width": 12
                        },
                        "success": true,
                        "weight": 1000
                    }
                }
            ],
            "paymentMethodCode": "cod-card",
            "paymentMethodName": "Оплата картой при получении",
            "paymentMethodType": "COD_CARD",
            "paymentStatus": "NOT_PAID",
            "permissionList": {
                "actionPermissions": [
                    {
                        "type": "CANCEL",
                        "value": false
                    },
                    {
                        "type": "CONFIRM",
                        "value": false
                    },
                    {
                        "type": "NEED_CONFIRM",
                        "value": false
                    },
                    {
                        "type": "PACK",
                        "value": false
                    },
                    {
                        "type": "COPY",
                        "value": true
                    },
                    {
                        "type": "PACK_CONTROL",
                        "value": false
                    },
                    {
                        "type": "UNPACK",
                        "value": false
                    },
                    {
                        "type": "SHIPPING",
                        "value": false
                    },
                    {
                        "type": "UNSHIPPING",
                        "value": false
                    },
                    {
                        "type": "REFRESH_RESERVE",
                        "value": false
                    },
                    {
                        "type": "RETURN_TO_DELIVERY",
                        "value": true
                    },
                    {
                        "type": "REVERT_RETURNS",
                        "value": false
                    },
                    {
                        "type": "DELIVER_SELF_PICKUP",
                        "value": false
                    },
                    {
                        "type": "DELIVER_COURIER",
                        "value": false
                    },
                    {
                        "type": "ACCEPT_RETURN",
                        "value": false
                    }
                ],
                "fieldPermissions": [
                    {
                        "reason": "Склад уже отгрузил заказ. Изменение заказа невозможно.",
                        "type": "ITEMS_EDITABLE",
                        "value": false
                    },
                    {
                        "reason": "Склад уже отгрузил заказ. Изменение заказа невозможно.",
                        "type": "PAYMENT_EDITABLE",
                        "value": false
                    },
                    {
                        "reason": "Склад уже отгрузил заказ. Изменение заказа невозможно.",
                        "type": "IS_PAID_EDITABLE",
                        "value": false
                    },
                    {
                        "reason": "Склад уже отгрузил заказ. Изменение заказа невозможно.",
                        "type": "RECEIVER_EDITABLE",
                        "value": false
                    },
                    {
                        "reason": "Склад уже отгрузил заказ. Изменение заказа невозможно.",
                        "type": "DELIVERY_EDITABLE",
                        "value": false
                    },
                    {
                        "reason": "Склад уже отгрузил заказ. Изменение заказа невозможно.",
                        "type": "WAREHOUSE_EDITABLE",
                        "value": false
                    },
                    {
                        "reason": "Склад уже отгрузил заказ. Изменение заказа невозможно.",
                        "type": "COMMENTS_EDITABLE",
                        "value": false
                    },
                    {
                        "type": "OPERATOR_COMMENTS_EDITABLE",
                        "value": true
                    }
                ],
                "infoStatus": "ORDER_INFO_DELIVERED"
            },
            "plannedTakeOutDate": "2022-06-01 09:00:00",
            "readyForFFExport": true,
            "shortUrl": "http://r.kak2c.ru/h5llc00",
            "status": "ORDER_INFO_DELIVERED",
            "summaryItemAmountState": {
                "amountDELIVERED": 1,
                "amountLOST": 0,
                "amountORDERED": 1,
                "amountPACKED": 1,
                "amountRESERVED": 1,
                "amountRETURNED": 0,
                "amountRETURNED_AS_CLAIMS": 0,
                "amountRETURNED_DEFECTIVE": 0,
                "amountRETURNED_TO_CLIENT": 0,
                "amountSHIPPED": 1
            },
            "totalOrderSum": 5486.00,
            "updateTs": "2022-05-31 13:13:34.341",
            "warehouseCode": "2b0cde46-043f-cdc9-e2e4-aed4ff5a7d4f",
            "warehouseFFExportError": false,
            "warehouseFFExported": false,
            "warehouseFFSync": false,
            "warehouseName": "BR_K",
            "warehouseShippingOptions": {}
        }
    ],
    "recordsTotal": 2,
    "success": true
}

/api/lite/orders/discounts

Добавить скидку для заказа

/api/lite/orders/discounts

Позволяет добавить промокод или фиксированную скидку ко всему заказу в процентах или сумме 

Поле Тип / формат Описание
id string Идентификатор заказа
promocode string Промокод
 manualDiscount object Объект, описывающий скидку
  isActive boolean Флаг активности промокода
discountType enum Тип скидки
FIX Фиксированная
PERCENT в процентах
    discountValue double Сумма скидки или процент

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

{
    "id": "2502-124471",
    "promocode": "",
    "manualDiscount": {
        "isActive": true,
        "discountType": "FIX",
        "discountValue": "1000"
    }
}

Ответ:

{
  "success": true
}

Ошибка:

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