获取股票列表
方法适用于所有模式.
目前不适用于卖家Market Yandex Go.
如果您使用API-Key令牌,调用该方法时需要具备列表中可用权限之一
返回有关市场促销的信息。 它不返回有关卖方创建的股票的数据。
默认情况下,卖方参与或可能参与的促销活动将被退回。
要获取当前或已完成的促销,请传递参数 participation
.
响应中返回的共享类型:
- 直接折扣;
- flash推广;
- 通过促销代码折扣.
**⚙️ 限制:**每小时1,000个请求 |
---|
Request
POST
https://api.partner.market.yandex.ru/v2/businesses/{businessId}/promos
Path parameters
Name |
Description |
businessId* |
Type: integer<int64> 内阁ID。 要找到答案,请使用请求 :no-translate[GET v2/campaigns]. Min value: |
Body
application/json
{
"participation": "PARTICIPATING_NOW",
"mechanics": "DIRECT_DISCOUNT"
}
Name |
Description |
mechanics |
Type: MechanicsType Фильтр по типу акции. По умолчанию возвращаются все типы акций. Enum: |
participation |
Type: PromoParticipationType 哪些促销活动将返回:
Enum: |
MechanicsType
推广类别:
-
DIRECT_DISCOUNT
-直接折扣。 -
BLUE_FLASH
-flash促销。 -
MARKET_PROMOCODE
-优惠码折扣。
Type |
Description |
Enum: |
PromoParticipationType
哪些促销活动将返回:
-
PARTICIPATING_NOW
-卖方参与或可能参与的当前和未来促销活动。 -
PARTICIPATED
-卖方在过去一年参与的促销活动已完成。 如果一年内少于15股,则响应将始终显示最后15股。
Type |
Description |
Enum: |
Responses
200 OK
的市场份额列表。
Body
application/json
{
"status": "OK",
"result": {
"promos": [
{
"id": "string",
"name": "string",
"period": {
"dateTimeFrom": "2022-12-29T18:02:01Z",
"dateTimeTo": "2022-12-29T18:02:01Z"
},
"participating": false,
"assortmentInfo": {
"activeOffers": 0,
"potentialOffers": 0,
"processing": false
},
"mechanicsInfo": {
"type": "DIRECT_DISCOUNT",
"promocodeInfo": {
"promocode": "string",
"discount": 0
}
},
"bestsellerInfo": {
"bestseller": false,
"entryDeadline": "2022-12-29T18:02:01Z",
"renewalEnabled": false
},
"channels": [
"PUSH"
],
"constraints": {
"warehouseIds": [
0
]
}
}
]
}
}
Name |
Description |
status* |
Type: ApiResponseStatusType 响应的类型。 可能的值:
Enum: |
result |
Type: GetPromosResultDTO 有关市场促销的信息。 |
ApiResponseStatusType
响应的类型。 可能的值:
OK
-没有错误。ERROR
-处理请求时发生错误。
Type |
Description |
Enum: |
GetPromoDTO
有关促销的信息。
Name |
Description |
assortmentInfo* |
Type: GetPromoAssortmentInfoDTO 有关促销中的产品的信息。 |
bestsellerInfo* |
Type: GetPromoBestsellerInfoDTO 有关"市场畅销书"促销的信息。 |
id* |
Type: string 促销的ID。 |
mechanicsInfo* |
Type: GetPromoMechanicsInfoDTO 促销类型的信息。 |
name* |
Type: string 促销的名称。 |
participating* |
Type: boolean 无论卖家是否参与此促销活动。 对于当前和未来的促销,它将随值返回 对于过去的促销活动,它始终与值一起返回 阅读有关产品自动和手动添加到促销活动的信息 在市场对卖家的帮助. |
period* |
Type: PromoPeriodDTO 促销的时间。 |
channels |
Type: ChannelType[] 品推广渠道列表。
Enum: Min items: Unique items |
constraints |
Type: GetPromoConstraintsDTO 促销活动的限制。 |
GetPromoAssortmentInfoDTO
有关促销中的产品的信息。
Name |
Description |
activeOffers* |
Type: integer<int32> 参与或参与促销的产品数量。 自动添加的产品不计算在内。 阅读有关产品自动和手动添加到促销活动的信息 在市场对卖家的帮助. |
potentialOffers |
Type: integer<int32> 促销中可用产品的数量。 该参数仅针对当前和未来的促销活动返回。 |
processing |
Type: boolean 产品范围是否有任何尚未应用的变化? 保存更改需要一些时间。 该参数仅针对当前和未来的促销活动返回。 |
GetPromoBestsellerInfoDTO
有关"市场畅销书"促销的信息。
Name |
Description |
bestseller* |
Type: boolean 促销是"市场畅销书"吗? 阅读更多有关此推广活动的资料 在市场对卖家的帮助. |
entryDeadline |
Type: string<date-time> 我可以在什么日期将商品添加到"市场畅销书"促销活动中? 该参数仅用于当前和未来的畅销书市场促销。 |
renewalEnabled |
Type: boolean 是否启用了"市场畅销书"促销之间的分类自动转移。 阅读它是如何工作的。 在市场对卖家的帮助. 该参数仅用于当前和未来的畅销书市场促销。 |
GetPromoMechanicsInfoDTO
促销类型的信息。
Name |
Description |
type* |
Type: MechanicsType 推广类别:
Enum: |
promocodeInfo |
Type: GetPromoPromocodeInfoDTO 类型的信息 该参数仅针对此类型的提升填写。 |
PromoPeriodDTO
促销的时间。
Name |
Description |
dateTimeFrom* |
Type: string<date-time> 促销开始的日期和时间。 |
dateTimeTo* |
Type: string<date-time> 促销结束的日期和时间。 |
ChannelType
产品推广渠道:
-
PUSH
-从Yandex市场应用程序推送通知。 -
STRETCH_MAIN
-顶部横幅是Yandex市场主页上的横幅。 -
MAIN_PAGE_CAROUSEL
-Yandex市场主页上的促销旋转木马。 -
PRODUCT_RETAIL_PAGE
-产品在零售场合页面上。 -
MAIN_PAGE_CAROUSEL_WEB
-yandex网页版主页上的促销旋转木马。 市场。 -
PRODUCT_SEPARATE_LANDING
-产品在促销的登陆页面上。 -
SUPER_SHELF_CATEGORY
-货架分类。 -
CAROUSEL_RETAIL_PAGE
-零售店登陆页面上的旋转木马。 -
POPUP_APPLICATION
-Yandex市场应用程序中的弹出窗口。 -
POST_TELEGRAM
-Yandex市场电报频道的帖子。 -
CPA
-在Yandex市场合作伙伴网络中投放广告。 -
WEB_PERFORMANCE_DIRECT
-在Yandex广告。 直接。 -
APP_PERFORMANCE
-广告在 AppStore 和 Google Play. -
BANNER_PICKUP_POINT
-市场PVZ的一面旗帜。 -
BLOGGER_PERFORMANCE
-博主的广告整合。 -
DIGITAL_CHANNEL_BANNER
-横幅在数字渠道和社交网络 VK, Одноклассники. -
YANDEX_ECOSYSTEM_CHANNELS
—其他Yandex服务的广告: GO, Delivery, Еда. -
PARTNERS_MAIN_BANNER
-主页上的横幅 mail.ru, auto.ru, ya.ru. -
OTHER
-其他的东西。
Type |
Description |
Enum: |
GetPromoConstraintsDTO
促销活动的限制。
Name |
Description |
warehouseIds |
Type: integer<int64>[] 促销有效的仓库id。 储存在其他仓库的货物将不会在促销活动下出售。 仅当促销条款中存在库存限制时,才返回该参数。
Min items: Unique items |
GetPromoPromocodeInfoDTO
类型的信息 MARKET_PROMOCODE
.
该参数仅针对此类型的提升填写。
Name |
Description |
discount* |
Type: integer<int32> 促销代码的折扣百分比。 |
promocode* |
Type: string 促销代码。 |
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: |
404 Not Found
找不到请求的资源。 有关错误的更多信息
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.