Статусы по номеру накладной

Данный эндпоинт для отслеживания этапов обработки заказа и доставки груза, который предоставляет информацию о текущем состоянии накладной.

Метод запроса: GET

https://gateway.spark-dev.team/cabinet/api/invoice-status/<invoice_number>

Пример запроса для получения статусов накладной с номером накладной SP00078479:

https://gateway.spark-dev.team/cabinet/api/invoice-status/SP00078479

Пример ответа:

{
    "data": {
        "invoice_number": "SP00078479",
        "status_history": [
            {
                "status_name": "Заказ создан",
                "status_code": 201,
                "state": "waiting",
                "date": null
            },
            {
                "status_name": "Забирается курьером",
                "status_code": 202,
                "state": "waiting",
                "date": null
            },
            {
                "status_name": "Обработка груза на складе",
                "status_code": 225,
                "state": "waiting",
                "date": null
            },
            {
                "status_name": "Груз в пути",
                "status_code": 206,
                "state": "waiting",
                "date": null
            },
            {
                "status_name": "Доставляется курьером",
                "status_code": 210,
                "state": "waiting",
                "date": null
            }
        ]
    }
}

Пример ответа (отмененная накладная):

{
    "data": {
        "invoice_number": "SP00300369",
        "client_sla_date": "23.08.2024",
        "cash_sum": null,
        "status_history": [
            {
                "status_name": "Заказ создан",
                "status_code": 201,
                "state": "completed",
                "date": "17.08.2024",
                "predict_date": "17.08.2024"
            },
            {
                "status_name": "Забор груза отменен",
                "status_code": 204,
                "state": "canceled",
                "date": "17.08.2024",
                "predict_date": null
            },
            {
                "status_name": "Груз забран у отправителя",
                "status_code": 203,
                "state": "waiting",
                "date": null,
                "predict_date": "18.08.2024"
            },
            {
                "status_name": "Груз обработан и ожидает отправку",
                "status_code": 205,
                "state": "waiting",
                "date": null,
                "predict_date": "20.08.2024"
            },
            {
                "status_name": "Груз в пути",
                "status_code": 206,
                "state": "waiting",
                "date": null,
                "predict_date": "22.08.2024"
            },
            {
                "status_name": "Груз в городе назначения",
                "status_code": 208,
                "state": "waiting",
                "date": null,
                "predict_date": "22.08.2024"
            },
            {
                "status_name": "Доставляется курьером",
                "status_code": 210,
                "state": "waiting",
                "date": null,
                "predict_date": "23.08.2024"
            },
            {
                "status_name": "Доставлен",
                "status_code": 211,
                "state": "waiting",
                "date": null,
                "predict_date": "23.08.2024"
            }
        ]
    }
}

Пример ответа (доставленная накладная):

{
    "data": {
        "invoice_number": "SP00234720",
        "client_sla_date": "08.01.2024",
        "cash_sum": null,
        "status_history": [
            {
                "status_name": "\u0417\u0430\u043a\u0430\u0437 \u0441\u043e\u0437\u0434\u0430\u043d",
                "status_code": 201,
                "state": "completed",
                "date": "01.01.2024",
                "predict_date": "01.01.2024"
            },
            {
                "status_name": "\u0413\u0440\u0443\u0437 \u0437\u0430\u0431\u0440\u0430\u043d \u0443 \u043e\u0442\u043f\u0440\u0430\u0432\u0438\u0442\u0435\u043b\u044f",
                "status_code": 203,
                "state": "completed",
                "date": "03.01.2024",
                "predict_date": "03.01.2024"
            },
            {
                "status_name": "\u0413\u0440\u0443\u0437 \u043e\u0431\u0440\u0430\u0431\u043e\u0442\u0430\u043d \u0438 \u043e\u0436\u0438\u0434\u0430\u0435\u0442 \u043e\u0442\u043f\u0440\u0430\u0432\u043a\u0443",
                "status_code": 205,
                "state": "completed",
                "date": "03.01.2024",
                "predict_date": "04.01.2024"
            },
            {
                "status_name": "\u0413\u0440\u0443\u0437 \u0432 \u043f\u0443\u0442\u0438",
                "status_code": 206,
                "state": "completed",
                "date": "03.01.2024",
                "predict_date": "05.01.2024"
            },
            {
                "status_name": "\u0413\u0440\u0443\u0437 \u0432 \u0433\u043e\u0440\u043e\u0434\u0435 \u043d\u0430\u0437\u043d\u0430\u0447\u0435\u043d\u0438\u044f",
                "status_code": 208,
                "state": "completed",
                "date": "04.01.2024",
                "predict_date": "05.01.2024"
            },
            {
                "status_name": "\u0414\u043e\u0441\u0442\u0430\u0432\u043b\u044f\u0435\u0442\u0441\u044f \u043a\u0443\u0440\u044c\u0435\u0440\u043e\u043c",
                "status_code": 210,
                "state": "completed",
                "date": "08.01.2024",
                "predict_date": "08.01.2024"
            },
            {
                "status_name": "\u0414\u043e\u0441\u0442\u0430\u0432\u043b\u0435\u043d",
                "status_code": 211,
                "state": "completed",
                "date": "08.01.2024",
                "predict_date": "08.01.2024"
            }
        ]
    }
}

Статусы:

Код	Наименование	Описание
201	Заказ создан	Статус приходит после создания заказа
202	Забирается курьером	Статус приходит, когда назначили курьера на забор груза
203	Груз забран у отправителя	Статус приходит, когда курьер забрал груз у отправителя
204	Забор груза отменен	Статус приходит, когда заказ отменили
225	Обработка груза на складе	Статус приходит, когда курьер привез груз на склад
205	Груз обработан и ожидает отправку	Статус приходит, когда груз обработали на складе и подготовили для отправки
206	Груз в пути	Статус приходит, когда груз отправили на доставку в город назначения
208	Груз в городе назначения	Статус приходит, когда груз прибыл в город назначения
210	Доставляется курьером	Статус приходит, когда груз выдан на доставку курьеру
211	Доставлен	Статус приходит, когда груз доставлен