Получение возвратов, входящих в отчёт

POST /v1/billing/report/return/list

POST/v1/billing/report/return/list

Возврат включается в отчёт по дате перехода в конечный статус возврата (status_changed_at). Дата создания возврата и изменения промежуточных статусов не влияют на его включение в отчёт.

Тело запроса

report_id
string
required
Уникальный идентификатор отчётного периода.
cursor
string
Курсор следующей страницы.
limit
integer
Размер страницы. min = 1; max = 300; default = 100.

Успешный ответ

200Идентификаторы возвратов, входящих в отчёт.
application/json
object
report_id
string
required
Уникальный идентификатор отчётного периода.
return_ids
array
required
Элементы списка. Недоступные или несуществующие return_id в ответ не возвращаются.
next_cursor
string
Курсор следующей страницы.

Ошибки

400Некорректный запрос
application/json
object
error_type
string
ERROR_TYPE_UNAUTHORIZED — 401, ERROR_TYPE_RATE_LIMIT — 429, ERROR_TYPE_INTERNAL — 500
Допустимые значения
ERROR_TYPE_UNSPECIFIEDERROR_TYPE_UNAUTHORIZEDERROR_TYPE_RATE_LIMITERROR_TYPE_INTERNAL
code
string
код ошибки
message
string
сообщение
details
object
401Ошибка авторизации
application/json
object
error_type
string
ERROR_TYPE_UNAUTHORIZED — 401, ERROR_TYPE_RATE_LIMIT — 429, ERROR_TYPE_INTERNAL — 500
Допустимые значения
ERROR_TYPE_UNSPECIFIEDERROR_TYPE_UNAUTHORIZEDERROR_TYPE_RATE_LIMITERROR_TYPE_INTERNAL
code
string
код ошибки
message
string
сообщение
details
object
429Превышен лимит запросов
application/json
object
error_type
string
ERROR_TYPE_UNAUTHORIZED — 401, ERROR_TYPE_RATE_LIMIT — 429, ERROR_TYPE_INTERNAL — 500
Допустимые значения
ERROR_TYPE_UNSPECIFIEDERROR_TYPE_UNAUTHORIZEDERROR_TYPE_RATE_LIMITERROR_TYPE_INTERNAL
code
string
код ошибки
message
string
сообщение
details
object
500Внутренняя ошибка сервера
application/json
object
error_type
string
ERROR_TYPE_UNAUTHORIZED — 401, ERROR_TYPE_RATE_LIMIT — 429, ERROR_TYPE_INTERNAL — 500
Допустимые значения
ERROR_TYPE_UNSPECIFIEDERROR_TYPE_UNAUTHORIZEDERROR_TYPE_RATE_LIMITERROR_TYPE_INTERNAL
code
string
код ошибки
message
string
сообщение
details
object
defaultОшибка (неожиданная или прочие)
application/json
object
error_type
string
ERROR_TYPE_UNAUTHORIZED — 401, ERROR_TYPE_RATE_LIMIT — 429, ERROR_TYPE_INTERNAL — 500
Допустимые значения
ERROR_TYPE_UNSPECIFIEDERROR_TYPE_UNAUTHORIZEDERROR_TYPE_RATE_LIMITERROR_TYPE_INTERNAL
code
string
код ошибки
message
string
сообщение
details
object
POST/v1/billing/report/return/list
1curl https://api.omninet.ru/v1/billing/report/return/list \2  --request POST \3  --header 'Content-Type: application/json' \4  --data '{5  "report_id": "string",6  "cursor": "string",7  "limit": 1008}'
{
  "report_id": "string",
  "return_ids": [
    "string"
  ],
  "next_cursor": "string"
}

Идентификаторы возвратов, входящих в отчёт.