Отримання замовлення

URI: /api/v2/insurance/order/:order_number

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

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

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

Параметри URI

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

Ім'я	Тип	Обов'язковий	Опис
order_number	string	Так	Номер замовлення Pharmapoint або номер страхового замовлення

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

/api/v2/insurance/order/AX-EH-HE-M5

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

Ім'я	Тип	Опис
data	object	Дані замовлення
data.order_number	string	Номер замовлення
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.ttn	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.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.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	created - передано в обробку canceled_by_marketplace - скасування з площадки (страхові замовлення) check_by_online_site - продано через онлайн сайт
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/AX-EH-HE-M5

{
    "data": {
        "order_number": "AX-EH-HE-M5",
        "order_delivery": {
            "delivery_type_code": "PickUp",
            "ttn": "123456"
        },
        "order_payment": {
            "payment_method_code": "LiqPay"
        },
        "drugstore_order_id": "4788694",
        "drugstore_id": 5266,
        "legal_entity_name": "Фіалка ПП \"ФІАЛКА\"",
        "legal_entity_code": "24730163",
        "created_at": "2021-12-17 15:13:16",
        "updated_at": "2021-12-19 15:17:02",
        "customer": {
            "phone_number": "380674307847",
            "last_name": "Якобчук",
            "first_name": "Катерина",
            "middle_name": "Ігорівна",
            "email": null,
            "insurance_card_number": "20847693",
            "franchising_percentage": 0
        },
        "insurance": {
            "name": "ПРАТ \"СК \"ПРОВІДНА\"",
            "code": "23510137",
            "order_number": "660464"
        },
        "insurance_doctor_name": "Имя доктора страховой",
        "status": {
            "comment": "Отмена",
            "name": "canceled",
            "cancel_reason": "Истек срок резервирования"
        },
        "comment": null,
        "goods": [
            {
                "id": 1620103,
                "name": "Цефодокс пор. сусп. 100 мг/5 мл фл. 50 мл ",
                "quantity": 1,
                "price": 280.4,
                "total": 280.4
            }
        ],
        "total": 280.4,
        "total_include_franchising_percentage": 0
    }
}