GET /billing/schedules

Возвращает список всех расписаний с автоматическим применением услуг для объявлений.

Формат запроса

GET https://apiauto.ru/1.0/billing/schedules
? [offer_id=<array[string]>]
& [product=<array[string]>]

offer_id

Идентификатор объявления.

Примечание

Если вы хотите добавить больше одного значения, укажите параметр несколько раз:

offer_id=1043045004-977b3&offer_id=1043045543-677b6

product

Код услуги.

Допустимые значения:
  • boost — поднятие объявления в поиске;
  • reset — обнуление.

Заголовки запроса

Заголовок

Описание

x-dealer-id

Идентификатор клиента. Используется для работы под учетной записью агентства.

x-session-id

Идентификатор сессии пользователя. Значение можно получить с помощью операции POST /auth/login.

Общая структура ответа приведена ниже. Порядок следования элементов не гарантируется. В структуре могут присутствовать служебные параметры, которые не описаны в таблице.

Формат ответа

{
  "offers": {
    "offerId": {
      "products": {
        "productId": {
          "schedule_type": {string},
          "once_at_time": {
            "weekdays": [
              {integer}
            ],
            "time": {string}
          }
        }
      }
    },
    "offerId": {
      "products": {
        "productId": {
          "schedule_type": {string},
          "once_at_time": {
            "weekdays": [
              {integer}
            ],
            "time": {string}
          }
        }
      }
    }
  },
  "status": {string}
}

status

Статус ответа.


offers

Массив идентификаторов объявлений с расписаниями.


offerId

Идентификатор объявления.


products

Список услуг.


productId

Код услуги.

Допустимые значения:
  • boost — поднятие объявления в поиске;
  • reset — обнуление.

schedule_type

Тип расписания.

Допустимые значения:
  • ONCE_AT_TIME

once_at_time

Информация о расписании.


weekdays

Дни недели, в которые необходимо применять услугу.

Допустимые значения:
  • 1 — понедельник;
  • 2 — вторник;
  • 3 — среда;
  • 4 — четверг;
  • 5 — пятница;
  • 6 — суббота;
  • 7 — воскресенье.

time

Время применения услуги в формате HH:mm.


Коды ответа

Код

Причина

Описание

200

OK

Успешный запрос.

400

BAD_REQUEST

Синтаксическая ошибка в запросе.

401

NO_AUTH

Не удалось авторизовать пользователя по переданным данным.

404

OFFER_NOT_FOUND

Объявление не найдено.

500

INTERNAL SERVER ERROR

Внутренняя ошибка сервера.

Пример

Запрос:

curl -i -X GET 'https://apiauto.ru/1.0/user/offers/cars?page=1&page_size=1&price_to=10000000' -H 'x-authorization: 2dtrer432...' -H 'x-session-id: 112_aoR02Tpv...'

Ответ:

HTTP/1.1 200 OK
Server: nginx
Date: Fri, 15 Jun 2018 13:30:59 GMT
Content-Type: application/json
Connection: keep-alive

{
  "offers": {
    "1085122228-021c1729": {
      "products": {
        "all_sale_fresh": {
          "schedule_type": "ONCE_AT_TIME",
          "once_at_time": {
            "weekdays": [
              3
            ],
            "time": "12:05"
          },
          "timezone": "+03:00"
        }
      }
    },
    "1083834903-d5a180d4": {
      "products": {
        "all_sale_fresh": {
          "schedule_type": "ONCE_AT_TIME",
          "once_at_time": {
            "weekdays": [
              3
            ],
            "time": "12:05"
          },
          "timezone": "+03:00"
        }
      }
    },
    "1085620906-fba5dba5": {
      "products": {
        "all_sale_fresh": {
          "schedule_type": "ONCE_AT_TIME",
          "once_at_time": {
            "weekdays": [
              3
            ],
            "time": "12:05"
          },
          "timezone": "+03:00"
        }
      }
    },
    "1082445034-9e24d943": {
      "products": {
        "all_sale_fresh": {
          "schedule_type": "ONCE_AT_TIME",
          "once_at_time": {
            "weekdays": [
              3
            ],
            "time": "12:05"
          },
          "timezone": "+03:00"
        }
      }
    }
  },
  "status": "SUCCESS"
}

Статус ответа.

Идентификатор объявления.

Примечание

Если вы хотите добавить больше одного значения, укажите параметр несколько раз:

offer_id=1043045004-977b3&offer_id=1043045543-677b6

Код услуги.

Допустимые значения:
  • boost — поднятие объявления в поиске;

  • reset — обнуление.