Отримання всіх оброблених замовлень за період
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_date | string | Так | Відобразити замовлення від дати |
| end_date | string | Так | Відобразити замовлення до дати |
Приклад запиту
/api/v1/marketplace/order/all?start_date=2022-12-01&end_date=2022-12-07
Параметри відповіді
| Ім'я | Тип | Опис |
|---|---|---|
| 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.fiscal_number | string | Фіскальний номер чека продажу, присвоєний фіскальним реєстратором (ПР РО / РРО) або програмним забезпеченням 🛈 Присутній, якщо замовлення було успішно фіскалізовано |
| data.refund_fiscal_number | string | Фіскальний номер чека повернення, присвоєний фіскальним реєстратором (ПРРО / РРО) 🛈 Присутній, якщо по замовленню була здійснена операція повернення коштів |
| data.order_delivery | object | Дані доставки |
| data.order_delivery.delivery_type_code | string | Код типу доставки |
| data.order_delivery.ttn | string | Номер ТТН |
| data.order_payment | object | Дані про оплату замовлення |
| data.order_payment.payment_method_code | string | Код методу оплати |
| data.order_payment.total_paid | float | Загальна оплачена сума |
| data.order_payment.terminal_id | string | Ідентифікатор термінала |
| data.order_payment.epz | string | Електронний платіжний засіб |
| data.order_payment.mid | string | Мерчант id |
| data.order_payment.card_type | string | Тип карти |
| data.order_payment.auth_code | string | Код авторизації |
| data.order_payment.rrn | string | Унікальний ідентифікатор банківської транзакції, який призначається банком Еквайєром під час ініціалізації платежу |
| data.order_payment.datetime | string | Дата та час операції у форматі: 2025-04-04 15:49:03 |
| data.order_payment.name | string | Тип оплати |
| data.order_payment.payment_system | string | Платіжна система |
| data.order_payment.cash_register_number | string | Номер касового апарату |
| data.pick_up_code | string | Номер замовлення для видачі кур'єру |
| data.created_at | string | Дата і час створення замовлення |
| data.updated_at | string | Дата і час останнього оновлення замовлення |
| data.drugstore | object | Дані аптеки |
| data.drugstore.id | string | Ідентифікатор аптеки |
| data.drugstore.name | string | Назва аптеки |
| data.drugstore.address | string | Адреса аптеки |
| data.source | object | Назва і код площадки, з якої поступило замовлення:
|
| data.source.name | string | Назва площадки |
| data.source.code | string | Код площадки |
| data.customer | object | Дані покупця |
| data.customer.phone_number | string | Номер телефона покупця |
| data.customer.last_name | string | Прізвище покупця |
| data.customer.first_name | string | Ім'я покупця |
| data.customer.middle_name | string | По-батькові покупця |
| data.customer.email | string | Електронна адреса покупця |
| data.customer.edrpou | string | ЄДРПОУ покупця |
| data.customer.insurance_card_number | string | Номер страхового полісу |
| data.customer.franchising_percentage | numeric | Франшиза |
| data.insurance | object | Дані страхової компанії |
| data.insurance.name | string | Назва |
| data.insurance.code | string | Код ЄДРПОУ |
| data.insurance.order_number | string | Номер замовлення |
| data.sales_agent | object | Дані користувача який продав товар (якщо це користувач аптеки) |
| data.sales_agent.first_name | string | Ім'я |
| data.sales_agent.last_name | string | Прізвище |
| data.sales_agent.middle_name | string | По-батькові |
| data.sales_agent.phone | string | Номер телефона |
| data.doctor | object | Дані лікаря |
| data.doctor.id | string | Ідентифікатор лікаря аптечної мережі |
| data.doctor.name | string | Повне ім'я лікаря (ПІБ) |
| data.online_drugstore_site | string | Джерело замовлення |
| data.status | object | Статус замовлення |
| data.status.comment | string | Назва статусу |
| data.status.name | string | Код статусу |
| data.comment | string | Коментар до замовлення |
| data.cancel_reason | string | Причина відмови |
| data.goods | list[object] | Перелік товарів |
| data.goods.name | string | Назва товару |
| data.goods.goods_id | string | Ідентифікатор товару |
| data.goods.goods_ids | string | Список ідентифікаторів товару (може містити один або кілька ID) |
| data.goods.preorder | boolean | Прапорець, що вказує, чи є замовлення попереднім замовленням: |
| data.goods.quantity | numeric | Кількість товару |
| data.goods.price | numeric | Вартість одиниці товару |
| data.goods.total | numeric | Загальна вартість товару |
| data.goods.batch | string | Ідентифікатор партії товару |
| data.goods.customer_bonus | float | Сума бонусів, нарахована клієнту за всю позицію товару (у грн.) |
| data.goods.customer_discount | float | Сума знижки (у грн.), застосована до всієї позиції товару (загальна знижка, а не знижка за одиницю) |
| data.goods.customer_paid_by_bonus | float | Сума оплачена бонусами за позицію товару (у грн.) |
| data.total | numeric | Загальна вартість замовлення |
| data.total_include_franchising_percentage | numeric | Загальна вартість замовлення з урахуванням франшизи |
Приклад успішної відповіді
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]",
"edrpou": "67859302"
},
"sales_agent": {
"first_name": "test",
"last_name": "test",
"middle_name": "test",
"phone": "380111111111"
},
"doctor": {
"id": "123",
"name": "Іванов Степан Вікторович"
},
"online_drugstore_site": "apteka-tas.com.ua",
"status": {
"comment": "Передан в обработку",
"name": "created"
},
"comment": "ЭТО ТЕСТОВЫЙ ЗАКАЗ",
"goods": [
{
"name": "Ергоферон табл.№20",
"goods_id": "003ba928-16fe-4f6b-a751-747c645bd19a",
"goods_ids": [
"003ba928-16fe-4f6b-a751-747c645bd19a"
],
"preorder": false,
"quantity": 1,
"price": 329.5,
"total": 329.5,
"batch": "59436ffd-b3b9-11f0-9026-005056962e80",
"customer_bonus": 3.3,
"customer_discount": 0,
"customer_paid_by_bonus": 10
}
],
"total": 77.5,
"total_include_franchising_percentage": 38.75
}
]
}