Отримання переліку замовлень
URI: /api/v2/insurance/order?status={status}&start_date={start_date}&end_date={end_date}
Метод використовується для отримання переліку замовлень страхової компанії, створених на платформі Pharmapoint.
Запит виконується методом GET.
⚠️ Запит повинен містити заголовок Accept: application/json
Параметри URI
Метод дозволяє передати в рядку запиту наступні параметри:
| Ім'я | Тип | Обов'язковий | Опис |
|---|---|---|---|
| status | string | Ні | Статус замовлення:
|
| start_date | string | Ні | Початок періоду у форматі YYYY-MM-DD 🛈 За замовчуванням використовується дата, що на 1 місяць менша за поточну. Період запиту не може перевищувати 1 місяць |
| end_date | string | Ні | Кінець періоду у форматі YYYY-MM-DD |
Увага!
Якщо параметри start_date та end_date не передані, за замовчуванням буде використано період за останній місяць. Максимально допустимий період між start_date та end_date — 1 місяць
Приклад запиту
/api/v2/insurance/order?status=canceled&start_date=2026-05-01&end_date=2026-05-25
Параметри відповіді
| Ім'я | Тип | Опис |
|---|---|---|
| data | list[object] | Список замовлень |
| data.order_number | string | Номер замовлення |
| data.drugstore_order_id | string | Ідентифікатор замовлення для аптеки |
| data.drugstore_id | integer | Ідентифікатор аптеки |
| data.legal_entity_name | string | Назва юридичної особи |
| data.legal_entity_code | string | Код юридичної особи |
| data.created_at | string | Дата і час створення замовлення |
| data.updated_at | string | Дата і час останнього оновлення замовлення |
| data.order_delivery | object | Дані доставки |
| data.order_delivery.delivery_type_code | string | Код типу доставки |
| data.order_delivery.ettn | string | Номер ТТН |
| data.order_payment | object | Дані про оплату |
| 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.insurance_card_number | string | Номер страхової картки покупця |
| data.customer.franchising_percentage | integer | Відсоток франшизи |
| data.insurance | object | Дані страхової компанії |
| data.insurance.name | string | Назва страхової компанії |
| data.insurance.code | string | Код ЄДРПОУ |
| data.insurance.order_number | string | Номер замовлення страхової компанії |
| data.insurance_doctor_name | string | Ім'я лікаря страхової компанії |
| data.status | object | Статус замовлення |
| data.status.comment | string | Назва статусу |
| data.status.name | string | Код статусу |
| data.status.cancel_reason | string | Причина скасування |
| data.comment | string | Коментар до замовлення |
| data.goods | list[object] | Товари в замовленні |
| data.goods.id | integer | Внутрішній ідентифікатор товару |
| data.goods.name | string | Назва товару |
| data.goods.quantity | float | Кількість товару |
| data.goods.price | float | Вартість одиниці товару |
| data.goods.total | float | Загальна вартість товару |
| data.total | float | Загальна вартість замовлення |
| data.total_include_franchising_percentage | float | Загальна вартість замовлення з урахуванням франшизи |
Приклад успішної відповіді
200 OK
Відповідь: /api/v2/insurance/order?status=canceled&start_date=2026-05-01&end_date=2026-05-25
{
"data": [
{
"order_number": "HK-K7-8E-45",
"drugstore_order_id": "18017666",
"drugstore_id": 39118,
"legal_entity_name": "ТОВ \"АВ МЕДТРЕЙД\"",
"legal_entity_code": "44220962",
"created_at": "2026-04-28 20:48:01",
"updated_at": "2026-04-30 20:53:04",
"customer": {
"phone_number": "380665778316",
"last_name": "Котенко",
"first_name": "Олена",
"middle_name": null,
"email": null,
"insurance_card_number": "Arx00787-0281",
"franchising_percentage": 0
},
"insurance": {
"name": "ТОВ «ЕНШУРІА АСИСТАНС УКРАЇНА»",
"code": "46074995",
"order_number": null
},
"insurance_doctor_name": null,
"status": {
"comment": "Відміна",
"name": "canceled",
"cancel_reason": "Закінчився термін резерву"
},
"comment": null,
"goods": [
{
"id": 1786539,
"name": "Вольтарен форте гель 2,32% туба 50 г №1",
"quantity": 1,
"price": 348,
"total": 348
}
],
"total": 348,
"total_include_franchising_percentage": 0
},
{
"order_number": "AA-B4-7B-E4",
"drugstore_order_id": "2132898",
"drugstore_id": 41469,
"legal_entity_name": "ТОВАРИСТВО З ОБМЕЖЕНОЮ ВІДПОВІДАЛЬНІСТЮ «ФАРМАСТОР»",
"legal_entity_code": "34048360",
"created_at": "2026-05-22 10:37:53",
"updated_at": "2026-05-25 11:04:56",
"customer": {
"phone_number": "380932626028",
"last_name": "Левченко",
"first_name": "Софія",
"middle_name": "Едуардівна",
"email": null,
"insurance_card_number": "111444333",
"franchising_percentage": 15
},
"insurance": {
"name": "ТОВ «ЕНШУРІА АСИСТАНС УКРАЇНА»",
"code": "46074995",
"order_number": null
},
"insurance_doctor_name": null,
"status": {
"comment": "Відміна",
"name": "canceled",
"cancel_reason": "Вийшов термін бронювання"
},
"comment": null,
"goods": [
{
"id": 1758172,
"name": "Нурофєн форте табл. в/о 400 мг №12",
"quantity": 1,
"price": 153.64,
"total": 153.64
},
{
"id": 1720800,
"name": "Но-шпа табл. 40 мг №24",
"quantity": 1,
"price": 123.26,
"total": 123.26
}
],
"total": 276.9,
"total_include_franchising_percentage": 41.54
}
]
}