Курʼєри

У цьому розділі описано функціонал взаємодії з кур’єром. Базова адреса для функцій даного розділу /couriers.

Отримати список рейсів, які відбулися

GET /couriers/departures/archive

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

{
  "archive_departures": [
    {
      "delivery_type": "6ACF4335ACB54F9A9B39BA62D5666A77",
            "is_ratable": True
            "driver": {
        "name": "Матус Ярослав",
        "photo_url": "https://cdn.bm.parts/devapibox/devapibox/workers/a9a2b5bb3bf593200f48.jpeg",
                "phone": "+380983778800"
      },
      "waybill_uuid": "81CB005056BA39E811EEE85E5C32B013",
      "route": {
        "points": [
          {
            "delivery_address": "Соборності 50",
            "delivery_end": "2024-05-20T18:00:00Z"
          },
          {
            "delivery_address": "просп. Відродження 20/1",
            "delivery_end": "2024-06-20T18:00:00Z"
          }
        ]
      },
      "ttn": [
        {
          "uuid": "81CB005056BA39E811EEE85560F02AAB",
          "number": "00011974332",
          "document_type": "00003A4D"
        },
        {
          "uuid": "81CB005056BA39E811EEE8556F78FA89",
          "number": "00011974333",
          "document_type": "00003A4D"
        }
      ],
      "feedback": {
        "comment": "Все чудово",
        "score": 3
      }
    }
  ]
}

Ключі з обовʼязковими значеннями

Параметр Опис
delivery_type UUID типу доставки.
is_ratable Булеве поле, яке вказує на можливість оцінки курʼєра.
name(в driver) Прізвище та імʼя водія.
delivery_address Адреса доставки.
uuid UUID ТТН.
number(в ttn) Номер ТТН.
document_type Тип документу ТТН.

Отримати список активних рейсів

GET /couriers/departures/active

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

{
  "active_departures": [
    {
      "delivery_type": "6ACF4335ACB54F9A9B39BA62D5422A92",
            "total": {
                "sum": 109.00,
                "currency": "ГРН"
            },
            "weight": 1.75,
      "car": {
        "number": "ВК 5266 ІЕ",
        "name": "Renault Master 4 2.3 DCI L3H2 (NEW ГАРАНТІЯ)",
                "colour": "Red"
            },
            "driver": {
                "name": "Гережун Володимир",
                "photo_url": "https://cdn.bm.parts/devapibox/devapibox/workers/530ff56d8c270f991324.jpeg",
                "phone": "+380983778800"
      },
      "product_returns": true,
      "places": 4,
      "return_money": {
        "sum": 109.00,
        "currency": "ГРН"
      },
      "warehouse_name": "Луцьк",
      "route": {
        "points": [
          {
            "position": null,
            "will_arrive": null,
            "delivery_address": "Соборності 45"
          },
          {
            "position": 45,
            "will_arrive": "2024-05-21T18:00:00Z",
            "delivery_address": "Кравчука 48"
          }
        ],
        "start": "2024-05-21T12:37:00Z",
        "finish": "2024-05-21T18:00:00Z",
        "progress": 98
      },
      "ttn": [
        {
          "uuid": "81CB005056BA39E811EEE5EF5F4E1DDE",
          "number": "00011974317",
          "document_type": "00003A4D"
        },
        {
          "uuid": "81CB005056BA39E811EEE5F5AAD495EB",
          "number": "00011974320",
          "document_type": "00003A4D"
        }
      ],
      "returns": null
    }
  ]
}

Ключі з обовʼязковими значеннями

Параметр Опис
delivery_type UUID типу доставки.
weight Вага доставки.
number(в car) Державний номер автомобіля.
name(в car) Марка та бренд автомобіля.
name(в driver) Прізвище та імʼя водія.
places Кількість мість, яку займає доставка.
warehouse_name Назва складу з якого відбувається доставка.
delivery_address Адреса доставки.
uuid UUID ТТН.
number(в ttn) Номер ТТН.
document_type Тип документу ТТН.

Отримати кількість активних та архівних виїздів курʼєрів.

GET /couriers/departures/count

Кількість архівних виїздів повертається з глибиною два дні.

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

{
  "waybill_count": 2,
  "archived_waybill_count": 3
}

Ключі з обовʼязковими значеннями

Параметр Опис
waybill_count Кількість доставок, які відбуваються в даний момент.
archived_waybill_count Кількість доставок, які вже відбулися.

Отримати список позитивних та негативних тегів.

GET /couriers/tags

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

{
  "tags": {
    "positive": [
      {
        "uuid": "81D2005056BA39E811EF4288EDA8A264",
        "name": "Швидка доставка"
      },
      {
        "uuid": "81D2005056BA39E811EF4288F6CAD117",
        "name": "Чіткий графік доставки"
      }
    ],
    "negative": [
      {
        "uuid": "81D2005056BA39E811EF428909599270",
        "name": "Затримка в доставці"
      },
      {
        "uuid": "81D2005056BA39E811EF4289110CCC53",
        "name": "Поганий графік доставки"
      }
    ]
  }
}

Ключі з обовʼязковими значеннями

Параметр Опис
uuid UUID тегу.
name Назва тегу.

Оцінити водія

POST /couriers/rate/(string: waybill_uuid)
param waybill_uuid:
 uuid шляхового листа

Потрібно передати параметри в body запиту, наприклад:

{
  "comment": "Все супер",
  "rating": 5
  "tag_uuids": [
    "81D2005056BA39E811EF4288EDA8A26м",
    "81D2005056BA39E811EF4289110CCC53"
  ]
}

Ключі з обовʼязковими значеннями

Параметр Опис
rating Оцінка водія від 1 до 5.

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

{
  "success": true,
  "message": "Ви успішно оцінили водія"
}

Ключі з обовʼязковими значеннями

Параметр Опис
success Булеве значення, яке вказує на успішність оцінки.
message Текст про успішність оцінки.