Оновлення інформації про замовлення

URI: /api/v1/company/order

Метод використовується для оновлення інформації про замовлення.

Запит виконується методом POST з тілом запиту у json форматі.

⚠️ Запит повинен містити заголовок Accept: application/json

Параметри запиту

Ім'я	Тип	Обов'язковий	Опис
order_number	string	Так	Номер замовлення, яке необхідно оновити
delivery	object	Ні	Об'єкт, що містить інформацію про доставку замовлення
delivery.delivery_type_code	string	Так	Код типу доставки Можливі значення: pick_up — самовивіз ukr_post — Укрпошта nova_post — Нова пошта meest_express — Meest Express justin - Justin uklon — Uklon i_post — iPost
delivery.delivery.ettn	string	Ні	Електронний товарно-транспортний номер (ТТН)
delivery.postcode	string	Ні	Поштовий індекс адреси доставки
delivery.city	string	Ні	Місто доставки
delivery.region	string	Ні	Область доставки
delivery.district	string	Ні	Район міста / області доставки
delivery.street	string	Ні	Вулиця доставки
delivery.house_number	string	Ні	Номер будинку адреси доставки
delivery.apartment_number	string	Ні	Номер квартири / офісу адреси доставки
delivery.post_office_box	string	Ні	Номер поштової скриньки / відділення
payment	object	Ні	Об'єкт, що містить інформацію про оплату замовлення
payment.payment_method_code	string	Так	Код методу оплати Можливі значення: liq_pay — оплата карткою на сайті cash_on_delivery — оплата при отриманні товару cash_in_store — оплата в аптеці карткою або готівкою google_pay — оплата за допомогою Google Pay
payment.total_paid	number	Ні	Сума, яка вже оплачена, за наявності оплати
payment.terminal_id	string	Ні	Ідентифікатор терміналу
payment.epz	string	Ні	Додатковий ідентифікатор транзакції
payment.mid	string	Ні	Merchant ID (ідентифікатор продавця)
payment.card_type	string	Ні	Тип платіжної картки
payment.auth_code	string	Ні	Код авторизації транзакції
payment.rrn	string	Ні	Retrieval Reference Number (унікальний номер посилання транзакції)
payment.datetime	string	Ні	Дата та час оплати у форматі 2025-04-04 15:49:03
payment.name	string	Ні	Назва типу оплати
payment.payment_system	string	Ні	Назва платіжної системи

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

Запит: /api/v1/company/order

{
   "order_number":" P6-P8-K8-05", 
   "delivery":{ 
      "delivery_type_code":"ukr_post", 
      "ettn": "12345678975432157", 
      "postcode":"12345", 
      "city":"Київ",
      "region":"Киїівська обл",
      "district":"Київський",
      "street":"Братиславська",
      "house_number":"11",
      "apartment_number":"145",
      "post_office_box":"1245"
   },
   "payment":{ 
      "payment_method_code":"cash_on_delivery",
      "total_paid": 12,
      "terminal_id": "40904582",
      "epz": "4149XXXXXXXX5807",
      "mid": "493084867",
      "card_type": "VISA GOLD",
      "auth_code": "538296",
      "rrn": "000018706638",
      "datetime": "2025-04-04 15:49:03",
      "name": "KARTKA",
      "payment_system": "Test pay system"
   }
}

Параметри відповіді

Ім'я	Тип	Опис
data	list[object]	Масив, що містить деталі замовлень 🛈 Кожен об'єкт у цьому масиві представляє окреме замовлення
data.order_number	string	Унікальний номер (ідентифікатор) замовлення в системі
data.order_number_for_customer	string	Номер замовлення, видимий для клієнта
data.drugstore_order_id	string	Ідентифікатор замовлення в системі аптеки
data.online_marketplace_order_code	string	Код замовлення з онлайн-маркетплейсу (якщо замовлення надійшло звідти)
data.preorder	boolean	Прапорець, що вказує, чи є замовлення попереднім замовленням: true — попереднє замовлення false — ні
data.order_delivery	object	Об'єкт, що містить деталі доставки замовлення
data.order_delivery.delivery_type_code	string	Код типу доставки Можливі значення: pick_up — самовивіз ukr_post — Укрпошта nova_post — Нова пошта meest_express — Meest Express justin - Justin uklon — Uklon i_post — iPost
data.order_delivery.ettn	string	Електронний товарно-транспортний номер
data.order_delivery.postcode	string	Поштовий індекс адреси доставки
data.order_delivery.region	string	Область доставки
data.order_delivery.city	string	Місто доставки
data.order_delivery.district	string	Район міста / області доставки
data.order_delivery.street	string	Вулиця доставки
data.order_delivery.house_number	string	Номер будинку адреси доставки
data.order_delivery.apartment_number	string	Номер квартири / офісу адреси доставки
data.order_delivery.post_office_box	string	Номер поштової скриньки / відділення
data.order_payment	object	Об'єкт, що містить інформацію про оплату замовлення
data.order_payment.payment_method_code	string	Код методу оплати Можливі значення: liq_pay — оплата карткою на сайті cash_on_delivery — оплата при отриманні товару cash_in_store — оплата в аптеці карткою або готівкою google_pay — оплата за допомогою Google Pay
data.order_payment.total_paid	number	Cума реімбурсації
data.created_at	string	Дата та час створення замовлення у форматі 2024-03-15 14:08:28
data.updated_at	string	Дата та час останнього оновлення замовлення у форматі 2024-03-15 14:08:56
data.comment	string	Додатковий коментар до замовлення
data.cancel_reason	string	Причина скасування замовлення, якщо воно було скасоване
data.total	number	Загальна роздрібна сума чеку за замовлення
data.total_include_franchising_percentage	number	Загальна сума чеку з врахуванням відсотка франшизи (якщо застосовується)
data.drugstore	object	Об'єкт, що містить інформацію про аптеку, до якої належить замовлення
data.drugstore.id	string	Ідентифікатор аптеки
data.drugstore.name	string	Назва аптеки
data.drugstore.address	string	Адреса аптеки
data.customer	object	Об'єкт, що містить інформацію про клієнта, який зробив замовлення
data.customer.first_name	string	Ім'я клієнта
data.customer.middle_name	string	По батькові клієнта
data.customer.last_name	string	Прізвище клієнта
data.customer.phone_number	string	Номер телефону клієнта
data.customer.email	string	Адреса електронної пошти клієнта
data.source	object	Об'єкт, що містить інформацію про джерело замовлення
data.source.name	string	Назва джерела замовлення
data.source.code	string	Кодовий ідентифікатор джерела замовлення
data.online_drugstore_site	string	Адреса онлайн-сайту аптеки, де було зроблено замовлення
data.marketplace	object	Об'єкт, що містить інформацію про маркетплейс, через який надійшло замовлення
data.marketplace.marketplace_code	string	Кодовий ідентифікатор маркетплейсу
data.marketplace.marketplace_name	string	Назва маркетплейсу
data.order_id	integer	Унікальний внутрішній ID замовлення в системі
data.status	object	Об'єкт, що містить деталі поточного статусу замовлення
data.status.id	integer	Числовий ідентифікатор статусу замовлення
data.status.comment	string	Коментар до статусу замовлення
data.status.name	string	Символьний (кодовий) ідентифікатор статусу замовлення
data.goods	list[object]	Масив, що містить інформацію про товари в замовленні 🛈 Кожен об'єкт у масиві представляє окрему позицію товару
data.goods.preorder	boolean	Прапорець, що вказує, чи був товар у замовленні попереднім замовленням
data.goods.quantity	integer	Кількість одиниць даного товару в замовленні
data.goods.price	number	Роздрібна ціна за одиницю товару в позиції
data.goods.total	number	Загальна роздрібна сума за дану позицію товару
data.goods.name	string	Назва товару
data.goods.local_goods_ids	list[string]	Масив локальних ідентифікаторів товару в системі аптеки
data.goods.goods_id	integer	Унікальний ідентифікатор товару в загальній системі

Приклад відповіді

Відповідь: /api/v1/company/order

{
    "data": {
        "order_number": "P6-P8-K8-05",
        "order_number_for_customer": "57-04-81",
        "drugstore_order_id": null,
        "online_marketplace_order_code": null,
        "preorder": true,
        "order_delivery": {
            "delivery_type_code": "ukr_post",
            "ettn": "12345678975432157",
            "postcode": "12345",
            "region": "Киїівська обл",
            "city": "Київ",
            "district": "Київський",
            "street": "Братиславська",
            "house_number": "11",
            "apartment_number": "145",
            "post_office_box": "1245"
        },
        "order_payment": {
            "payment_method_code": "cash_on_delivery",
            "total_paid": 12
        },
        "created_at": "2024-08-14 16:40:02",
        "updated_at": "2024-08-14 16:44:01",
        "comment": null,
        "cancel_reason": null,
        "total": 98.5,
        "total_include_franchising_percentage": 98.5,
        "drugstore": {
            "id": "4868",
            "name": "Аптека №1, АТ \"УКРПОШТА\"",
            "address": "Київська обл. м. Київ, проспект Червоної Калини 1-В"
        },
        "customer": {
            "first_name": "тест",
            "middle_name": "тест",
            "last_name": "тест",
            "phone_number": "380999808034",
            "email": ""
        },
        "source": {
            "name": "aptekaskarb.ua",
            "code": "aptekaskarb"
        },
        "online_drugstore_site": "aptekaskarb.ua",
        "marketplace": {
            "marketplace_code": "aptekaskarb",
            "marketplace_name": "aptekaskarb.ua"
        },
        "order_id": 6428070937,
        "status": {
            "id": 21,
            "comment": "Опрацьовано в аптеці",
            "name": "processed_by_pharmacy"
        },
        "goods": [
            {
                "preorder": true,
                "quantity": 1,
                "price": 98.5,
                "total": 98.5,
                "name": "Соннат табл. в/о 7,5 мг №10",
                "local_goods_ids": [
                    "34356"
                ],
                "goods_id": 1588578
            }
        ]
    }
}