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

Скасування замовлення

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

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

Запит виконується методом DELETE у json форматі.

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

Параметри URI

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

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

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

/api/v2/insurance/order/11-P9-6B-K6

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

Ім'яТипОпис
dataobjectДані замовлення
data.order_numberstringНомер замовлення
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.ttnstringНомер ТТН
    data.order_paymentobjectДані про оплату замовлення
    data.order_payment.payment_method_codestringКод типу оплати:
  • liq_pay - Оплата карткою на сайті
  • cash_on_delivery - Оплата при отриманні товару
  • cash_in_store - В аптеці карткою або готівкою
  • google_pay - Оплата за допомогою Google Pay
  • data.created_atstringДата і час створення замовлення
    data.updated_atstringДата і час останнього оновлення замовлення
    data.customerobjectДані покупця
    data.customer.phone_numberstringНомер телефону покупця
    data.customer.last_namestringПрізвище покупця
    data.customer.first_namestringІм'я покупця
    data.customer.middle_namestringПо батькові покупця
    data.customer.emailstringЕлектронна пошта покупця
    data.customer.insurance_card_numberstringНомер страхової картки покупця
    data.customer.franchising_percentageinteger
    data.insuranceobjectДані страхової компанії
    data.insurance.namestringНазва страхової компанії
    data.insurance.codestringКод ЄДРПОУ
    data.insurance.order_numberstringНомер замовлення
    data.statusobjectСтатус замовлення
    data.status.commentstringНазва статусу
    data.status.namestring
    • created - передано в обробку
    • canceled_by_marketplace - скасування з площадки (страхові замовлення)
    • check_by_online_site - продано через онлайн сайт
    data.commentstringКоментар до замовлення
    data.goodslist[object]Товари в замовленні
    data.goods.idintegerВнутрішній ідентифікатор товару
    data.goods.namestringНазва товару
    data.goods.quantityfloatКількість товару
    data.goods.pricefloatВартість одиниці товару
    data.goods.totalfloatЗагальна вартість товару
    data.totalfloatЗагальна вартість замовлення
    data.total_include_franchising_percentagefloatЗагальна вартість замовлення з урахуванням франшизи

    Приклад успішної відповіді

    200 OK

    Відповідь: /api/v2/insurance/order/11-P9-6B-K6
    {
    "data": {
    "order_number": "11-P9-6B-K6",
    "order_delivery": {
    "delivery_type_code": "PickUp",
    "ttn": "123456"
    },
    "order_payment": {
    "payment_method_code": "LiqPay"
    },
    "created_at": "2020-11-20 12:20:23",
    "updated_at": "2020-11-20 12:20:30",
    "customer": {
    "phone_number": "380000000000",
    "last_name": "TEST",
    "first_name": "TEST",
    "middle_name": "TEST",
    "email": "[email protected]",
    "insurance_card_number": "100000",
    "franchising_percentage": 10
    },
    "insurance": {
    "name": "СК",
    "code": "31231231",
    "order_number": "100"
    },
    "status": {
    "comment": "Отмена с площадки",
    "name": "canceled_by_marketplace"
    },
    "comment": "комментарий",
    "goods": [
    {
    "id": 1916798,
    "name": "Нурофен экспресс форте капс. мягкие 400 мг №20",
    "quantity": 1,
    "price": 192.88,
    "total": 192.88
    }
    ],
    "total": 192.88,
    "total_include_franchising_percentage": 19.29
    }
    }