Отримання списку замовлень

URI: /api/v1/orders?start_date={start_date}&end_date={end_date}&edrpou={edrpou}&status={status}

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

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

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

Параметри URI

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

Ім'я	Тип	Обов'язковий	Опис
start_date	string	Ні	Дата початку періоду 🛈 У разі відсутності значення буде використано початок поточного дня
end_date	string	Ні	Дата закінчення періоду 🛈 У разі відсутності значення буде використано кінець поточного дня
edrpou	string	Ні	ЕДРПОУ юридичної особи, до якої належить аптека
status	string	Ні	Статус замовлення, за яким необхідно відфільтрувати список: refund сheck

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

/api/v1/orders?start_date=2024-03-06&end_date=2024-03-11&edrpou=12345678&status=check

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

Ім'я	Тип	Опис
data	list[object]	Масив, що містить деталі замовлень 🛈 Кожен об'єкт у цьому масиві представляє окреме замовлення
data.order_number	string	Унікальний номер (ідентифікатор) замовлення в системі
data.fiscal_number	string	Фіскальний номер чека продажу, присвоєний фіскальним реєстратором (ПРРО / РРО) або програмним забезпеченням 🛈 Присутній, якщо замовлення було успішно фіскалізовано
data.refund_fiscal_number	string	Фіскальний номер чека повернення, присвоєний фіскальним реєстратором (ПРРО / РРО) 🛈 Присутній, якщо по замовленню була здійснена операція повернення коштів
data.order_number_for_customer	string	Номер замовлення, видимий для клієнта
data.drugstore_order_id	string	Ідентифікатор замовлення в системі аптеки
data.online_marketplace_order_code	string	Код замовлення з онлайн-маркетплейсу (якщо замовлення надійшло звідти)
data.preorder	boolean	Прапорець, що вказує, чи є замовлення попереднім замовленням: true — попереднє замовлення false — ні
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	number	Cума реімбурсації
data.created_at	string	Дата та час створення замовлення у форматі 2024-03-15 14:08:28
data.updated_at	string	Дата та час останнього оновлення замовлення у форматі 2024-03-15 14:08:56
data.comment	string	Додатковий коментар до замовлення
data.cancel_reason	string	Причина скасування замовлення, якщо воно було скасоване
data.total	number	Загальна роздрібна сума чеку за замовлення
data.total_include_franchising_percentage	number	Загальна сума чеку з врахуванням відсотка франшизи (якщо застосовується)
data.recipe	object	Об'єкт, що містить інформацію про електронний рецепт, пов'язаний із замовленням
data.recipe.number	string	Номер електронного рецепту
data.recipe.repayment_code	string	Код погашення рецепту
data.recipe.total_include_reimbursement	number	Cума оплати після врахування реімбурсації
data.drugstore	object	Об'єкт, що містить інформацію про аптеку, до якої належить замовлення
data.drugstore.id	string	Ідентифікатор аптеки
data.drugstore.name	string	Назва аптеки
data.drugstore.address	string	Адреса аптеки
data.customer	object	Об'єкт, що містить інформацію про клієнта, який зробив замовлення
data.customer.first_name	string	Ім'я клієнта
data.customer.middle_name	string	По батькові клієнта
data.customer.last_name	string	Прізвище клієнта
data.customer.phone_number	string	Номер телефону клієнта
data.customer.email	string	Адреса електронної пошти клієнта
data.source	object	Об'єкт, що містить інформацію про джерело замовлення
data.source.name	string	Назва джерела замовлення
data.source.code	string	Кодовий ідентифікатор джерела замовлення
data.online_drugstore_site	string	Адреса онлайн-сайту аптеки, де було зроблено замовлення
data.marketplace	object	Об'єкт, що містить інформацію про маркетплейс, через який надійшло замовлення
data.marketplace.marketplace_code	string	Кодовий ідентифікатор маркетплейсу
data.marketplace.marketplace_name	string	Назва маркетплейсу
data.order_id	integer	Унікальний внутрішній ID замовлення в системі
data.status	object	Об'єкт, що містить деталі поточного статусу замовлення
data.status.id	integer	Числовий ідентифікатор статусу замовлення
data.status.comment	string	Коментар до статусу замовлення
data.status.name	string	Символьний (кодовий) ідентифікатор статусу замовлення
data.goods	list[object]	Масив, що містить інформацію про товари в замовленні 🛈 Кожен об'єкт у масиві представляє окрему позицію товару
data.goods.preorder	boolean	Прапорець, що вказує, чи був товар у замовленні попереднім замовленням
data.goods.quantity	integer	Кількість одиниць даного товару в замовленні
data.goods.price	number	Роздрібна ціна за одиницю товару в позиції
data.goods.total	number	Загальна роздрібна сума за дану позицію товару
data.goods.reimbursement_price	number	Ціна відшкодування (реімбурсації) за одиницю товару в позиції
data.goods.reimbursement_total	number	Загальна сума відшкодування (реімбурсації) за дану позицію товару
data.goods.surcharge_price	number	Ціна доплати покупцем за одиницю товару в позиції (після врахування реімбурсації)
data.goods.surcharge_total	number	Загальна сума доплати покупцем за дану позицію товару
data.goods.name	string	Назва товару
data.goods.local_goods_ids	list[string]	Масив локальних ідентифікаторів товару в системі аптеки
data.goods.goods_id	integer	Унікальний ідентифікатор товару в загальній системі

Приклад відповіді

Відповідь: /api/v1/orders?start_date=2024-03-06&end_date=2024-03-11&edrpou=12345678&status=check

{
    "data": [
        {
            "order_number": "3M-PM-BM-T3",
            "order_number_for_customer": "48-56-29",
            "drugstore_order_id": null,
            "online_marketplace_order_code": null,
            "preorder": true,
            "order_delivery": {
                "delivery_type_code": null,
                "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": "reimbursement",
                "total_paid": 42.81
            },
            "created_at": "2024-03-15 14:08:28",
            "updated_at": "2024-03-15 14:08:56",
            "comment": null,
            "cancel_reason": null,
            "total": 99.6, 
            "total_include_franchising_percentage": 99.6,
            "recipe": {
                "number": "0000-P9P5-3K72-XT33",
                "repayment_code": "1234",
                "total_include_reimbursement": 56.79 
            },
            "drugstore": {
                "id": "4868",
                "name": "Аптека №1, АТ \"УКРПОШТА\"",
                "address": "Київська обл. м. Київ, проспект Червоної Калини 1-В"
            },
            "customer": {
                "first_name": "TEST",
                "middle_name": "",
                "last_name": "TEST",
                "phone_number": "380000000000",
                "email": "[email protected]"
            },
            "source": {
                "name": "aptekaskarb.ua",
                "code": "aptekaskarb"
            },
            "online_drugstore_site": "aptekaskarb.ua",
            "marketplace": {
                "marketplace_code": "aptekaskarb",
                "marketplace_name": "aptekaskarb.ua"
            },
            "order_id": 5045095123,
            "status": {
                "id": 20,
                "comment": "Отправлено дистрибьютору",
                "name": "send_to_distributor"
            },
            "goods": [
                {
                    "preorder": true,
                    "quantity": 3,
                    "price": 33.2, 
                    "total": 99.6, 
                    "reimbursement_price": 14.27, 
                    "reimbursement_total": 42.81, 
                    "surcharge_price": 18.93, 
                    "surcharge_total": 56.79, 
                    "name": "Еналаприл табл. 20 мг блістер №20",
                    "local_goods_ids": [
                        "54535"
                    ],
                    "goods_id": 1608185
                }
            ]
        }
    ]
}