Versions Compared

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.

...

Функція orders/get (<http://<DOMAIN>>/api/orders/get/)

Tip

Увага: ми оновили Отримання списку замовлень - додано новий блок delivery_data, у якому передаватимуться всі дані про доставку.

Якщо у вас уже налаштована інтеграція за API, то вона продовжує працювати в штатному режимі. Для Нової пошти зберігається передача всіх параметрів у блоці additional_data. Але в майбутньому ми будемо підтримувати і розвивати новий блок, тому рекомендуємо вам переналаштувати свої інтеграції для отримання нових параметрів.

Panel
panelIconId1f195
panelIcon:new:
panelIconText🆕
bgColor#DEEBFF

Новий блок даних про джерело замовлення analytics

Новий блок customer_details в Отримання списку замовлень для b2b проєктів

Новий блок dropshipping_details та новий параметр ownTTNPicked в масиві delivery_data в Отриманні списку замовлень для b2b проєктів - детальніше тут

Функция orders/get (http://<DOMAIN>/api/orders/get/)

Tip

Увага: ми оновили Отримання списку замовлень - додано новий блок delivery_data, у якому передаватимуться всі дані про доставку.

Якщо у вас уже налаштована інтеграція за API, то вона продовжує працювати в штатному режимі. Для Нової пошти зберігається передача всіх параметрів у блоці additional_data. Але в майбутньому ми будемо підтримувати і розвивати новий блок, тому рекомендуємо вам переналаштувати свої інтеграції для отримання нових параметрів.

Panel
panelIconId1f195
panelIcon:new:
panelIconText🆕
bgColor#DEEBFF

Новий блок даних про джерело замовлення analytics

Новий блок customer_details в Отримання списку замовлень для b2b проєктів

Новий блок dropshipping_details та новий параметр ownTTNPicked в масиві delivery_data в Отриманні списку замовлень для b2b проєктів - детальніше тут

Параметры для тела запроса:

...

token — ключ авторизации полученный через функцию auth.

...

Параметры для тела запроса:

  • token — ключ авторизации полученный через функцию auth.

  • from — показать заказы от указанной даты (включительно). Необязательный параметр.
    Формат даты:

    • YYYY-MM-DD

    • DD.MM.YYYY

    • Начиная с версии 3.30

    • YYYY-MM-DD HH:mm:ss

    • DD.MM.YYYY HH:mm:ss

  • to — показать заказы до указанной даты (включительно). Необязательный параметр.
    Формат даты:

    • YYYY-MM-DD

    • DD.MM.YYYY

    • Начиная с версии 3.30

    • YYYY-MM-DD HH:mm:ss

    • DD.MM.YYYY HH:mm:ss

  • ids[] — номера заказов для отображения

  • status — показать заказы с выбранными статусами (выгрузить все статусы можно через функцию orders/get_available_statuses). Необязательный параметр. Параметр можно передавать как массив или переменную (status=1 или status[]=1&status[]=2, {status:1}, {status:[1, 2]}). Возможные значения:

    • 1 — новый

    • 2 — в обработке

    • 3 — доставлен

    • 4 — не доставлен

    • 6 — доставляется

  • additionalData — boolean значение (true или false). Позволяет выгрузить дополнительную информацию о заказе, например, данные о ТТН Новой Почты, складе получателя и отправителя.

  • Начиная с версии 3.30

  • offset — смещение относительно начала выборки заказов (работает только в паре с параметром limit)

  • limit — количество выводимых заказов


Ответ:

  • status

    • OK — заказы успешно найдены

    • EMPTY — заказы не найдены

  • response.orders — массив, содержащий заказы

    • response.orders[i]

      • order_id — номер заказа

      • user — идентификатор пользователя в системе (уникален для каждого пользователя)

      • delivery_name — ФИО получателя

      • delivery_email — email (уникален для каждого пользователя внутри системы, дублирование невозможно)

      • delivery_phone — номер телефона

      • delivery_city — город

      • delivery_address — адрес доставки (при выборе варианта доставки УкрПочтой поля разбиваются символом @)

      • delivery_type — тип доставки

        • delivery_type.id — идентификатор доставки в API. Получить информацию о вариантах доставки можно через функции: delivery/export и delivery/exportTypes.

          • 3 — Новой почтой

          • 8 — Самовывоз

          • 9 — Укрпочтой

          • и т. д. (на каждом проекте идентификаторы вариантов доставки могут отличаться)

        • delivery_type.title — название варианта доставки

      • delivery_price — стоимость доставки ("delivery_price": -1 — означает, что стоимость доставки рассчитывается по тарифам перевозчика)

      • comment — комментарий покупателя к заказу

      • payment_type — тип оплаты. Получить информацию о вариантах оплаты можно через функции: payment/export и payment/exportMethods.

        • payment_type.id — идентификатор оплаты в API

          • 11 — Оплата курьеру

          • 12 — Безналичный расчет

          • 13 — Наличными

          • 14 — Онлайн-оплата кредитной картой

          • 15 — Оплата при получении (наложенный платеж)

          • и т. д.

        • payment_type.title — название варианта оплаты

      • payment_price — комиссия за оплату

      • payed — оплачено (1 — да; 0 — нет)

      • total_default — стоимость товаров (без учета скидок)

      • total_sum — итоговая стоимость (с учетом всех скидок, но без учета стоимости доставки)

      • total_quantity — общее количество товаров в заказе

      • discount_percent — относительная скидка

      • discount_value — сумма скидки

      • coupon_code — код купона на скидку

      • coupon_percent — относительная скидка купона

      • coupon_discount_value — сумма скидки по купону

      • coupon_type — тип купона

        • 0 — без купона

        • 1 — сертификат на сумму

        • 2 — многоразовый купон на скидку

      • stat_status — статус заказа. Получить информацию о всех статусах заказов можно через функцию orders/get_available_statuses (доступно начиная с версии 4.0).

        • 1 — новый

        • 2 — в обработке

        • 3 — доставлен

        • 4 — не доставлен

      • stat_created — дата и время оформления заказа (пример: 2021-04-09 12:09:01)

      • currency — валюта в которой был оформлен заказ (в формате ISO, например: UAH — гривна, USD — доллар, EUR — евро и т. д.). Получить информацию о всех валютах можно через функцию currency/export.

      • order_without_callback — boolean значение (true или false). Нужно ли перезванивать покупателю (добавлено в версии 3.32).

      • manager_id - id менеджера который обрабатывал заказ

      • manager_comment - комментарий менеджера

      • manager_discount - скидка от менеджера

      • manager_discount_title - название скидки от менеджера

      • delivery_country - страна доставки (если включена функция выбора стран на странице оформления заказа)

      • products[i] — товары в заказе

        • title — название товара

        • article — артикул товара

        • price — стоимость единицы товара для пользователя

        • quantity — количество заказанных единиц товара

        • total_price — итоговая стоимость товара с учетом заказанного количества

        • discount_marker — маркер использованной скидки на товар

          • PRICE_OLD — старая цена / относительная скидка на товар

          • PAGE_DISCOUNT — скидка на раздел

          • DISCOUNT_CARD — накопительная скидка

          • DISCOUNT_NONE — отсутствие скидки (при условиях акций и т. д.)

          • NONE — без скидки

        • type — данный параметр появился в v4.7.0 и может содержать такие значения (как определить какой товар относиться к комплекту, или к какому товару относится подарок можно на примере этого скриншота):

          • gift_parent — товар, к которому был добавлен подарок

          • gift — сам подарок

          • set_main — товар, к которому был добавлен комплект

          • set_item — товар, входящий в комплект

        • storage_id — уникальный идентификатор, который в последствии передаётся в следующий параметр parent_storage_id, для указания связи между товарами на уровни комплектов / подарков

        • parent_storage_id — если значение null — значит, что к товару был добавлен подарок или товары в комплект (на данном скриншоте показан пример связи между товарами).

      • additional_data — дополнительная информация о заказе (отображается только в том случае, если в теле запроса передать ключ "additionalData": true)

        • np_ref — идентификатор электронной накладной (далее ЭН) для API Новой Почты v.2

        • np_number — номер ЭН

        • sender_warehouse_ref — идентификатор склада отправителя в API Новой Почты

        • recipient_warehouse_ref — идентификатор склада получателя в API Новой Почты для способа доставки “Новая почта” (на отделение)

        • recipient_address — данные об адресе получателя для способа доставки “Курьером Новой почты”(адресная доставка):

          • recipient_address.street_id –– идетнификатор улицы получателя в API Новой Почты

          • recipient_address.street_name –– название улицы

          • recipient_address.building_number –– номер дома

          • recipient_address.flat –– номер квартиры

  • delivery_data - массив данных о способе доставки

    • deliveryOperatorType- тип оператора доставки. Возможные значения: nova_poshta, ukrposhta

    • tnID — уникальный идентификатор ЭН

    • tnNumber номер ЭН

    • tnStatusName — текст статуса накладной у оператора

    • tnTrackingUpdateDate — время последнего изменения статуса у оператора

    • estimatedDeliveryDate — предполагаемая дата доставки

    • departure

      • sender — массив данных по отправителю

        • id — уникальный идентификатор отправителя в базе оператора доставки

        • title — название отправителя

        • contactPerson — массив данных по контактному лицу (передается только для deliveryOperatorType= **nova_poshta)

          • id — уникальный идентификатор контактного лица в базе оператора доставки

          • name — имя контактного лица

          • phone — телефон контактного лица

        • type — тип отправителя (ключ передается только для deliveryOperatorType= **ukrposhta) . Возможные значения:

          • COMPANY — Юридическое лицо

          • PRIVATE_ENTREPRENEUR — ФЛП

          • INDIVIDUAL — Физическое лицо

        • phone — телефон отправителя (ключ передается только для deliveryOperatorType= **ukrposhta)

    • address

      • type — тип адреса отправителя. Возможные значения: warehouse

      • geoObject — массив данных о складе отправителя

        • id — уникальный идентификатор города отправителя в базе оператора доставки

        • name — город отправителя

      • warehouse (передается для type = warehouse)

        • id — идентификатор склада отправителя в базе оператора доставки

        • name — склад отправителя

    • destination

      • recipient массив данных о получателе

        • name— имя получателя

        • surname— фамилия получателя

        • patronymic— отчество получателя

        • phone — телефон получателя

      • address — массив данных об адресе получателя

        • type — тип адреса отправителя. Возможные значения: warehouse / doors

        • geoObject — данные о городе

          • id — уникальный идентификатор города в базе оператора доставки

          • name — город получателя

        • warehouse — данные о складе (передается для type = warehouse)

          • id — уникальный идентификатор склада получателя в базе оператора доставки

          • name — склад получателя

        • street — данные о адресе для курьерской доставки (передается для type = doors)

          • id — уникальный идентификатор улицы в базе оператора доставки

          • name — название улицы

        • buildingNumber — номер дома получателя (передается для type = doors)

        • flatNumber — номер квартиры получателя (передается для type = doors)

    • payment — данные об оплате услуг за доставку

      • type — тип оплаты услуг доставки (ключ передается только при ****deliveryOperatorType= ****nova_poshta)

      • payer — плательщик за услуги доставки

    • redelivery — данные об обратной доставке

      • cost — сумма обратной доставки

      • payer — плательщик за обратную доставку

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

Параметри для тіла запиту:

  • token - ключ авторизації отриманий через функцію auth.

  • from - показати замовлення від зазначеної дати (включно). Необов'язковий параметр. Формат дати:

    • YYYY-MM-DD

    • DD.MM.YYYY

    • Начиная с версии Починаючи з версії 3.30

    • YYYY-MM-DD HH:mm:ss

    • DD.MM.YYYY YYYYY HH:mm:ss

  • to — показать заказы до указанной даты (включительно). Необязательный параметр.
    Формат даты- показати замовлення до зазначеної дати (включно). Необов'язковий параметр. Формат дати:

    • YYYY-MM-DD

    • DD.MM.YYYY

    • Начиная с версии Починаючи з версії 3.30

    • YYYY-MM-DD HH:mm:ss

    • DD.MM.YYYY YYYYY HH:mm:ss

  • ids[] — номера заказов для отображенияstatus — показать заказы с выбранными статусами (выгрузить все статусы можно через функцию - номери замовлень для відображення

  • status - показати замовлення з обраними статусами (вивантажити всі статуси можна через функцію orders/get_available_statuses). Необязательный Необов'язковий параметр. Параметр можно передавать как массив или переменную можна передавати як масив або змінну (status=1 или або status[]=1&status[]=2, {status:1}, {status:[1, 2]}). Возможные значенияМожливі значення:

    • 1 — новый- новий

    • 2 - в обработкеобробці

    • 3 — доставлен- доставлено

    • 4 - не доставлендоставлено

    • 6 — доставляется- доставляється

  • additionalData - boolean значение значення (true или або false). Позволяет выгрузить дополнительную информацию о заказе, например, данные о ТТН Новой Почты, складе получателя и отправителя.Начиная с версии Дозволяє вивантажити додаткову інформацію про замовлення, наприклад, дані про ТТН Нової Пошти, склад одержувача і відправника.

  • Починаючи з версії 3.30

  • offset — смешение относительно начала выборки пользователей (работает только в паре с - зміщення щодо початку вибірки користувачів (працює тільки в парі з параметром limit)

  • limit — количество выводимых заказов

...

  • - кількість виведених замовлень

Відповідь:

  • status

    • OK — заказы успешно найдены- замовлення успішно знайдено

    • EMPTY — заказы - замовлення не найденызнайдено

  • response.orders — массив, содержащий заказы- масив, що містить замовлення

    • response.orders[i]

      • order_id - номер заказазамовлення

      • user — идентификатор пользователя в системе (уникален для каждого пользователя- ідентифікатор користувача в системі (унікальний для кожного користувача)

      • delivery_name — ФИО получателя- ПІБ одержувача

      • delivery_email - email (уникален для каждого пользователя внутри системы, дублирование невозможноунікальний для кожного користувача всередині системи, дублювання неможливе)

      • delivery_phone - номер телефонателефону

      • delivery_city — город- місто

      • delivery_address — адрес - адреса доставки (при выборе варианта виборі варіанту доставки УкрПочтой Укрпоштою поля разбиваются розбиваються символом @)

      • delivery_type - тип доставки

        • delivery_type.id — идентификатор - ідентифікатор доставки в API. Получить информацию о вариантах доставки можно через функцииОтримати інформацію про варіанти доставки можна через функції: delivery/export и і delivery/exportTypes.

          • 3 — Новой почтой- Новою поштою

          • 8 — Самовывоз- Самовивіз

          • 9 — Укрпочтой- Укрпоштою

          • и і т. д. (на каждом проекте идентификаторы вариантов доставки могут отличаться)кожному проєкті ідентифікатори варіантів доставки можуть відрізнятися

    • delivery_type.title

      — название варианта

      - назва варіанта доставки

    • delivery_price

      — стоимость

      - вартість доставки ("delivery_price": -1

      — означает, что стоимость доставки рассчитывается по тарифам перевозчика)comment — комментарий покупателя к заказу

      - означає, що вартість доставки розраховується за тарифами перевізника)

    • comment - коментар покупця до замовлення

    • payment_type

      - тип

      оплаты. Получить информацию о вариантах оплаты можно через функции

      оплати. Отримати інформацію про варіанти оплати можна через функції: payment/export

      и

      і payment/exportMethods.

      • payment_type.id

        — идентификатор оплаты

        - ідентифікатор оплати в API

        • 11

          - Оплата

          курьеру

          кур'єру

        • 12

          — Безналичный расчет

          - Безготівковий розрахунок

        • 13

          — Наличными

          - Готівкою

        • 14

          - Онлайн-оплата

          кредитной картой

          кредитною карткою

        • 15

          - Оплата при

          получении

          отриманні (

          наложенный платеж

          накладений платіж)

        • и т. д

          тощо.

    • payment_type.title

      — название варианта оплаты

      - назва варіанта оплати

    • payment_price

      — комиссия

      - комісія за оплату

    • payed

      paided - оплачено (1

      — да

      - так; 0

      — нет

      - ні)

    • total_default

      — стоимость товаров

      - вартість товарів (без

      учета скидок

      урахування знижок)

    • total_sum

      — итоговая стоимость (с учетом всех скидок, но без учета стоимости

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

    • total_quantity

      — общее количество товаров в заказе

      - загальна кількість товарів у замовленні

    • discount_percent

      — относительная скидка

      - відносна знижка

    • discount_value

      — сумма скидки

      - сума знижки

    • coupon_code

      - код купона на

      скидку

      знижку

    • coupon_percent

      — относительная скидка

      - відносна знижка купона

    • coupon_discount_value

      — сумма скидки по купону

      - сума знижки за купоном

    • coupon_type

      - тип купона

      • 0

        - без купона

      • 1

        — сертификат

        - сертифікат на

        сумму

        суму

      • 2

        — многоразовый

        - багаторазовий купон на

        скидку

        знижку

    • stat_status

      - статус

      заказа. Получить информацию о всех статусах заказов можно через функцию

      замовлення. Отримати інформацію про всі статуси замовлень можна через функцію orders/get_available_statuses (доступно

      начиная с версии

      починаючи з версії 4.0).

      • 1

        — новый

        - новий

      • 2

        - в

        обработке

        обробці

      • 3

        — доставлен

        - доставлено

      • 4

        - не

        доставлен

        доставлено

    • stat_created

      — дата и время оформления заказа (пример

      - дата і час оформлення замовлення (приклад: 2021-04-09 12:09:01)

    • currency

      — валюта в которой был оформлен заказ (в формате ISO, например: UAH — гривна, USD — доллар, EUR — евро и т. д.). Получить информацию о всех валютах можно через функцию

      - валюта, у якій було оформлено замовлення (у форматі ISO, наприклад: UAH - гривня, USD - долар, EUR - євро тощо). Отримати інформацію про всі валюти можна через функцію currency/export.

    • order_without_callback

      - boolean

      значение

      значення (true

      или

      або false).

      Нужно ли перезванивать покупателю (добавлено в версии

      Чи потрібно передзвонювати покупцеві (додано у версії 3.32).

    • manager_id - id менеджера

      который обрабатывал заказ

      , який обробляв замовлення

    • manager_comment -

      комментарий

      коментар менеджера

    • manager_discount -

      скидка от

      знижка від менеджера

    • manager_discount_title -

      название скидки от

      назва знижки від менеджера

    • delivery_country -

      страна

      країна доставки (

      если включена функция выбора стран на странице оформления заказа

      якщо ввімкнено функцію вибору країн на сторінці оформлення замовлення)

    • products[i]

      — товары

      - товари в

      заказе

      замовленні

      • title

        — название товара

        - назва товару

      • article

        - артикул

        товара

        товару

      • price

        — стоимость единицы товара для пользователя
      • quantity — количество заказанных единиц товара

      • total_price — итоговая стоимость товара с учетом заказанного количества

        - вартість одиниці товару для користувача

      • quantity - кількість замовлених одиниць товару

    • total_price - підсумкова вартість товару з урахуванням замовленої кількості

    • discount_marker

      - маркер

      использованной скидки

      використаної знижки на товар

      • PRICE_OLD

        — старая цена / относительная скидка

        - стара ціна / відносна знижка на товар

      • PAGE_DISCOUNT

        — скидка

        - знижка на

        раздел

        розділ

      • DISCOUNT_CARD

        — накопительная скидка

        - накопичувальна знижка

      • DISCOUNT_NONE

        — отсутствие скидки (при условиях акций и т. д.

        - відсутність знижки (за умов акцій тощо)

      • NONE

        - без

        скидки

        знижки

    • type

      — данный параметр появился в

      - цей параметр з'явився у v4.7.0

      и может содержать такие значения (как определить какой товар относиться к комплекту, или к какому товару относится подарок можно на примере этого скриншота

      і може містити такі значення (як визначити, який товар належить до комплекту, або до якого товару належить подарунок, можна на прикладі цього скріншота):

    • gift_parent

      - товар,

      к которому был добавлен подарок

      до якого було додано подарунок

    • gift

      - сам

      подарок

      подарунок

    • set_main

      - товар,

      к которому был добавлен

      до якого було додано комплект

    • set_item

      - товар,

      входящий в комплект

      що входить до комплекту

    • storage_id

      — уникальный идентификатор, который в последствии передаётся в следующий

      - унікальний ідентифікатор, який надалі передається в наступний параметр parent_storage_id, для

      указания связи между

      вказівки зв'язку між товарами на

      уровни комплектов

      рівні комплектів /

      подарков

      подарунків

    • parent_storage_id

      — если значение null — значит, что к товару был добавлен подарок или товары в комплект (на данном скриншоте показан пример связи между

      - якщо значення null - значить, що до товару було додано подарунок або товари в комплект (на цьому скріншоті показано приклад зв'язку між товарами).

    • additional_data

      — дополнительная информация о заказе (отображается только в том случае, если в теле запроса передать

      - додаткова інформація про замовлення (відображається тільки в тому випадку, якщо в тілі запиту передати ключ "additionalData": true)

      • np_ref

        — идентификатор электронной накладной (далее ЭН

        - ідентифікатор електронної накладної (далі ЕН) для API

        Новой Почты

        Нової Пошти v.2

      • np_number

        - номер

        ЭН

        ЕН

      • sender_warehouse_ref

        — идентификатор склада отправителя

        - ідентифікатор складу відправника в API

        Новой Почты

        Нової Пошти

      • recipient_warehouse_ref

        — идентификатор склада получателя

        - ідентифікатор складу одержувача в API

        Новой Почты

        Нової Пошти для

        способа доставки “Новая почта”

        способу доставки "Нова пошта" (на

        отделение

        відділення)

      • recipient_address

        — данные об адресе получателя для способа доставки “Курьером Новой почты”(адресная

        - дані про адресу одержувача для способу доставки "Кур'єром Нової пошти" (адресна доставка):

      • recipient_address.street_id

        –– идетнификатор улицы получателя

        -- йденіфікатор вулиці одержувача в API

        Новой Почты

        Нової Пошти

      • recipient_address.street_name

        –– название улицы

        -- назва вулиці

      • recipient_address.building_number

        ––

        -- номер

        дома

        будинку

      • recipient_address.flat

        ––

        -- номер

        квартиры

        квартири

    • delivery_data -

    массив данных о способе
    • масив даних про спосіб доставки

      • deliveryOperatorType -- тип оператора доставки.

      Возможные значения
      • Можливі значення: nova_poshta, ukrposhta

      • tnID

      — уникальный идентификатор ЭН
    • tnNumber номер ЭН

    • tnStatusName — текст статуса накладной у оператора

    • tnTrackingUpdateDate — время последнего изменения статуса у оператора

    • estimatedDeliveryDate — предполагаемая
      • - унікальний ідентифікатор ЕН

      • tnNumber - номер ЕН

      • tnStatusName - текст статусу накладної в оператора

      • tnTrackingUpdateDate - час останньої зміни статусу в оператора

      • estimatedDeliveryDate - передбачувана дата доставки

        • departure

          • sender

        — массив данных по отправителю
        • id — уникальный идентификатор отправителя в базе
          • - масив даних щодо відправника

            • id - унікальний ідентифікатор відправника в базі оператора доставки

            • title

          — название отправителяcontactPerson — массив данных по контактному лицу (передается только
            • - назва відправника

            • contactPerson - масив даних щодо контактної особи (передається тільки для deliveryOperatorType= **nova_poshta)

            • id

            — уникальный идентификатор контактного лица в базе
            • - унікальний ідентифікатор контактної особи в базі оператора доставки

            • name

            — имя контактного лица
            • - ім'я контактної особи

            • phone

            • - телефон

            контактного лица
            • контактної особи

          • type

          • - тип

          отправителя
          • відправника (ключ

          передается только
          • передається тільки для deliveryOperatorType= **ukrposhta) .

          Возможные значения
          • Можливі значення:

            • COMPANY

            — Юридическое лицо
            • - Юридична особа

            • PRIVATE_ENTREPRENEUR

            • - ФЛП

            • INDIVIDUAL

            — Физическое лицо
            • - Фізична особа

          • phone

          • - телефон

          отправителя
          • відправника (ключ

          передается только
          • передається тільки для deliveryOperatorType= **ukrposhta)

          • address

            • type

            • - тип

        адреса отправителя. Возможные значения
            • адреси відправника. Можливі значення: warehouse

            • geoObject

        — массив данных о складе отправителя
        • id — уникальный идентификатор города отправителя в базе
            • - масив даних про склад відправника

            • id - унікальний ідентифікатор міста відправника в базі оператора доставки

            • name

          — город отправителя
            • - місто відправника

            • warehouse (

        передается
            • передається для type = warehouse)

            • id

          — идентификатор склада отправителя в базе
            • - ідентифікатор складу відправника в базі оператора доставки

            • name

            • - склад

          отправителя
            • відправника

      • destination

        • recipient

        массив данных о получателе
        • name— имя получателя

        • surname— фамилия получателя

        • patronymic— отчество получателя

        • phone — телефон получателя

        address — массив данных об адресе получателя

        • type — тип адреса отправителя. Возможные значения- масив даних про одержувача

          • name- ім'я одержувача

          • surname- прізвище одержувача

          • patronymic- по батькові одержувача

          • phone - телефон одержувача

          • address - масив даних про адресу одержувача

          • type - тип адреси відправника. Можливі значення: warehouse / doors

          • geoObject

          — данные о городе
          • id — уникальный идентификатор города в базе - дані про місто

            • id - унікальний ідентифікатор міста в базі оператора доставки

            • name

            — город получателя
          warehouse — данные о складе (передается
            • - місто одержувача

          • warehouse - дані про склад (передається для type = warehouse)

          • id — уникальный идентификатор склада получателя в базе - унікальний ідентифікатор складу одержувача в базі оператора доставки

          • name - склад получателяодержувача

          • street

          — данные о адресе для курьерской
          • - дані про адресу для кур'єрської доставки (

          передается
          • передається для type = doors)

          • id — уникальный идентификатор улицы в базе - унікальний ідентифікатор вулиці в базі оператора доставки

          • name — название улицы- назва вулиці

          • buildingNumber

          • - номер

          дома получателя
          • будинку одержувача (

          передается
          • передається для type = doors)

          • flatNumber

          • - номер

          квартиры получателя
          • квартири одержувача (

          передается
          • передається для type = doors)

      • payment

      — данные об оплате услуг
      • - дані про оплату послуг за доставку

        • type

        • - тип

        оплаты услуг
        • оплати послуг доставки (ключ

        передается только
        • передається тільки при ****deliveryOperatorType= ****nova_poshta)

        • payer

        — плательщик
        • - платник за

        услуги
        • послуги доставки

        • redelivery

      — данные об обратной доставке
      • cost — сумма обратной
        • - дані про зворотне доставлення

        • cost - сума зворотної доставки

        • payer

        — плательщик
        • - платник за

        обратную
        • зворотну доставку

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

Panel
panelIconId1f195
panelIcon:new:
panelIconText🆕
bgColor#DEEBFF

Новый блок в ответе analytics — массив данных о источнике заказа и client_id

analytics — массив данных источнике заказа (utm-метки) и покупателе

...

Примітка: передача інформації про замовлення здійснюється мовою тієї версії сайту, на якій воно було зроблено.

Info

Блок analytics у відповіді — масив даних про джерело замовлення та client_id

  • analytics - масив даних про джерело замовлення (utm-мітки) і покупця

    • utm_source - ідентифікатор джерела трафіку;

    • utm_medium - конкретного маркетингового каналаканалу;

    • utm_campaign — идентификатор рекламной кампании- ідентифікатор рекламної кампанії;

    • utm_term — идентификатор ключевого - ідентифікатор ключового слова;

    • utm_content — идентификатор - ідентифікатор конткертного объявленияоголошення;

    • google_client_id — уникальный идентификатор пользователя- унікальний ідентифікатор користувача.

...

panelIconId1f195
panelIcon:new:
panelIconText🆕
bgColor#DEEBFF

...

Info

Додаткові дані — блок customer_details - только для b2b проектов

В Получение списка заказов добавляем дополнительные данные о покупателе - группу, к которой он относится и тип цены, назначенной этой группеОтримання списку замовлень додаємо додаткові дані про покупця - групу, до якої він належить і тип ціни, призначеної цій групі.

  • customer_details — массив дополнительных данных о покупателе - масив додаткових даних про покупця для b2b-проектовпроектів

    • group

      • id - id группы покупателей, к которой принадлежит покупательгрупи покупців, до якої належить покупець

      • title - название группы покупателей, к которой принадлежит покупательназва групи покупців, до якої належить покупець

    • price_level

      • id - id типа цены для группы покупателятипу ціни для групи покупця

      • title - название типа цены для группы покупателяназва типу ціни для групи покупця

 

Приклад PUT запиту

Code Block
languagejs
{
    "token": "c5bc0cd25647e701bc6427f3629b27b4",
    "from": "01.04.2021",
    "to": "03.04.2021",
    "additionalData": true
}

...