Перейти к основному контенту

/api/lite/orders/delivery

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

/api/lite/orders/delivery

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

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

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

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

    
Поле Тип Описание id string Номер заказа.
Основной идентификатор заказа. externalId string Внешний номер заказа – дополнительный номер заказа, например в сторонней CRM системе. externalId2 string Внешний номер заказа externalId3 string Внешний номер заказа externalId4 string Внешний номер заказа externalId5 string Внешний номер заказа date datetime Дата создания заказа. needReserve boolean Нужно ли брать резерв  updateTs datetime Дата последнего обновления заказа. status enum

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

    ORDER_INFO_DRAFT – Черновик. Заказ свободно редактируется, может быть не полностью заполнен, обязательность полей не контролируется. 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_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_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 Метка для добавления заказу - для записи 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

              ранее 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

                Часть ссылки на трекинг. Для получения полной ссылки на трекинг в курьерской службе, необходимо сцепить trackingURL и trackingNumber.

                Пример: trackingURL="https://boxberry.ru/tracking/" + trackingNumber="11122233" дают полную ссылку на трекинг https://boxberry.ru/tracking/11122233.

                desiredDeliveryDate date

                Желаемая покупателем дата доставки. 

                Кактус передает эту информацию в курьерские службы как рекомендательный параметр. Не все курьерские службы учитывают эту информацию. 

                desiredDeliveryTimeFrom": "09:00",

                ранее timeFrom

                HH:ss

                Желаемое время доставки "от". С лидирующими нулями.

                Пример "09:00".

                "desiredDeliveryTimeTo": "20:00",

                ранее timeTo

                HH:ss

                Желаемое время доставки "по". С лидирующими нулями.

                Пример "20:00".

                deliveryComment string

                Комментарий для целей доставки.

                pvzComment string

                В случае способа доставки через ПВЗ, содержит адрес и время работы ПВЗ.

                actualDeliveryDate string

                Дата фактической доставки от курьерской службы

                courierPlanDeliveryDate date

                Плановая дата доставки от курьерской службы

                courierPlanDeliveryDateChangeReason string

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

                address Object Объект, описывающий адрес доставки 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 Код района по ФИАС cityFias string Код города по ФИАС settlementFias string Код населенного пункта по ФИАС 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 – Услуга, например "Доставка" 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 warehouseShippingOptions Object

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

                            Пример запроса по одному заказу и полными данным

                              

                            Запрос

                            {
                             
                                        "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": "Текст ошибки"
                                    }
                                ]  
                            }