Отримання замовлення за номером
URI: /api/v1/marketplace/order/by-number/{order_number}
Метод використовується для отримання замовлення за його номером.
Запит виконується методом GET.
Авторизація
Запит повинен містити заголовок API-Key.
Headers:
API-Key: api_key
Параметри URI
| Ім'я | Тип | Обов'язковий | Опис |
|---|---|---|---|
| order_number | string | Так | Номер замовлення |
Приклад запиту
/api/v1/marketplace/order/by-number/4M-1P-8E-B5
Параметри відповіді
Метод повертає дані замовлення в об'єкті data.
| Ім'я | Тип | Опис |
|---|---|---|
| data | 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.preorder | boolean | Прапорець, що вказує, чи є замовлення попереднім замовленням: |
| data.order_delivery | object | Дані доставки |
| data.order_delivery.delivery_type_code | string | Код типу доставки: |
| 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 | Код типу оплати: |
| 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.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.company_name | string | Назва компанії покупця (юр. особа) |
| data.customer.company_edrpou | string | ЄДРПОУ компанії покупця (юр. особа) |
| data.customer.franchising_percentage | numeric | Франшиза |
| data.recipient | object | Дані отримувача |
| data.recipient.company_edrpou | string | ЄДРПОУ компанії отримувача (юр. особа) |
| data.recipient.company_name | string | Назва компанії отримувача (юр. особа) |
| data.recipient.last_name | string | Прізвище отримувача (фіз. особа) |
| data.recipient.first_name | string | Ім'я отримувача (фіз. особа) |
| data.recipient.middle_name | string | По-батькові отримувача (фіз. особа) |
| data.recipient.phone_number | string | Номер телефону отримувача |
| data.recipient.email | string | Email отримувача |
| data.recipient.edrpou | string | ЄДРПОУ отримувача (фіз. особа) |
| data.online_drugstore_site | string | Джерело замовлення |
| data.status | object | Статус замовлення |
| data.status.id | integer | Числовий ідентифікатор статусу замовлення |
| data.status.comment | string | Назва статусу |
| data.status.name | string | Код статусу |
| data.comment | string | Коментар до замовлення |
| data.cancel_reason | string | Причина відмови |
| data.refund_at | string | Дата і час повернення |
| data.goods | list[object] | Перелік товарів |
| data.goods.name | string | Назва товару |
| data.goods.goods_id | string | Ідентифікатор товару |
| data.goods.goods_ids | string | Список ідентифікаторів товару (може містити один або кілька ID) |
| data.goods.medication_id | string | null | ID товару EHealth |
| 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.goods.surcharge | float | Сума надбавки до вартості за позицію товару |
| data.goods.discount | float | Сума знижки за позицію, включаючи округлення (без урахування бонусних знижок і списаних бонусів) |
| data.total | numeric | Загальна вартість замовлення з урахуванням знижок і надбавок |
| data.total_include_franchising_percentage | numeric | Загальна вартість замовлення з урахуванням франшизи |
Приклад відповіді
Відповідь: /api/v1/marketplace/order/by-number/4M-1P-8E-B5
{
"data": {
"order_number": "4M-1P-8E-B5",
"fiscal_number": null,
"refund_fiscal_number": null,
"order_number_for_customer": "42-76-10",
"drugstore_order_id": "2842-010262",
"online_marketplace_order_code": null,
"preorder": false,
"order_delivery": {
"delivery_type_code": "pick_up",
"ettn": null,
"postcode": null,
"region": null,
"city": null,
"district": null,
"street": null,
"house_number": null,
"apartment_number": null,
"post_office_box": null
},
"order_payment": {
"payment_method_code": "cash_in_store",
"total_paid": null,
"terminal_id": null,
"epz": null,
"mid": null,
"card_type": null,
"auth_code": null,
"rrn": null,
"datetime": null,
"name": null,
"payment_system": null,
"cash_register_number": null
},
"created_at": "2026-10-13 16:52:58",
"updated_at": "2026-10-13 16:54:21",
"comment": "Замовлення з сайту Подорожник №12540706",
"cancel_reason": null,
"total": 511.84,
"total_include_franchising_percentage": 511.84,
"drugstore": {
"id": "f0a4c8b8-d697-11f0-a1ac-00155d050302",
"name": "Подорожник №2842",
"address": "м. Львів, просп. Червоної Калини, 54, прим.101"
},
"customer": {
"company_name": "",
"company_edrpou": "",
"first_name": "Євген",
"middle_name": "",
"last_name": "Камша",
"phone_number": "380956710516",
"email": "",
"edrpou": "",
"franchising_percentage": 100
},
"recipient": {
"company_edrpou": "",
"company_name": "",
"first_name": "",
"middle_name": "",
"last_name": "",
"phone_number": "",
"email": "",
"edrpou": ""
},
"source": {
"name": "own site",
"code": "own"
},
"online_drugstore_site": "podorozhnyk.android",
"status": {
"id": 12,
"comment": "Опрацьовано в аптеці",
"name": "processed_by_pharmacy"
},
"refund_at": null,
"goods": [
{
"name": "Ліпразид табл. 10мг №30",
"goods_id": "1cf6b0ee-7896-11e4-881f-001d60d868ae",
"goods_ids": [
"1cf6b0ee-7896-11e4-881f-001d60d868ae"
],
"preorder": false,
"quantity": 4,
"price": 79.35,
"batch": null,
"customer_bonus": 0,
"customer_discount": 0,
"customer_paid_by_bonus": 0,
"discount": 0,
"surcharge": 0,
"medication_id": null,
"total": 317.4
},
{
"name": "Магнікор табл. №100",
"goods_id": "6f46c6a8-7896-11e4-881f-001d60d868ae",
"goods_ids": [
"6f46c6a8-7896-11e4-881f-001d60d868ae"
],
"preorder": false,
"quantity": 2,
"price": 97.22,
"batch": null,
"customer_bonus": 0,
"customer_discount": 0,
"customer_paid_by_bonus": 0,
"discount": 0,
"surcharge": 0,
"medication_id": null,
"total": 194.44
}
]
}
}