Store Settings

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

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/campaigns/{campaignId}/settings

Path parameters

Name

Description

campaignId*

Type: integer<int64>

The campaign ID.

You can find it using a query GET campaigns or find it in the seller's office 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.

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: CampaignSettingsDTO

Store settings.

CampaignSettingsDTO

Store settings.

Name

Description

countryRegion

Type: integer<int64>

ID of the region where the store is located.

localRegion

Type: CampaignSettingsLocalRegionDTO

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.

CampaignSettingsLocalRegionDTO

Information about your store's region.

Name	Description
delivery	Type: CampaignSettingsDeliveryDTO Information about delivery in your store's region.
deliveryOptionsSource	Type: CampaignSettingsScheduleSourceType 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 price list of the store. Enum: `WEB`, `YML`
id	Type: integer<int64> ID of the region.
name	Type: string The name of the region.
type	Type: RegionType 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` — district of the subject of the federation. `REPUBLIC` — the subject of the Federation. `SUBWAY_STATION` — the metro station. `VILLAGE` — the city. `OTHER` — unknown region. Enum: `OTHER`, `CONTINENT`, `REGION`, `COUNTRY`, `COUNTRY_DISTRICT`, `REPUBLIC`, `CITY`, `VILLAGE`, `CITY_DISTRICT`, `SUBWAY_STATION`, `REPUBLIC_AREA`

CampaignSettingsDeliveryDTO

Information about delivery in your store's region.

Name

Description

schedule

Type: CampaignSettingsScheduleDTO

The delivery service's schedule in your region.

CampaignSettingsScheduleSourceType

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 price list of the store.

Type	Description
CampaignSettingsScheduleSourceType	Enum: `WEB`, `YML`

RegionType

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 — district of the subject of the federation.
REPUBLIC — the subject of the Federation.
SUBWAY_STATION — the metro station.
VILLAGE — the city.
OTHER — unknown region.

Type	Description
RegionType	Enum: `OTHER`, `CONTINENT`, `REGION`, `COUNTRY`, `COUNTRY_DISTRICT`, `REPUBLIC`, `CITY`, `VILLAGE`, `CITY_DISTRICT`, `SUBWAY_STATION`, `REPUBLIC_AREA`

CampaignSettingsScheduleDTO

The delivery service's schedule in your region.

Name	Description
customHolidays*	Type: string<date-dd-MM-yyyy>[] 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<date-dd-MM-yyyy>[] 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<date-dd-MM-yyyy>[] 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<int32>[] A list of weekends 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: CampaignSettingsTimePeriodDTO The period for which the final list of non-working days of the delivery service is calculated.

CampaignSettingsTimePeriodDTO

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

Name

Description

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

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 the 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?

Cabinet Settings

The category tree