Перейти до основного вмісту

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

URI: /api/v1/marketplace/order/by-number/{order_number}

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

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

Авторизація​

Запит повинен містити заголовок API-Key.

Headers:
API-Key: api_key

Параметри URI​

Ім'яТипОбов'язковийОпис
order_numberstringТакНомер замовлення

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

/api/v1/marketplace/order/by-number/4M-1P-8E-B5

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

Метод повертає дані замовлення в об'єкті data.

Ім'яТипОпис
dataobjectДані замовлення
data.order_numberstringНомер замовлення
data.order_number_for_customerstringНомер замовлення для покупця
data.drugstore_order_idstringНомер замовлення аптеки
data.online_marketplace_order_codestringНомер замовлення онлайн площадки
data.fiscal_numberstringФіскальний номер чека продажу, присвоєний фіскальним реєстратором (ПРРО / РРО) або програмним забезпеченням
🛈 Присутній, якщо замовлення було успішно фіскалізовано
data.refund_fiscal_numberstringФіскальний номер чека повернення, присвоєний фіскальним реєстратором (ПРРО / РРО)
🛈 Присутній, якщо по замовленню була здійснена операція повернення коштів
data.preorderbooleanПрапорець, що вказує, чи є замовлення попереднім замовленням:
  • true — попереднє замовлення
  • false — ні
  • data.order_deliveryobjectДані доставки
    data.order_delivery.delivery_type_codestringКод типу доставки:
  • pick_up - Самовивіз
  • ukr_post - Укрпошта
  • nova_post - Нова Пошта
  • meest_express - Meest Express
  • justin - Justin
  • uklon - Uklon
  • i_post - iPost
  • data.order_delivery.ettnstringНомер ТТН
    data.order_delivery.postcodestringПоштовий індекс отримувача
    data.order_delivery.regionstringОбласть отримувача
    data.order_delivery.citystringМісто отримувача
    data.order_delivery.districtstringРайон отримувача
    data.order_delivery.streetstringВулиця отримувача
    data.order_delivery.house_numberstringНомер будинку отримувача
    data.order_delivery.apartment_numberstringНомер квартири отримувача
    data.order_delivery.post_office_boxstringНомер поштової скриньки отримувача
    data.order_paymentobjectДані про оплату замовлення
    data.order_payment.payment_method_codestringКод типу оплати:
  • liq_pay - Оплата карткою на сайті
  • cash_on_delivery - Оплата при отриманні товару
  • cash_in_store - В аптеці карткою або готівкою
  • google_pay - Оплата за допомогою Google Pay
  • data.order_payment.total_paidfloatЗагальна оплачена сума
    data.order_payment.terminal_idstringІдентифікатор термінала
    data.order_payment.epzstringЕлектронний платіжний засіб
    data.order_payment.midstringМерчант id
    data.order_payment.card_typestringТип карти
    data.order_payment.auth_codestringКод авторизації
    data.order_payment.rrnstringУнікальний ідентифікатор банківської транзакції, який призначається банком Еквайєром під час ініціалізації платежу
    data.order_payment.datetimestringДата та час операції у форматі: 2025-04-04 15:49:03
    data.order_payment.namestringТип оплати
    data.order_payment.payment_systemstringПлатіжна система
    data.order_payment.cash_register_numberstringНомер касового апарату
    data.created_atstringДата і час створення замовлення
    data.updated_atstringДата і час останнього оновлення замовлення
    data.drugstoreobjectДані аптеки
    data.drugstore.idstringУнікальний ідентифікатор аптеки аптечної мережі
    data.drugstore.namestringНазва аптеки
    data.drugstore.addressstringАдреса аптеки
    data.sourceobjectНазва і код площадки, з якої поступило замовлення:
    • all - *
    • tabletki.ua - tabletki
    • aptekaskarb.ua - aptekaskarb
    • liki24.com - liki24
    • apteki.ua - geoapteka
    • glovoapp.com - glovo
    • telegram.org - telegram
    • own site - own
    • zdorovi.ua - zdorovi
    • atb.ua - atb
    • liki.ua - liki
    • viber.com - viber
    • helsi.me - helsi
    data.source.namestringНазва площадки
    data.source.codestringКод площадки
    data.customerobjectДані покупця
    data.customer.phone_numberstringНомер телефона покупця
    data.customer.last_namestringПрізвище покупця
    data.customer.first_namestringІм'я покупця
    data.customer.middle_namestringПо-батькові покупця
    data.customer.emailstringЕлектронна адреса покупця
    data.customer.edrpoustringЄДРПОУ покупця
    data.customer.company_namestringНазва компанії покупця (юр. особа)
    data.customer.company_edrpoustringЄДРПОУ компанії покупця (юр. особа)
    data.customer.franchising_percentagenumericФраншиза
    data.recipientobjectДані отримувача
    data.recipient.company_edrpoustringЄДРПОУ компанії отримувача (юр. особа)
    data.recipient.company_namestringНазва компанії отримувача (юр. особа)
    data.recipient.last_namestringПрізвище отримувача (фіз. особа)
    data.recipient.first_namestringІм'я отримувача (фіз. особа)
    data.recipient.middle_namestringПо-батькові отримувача (фіз. особа)
    data.recipient.phone_numberstringНомер телефону отримувача
    data.recipient.emailstringEmail отримувача
    data.recipient.edrpoustringЄДРПОУ отримувача (фіз. особа)
    data.online_drugstore_sitestringДжерело замовлення
    data.statusobjectСтатус замовлення
    data.status.idintegerЧисловий ідентифікатор статусу замовлення
    data.status.commentstringНазва статусу
    data.status.namestringКод статусу
    data.commentstringКоментар до замовлення
    data.cancel_reasonstringПричина відмови
    data.refund_atstringДата і час повернення
    data.goodslist[object]Перелік товарів
    data.goods.namestringНазва товару
    data.goods.goods_idstringІдентифікатор товару
    data.goods.goods_idsstringСписок ідентифікаторів товару (може містити один або кілька ID)
    data.goods.medication_idstring | nullID товару EHealth
    data.goods.preorderbooleanПрапорець, що вказує, чи є замовлення попереднім замовленням:
  • true — попереднє замовлення
  • false — ні
  • data.goods.quantitynumericКількість товару
    data.goods.pricenumericВартість одиниці товару
    data.goods.totalnumericЗагальна вартість товару з урахуванням знижок і надбавок
    data.goods.batchstringІдентифікатор партії товару
    data.goods.customer_bonusfloatСума бонусів, нарахована клієнту за всю позицію товару (у грн.)
    data.goods.customer_discountfloatСума знижки (у грн.), застосована до всієї позиції товару (загальна знижка, а не знижка за одиницю)
    data.goods.customer_paid_by_bonusfloatСума оплачена бонусами за позицію товару (у грн.)
    data.goods.surchargefloatСума надбавки до вартості за позицію товару
    data.goods.discountfloatСума знижки за позицію, включаючи округлення (без урахування бонусних знижок і списаних бонусів)
    data.totalnumericЗагальна вартість замовлення з урахуванням знижок і надбавок
    data.total_include_franchising_percentagenumericЗагальна вартість замовлення з урахуванням франшизи

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

    Відповідь: /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
    }
    ]
    }
    }