Получение истории изменения сущностей

Изменено Вт, 18 Июл, 2023 на 5:56 PM

Route: https://cdek.orderadmin.ru/api/entity-versions
Method: GET
Headers: Accept: application/json
Authorization: basic

Получить историю изменения можно у следующих сущностей:

Orderadmin\Products\Entity\Order - заказ
Orderadmin\DeliveryServices\Entity\DeliveryRequest - заявка на доставку
Orderadmin\Storage\Entity\Item - единица хранения
Orderadmin\Storage\Entity\Movement\Acceptance - приемная накладная
Orderadmin\Products\Entity\Product\Offer - товар

Обязательные GET параметры:

Параметр	Значение
entity	Orderadmin\Products\Entity\Order (или другая сущность из списка выше)
filter[0[type]	eq
filter[0][field]	objectId
filter[0][value]	1234 (id сущности)

Также поддерживается фильтр по следующим полям:

action со значениями create или update - события создания или обновления
loggedAt - время логирования в формате 2023-07-18 17:24:00 (удобно использовать для фильтров gte и lte, подробнее про типы фильтров здесь: API Filter)

Пример запроса с указанием всех фильтров:

https://cdek.orderadmin.ru/api/entity-versions?entity=Orderadmin\Products\Entity\Order&filter[1][type]=gte&filter[1][field]=loggedAt&filter[1][value]=2023-07-18 16:24:00&filter[2][type]=eq&filter[2][field]=objectId&filter[2][value]=1&filter[0][type]=eq&filter[0][field]=action&filter[0][value]=update&per_page=250

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

{
    "_links": {
        "self": {
            "href": "..."
        },
        "first": {
            "href": "..."
        },
        "last": {
            "href": "..."
        },
        "next": {
            "href": "..."
        }
    },
    "_embedded": {
        "entity-version": [
            {
                "comment": null,
                "objects": {
                    "Orderadmin\\Products\\Entity\\Order": 29874343
                },
                "action": "update",
                "loggedAt": {
                    "date": "2023-07-18 17:19:55.000000",
                    "timezone_type": 1,
                    "timezone": "+03:00"
                },
                "objectId": "29874343",
                "objectClass": "Orderadmin\\Products\\Entity\\Order",
                "version": 1689689995,
                "data": {
                    "state": "assembled"
                },
                "username": "employee@cdek.ru",
                "id": 123192476,
                "executive": null,
                "_links": {
                    "self": {
                        "href": "https://cdek.orderadmin.ru/api/entity-versions/123192476"
                    }
                }
            }
        ]
    },
    "page_count": 53,
    "page_size": 1,
    "total_items": 53,
    "page": 1
}

В ответе содержится общая информации о записи и пользователе, изменившем сущность. В поле data содержится набор измененных полей.