Настройки кабинета

Info

Console

Метод доступен для всех моделей.

Если вы используете API-Key-токен, для вызова метода необходим один из доступов в списке

inventory-and-order-processing — Обработка заказов и учёт товаров
inventory-and-order-processing:read-only — Просмотр информации о заказах
pricing — Управление ценами
pricing:read-only — Просмотр цен
offers-and-cards-management — Управление товарами и карточками
offers-and-cards-management:read-only — Просмотр товаров и карточек
promotion — Продвижение товаров
promotion:read-only — Просмотр информации о продвижении товаров
finance-and-accounting — Просмотр финансовой информации и отчётности
communication — Общение с покупателями
settings-management — Настройка магазинов
supplies-management:read-only — Получение информации по FBY-заявкам
all-methods — Полное управление кабинетом
all-methods:read-only — Просмотр всех данных

Возвращает информацию о настройках кабинета, идентификатор которого указан в запросе.

⚙️ Лимит: 100 запросов в час

Request

POST

https://api.partner.market.yandex.ru/v2/businesses/{businessId}/settings

Path parameters

Name

Description

businessId

Type: integer

Идентификатор кабинета. Чтобы его узнать, воспользуйтесь запросом GET v2/campaigns.

ℹ️ Что такое кабинет и магазин на Маркете

Min value: 1

Responses

200 OK

Настройки кабинета.

Body

application/json

{
  "status": "OK",
  "result": {
    "info": {
      "id": 1,
      "name": "example"
    },
    "settings": {
      "onlyDefaultPrice": true,
      "currency": "RUR"
    },
    "subscriptionLevel": "NONE",
    "traits": [
      "MARKET_YANDEX_GO"
    ]
  }
}

Type: object

All of 2 types

Type: ApiResponse

Стандартная обертка для ответов сервера.
Example
```
{
  "status": "OK"
}
```

Type: object

result

Type: GetBusinessSettingsInfoDTO

Информация о кабинете и его настройках.

Example

{
  "info": {
    "id": 1,
    "name": "example"
  },
  "settings": {
    "onlyDefaultPrice": true,
    "currency": "RUR"
  },
  "subscriptionLevel": "NONE",
  "traits": [
    "MARKET_YANDEX_GO"
  ]
}

Example

{
  "result": {
    "info": {
      "id": 1,
      "name": "example"
    },
    "settings": {
      "onlyDefaultPrice": true,
      "currency": "RUR"
    },
    "subscriptionLevel": "NONE",
    "traits": [
      "MARKET_YANDEX_GO"
    ]
  }
}

ApiResponseStatusType

Тип ответа. Возможные значения:

OK — ошибок нет.
ERROR — при обработке запроса произошла ошибка.

Type: string

Enum: OK, ERROR

ApiResponse

Стандартная обертка для ответов сервера.

Name

Description

status

Type: ApiResponseStatusType

Тип ответа. Возможные значения:

OK — ошибок нет.
ERROR — при обработке запроса произошла ошибка.

Enum: OK, ERROR

Example

{
  "status": "OK"
}

BusinessId

Идентификатор кабинета. Чтобы его узнать, воспользуйтесь запросом GET v2/campaigns.

ℹ️ Что такое кабинет и магазин на Маркете

Type: integer

Min value: 1

BusinessDTO

Информация о кабинете.

Name

Description

Type: BusinessId

Идентификатор кабинета. Чтобы его узнать, воспользуйтесь запросом GET v2/campaigns.

ℹ️ Что такое кабинет и магазин на Маркете

Min value: 1

Example: 1

name

Type: string

Название бизнеса.

Example: example

Example

{
  "id": 1,
  "name": "example"
}

CurrencyType

Коды валют:

RUR — российский рубль.
UAH — украинская гривна.
BYR — белорусский рубль.
KZT — казахстанский тенге.
UZS — узбекский сум.

Type: string

Enum: RUR, USD, EUR, UAH, AUD, GBP, BYR, BYN, DKK, ISK, KZT, CAD, CNY, NOK, XDR, SGD, TRY, SEK, CHF, JPY, AZN, ALL, DZD, AOA, ARS, AMD, AFN, BHD, BGN, BOB, BWP, BND, BRL, BIF, HUF, VEF, KPW, VND, GMD, GHS, GNF, HKD, GEL, AED, EGP, ZMK, ILS, INR, IDR, JOD, IQD, IRR, YER, QAR, KES, KGS, COP, CDF, CRC, KWD, CUP, LAK, LVL, SLL, LBP, LYD, SZL, LTL, MUR, MRO, MKD, MWK, MGA, MYR, MAD, MXN, MZN, MDL, MNT, NPR, NGN, NIO, NZD, OMR, PKR, PYG, PEN, PLN, KHR, SAR, RON, SCR, SYP, SKK, SOS, SDG, SRD, TJS, THB, TWD, BDT, TZS, TND, TMM, UGX, UZS, UYU, PHP, DJF, XAF, XOF, HRK, CZK, CLP, LKR, EEK, ETB, RSD, ZAR, KRW, NAD, TL, UE

BusinessSettingsDTO

Настройки кабинета.

Name

Description

currency

Type: CurrencyType

Валюта в кабинете продавца на Маркете.

Коды валют:

RUR — российский рубль.
UAH — украинская гривна.
BYR — белорусский рубль.
KZT — казахстанский тенге.
UZS — узбекский сум.

onlyDefaultPrice

Type: boolean

Управление ценами на товары:

false — можно установить цену, которая действует:
- во всех магазинах кабинета — POST v2/businesses/{businessId}/offer-prices/updates;
- в конкретном магазине — POST v2/campaigns/{campaignId}/offer-prices/updates.
true — можно установить только цену, которая действует во всех магазинах кабинета, — POST v2/businesses/{businessId}/offer-prices/updates.

Example

{
  "onlyDefaultPrice": true,
  "currency": "RUR"
}

BusinessSubscriptionLevelType

Уровень подписки кабинета:

NONE — подписка отсутствует.
LIGHT — уровень подписки Лайт.
MEDIUM — уровень подписки Медиум.

Type: string

Enum: NONE, LIGHT, MEDIUM

BusinessTraitType

Свойства кабинета:

MARKET_YANDEX_GO — продавец Market Yandex Go.

Type: string

Const: MARKET_YANDEX_GO

Example: example

GetBusinessSettingsInfoDTO

Информация о кабинете и его настройках.

Name	Description
info	Type: BusinessDTO Базовая информация о кабинете. Информация о кабинете. Example `{ "id": 1, "name": "example" }`
settings	Type: BusinessSettingsDTO Настройки на уровне кабинета. Настройки кабинета. Example `{ "onlyDefaultPrice": true, "currency": "RUR" }`
subscriptionLevel	Type: BusinessSubscriptionLevelType Уровень подписки кабинета. Подробнее о подписке для продавцов читайте в Справке Маркета для продавцов. Уровень подписки кабинета: `NONE` — подписка отсутствует. `LIGHT` — уровень подписки Лайт. `MEDIUM` — уровень подписки Медиум. Enum: `NONE`, `LIGHT`, `MEDIUM`
traits	Type: BusinessTraitType[] \| null Свойства кабинета. Min items: `1` Unique items: `true` Example `[ "example" ]`

Example

{
  "info": {
    "id": 1,
    "name": "example"
  },
  "settings": {
    "onlyDefaultPrice": true,
    "currency": "RUR"
  },
  "subscriptionLevel": "NONE",
  "traits": [
    "MARKET_YANDEX_GO"
  ]
}

400 Bad Request

Запрос содержит неправильные данные. Подробнее об ошибке

Body

application/json

{
  "status": "OK",
  "errors": [
    {
      "code": "example",
      "message": "example"
    }
  ]
}

Type: object

All of 1 type

Type: ApiErrorResponse

Стандартная обертка для ошибок сервера.

Example

{
  "status": "OK",
  "errors": [
    {
      "code": "example",
      "message": "example"
    }
  ]
}

ApiErrorDTO

Общий формат ошибки.

Name

Description

code

Type: string

Код ошибки.

Example: example

message

Type: string

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

Example: example

Example

{
  "code": "example",
  "message": "example"
}

ApiErrorResponse

Стандартная обертка для ошибок сервера.

Type: object

All of 2 types

Type: ApiResponse

Стандартная обертка для ответов сервера.
Example
```
{
  "status": "OK"
}
```

Type: object

errors

Type: ApiErrorDTO[] | null

Список ошибок.

Min items: 1

Example

[
  {
    "code": "example",
    "message": "example"
  }
]

Example

{
  "errors": [
    {
      "code": "example",
      "message": "example"
    }
  ]
}

Example

{
  "status": "OK",
  "errors": [
    {
      "code": "example",
      "message": "example"
    }
  ]
}

401 Unauthorized

В запросе не указаны данные для авторизации. Подробнее об ошибке

Body

application/json

{
  "status": "OK",
  "errors": [
    {
      "code": "example",
      "message": "example"
    }
  ]
}

Type: object

All of 1 type

Type: ApiErrorResponse

Стандартная обертка для ошибок сервера.

Example

{
  "status": "OK",
  "errors": [
    {
      "code": "example",
      "message": "example"
    }
  ]
}

403 Forbidden

Данные для авторизации неверны или доступ к ресурсу запрещен. Подробнее об ошибке

Body

application/json

{
  "status": "OK",
  "errors": [
    {
      "code": "example",
      "message": "example"
    }
  ]
}

Type: object

All of 1 type

Type: ApiErrorResponse

Стандартная обертка для ошибок сервера.

Example

{
  "status": "OK",
  "errors": [
    {
      "code": "example",
      "message": "example"
    }
  ]
}

404 Not Found

Запрашиваемый ресурс не найден. Подробнее об ошибке

Body

application/json

{
  "status": "OK",
  "errors": [
    {
      "code": "example",
      "message": "example"
    }
  ]
}

Type: object

All of 1 type

Type: ApiErrorResponse

Стандартная обертка для ошибок сервера.

Example

{
  "status": "OK",
  "errors": [
    {
      "code": "example",
      "message": "example"
    }
  ]
}

420 Method Failure

Превышено ограничение на доступ к ресурсу. Подробнее об ошибке

Body

application/json

{
  "status": "OK",
  "errors": [
    {
      "code": "example",
      "message": "example"
    }
  ]
}

Type: object

All of 1 type

Type: ApiErrorResponse

Стандартная обертка для ошибок сервера.

Example

{
  "status": "OK",
  "errors": [
    {
      "code": "example",
      "message": "example"
    }
  ]
}

500 Internal Server Error

Внутренняя ошибка Маркета. Подробнее об ошибке

Body

application/json

{
  "status": "OK",
  "errors": [
    {
      "code": "example",
      "message": "example"
    }
  ]
}

Type: object

All of 1 type

Type: ApiErrorResponse

Стандартная обертка для ошибок сервера.

Example

{
  "status": "OK",
  "errors": [
    {
      "code": "example",
      "message": "example"
    }
  ]
}

Была ли статья полезна?

Информация о магазине

Настройки магазина