Перейти до основного вмісту

Отримання всіх оброблених замовлень за період​

URI: /api/v1/marketplace/order/all?start_date={start_date}&end_date={end_date}

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

Метод повертає тільки оброблені замовлення у статусах: processed_by_pharmacy, check, canceled, in_process_by_pharmacy, in_process_by_operator, in_process_by_operator, send_to_distributor, got_in_pharmacy.

Запит виконується методом GET.

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

Параметри URI​

Метод дозволяє передати в рядку запиту наступні параметри:

Ім'яТипОбов'язковийОпис
start_datestringТакВідобразити замовлення від дати
end_datestringТакВідобразити замовлення до дати

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

/api/v1/marketplace/order/all?start_date=2022-12-01&end_date=2022-12-07

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

Ім'яТипОпис
datalist[object]Дані замовлень
data.order_numberstringНомер замовлення
data.order_number_for_customerstringНомер замовлення для покупця
data.drugstore_order_idstringНомер замовлення аптеки
data.online_marketplace_order_codestringНомер замовлення онлайн площадки
data.fiscal_numberstringФіскальний номер чека продажу, присвоєний фіскальним реєстратором (ПРРО / РРО) або програмним забезпеченням
🛈 Присутній, якщо замовлення було успішно фіскалізовано
data.refund_fiscal_numberstringФіскальний номер чека повернення, присвоєний фіскальним реєстратором (ПРРО / РРО)
🛈 Присутній, якщо по замовленню була здійснена операція повернення коштів
data.order_deliveryobjectДані доставки
data.order_delivery.delivery_type_codestringКод типу доставки
data.order_delivery.ttnstringНомер ТТН
data.order_paymentobjectДані про оплату замовлення
data.order_payment.payment_method_codestringКод методу оплати
data.order_payment.total_paidfloatЗагальна оплачена сума
data.order_payment.terminal_idstringІдентифікатор термінала
data.order_payment.epzstringЕлектронний платіжний засіб
data.order_payment.midstringМерчант id
data.order_payment.card_typestringТип карти
data.order_payment.auth_codestringКод авторизації
data.order_payment.rrnstringУнікальний ідентифікатор банківської транзакції, який призначається банком Еквайєром під час ініціалізації платежу
data.order_payment.datetimestringДата та час операції у форматі: 2025-04-04 15:49:03
data.order_payment.namestringТип оплати
data.order_payment.payment_systemstringПлатіжна система
data.order_payment.cash_register_numberstringНомер касового апарату
data.pick_up_codestringНомер замовлення для видачі кур'єру
data.created_atstringДата і час створення замовлення
data.updated_atstringДата і час останнього оновлення замовлення
data.drugstoreobjectДані аптеки
data.drugstore.idstringІдентифікатор аптеки
data.drugstore.namestringНазва аптеки
data.drugstore.addressstringАдреса аптеки
data.sourceobjectНазва і код площадки, з якої поступило замовлення:
  • all - *
  • tabletki.ua - tabletki
  • aptekaskarb.ua - aptekaskarb
  • liki24.com - liki24
  • apteki.ua - geoapteka
  • glovoapp.com - glovo
  • telegram.org - telegram
  • own site - own
  • zdorovi.ua - zdorovi
  • atb.ua - atb
  • liki.ua - liki
  • viber.com - viber
  • helsi.me - helsi
data.source.namestringНазва площадки
data.source.codestringКод площадки
data.customerobjectДані покупця
data.customer.phone_numberstringНомер телефона
data.customer.last_namestringПрізвище
data.customer.first_namestringІм'я
data.customer.middle_namestringПо-батькові
data.customer.emailstringЕлектронна адреса
data.customer.insurance_card_numberstringНомер страхового полісу
data.customer.franchising_percentagenumericФраншиза
data.insuranceobjectДані страхової компанії
data.insurance.namestringНазва
data.insurance.codestringКод ЄДРПОУ
data.insurance.order_numberstringНомер замовлення
data.sales_agentobjectДані користувача який продав товар (якщо це користувач аптеки)
data.sales_agent.first_namestringІм'я
data.sales_agent.last_namestringПрізвище
data.sales_agent.middle_namestringПо-батькові
data.sales_agent.phonestringНомер телефона
data.online_drugstore_sitestringДжерело замовлення
data.statusobjectСтатус замовлення
data.status.commentstringНазва статусу
data.status.namestringКод статусу
data.commentstringКоментар до замовлення
data.cancel_reasonstringПричина відмови
data.goodslist[object]Перелік товарів
data.goods.goods_idsstringІдентифікатор товару
data.goods.namestringНазва товару
data.goods.quantitynumericКількість товару
data.goods.pricenumericВартість одиниці товару
data.goods.totalnumericЗагальна вартість товару
data.goods.batchstringПартія товару
goods.customer_bonusfloatСума бонусів, нарахована клієнту за всю позицію товару (у грн.)
goods.customer_discountfloatСума знижки (у грн.), застосована до всієї позиції товару (загальна знижка, а не знижка за одиницю)
goods.customer_paid_by_bonusfloatСума оплачена бонусами за позицію товару (у грн.)
data.total_include_franchising_percentagenumericЗагальна вартість замовлення з урахуванням франшизи

Приклад успішної відповіді​

200 OK

Відповідь: /api/v1/marketplace/order/all?start_date=2022-12-01&end_date=2022-12-07
{
    "data": [
        {
            "order_number": "58-63-72-43",
            "order_number_for_customer": "123456",
            "drugstore_order_id": "56699",
            "online_marketplace_order_code": "107613858",
            "fiscal_number": "123-HY",
            "refund_fiscal_number": "123-HYR", 
            "order_delivery": {
                "delivery_type_code": "PickUp",
                "ttn": "123456"
            },
            "order_payment": {
                "payment_method_code": "LiqPay",
                "total_paid": 123.09,
                "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",
                "cash_register_number": "001A" 
            },
            "pick_up_code": "123",
            "created_at": "2021-04-14 17:25:54",
            "updated_at": "2021-04-14 17:25:54",
            "drugstore": {
                "id": "255",
                "name": "Аптека №Дн050",
                "address": "Кіровоградська область, м.Кропивницький, вул.Соборна, 27б"
            },
            "source": {
                "name": "apteki.ua",
                "code": "geoapteka"
            },
            "customer": {
                "phone_number": "380000000000",
                "last_name": "TEST",
                "first_name": "TEST",
                "middle_name": "TEST",
                "email": "[email protected]"
            },
            "sales_agent": {
                "first_name": "test",
                "last_name": "test",
                "middle_name": "test",
                "phone": "380111111111"
            },
            "online_drugstore_site": "apteka-tas.com.ua",
            "status": {
                "comment": "Передан в обработку",
                "name": "created"
            },
            "comment": "ЭТО ТЕСТОВЫЙ ЗАКАЗ",
            "cancel_reason": null,
            "goods": [
                {
                    "goods_ids": ["1"],
                    "name": "Ацикловир мазь 25 мг/г туба 10 г №1",
                    "quantity": 0.5,
                    "price": 155,
                    "total": 77.5,
                    "batch": "123456",
                    "customer_bonus": 10, 
                    "customer_discount": 0,
                    "customer_paid_by_bonus": 7
                }
            ],
            "total": 77.5,
            "total_include_franchising_percentage": 38.75
        }
    ]
}