存储设置

方法适用于模式:FBY, FBS, ExpressDBS.

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

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

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

Request

GET

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

Path parameters

Name

Description

campaignId

Type: integer

广告系列(商店)的ID — 通过API工作时,代表您在Yandex市场系统中的商店的技术标识符。 它与您的商店唯一链接,但仅用于自动交互。

您可以使用查询找到它 GET v2/campaigns 或者在市场上的卖家办公室找到它。 点击您的帐户图标→ 设置 在左边的菜单中,选择 Api和模块:

  • 运动ID;
  • 标签 查询日志 →块中的下拉列表 显示日志.

⚠️ 不要把它与:

  • 商店的标识符,显示在商家的个人帐户中。
  • 广告活动。

Min value: 1

Responses

200 OK

存储设置。

Body

application/json
{
  "settings": {
    "countryRegion": 0,
    "shopName": "example",
    "showInContext": true,
    "showInPremium": true,
    "useOpenStat": true,
    "localRegion": {
      "id": 0,
      "name": "example",
      "type": "OTHER",
      "deliveryOptionsSource": "WEB",
      "delivery": {
        "schedule": {
          "availableOnHolidays": true,
          "customHolidays": [
            null
          ],
          "customWorkingDays": [
            null
          ],
          "period": {},
          "totalHolidays": [
            null
          ],
          "weeklyHolidays": [
            null
          ]
        }
      }
    }
  }
}

Name

Description

settings

Type: object

countryRegion

Type: integer

商店所在区域的ID。

localRegion

Type: object

delivery

Type: object

schedule

Type: object

customHolidays

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

送货服务关闭的日期列表。 商店的日子在市场上的卖家办公室注明。

Unique items: true

Example
[
  "23-09-2022"
]

customWorkingDays

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

送货服务运营的周末和节假日列表。 商店的日子在市场上的卖家办公室注明。

Unique items: true

Example
[
  "23-09-2022"
]

totalHolidays

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

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

Unique items: true

Example
[
  "23-09-2022"
]

weeklyHolidays

Type: integer[]

休息日及公众假期一览表。

Unique items: true

Example
[
  1
]

availableOnHolidays

Type: boolean

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

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

period

Type: object

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

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

Example
{
  "fromDate": "23-09-2022",
  "toDate": "23-09-2022"
}

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

Example
{
  "availableOnHolidays": true,
  "customHolidays": [
    "23-09-2022"
  ],
  "customWorkingDays": [
    "23-09-2022"
  ],
  "period": {
    "fromDate": "23-09-2022",
    "toDate": "23-09-2022"
  },
  "totalHolidays": [
    "23-09-2022"
  ],
  "weeklyHolidays": [
    1
  ]
}

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

Example
{
  "schedule": {
    "availableOnHolidays": true,
    "customHolidays": [
      "23-09-2022"
    ],
    "customWorkingDays": [
      "23-09-2022"
    ],
    "period": {
      "fromDate": "23-09-2022",
      "toDate": "23-09-2022"
    },
    "totalHolidays": [
      "23-09-2022"
    ],
    "weeklyHolidays": [
      1
    ]
  }
}

deliveryOptionsSource

Type: string

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

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

Enum: WEB, YML

id

Type: integer

区域的ID。

name

Type: string

区域的名称。

Example: example

type

Type: string

区域的类型。

可能的值:

  • 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

有关商店区域的信息。

Example
{
  "id": 0,
  "name": "example",
  "type": "OTHER",
  "deliveryOptionsSource": "WEB",
  "delivery": {
    "schedule": {
      "availableOnHolidays": true,
      "customHolidays": [
        "23-09-2022"
      ],
      "customWorkingDays": [
        "23-09-2022"
      ],
      "period": {
        "fromDate": "23-09-2022",
        "toDate": "23-09-2022"
      },
      "totalHolidays": [
        "23-09-2022"
      ],
      "weeklyHolidays": [
        1
      ]
    }
  }
}

shopName

Type: string

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

Example: example

showInContext

Type: boolean

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

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

showInPremium

Type: boolean

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

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

useOpenStat

Type: boolean

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

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

存储设置。

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

400 Bad Request

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

Body

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

Type: object

All of 1 type
  • Type: object

    All of 2 types
    • Type: object

      status

      Type: string

      响应的类型。 可能的值:

      • OK — 没有错误。
      • ERROR — 处理请求时出错。

      Enum: OK, ERROR

      服务器响应的标准包装器。

      Example
      {
        "status": "OK"
      }
      
    • Type: object

      errors

      Type: object[]

      code

      Type: string

      的错误代码。

      Example: example

      message

      Type: string

      错误的描述。

      Example: example

      错误列表。

      Min items: 1

      Example
      [
        {
          "code": "example",
          "message": "example"
        }
      ]
      
      Example
      {
        "errors": [
          {
            "code": "example",
            "message": "example"
          }
        ]
      }
      

    服务器错误的标准包装器。

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

401 Unauthorized

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

Body

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

Type: object

All of 1 type
  • Type: object

    All of 2 types
    • Type: object

      status

      Type: string

      响应的类型。 可能的值:

      • OK — 没有错误。
      • ERROR — 处理请求时出错。

      Enum: OK, ERROR

      服务器响应的标准包装器。

      Example
      {
        "status": "OK"
      }
      
    • Type: object

      errors

      Type: object[]

      code

      Type: string

      的错误代码。

      Example: example

      message

      Type: string

      错误的描述。

      Example: example

      错误列表。

      Min items: 1

      Example
      [
        {
          "code": "example",
          "message": "example"
        }
      ]
      
      Example
      {
        "errors": [
          {
            "code": "example",
            "message": "example"
          }
        ]
      }
      

    服务器错误的标准包装器。

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

403 Forbidden

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

Body

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

Type: object

All of 1 type
  • Type: object

    All of 2 types
    • Type: object

      status

      Type: string

      响应的类型。 可能的值:

      • OK — 没有错误。
      • ERROR — 处理请求时出错。

      Enum: OK, ERROR

      服务器响应的标准包装器。

      Example
      {
        "status": "OK"
      }
      
    • Type: object

      errors

      Type: object[]

      code

      Type: string

      的错误代码。

      Example: example

      message

      Type: string

      错误的描述。

      Example: example

      错误列表。

      Min items: 1

      Example
      [
        {
          "code": "example",
          "message": "example"
        }
      ]
      
      Example
      {
        "errors": [
          {
            "code": "example",
            "message": "example"
          }
        ]
      }
      

    服务器错误的标准包装器。

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

404 Not Found

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

Body

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

Type: object

All of 1 type
  • Type: object

    All of 2 types
    • Type: object

      status

      Type: string

      响应的类型。 可能的值:

      • OK — 没有错误。
      • ERROR — 处理请求时出错。

      Enum: OK, ERROR

      服务器响应的标准包装器。

      Example
      {
        "status": "OK"
      }
      
    • Type: object

      errors

      Type: object[]

      code

      Type: string

      的错误代码。

      Example: example

      message

      Type: string

      错误的描述。

      Example: example

      错误列表。

      Min items: 1

      Example
      [
        {
          "code": "example",
          "message": "example"
        }
      ]
      
      Example
      {
        "errors": [
          {
            "code": "example",
            "message": "example"
          }
        ]
      }
      

    服务器错误的标准包装器。

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

420 Method Failure

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

Body

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

Type: object

All of 1 type
  • Type: object

    All of 2 types
    • Type: object

      status

      Type: string

      响应的类型。 可能的值:

      • OK — 没有错误。
      • ERROR — 处理请求时出错。

      Enum: OK, ERROR

      服务器响应的标准包装器。

      Example
      {
        "status": "OK"
      }
      
    • Type: object

      errors

      Type: object[]

      code

      Type: string

      的错误代码。

      Example: example

      message

      Type: string

      错误的描述。

      Example: example

      错误列表。

      Min items: 1

      Example
      [
        {
          "code": "example",
          "message": "example"
        }
      ]
      
      Example
      {
        "errors": [
          {
            "code": "example",
            "message": "example"
          }
        ]
      }
      

    服务器错误的标准包装器。

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

500 Internal Server Error

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

Body

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

Type: object

All of 1 type
  • Type: object

    All of 2 types
    • Type: object

      status

      Type: string

      响应的类型。 可能的值:

      • OK — 没有错误。
      • ERROR — 处理请求时出错。

      Enum: OK, ERROR

      服务器响应的标准包装器。

      Example
      {
        "status": "OK"
      }
      
    • Type: object

      errors

      Type: object[]

      code

      Type: string

      的错误代码。

      Example: example

      message

      Type: string

      错误的描述。

      Example: example

      错误列表。

      Min items: 1

      Example
      [
        {
          "code": "example",
          "message": "example"
        }
      ]
      
      Example
      {
        "errors": [
          {
            "code": "example",
            "message": "example"
          }
        ]
      }
      

    服务器错误的标准包装器。

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

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

上一篇
下一篇