Store Settings

Info

Console

The method is available for models: FBY, FBS, Express and DBS.

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

Returns information about the settings of the store whose ID is specified in the request.

⚙️ Limit: 1,000 requests per hour

Request

GET

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

Path parameters

Name

Description

campaignId*

Type: integer<int64>

The campaign ID.

You can find it using a query GET v2/campaigns or find it in the seller's office on the Market — click on your account icon → Settings and in the menu on the left, select APIs and modules:

block Campaign ID;
tab 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.

Min value: 1

Responses

200 OK

Store settings.

Body

application/json

{
    "settings": {
        "countryRegion": 0,
        "shopName": "string",
        "showInContext": false,
        "showInPremium": false,
        "useOpenStat": false,
        "localRegion": {
            "id": 0,
            "name": "string",
            "type": "OTHER",
            "deliveryOptionsSource": "WEB",
            "delivery": {
                "schedule": {
                    "availableOnHolidays": false,
                    "customHolidays": [
                        "23-09-2022"
                    ],
                    "customWorkingDays": [
                        "23-09-2022"
                    ],
                    "period": {
                        "fromDate": "23-09-2022",
                        "toDate": "23-09-2022"
                    },
                    "totalHolidays": [
                        "23-09-2022"
                    ],
                    "weeklyHolidays": [
                        0
                    ]
                }
            }
        }
    }
}

Name

Description

settings

Type: object

countryRegion

Type: integer<int64>

ID of the region where the store is located.

localRegion

Type: object

delivery

Type: object

schedule

Type: object

customHolidays*

Type: string[]

A list of days when the delivery service is closed. The store's days are indicated in the seller's office on the Market.
Date format: DD-MM-YYYY.

Example: 23-09-2022

Unique items

customWorkingDays*

Type: string[]

A list of weekends and holidays on which the delivery service operates. The store's days are indicated in the seller's office on the Market.
Date format: DD-MM-YYYY.

Example: 23-09-2022

Unique items

totalHolidays*

Type: string[]

The final list of non-working days of the delivery service. The list is calculated taking into account weekends, non-working days and public holidays. The store indicates information about them in the seller's account on the Market.
Date format: DD-MM-YYYY.

Example: 23-09-2022

Unique items

weeklyHolidays*

Type: integer[]

A list of days off and public holidays.
The number of the day of the week. Possible values:

1 — Monday.
2 — Tuesday.
3 — wednesday.
4 — Thursday.
5 — Friday.
6 — Saturday.
7 — Sunday.

For the JSON format, the day number is output as a number.

Min value: 1

Max value: 7

Unique items

availableOnHolidays

Type: boolean

Indicates that the delivery service is open on public holidays. Possible values.

false — The delivery service is closed on public holidays.
true — The delivery service is open on public holidays.

period

Type: object

fromDate

Type: string<date-dd-MM-yyyy>

Date format: DD-MM-YYYY.

Example: 23-09-2022

toDate

Type: string<date-dd-MM-yyyy>

Date format: DD-MM-YYYY.

Example: 23-09-2022

The period for which the final list of non-working days of the delivery service is calculated.

The delivery service's schedule in your region.

Information about delivery in your store's region.

deliveryOptionsSource

Type: string

The source of information about the delivery service's schedule. Possible values:

WEB — the information is obtained from the settings of the merchant's account on the Market.
YML — The information is obtained from the store's price list.

Enum: WEB, YML

Type: integer<int64>

ID of the region.

name

Type: string

The name of the region.

type

Type: string

The type of region.

Possible values:

CITY_DISTRICT — the area of the city.
CITY — a large city.
CONTINENT — the continent.
COUNTRY_DISTRICT — area.
COUNTRY — country.
REGION — region.
REPUBLIC_AREA — the district of the subject of the federation.
REPUBLIC — the subject of the Federation.
SUBWAY_STATION — the metro station.
VILLAGE — city.
OTHER — unknown region.

Enum: OTHER, CONTINENT, REGION, COUNTRY, COUNTRY_DISTRICT, REPUBLIC, CITY, VILLAGE, CITY_DISTRICT, SUBWAY_STATION, REPUBLIC_AREA

Information about your store's region.

shopName

Type: string

The name of the store on Yandex Market. If the name is missing, the parameter value is output — null.

showInContext

⦸

Type: boolean

Indicates whether the store is located on the websites of Yandex Distribution partners. Possible values:

false — The store is not hosted on the websites of Yandex Distribution partners.
true — The store is hosted on the websites of Yandex Distribution partners.

showInPremium

⦸

Type: boolean

Indicates whether the store's offers are displayed in the block above the search results (special placement). Possible values:

false — offers are not shown in the special placement section.
true — offers are shown in the special placement section.

useOpenStat

⦸

Type: boolean

Indicates the use of external Internet statistics. Possible values:

false — external Internet statistics are not used.
true — external Internet statistics are used.

Store settings.

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: object[]

A list of errors.
The general error format.

Min items: 1

status

Type: string

The type of response. Possible values:

OK — There are no errors.
ERROR — an error occurred while processing the request.

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: object[]

A list of errors.
The general error format.

Min items: 1

status

Type: string

The type of response. Possible values:

OK — There are no errors.
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: object[]

A list of errors.
The general error format.

Min items: 1

status

Type: string

The type of response. Possible values:

OK — There are no errors.
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: object[]

A list of errors.
The general error format.

Min items: 1

status

Type: string

The type of response. Possible values:

OK — There are no errors.
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: object[]

A list of errors.
The general error format.

Min items: 1

status

Type: string

The type of response. Possible values:

OK — There are no errors.
ERROR — an error occurred while processing the request.

Enum: OK, ERROR

500 Internal Server Error

Internal error of the Market. More information about the error

Body

application/json

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

Name

Description

errors

Type: object[]

A list of errors.
The general error format.

Min items: 1

status

Type: string

The type of response. Possible values:

OK — There are no errors.
ERROR — an error occurred while processing the request.

Enum: OK, ERROR

Was the article helpful?

Cabinet Settings

The category tree