存储设置

方法适用于模式:FBY, FBS, 快递DBS.

如果您使用API-Key令牌,调用该方法时需要具备列表中可用权限之一

返回有关在请求中指定其ID的存储的设置的信息。

**⚙️ 限制:**每小时1,000个请求

Request

GET

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

Path parameters

Name

Description

campaignId*

Type: integer<int64>

活动ID。

您可以使用查询找到它 :no-translate[GET v2/campaigns] 或者在市场上的卖家办公室找到它-点击您的企业名称并转到页面:

  • 模块和 API→区块 向Yandex发送数据。街市.
  • 查询日志 →块中的下拉列表 显示日志.

,不要发送商店的ID,而不是,这是在卖方的帐户在市场上的商店名称旁边和一些报告。

Min value: 1

Responses

200 OK

存储设置。

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

存储设置。

CampaignSettingsDTO

存储设置。

Name

Description

countryRegion

Type: integer<int64>

商店所在区域的ID。

localRegion

Type: CampaignSettingsLocalRegionDTO

有关商店区域的信息。

shopName

Type: string

Yandex市场上的商店名称。 如果缺少名称,则输出参数值 — null.

showInContext

Type: boolean

指示商店是否位于Yandex分销合作伙伴的网站上。 可能的值:

  • false -商店不在Yandex分销合作伙伴的网站上托管。
  • true -商店托管在Yandex分销合作伙伴的网站上。

showInPremium

Type: boolean

指示商店的优惠是否显示在搜索结果上方的块中(特殊位置)。 可能的值:

  • false -优惠不显示在特别安置部分。
  • true -优惠显示在特别安置部分。

useOpenStat

Type: boolean

指示使用外部互联网统计信息。 可能的值:

  • false -不使用外部互联网统计数据。
  • true -使用外部互联网统计数据。

CampaignSettingsLocalRegionDTO

有关商店区域的信息。

Name

Description

delivery

Type: CampaignSettingsDeliveryDTO

有关您商店所在地区送货的信息。

deliveryOptionsSource

Type: CampaignSettingsScheduleSourceType

送服务的日程安排的信息的来源。 可能的值:

  • WEB -该信息是从商家的帐户在市场上的设置获得。
  • YML -信息是从商店的价格表中获得的。

Enum: WEB, YML

id

Type: integer<int64>

区域的ID。

name

Type: string

区域的名称。

type

Type: RegionType

区域的类型。

可能的值:

  • CITY_DISTRICT -城市的面积。

  • CITY -一个大城市。

  • CONTINENT -大陆。

  • COUNTRY_DISTRICT -区域。

  • COUNTRY -国家。

  • REGION -地区。

  • REPUBLIC_AREA -联邦主体区。

  • REPUBLIC -联邦的主题。

  • SUBWAY_STATION -地铁站。

  • VILLAGE -城市。

  • OTHER -未知区域。

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

CampaignSettingsDeliveryDTO

有关您商店所在地区送货的信息。

Name

Description

schedule

Type: CampaignSettingsScheduleDTO

您所在地区的送货服务时间表。

CampaignSettingsScheduleSourceType

送服务的日程安排的信息的来源。 可能的值:

  • WEB -该信息是从商家的帐户在市场上的设置获得。
  • YML -信息是从商店的价格表中获得的。

Type

Description

CampaignSettingsScheduleSourceType

Enum: WEB, YML

RegionType

区域的类型。

可能的值:

  • CITY_DISTRICT -城市的面积。

  • CITY -一个大城市。

  • CONTINENT -大陆。

  • COUNTRY_DISTRICT -区域。

  • COUNTRY -国家。

  • REGION -地区。

  • REPUBLIC_AREA -联邦主体区。

  • REPUBLIC -联邦的主题。

  • SUBWAY_STATION -地铁站。

  • VILLAGE -城市。

  • OTHER -未知区域。

Type

Description

RegionType

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

CampaignSettingsScheduleDTO

您所在地区的送货服务时间表。

Name

Description

customHolidays*

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

送货服务关闭的日期列表。 商店的日子在市场上的卖家办公室注明。
日期格式: DD-MM-YYYY.

Example: 23-09-2022

Unique items  

customWorkingDays*

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

送货服务运营的周末和节假日列表。 商店的日子在市场上的卖家办公室注明。
日期格式: DD-MM-YYYY.

Example: 23-09-2022

Unique items  

totalHolidays*

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

送服务的非工作日的最终列表。 该列表的计算考虑到周末,非工作日和公众假期。 商店在市场上的卖家帐户中显示有关它们的信息。
日期格式: DD-MM-YYYY.

Example: 23-09-2022

Unique items  

weeklyHolidays*

Type: integer<int32>[]

周末和公众假期的列表。
星期几的编号。 可能的值:

  • 1 -星期一。
  • 2 "星期二。"
  • 3 -星期三。
  • 4 -星期四。
  • 5 -今天是星期五
  • 6 "星期六。"
  • 7 -星期天。

对于JSON格式,日数作为数字输出。

Min value: 1

Max value: 7

Unique items  

availableOnHolidays

Type: boolean

表示送货服务于公众假期开放。 可能的值。

  • false -送货服务于公众假期休息。
  • true -送货服务于公众假期开放。

period

Type: CampaignSettingsTimePeriodDTO

计算派递服务非工作天数的最终名单的期间。

CampaignSettingsTimePeriodDTO

计算派递服务非工作天数的最终名单的期间。

Name

Description

fromDate

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

日期格式: DD-MM-YYYY.

Example: 23-09-2022

toDate

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

日期格式: DD-MM-YYYY.

Example: 23-09-2022

400 Bad Request

请求包含不正确的数据。 有关错误的更多信息

Body

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

Name

Description

errors

Type: ApiErrorDTO[]

错误列表。
一般错误格式。

Min items: 1

status

Type: ApiResponseStatusType

响应的类型。 可能的值:

  • OK -没有错误。
  • ERROR -处理请求时发生错误。

Enum: OK, ERROR

ApiErrorDTO

一般错误格式。

Name

Description

code*

Type: string

的错误代码。

message

Type: string

错误的描述。

ApiResponseStatusType

响应的类型。 可能的值:

  • OK -没有错误。
  • ERROR -处理请求时发生错误。

Type

Description

ApiResponseStatusType

Enum: OK, ERROR

401 Unauthorized

请求中未指定授权数据。 有关错误的更多信息

Body

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

Name

Description

errors

Type: ApiErrorDTO[]

错误列表。
一般错误格式。

Min items: 1

status

Type: ApiResponseStatusType

响应的类型。 可能的值:

  • OK -没有错误。
  • ERROR -处理请求时发生错误。

Enum: OK, ERROR

403 Forbidden

授权数据不正确或禁止访问资源。 有关错误的更多信息

Body

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

Name

Description

errors

Type: ApiErrorDTO[]

错误列表。
一般错误格式。

Min items: 1

status

Type: ApiResponseStatusType

响应的类型。 可能的值:

  • OK -没有错误。
  • ERROR -处理请求时发生错误。

Enum: OK, ERROR

404 Not Found

找不到请求的资源。 有关错误的更多信息

Body

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

Name

Description

errors

Type: ApiErrorDTO[]

错误列表。
一般错误格式。

Min items: 1

status

Type: ApiResponseStatusType

响应的类型。 可能的值:

  • OK -没有错误。
  • ERROR -处理请求时发生错误。

Enum: OK, ERROR

420 Method Failure

已超出资源访问限制。 有关错误的更多信息

Body

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

Name

Description

errors

Type: ApiErrorDTO[]

错误列表。
一般错误格式。

Min items: 1

status

Type: ApiResponseStatusType

响应的类型。 可能的值:

  • OK -没有错误。
  • ERROR -处理请求时发生错误。

Enum: OK, ERROR

500 Internal Server Error

市场的内部错误。 有关错误的更多信息

Body

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

Name

Description

errors

Type: ApiErrorDTO[]

错误列表。
一般错误格式。

Min items: 1

status

Type: ApiResponseStatusType

响应的类型。 可能的值:

  • OK -没有错误。
  • ERROR -处理请求时发生错误。

Enum: OK, ERROR

No longer supported, please use an alternative and newer version.

上一篇
下一篇