Параметр | Тип | Обязательность | Описание |
---|---|---|---|
page | число | нет | Номер страницы |
limit | число | нет | Количество записей на странице |
sort | строка | нет | Используется при get запросе. Сортировка по столбцу. Допустимые значения: id, -id, name, -name, type, -type, campaign, campaign |
Код ответа | Описание |
---|---|
200 ОК | Положительный статус запроса |
401 Unauthorized | Доступ запрещен, невалидный токен |
Параметр | Тип | Обязательность | Описание |
---|---|---|---|
id | число | да | идентификатор креатива |
Код ответа | Описание |
---|---|
200 ОК | Статус успешного запроса |
401 Unauthorized | Доступ запрещен |
404 Not found | Идентификатор креатива не найден |
Код ответа | Описание |
---|---|
201 Created | Креатив создан |
401 Unauthorized | Доступ запрещен, невалидный токен |
422 Unprocessable Content | Некорректный запрос |
Параметр | Тип | Обязательность | Описание |
---|---|---|---|
id | число | да | идентификатор креатива |
Код ответа | Описание |
---|---|
200 ОК | Запрос выполнен |
401 Unauthorized | Доступ запрещен, невалидный токен |
404 Not found | Идентификатор креатива не найден |
422 Unprocessable Content | Некорректный запрос |
Параметр | Тип | Обязательность | Описание |
---|---|---|---|
id | число | да | идентификатор креатива |
Код ответа | Описание |
---|---|
204 No Content | Статус успешного запроса |
401 Unauthorized | Доступ запрещен, невалидный токен |
400 Bad Request | У объекта есть зависящие сущности, мешающие удалению |
404 Not found | Идентификатор креатива не найден |
Параметр | Тип | Обязательность | Описание |
---|---|---|---|
id | число | да | идентификатор креатива |
Код ответа | Описание |
---|---|
200 ОК | Статус успешного запроса |
401 Unauthorized | Доступ запрещен, невалидный токен |
404 Not found | Идентификатор креатива не найден |
Код ответа | Описание |
---|---|
200 ОК | Запрос выполнен |
401 Unauthorized | Доступ запрещен, невалидный токен |
422 Unprocessable Content | Некорректный запрос |
Код ответа | Описание |
---|---|
200 ОК | Запрос выполнен |
401 Unauthorized | Доступ запрещен, невалидный токен |
Параметр | Тип | Обязательность | Описание |
---|---|---|---|
contract_id | число, массив | Условно обязательно | Идентификатор договора (отсылка к ранее зарегистрированному договору/доп.соглашению),
в случае саморекламы передается NULL Для "co_branding": true передается массив id договоров. В массиве должно быть указано как минимум два договора. |
self_promotion _organization_id | число | Условно обязательно | Обязательно в случае, если креатив является саморекламой. Указывается id организации - владельца |
co_branding | булево | нет | Признак совместных кампаний (кобрендинг). Данный параметр является необязательным. Если не передавать, по умолчанию проставляется как false |
description | строка (1000) | да | Общее описание объекта рекламирования |
campaign | строка (255) | да | Тип рекламной компании. Возможные значения: other - Иное; cpm - CPM; cpc - CPC; cpa - CPA. |
campaign _name | строка (255) | нет | Название рекламной кампании |
published_at | дата (date) | да | Дата добавления |
type | строка (255) | да | Тип распространения рекламы. Возможные значения:
|
url | массив строк (2000) | нет | Целевая ссылка (URL)
|
is_social | булево | нет | Признак социальной рекламы |
is_native | булево | да | Признак нативной рекламы |
kktu | массив строк | нет | Массив кодов справочника ККТУ (классификатора категорий товаров и услуг)
Если «co_branding»=false или не передано (null), то должен быть передан один элемент в массиве. Если «co_branding»=true, может быть 1 и более элементов в массиве. Значения в массиве должны передаваться в соответствии со значений в справочнике ККТУ. |
external_id | строка (255) | да | Учетный идентификатор в базе пользователя |
limit | число | нет | Используется при get запросе. Количество записей при пагинации на странице. |
page | число | нет | Используется при get запросе. Номер страницы при пагинации на странице |
sort | строка | нет | Используется при get запросе. Сортировка по столбцу. Допустимые значения: id, -id, name, -name, type, -type, campaign, campaign |
dependent_relationships | массив | не заполняется | Связанные (дочерние) объекты. Пример: "dependent_relationships": [ {"name": "statistics", "id": 15} ] |
include | Строка | нет | Параметр для получения статусов сущностей для GET запроса, значение – lastEntity пример использования (https://api.ord-a.ru/api/v2/creatives?include=erirEntity)В json ответе от сервера появятся данные: ... "erir_entity": { "id": 10454, "status": "Регистрация", "status_label": "registration", "last_item": { "id": 15148, "status": "Регистрация", "status_label": "registration", "errors": [], "message": null, "created_at": "2024-07-18T11:55:20+03:00", "pending_at": "2024-07-18T12:00:20+03:00", "status_changed_at": "2024-07-18T12:00:23+03:00" }, "registered_at": null, "created_at": "2024-07-18T11:55:19+03:00" } ... |
filter[option] | строка | нет | Параметр для поиска записей сущностей для GET запроса, допустимые значения - id, idNumber, name, erid, type, contract-type, campaign, contract, contract_id, created_at, campaign_name, url. Для фильтра type доступные значения - audio-rec, banner, live-audio, live-video, text-block, text-graphic-block, video, other. Для фильтра contract-type доступные значения - contract, intermediary-contract, additional-agreement, self-promotion. Для фильтра campaign доступные значения - cpa, cpc, cpm, other. |
Параметр | Тип | Обязательность | Описание |
---|---|---|---|
creative_id | число | да | идентификатор креатива |
Код ответа | Описание |
---|---|
200 ОК | Статус успешного запроса |
401 Unauthorized | Доступ запрещен, невалидный токен |
403 Forbidden | Ошибка |
Параметр | Тип | Обязательность | Описание |
---|---|---|---|
creative_id | число | да | идентификатор креатива |
id | число | да | идентификатор пункта креатива |
Код ответа | Описание |
---|---|
200 ОК | Статус успешного запроса |
401 Unauthorized | Доступ запрещен, невалидный токен |
403 Forbidden | Ошибка |
Параметр | Тип | Обязательность | Описание |
---|---|---|---|
creative_id | число | да | идентификатор креатива |
Код ответа | Описание |
---|---|
201 Created | Запрос выполнен |
401 Unauthorized | Доступ запрещен, невалидный токен |
422 Unprocessable Content | Ошибка во входных данных |
Параметр | Тип | Обязательность | Описание |
---|---|---|---|
creative_id | число | да | идентификатор креатива |
id | число | да | идентификатор пункта креатива (items) |
Код ответа | Описание |
---|---|
200 OK | Запрос выполнен |
401 Unauthorized | Доступ запрещен, невалидный токен |
403 Forbidden | Ошибка |
Параметр | Тип | Обязательность | Описание |
---|---|---|---|
creative_id | число | да | идентификатор креатива |
id | число | да | идентификатор пункта креатива (items) |
Код ответа | Описание |
---|---|
200 OK | Запрос выполнен |
401 Unauthorized | Доступ запрещен, невалидный токен |
403 Forbidden | Ошибка |
Параметр | Тип | Обязательность | Описание |
---|---|---|---|
creative_id | число | да | идентификатор креатива |
Код ответа | Описание |
---|---|
200 OK | Запрос выполнен |
401 Unauthorized | Доступ запрещен, невалидный токен |
403 Forbidden | Ошибка |
Параметр | Тип | Обязательность | Описание |
---|---|---|---|
creative_id | число | да | идентификатор креатива, к которому крепится медиафайл / текстовые данные |
id | число | да | идентификатор загруженного объекта |
media | строка, file | Условно обязательно |
Обязательно если форма распространения креатива (type):
Значение "zip" может быть указано только для формы распространения креатива (form) HTML5-баннер (banner-html5) |
text_data | строка (65000) | Условно обязательно |
Обязательно если форма распространения креатива (type):
|
description | строка (1000) | нет | Заполняется, если передается "media" в формате "Изображение". Возможные расширения для формата "Изображение":
Если не заполнено, будет подтягиваться автоматически из поля «description» (Описание объекта рекламирования) соответствующего креатива. |
external_id | строка (255) | нет | Учетный идентификатор в базе пользователя |
media_id | число | да | Идентификатор медиа, полученный при использовании пункта 3.8.2 |
Код ответа | Описание |
---|---|
200 OK | Статус успешного запроса |
401 Unauthorized | Доступ запрещен, невалидный токен |
Код ответа | Описание |
---|---|
200 OK | Статус успешного запроса |
401 Unauthorized | Ошибка во входных данных |
Параметр | Тип | Обязательность | Описание |
---|---|---|---|
id | число | да | идентификатор креатива |
Код ответа | Описание |
---|---|
204 OK | Запрос выполнен |
401 Unauthorized | Доступ запрещен, невалидный токен |
404 Not Found | Медиафайл не найден |
Параметр | Тип | Обязательность | Описание |
---|---|---|---|
id | число | да | идентификатор медиа |
media[] | array file | да | Массив медиа для загрузки |
Параметр | Тип | Обязательность | Описание |
---|---|---|---|
page | число | нет | Номер страницы |
limit | число | нет | Количество записей на странице |
sort | строка | нет | Используется при get запросе. Сортировка по столбцу. Допустимые значения: id, -id, number, -number, date, -date, amount, -amount |
Код ответа | Описание |
---|---|
200 OK | Положительный статус запроса |
401 Unauthorized | Доступ запрещен, невалидный токен |
Параметр | Тип | Обязательность | Описание |
---|---|---|---|
id | число | нет | идентификатор акта |
Код ответа | Описание |
---|---|
200 OK | Статус успешного запроса |
401 Unauthorized | Доступ запрещен, невалидный токен |
404 Not found | Идентификатор акта не найден |
Код ответа | Описание |
---|---|
201 Created | Акт создан |
401 Unauthorized | Доступ запрещен, невалидный токен |
422 Unprocessable Content | Некорректный запрос |
Параметр | Тип | Обязательность | Описание |
---|---|---|---|
id | число | да | идентификатор акта |
Код ответа | Описание |
---|---|
200 OK | Статус успешного запроса |
401 Unauthorized | Доступ запрещен, невалидный токен |
404 Not found | Идентификатор акта не найден |
422 Unprocessable Content | Некорректный запрос |
Код ответа | Описание |
---|---|
200 ОК | Статус успешного запроса |
401 Unauthorized | Доступ запрещен, невалидный токен |
422 Unprocessable Content | Некорректный запрос |
Параметр | Тип | Обязательность | Описание |
---|---|---|---|
id | число | да | идентификатор акта |
relations | булево | Условно обязательно | Параметр, определяющий удаление связанных invoice_items. При передаче true удаляются invoices и invoice_items. При передаче false будет происходит проверка на наличие invoice_items. Если такие имеются, в ответе придет ошибка 422. Обязателен, если передается unset_statistics (при этом передается relations=true) |
unset_statistics | булево | нет | Параметр, определяющий удаление или открепление связанных statistics от inovice_ietms. Если передано false, то вся статистика, связанная с актом, удалится. Если передать true, то статистика останется, однако открепится от детализации акта по атрибутам изначального договора (invoice_item_id уйдет в null) |
Код ответа | Описание |
---|---|
204 No Content | Запрос прошел успешно |
404 Not found | Объект не найден |
401 Unauthorized | Доступ запрещен |
Параметр | Тип | Обязательность | Описание |
---|---|---|---|
id | число | да | идентификатор акта |
Код ответа | Описание |
---|---|
200 ОК | Статус успешного запроса |
401 Unauthorized | Доступ запрещен, невалидный токен |
404 Not found | Идентификатор акта не найден |
Параметр | Тип | Обязательность | Описание |
---|---|---|---|
contract _id | число | Условно обязательно | Идентификатор договора (отсылка к ранее зарегистрированному договору/доп.соглашению) Если client_role='rd', то invoice.contract_id = invoice_items.contract_id ИЛИ invoice.contract_id - это доп. соглашение к invoice_items.contract_id |
date | дата (date) | да | Дата акта в формате ГГГГ-мм-дд
|
start_date | дата (date) | да | Дата начала периода в формате ГГГГ-мм-дд
|
end_date | дата (date) | да | Дата окончания периода в формате ГГГГ-мм-дд
|
amount | число | да | Сумма акта. Сумма в актах должна быть больше нуля, исключение, если акт относится к безвозмездным договорам, когда в договоре явным образом указана стоимость договора равная 0. Формат: два знака после запятой, разделитель - точка 22.23 Ограничить сумму, передаваемую в акте: максимальное число, которое может быть передано 10 000 000 000 руб. Сумма акта должна быть больше или равна сумме всех сумм в пунктах разаллокации по изначальному договору. |
number | строка (255) | нет | Номер акта |
page | число | нет | Номер страницы |
limit | число | нет | Количество записей на странице |
sort | строка | нет | Используется при get запросе. Сортировка по стоблцу. Допустимые значения: id,-id, number, -number, date, -date, amount_fact, -amount_fact |
external_id | строка (255) | нет | Учетный идентификатор в базе пользователя |
client_role | строка (20) | да | Роль заказчика в акте: rr - Рекламораспространительors - Оператор рекламной системы rd - Рекламодатель ra - Рекламное агентство В случае обычного договора и посреднического договора: В случае посреднического договора, когда агент предоставляет сторону принципала (agent_acting_for_publisher=true): |
contractor _role | строка (20) | да | Роль исполнителя в акте: rr - Рекламораспространительors - Оператор рекламной системы ra - Рекламное агентство Исполнитель не может быть в роли РД В случае посреднического договора, когда агент предоставляет сторону принципала (agent_acting_for_publisher=true) исполнитель не может быть в роли РР |
include | Строка | нет | Параметр для получения статусов сущностей для GET запроса, значение – erirEntity пример использования (https://api.ord-a.ru/api/v2/ invoices?include=erirEntity) В json ответе от сервера появятся данные: ... "erir_entity": { "id": 10351, "status": "Зарегистрирован", "status_label": "registered", "last_item": { "id": 15146, "status": "Регистрация", "status_label": "registration", "errors": [], "message": null, "created_at": "2024-07-17T17:07:11+03:00", "pending_at": "2024-07-17T17:12:11+03:00", "status_changed_at": "2024-07-17T17:12:15+03:00" }, "registered_at": "2024-07-17 17:07:09", "created_at": "2024-07-15T09:44:45+03:00" } ... |
filter [option] | строка | нет | Параметр для поиска записей сущностей для GET запроса, допустимые значения: - id; - number; - number-exact; - period; - date; - amount; - contract.amount; - contract_id; - external_id, - status (1, 2, 3, 4, 6, 10) Пример запроса: https://api.ord-a.ru/api/v2/invoices /?include=erirEntity&limit=10&page=1&filter[id]=4 Пример запроса по фильтру period: https://api.ord-a.ru/api/v2/invoices?filter[period]=20.07.2023-20.07.2023 |
Параметр | Тип | Обязательность | Описание |
---|---|---|---|
page | число | нет | Номер страницы |
limit | число | нет | Количество записей на странице |
sort | строка | нет | Используется при get запросе. Сортировка по столбцу. Допустимые значения: id, -id, amount, -amount |
Код ответа | Описание |
---|---|
200 ОК | Положительный статус запроса |
401 Unauthorized | Доступ запрещен, невалидный токен |
Параметр | Тип | Обязательность | Описание |
---|---|---|---|
id | число | нет | идентификатор пункта акта |
Код ответа | Описание |
---|---|
200 ОК | Статус успешного запроса |
401 Unauthorized | Доступ запрещен, невалидный токен |
404 Not found | Идентификатор пункта акта не найден |
Код ответа | Описание |
---|---|
201 Created | Пункт акта создан |
401 Unauthorized | Доступ запрещен, невалидный токен |
422 Unprocessable Content | Некорректный запрос |
Параметр | Тип | Обязательность | Описание |
---|---|---|---|
id | число | да | идентификатор пункта акта |
Код ответа | Описание |
---|---|
200 ОК | Статус успешного запроса |
401 Unauthorized | Доступ запрещен, невалидный токен |
404 Not found | Идентификатор пункта акта не найден |
422 Unprocessable Content | Некорректный запрос |
Параметр | Тип | Обязательность | Описание |
---|---|---|---|
id | число | да | идентификатор пункта акта |
unset_statistics | булево | нет | Параметр, определяющий удаление или открепление связанных statistics от inovice_items. Если передано false, то вся статистика, связанная с детализацией акта по атрибутам ИД, удалится. Если передать true, то статистика останется, однако открепится от детализации акта по атрибутам ИД (invoice_item_id уйдет в null) |
Код ответа | Описание |
---|---|
204 No Content | Статус успешного запроса |
401 Unauthorized | Доступ запрещен, невалидный токен |
404 Not found | Идентификатор организации не найден |
Параметр | Тип | Обязательность | Описание |
---|---|---|---|
id | число | да | идентификатор пункта акта |
Код ответа | Описание |
---|---|
200 ОК | Статус успешного запроса |
401 Unauthorized | Доступ запрещен, невалидный токен |
404 Not found | Идентификатор пункта акта не найден |
Код ответа | Описание |
---|---|
200 ОК | Статус успешного запроса |
401 Unauthorized | Доступ запрещен, невалидный токен |
422 Unprocessable Content | Некорректный запрос |
Параметр | Тип | Обязательность | Описание |
---|---|---|---|
contract_id | число | да | Идентификатор договора (отсылка к ранее зарегистрированному договору/доп.соглашению) |
amount | число | да | Сумма в привязке к изначальному договору Формат: два знака после запятой, разделитель - точка 22.2312 цифр до точки, т.е. максимальное число, которое может быть передано = 999 999 999 999 |
invoice_id | число | да | id акта |
external_id | строка(255) | нет | Учетный идентификатор в базе пользователя |
sort | строка | нет | Параметр для сортировки массива сущностей для GET запроса, допустимые значения: id, -id, -amount. Пример запроса - https://api.ord-a.ru/api/v1 /invoices/items?sort=name |
filter[option] | строка | нет | Параметр для поиска записей сущностей для GET запроса, допустимые значения - invoice_id. Пример запроса - https://api.ord-a.ru/api/v2/invoices/items /?filter[invoice_id]=4 |