Баланс магазина и прогноз расходования средств

Описание

GET /campaigns/{campaignId}/balance

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

URL ресурса:

https://api.partner.market.yandex.ru/v2/campaigns/{campaignId}/balance.[format]

Входные данные

Параметр

Тип

Значение

Обязательные

campaignId

Int64

Идентификатор магазина.

Выходные данные

Структура выходных данных приведена ниже. Порядок следования параметров не гарантируется.

<response>
  <balance balance="{double}" days-left="{int32}" recommended-payment="{double}"/>
</response>
Структура выходных данных для формата XML до версии 2.0 партнерского API Яндекс.Маркета
<balance>
  <balance balance="{double}" days-left="{int32}" recommended-payment="{double}"/>
</balance>

Описание параметров:

Параметр для формата XML

Параметр для формата JSON

Тип

Значение

response

Ответ.

Параметр выводится только для формата XML.

Параметры, вложенные в response

balancebalance

Баланс.

Параметры, вложенные в balance

balancebalanceDouble

Значение актуального баланса магазина, в условных единицах.

Для формата XML является атрибутом параметра balance.

days-leftdaysLeftInt32

Прогнозируемое количество дней, оставшихся до полного израсходования средств.

Для формата XML является атрибутом параметра balance.

recommended-paymentrecommendedPaymentDouble

Рекомендованная сумма платежа, в условных единицах.

Для формата XML является атрибутом параметра balance.

Описание ошибок

В случае ошибки сервер возвращает HTTP-код ответа и краткое описание ошибки.

Примеры

Пример запроса:

curl -i -H 'Content-Type: application/xml' 'https://api.partner.market.yandex.ru/v2/campaigns/10002/balance.xml'

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

HTTP/1.1 200 OK
Date: Sat, 19 Mar 2016 00:42:42 GMT
Content-Type: application/xml;charset=utf-8
...

<response>
  <balance balance="85.74" days-left="4" recommended-payment="415.00"/>
</response>