有关您隐藏的商品的信息
方法适用于所有模式.
如果您使用API-Key令牌,调用该方法时需要具备列表中可用权限之一
检索指定存储的隐藏项列表。
该列表将包含以任何方式隐藏的产品-通过 API,使用YML提要,在仪表板中,等等。
**⚙️ 限制:**每分钟10,000个产品,每个请求不超过500个产品 |
---|
Request
GET
https://api.partner.market.yandex.ru/v2/campaigns/{campaignId}/hidden-offers
Path parameters
Name |
Description |
campaignId* |
Type: integer<int64> 活动ID。 您可以使用查询找到它 :no-translate[GET v2/campaigns] 或者在市场上的卖家办公室找到它-点击您的企业名称并转到页面:
,不要发送商店ID,而不是,这是在卖方的帐户在市场上的商店名称旁边和一些报告。
Min value: |
Query parameters
Name |
Description |
limit |
Type: integer<int32> 每页的值数。
Min value: |
offer_id |
Type: string[] 隐藏报价的ID。
使用规则 SKU:
SKU 产品可以在市场上的卖方帐户中更改。 阅读有关如何做到这一点。 在市场对卖家的帮助. Min length: Max length: Pattern: |
page_token |
Type: string 结果页面的ID。 如果省略该参数,则返回第一页。 我们建议传输输出参数的值 如果设置 |
Responses
200 OK
有关您隐藏的商品的信息。
Body
application/json
{
"status": "OK",
"result": {
"paging": {
"nextPageToken": "string",
"prevPageToken": "string"
},
"hiddenOffers": [
{
"offerId": "string"
}
]
}
}
Name |
Description |
status* |
Type: ApiResponseStatusType 响应的类型。 可能的值:
Enum: |
result |
Type: GetHiddenOffersResultDTO 隐藏项目的列表。 |
ApiResponseStatusType
响应的类型。 可能的值:
OK
-没有错误。ERROR
-处理请求时发生错误。
Type |
Description |
Enum: |
GetHiddenOffersResultDTO
隐藏项目的列表。
Name |
Description |
hiddenOffers* |
Type: HiddenOfferDTO[] 隐藏物品清单。 |
paging |
Type: ScrollingPagerDTO 有关结果页的信息。 |
HiddenOfferDTO
有关隐藏的信息。
Name |
Description |
offerId* |
Type: string 你的 SKU -系统中的产品ID。 使用规则 SKU:
SKU 产品可以在市场上的卖方帐户中更改。 阅读有关如何做到这一点。 在市场对卖家的帮助. Min length: Max length: Pattern: |
ScrollingPagerDTO
有关结果页的信息。
Name |
Description |
nextPageToken |
Type: string 下一个结果页面的ID。 |
prevPageToken |
Type: string 上一个结果页面的ID。 |
400 Bad Request
请求包含不正确的数据。 有关错误的更多信息
Body
application/json
{
"status": "OK",
"errors": [
{
"code": "string",
"message": "string"
}
]
}
Name |
Description |
errors |
Type: ApiErrorDTO[] 错误列表。 Min items: |
status |
Type: ApiResponseStatusType 响应的类型。 可能的值:
Enum: |
ApiErrorDTO
一般错误格式。
Name |
Description |
code* |
Type: string 的错误代码。 |
message |
Type: string 错误的描述。 |
401 Unauthorized
请求中未指定授权数据。 有关错误的更多信息
Body
application/json
{
"status": "OK",
"errors": [
{
"code": "string",
"message": "string"
}
]
}
Name |
Description |
errors |
Type: ApiErrorDTO[] 错误列表。 Min items: |
status |
Type: ApiResponseStatusType 响应的类型。 可能的值:
Enum: |
403 Forbidden
授权数据不正确或禁止访问资源。 有关错误的更多信息
Body
application/json
{
"status": "OK",
"errors": [
{
"code": "string",
"message": "string"
}
]
}
Name |
Description |
errors |
Type: ApiErrorDTO[] 错误列表。 Min items: |
status |
Type: ApiResponseStatusType 响应的类型。 可能的值:
Enum: |
420 Method Failure
已超出资源访问限制。 有关错误的更多信息
Body
application/json
{
"status": "OK",
"errors": [
{
"code": "string",
"message": "string"
}
]
}
Name |
Description |
errors |
Type: ApiErrorDTO[] 错误列表。 Min items: |
status |
Type: ApiResponseStatusType 响应的类型。 可能的值:
Enum: |
500 Internal Server Error
Yandex中的内部错误。 市场。 有关错误的更多信息
Body
application/json
{
"status": "OK",
"errors": [
{
"code": "string",
"message": "string"
}
]
}
Name |
Description |
errors |
Type: ApiErrorDTO[] 错误列表。 Min items: |
status |
Type: ApiResponseStatusType 响应的类型。 可能的值:
Enum: |
No longer supported, please use an alternative and newer version.