User's Store List

Info

Console

The method is available for all models.

If you are using an API Key token, one of the accesses in the list is required to call the method

inventory-and-order-processing — Order processing and inventory
inventory-and-order-processing:read-only — View order information
pricing — Manage prices
pricing:read-only — View prices
offers-and-cards-management — Manage products and cards
offers-and-cards-management:read-only — View products and cards
promotion — Product promotion
promotion:read-only — View promotion information
finance-and-accounting — View financial data and reports
communication — Customer communication
settings-management — Store settings
supplies-management:read-only — View FBY requests
all-methods — Full account management
all-methods:read-only — View all data

For the Api Key Token: returns the list of stores in the account for which the token was issued. You cannot get a list of only subagency stores.

For the OAuth token: returns a list of stores that the user who owns the authorization token used in the request has access to. For agency users, the list consists of subagency stores.

, Limit: 1,000 requests per hour

Request

GET

https://api.partner.market.yandex.ru/campaigns

Query parameters

Name

Description

page

Type: integer<int32>

If the method has page_token

Use it instead of the parameter page.

Learn more about the types of pagination and their use

The number of the results page.

Used together with the parameter pageSize.

page ignored if specified page_token or limit.

Default: 1

Max value: 10000

pageSize

Type: integer<int32>

Page size.

Used together with the parameter page.

pageSize ignored if specified page_token or limit.

Responses

200 OK

The user's stores.

Body

application/json

{
    "campaigns": [
        {
            "domain": "string",
            "id": 0,
            "clientId": 0,
            "business": {
                "id": 0,
                "name": "string"
            },
            "placementType": "FBS"
        }
    ],
    "pager": {
        "total": 0,
        "from": 0,
        "to": 0,
        "currentPage": 0,
        "pagesCount": 0,
        "pageSize": 0
    }
}

Name

Description

campaigns*

Type: CampaignDTO[]

A list with information for each store.
Information about the store.

pager

Type: FlippingPagerDTO

A model for pagination.

CampaignDTO

Information about the store.

Name	Description
business	Type: BusinessDTO Information about the cabinet.
clientId ⦸	Type: integer<int64> The payer's ID in Yandex.Balance.
domain	Type: string The store's name.
id	Type: integer<int64> The campaign ID. You can also find it in the seller's account on the Market. Click on the name of your business and go to the page: Modules and APIs → block Sending data to Yandex.Market. Query log → drop-down list in the block Show logs. , Do not send the store ID instead, which is indicated in the seller's account on the Market next to the store name and in some reports.
placementType	Type: PlacementType The model that the store uses: `FBS` — FBS or Express. `FBY` — FBY. `DBS` — DBS. Enum: `FBS`, `FBY`, `DBS`

FlippingPagerDTO

A model for pagination.

Name	Description
currentPage	Type: integer<int32> The current page.
from	Type: integer<int32> The initial number of the found element on the page.
pageSize	Type: integer<int32> Page size.
pagesCount	Type: integer<int32> The total number of pages.
to	Type: integer<int32> The final number of the found element on the page.
total	Type: integer<int32> How many items were found in total.

BusinessDTO

Information about the cabinet.

Name

Description

Type: integer<int64>

Cabinet ID.

name

Type: string

Business name.

PlacementType

The model that the store uses:

FBS — FBS or Express.
FBY — FBY.
DBS — DBS.

Type	Description
PlacementType	Enum: `FBS`, `FBY`, `DBS`

400 Bad Request

The request contains incorrect data. More information about the error

Body

application/json

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

Name

Description

errors

Type: ApiErrorDTO[]

A list of errors.
The general error format.

Min items: 1

status

Type: ApiResponseStatusType

The type of response. Possible values:

OK — there are no mistakes.
ERROR — an error occurred while processing the request.

Enum: OK, ERROR

ApiErrorDTO

The general error format.

Name

Description

code*

Type: string

The error code.

message

Type: string

Description of the error.

ApiResponseStatusType

The type of response. Possible values:

OK — there are no mistakes.
ERROR — an error occurred while processing the request.

Type	Description
ApiResponseStatusType	Enum: `OK`, `ERROR`

401 Unauthorized

The authorization data is not specified in the request. More information about the error

Body

application/json

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

Name

Description

errors

Type: ApiErrorDTO[]

A list of errors.
The general error format.

Min items: 1

status

Type: ApiResponseStatusType

The type of response. Possible values:

OK — there are no mistakes.
ERROR — an error occurred while processing the request.

Enum: OK, ERROR

403 Forbidden

The authorization data is incorrect or access to the resource is prohibited. More information about the error

Body

application/json

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

Name

Description

errors

Type: ApiErrorDTO[]

A list of errors.
The general error format.

Min items: 1

status

Type: ApiResponseStatusType

The type of response. Possible values:

OK — there are no mistakes.
ERROR — an error occurred while processing the request.

Enum: OK, ERROR

404 Not Found

The requested resource was not found. More information about the error

Body

application/json

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

Name

Description

errors

Type: ApiErrorDTO[]

A list of errors.
The general error format.

Min items: 1

status

Type: ApiResponseStatusType

The type of response. Possible values:

OK — there are no mistakes.
ERROR — an error occurred while processing the request.

Enum: OK, ERROR

420 Method Failure

The resource access limit has been exceeded. More information about the error

Body

application/json

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

Name

Description

errors

Type: ApiErrorDTO[]

A list of errors.
The general error format.

Min items: 1

status

Type: ApiResponseStatusType

The type of response. Possible values:

OK — there are no mistakes.
ERROR — an error occurred while processing the request.

Enum: OK, ERROR

500 Internal Server Error

Internal error of Yandex. Market. More information about the error

Body

application/json

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

Name

Description

errors

Type: ApiErrorDTO[]

A list of errors.
The general error format.

Min items: 1

status

Type: ApiResponseStatusType

The type of response. Possible values:

OK — there are no mistakes.
ERROR — an error occurred while processing the request.

Enum: OK, ERROR

Was the article helpful?

Feedback

Store Information