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

Возвращает информацию о магазине.

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

Request

GET

https://api.partner.market.yandex.ru/campaigns/{campaignId}

Path parameters

Name

Type

Description

campaignId*

integer<int64>

Идентификатор кампании в API и магазина в кабинете. Каждая кампания в API соответствует магазину в кабинете.

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

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

Responses

200 OK

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

Body

application/json
{
    "campaign": {
        "domain": "string",
        "id": 0,
        "clientId": 0,
        "business": {
            "id": 0,
            "name": "string"
        },
        "placementType": "FBS"
    }
}

Name

Type

Description

campaign

CampaignDTO

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

CampaignDTO

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

Name

Type

Description

domain

string

URL магазина.

id

integer<int64>

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

clientId

integer<int64>

Идентификатор плательщика в Яндекс Балансе.

business

BusinessDTO

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

placementType

PlacementType

Модель, по которой работает магазин:

  • FBS — FBS или Экспресс;
  • FBY — FBY;
  • DBS — DBS.


Enum: FBS, FBY, DBS

BusinessDTO

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

Name

Type

Description

id

integer<int64>

Идентификатор кабинета.

name

string

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

PlacementType

Модель, по которой работает магазин:

  • FBS — FBS или Экспресс;
  • FBY — FBY;
  • DBS — DBS.

Type

Description

PlacementType

Enum: FBS, FBY, DBS

400 Bad Request

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

Body

application/json
{
    "status": "OK",
    "errors": [
        {
            "code": "string",
            "message": "string"
        }
    ]
}

Name

Type

Description

status

ApiResponseStatusType

Тип ответа.
Enum: OK, ERROR

errors

ApiErrorDTO[]

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

ApiResponseStatusType

Тип ответа.

Type

Description

ApiResponseStatusType

Enum: OK, ERROR

ApiErrorDTO

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

Name

Type

Description

code*

string

Код ошибки.

message

string

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

401 Unauthorized

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

Body

application/json
{
    "status": "OK",
    "errors": [
        {
            "code": "string",
            "message": "string"
        }
    ]
}

Name

Type

Description

status

ApiResponseStatusType

Тип ответа.
Enum: OK, ERROR

errors

ApiErrorDTO[]

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

403 Forbidden

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

Body

application/json
{
    "status": "OK",
    "errors": [
        {
            "code": "string",
            "message": "string"
        }
    ]
}

Name

Type

Description

status

ApiResponseStatusType

Тип ответа.
Enum: OK, ERROR

errors

ApiErrorDTO[]

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

404 Not Found

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

Body

application/json
{
    "status": "OK",
    "errors": [
        {
            "code": "string",
            "message": "string"
        }
    ]
}

Name

Type

Description

status

ApiResponseStatusType

Тип ответа.
Enum: OK, ERROR

errors

ApiErrorDTO[]

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

420 Method Failure

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

Body

application/json
{
    "status": "OK",
    "errors": [
        {
            "code": "string",
            "message": "string"
        }
    ]
}

Name

Type

Description

status

ApiResponseStatusType

Тип ответа.
Enum: OK, ERROR

errors

ApiErrorDTO[]

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

500 Internal Server Error

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

Body

application/json
{
    "status": "OK",
    "errors": [
        {
            "code": "string",
            "message": "string"
        }
    ]
}

Name

Type

Description

status

ApiResponseStatusType

Тип ответа.
Enum: OK, ERROR

errors

ApiErrorDTO[]

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