获取参与或可能参与促销的产品列表

Info

Console

方法适用于所有模式.

目前不适用于卖家Market Yandex Go.

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

pricing — 价格管理
pricing:read-only — 查看价格
promotion — 商品推广
promotion:read-only — 查看商品推广信息
all-methods — 全面管理账户
all-methods:read-only — 查看所有数据

返回参与或可能参与促销的产品列表。

参与促销活动的条款可能会改变

例如, maxPromoPrice.

设定的价格不会改变。 — price 和 promoPrice.

⚙️ 限制: 每小时10,000个请求，每个请求不超过500个项目

Request

POST

https://api.partner.market.yandex.ru/v2/businesses/{businessId}/promos/offers

Path parameters

Name

Description

businessId*

Type: integer<int64>

内阁ID。要找到答案，请使用请求 GET v2/campaigns.

ℹ️ 什么是市场上的橱柜和商店？

Min value: 1

Query parameters

Name

Description

limit

Type: integer<int32>

每页的值数。

Min value: 1
Example: 20

page_token

Type: string

结果页面的ID。

如果省略该参数，则返回第一页。

我们建议传输输出参数的值 nextPageToken，在最后一次请求期间接收。

如果设置 page_token 并且请求有参数 page 和 pageSize 它们被忽略了。
Example: eyBuZXh0SWQ6IDIzNDIgfQ==

Body

application/json

{
    "promoId": "string",
    "statusType": "MANUALLY_ADDED",
    "statuses": [
        "MANUALLY_ADDED"
    ]
}

Name	Description
promoId*	Type: string 促销的ID。
statusType ⦸	Type: PromoOfferParticipationStatusFilterType Вместо него используйте `statuses`. Фильтр для товаров, которые добавлены в акцию вручную. Если не передать параметр `statusType`, вернутся все товары. Enum: `MANUALLY_ADDED`, `NOT_MANUALLY_ADDED`
statuses	Type: PromoOfferParticipationStatusMultiFilterType[] 筛选可参与促销的产品。您可以设置多个值。筛选可参与推广的产品: `MANUALLY_ADDED` — 手动添加的产品。 `RENEWED` — 从以前的"市场畅销书"促销中自动添加的产品。仅适用于"市场畅销书"促销活动。 `RENEW_FAILED` — 不能从以前的"市场畅销书"促销转移的产品。仅适用于"市场畅销书"促销活动。 `NOT_MANUALLY_ADDED` — 不包括在促销中的产品和那些自动添加的产品。 `MINIMUM_FOR_PROMOS` — 有[设定股票最低价格]的产品(minimumForBestseller)，其对应于阈值 `maxPromoPrice`. 此类产品以价格参与促销 `maxPromoPrice`. 仅适用于"市场畅销书"促销活动。如果不传递参数 `statuses`，所有项目将被退回。阅读有关产品自动和手动添加到促销活动的信息在市场对卖家的帮助. Enum:* `MANUALLY_ADDED`, `RENEWED`, `RENEW_FAILED`, `NOT_MANUALLY_ADDED`, `MINIMUM_FOR_PROMOS` Min items: `1` Unique items

PromoOfferParticipationStatusFilterType

筛选手动添加到促销的产品:

MANUALLY_ADDED — 手动添加的产品。
NOT_MANUALLY_ADDED— 不包括在促销中的产品和那些自动添加的产品。

阅读有关产品自动和手动添加到促销活动的信息在市场对卖家的帮助.

Type	Description
PromoOfferParticipationStatusFilterType	Enum: `MANUALLY_ADDED`, `NOT_MANUALLY_ADDED`

PromoOfferParticipationStatusMultiFilterType

筛选可参与推广的产品:

MANUALLY_ADDED — 手动添加的产品。
RENEWED — 从以前的"市场畅销书"促销中自动添加的产品。仅适用于"市场畅销书"促销活动。
RENEW_FAILED — 不能从以前的"市场畅销书"促销转移的产品。仅适用于"市场畅销书"促销活动。
NOT_MANUALLY_ADDED — 不包括在促销中的产品和那些自动添加的产品。
MINIMUM_FOR_PROMOS — 有[设定股票最低价格]的产品(*minimumForBestseller)，其对应于阈值 maxPromoPrice. 此类产品以价格参与促销 maxPromoPrice. 仅适用于"市场畅销书"促销活动。

如果不传递参数 statuses，所有项目将被退回。

阅读有关产品自动和手动添加到促销活动的信息在市场对卖家的帮助.

Type	Description
PromoOfferParticipationStatusMultiFilterType	Enum: `MANUALLY_ADDED`, `RENEWED`, `RENEW_FAILED`, `NOT_MANUALLY_ADDED`, `MINIMUM_FOR_PROMOS`

Responses

200 OK

参与或可能参与促销的产品列表。

Body

application/json

{
    "status": "OK",
    "result": {
        "offers": [
            {
                "offerId": "string",
                "status": "AUTO",
                "params": {
                    "discountParams": {
                        "price": 0,
                        "promoPrice": 0,
                        "maxPromoPrice": 0
                    }
                },
                "autoParticipatingDetails": {
                    "campaignIds": [
                        0
                    ]
                }
            }
        ],
        "paging": {
            "nextPageToken": "string"
        }
    }
}

Name

Description

status*

Type: ApiResponseStatusType

响应的类型。可能的值:

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

Enum: OK, ERROR

result

Type: GetPromoOffersResultDTO

参与或可能参与促销的产品列表。

ApiResponseStatusType

响应的类型。可能的值:

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

Type	Description
ApiResponseStatusType	Enum: `OK`, `ERROR`

GetPromoOffersResultDTO

参与或可能参与促销的产品列表。

Name

Description

offers*

Type: GetPromoOfferDTO[]

参与或可能参与促销的产品。
参与或可能参与促销的产品。

paging

Type: ForwardScrollingPagerDTO

下一页的ID。

GetPromoOfferDTO

参与或可能参与促销的产品。

Name	Description
offerId*	Type: string 你的 SKU — 系统中的产品ID。使用规则 SKU: 对于每个产品 SKU 一定有一个。已经设置 SKU 它不能被释放并重新用于另一个产品。每个产品都应该收到一个以前从未在目录中使用过的新标识符。 SKU 产品可以在市场上的卖方帐户中更改。阅读有关如何做到这一点。在市场对卖家的帮助. 什么是 SKU 以及如何分配它 Min length: `1` Max length: `255` Pattern: `^(?=.\S.)[^\x00-\x08\x0A-\x1f\x7f]{1,255}$`
params*	Type: PromoOfferParamsDTO 推广中的产品参数。返回与提升类型相对应的参数。
status*	Type: PromoOfferParticipationStatusType 促销中的产品状态: `AUTO` — 自动添加在所有橱柜商店的产品可供购买. `PARTIALLY_AUTO` — 为某些商店自动添加。 `MANUAL` — 手动添加。 `NOT_PARTICIPATING` — 不参与促销活动。 `RENEWED` — 成功地从以前的"市场畅销书"推广转移。仅适用于"市场畅销书"促销活动。 `RENEW_FAILED` — 这是不可能从以前的"市场畅销书"推广转移。仅适用于"市场畅销书"促销活动。 `MINIMUM_FOR_PROMOS` — 以价格参与行动 `maxPromoPrice` ([股份最低价格](minimumForBestseller)，其对应于阈值 `maxPromoPrice`). 仅适用于"市场畅销书"促销活动。阅读有关产品自动和手动添加到促销活动的信息在市场对卖家的帮助. Enum:* `AUTO`, `PARTIALLY_AUTO`, `MANUAL`, `NOT_PARTICIPATING`, `RENEWED`, `RENEW_FAILED`, `MINIMUM_FOR_PROMOS`
autoParticipatingDetails	Type: PromoOfferAutoParticipatingDetailsDTO 有关自动产品添加到促销的信息。在其他商店中没有自动添加产品的原因可以在促销页面上的市场上的卖家帐户中找到。阅读有关产品自动和手动添加到促销活动的信息在市场对卖家的帮助.

ForwardScrollingPagerDTO

下一页的ID。

Name

Description

nextPageToken

Type: string

下一个结果页面的ID。

PromoOfferParamsDTO

推广中的产品参数。

返回与提升类型相对应的参数。

Name

Description

discountParams

Type: PromoOfferDiscountParamsDTO

促销中的产品参数与类型 DIRECT_DISCOUNT 或 BLUE_FLASH.

PromoOfferParticipationStatusType

促销中的产品状态:

AUTO — 自动添加在所有橱柜商店的产品可供购买.
PARTIALLY_AUTO — 为某些商店自动添加。
MANUAL — 手动添加。
NOT_PARTICIPATING — 不参与促销活动。
RENEWED — 成功地从以前的"市场畅销书"推广转移。仅适用于"市场畅销书"促销活动。
RENEW_FAILED — 这是不可能从以前的"市场畅销书"推广转移。仅适用于"市场畅销书"促销活动。
MINIMUM_FOR_PROMOS — 以价格参与行动 maxPromoPrice ([股份最低价格](*minimumForBestseller)，其对应于阈值 maxPromoPrice). 仅适用于"市场畅销书"促销活动。

阅读有关产品自动和手动添加到促销活动的信息在市场对卖家的帮助.

Type	Description
PromoOfferParticipationStatusType	Enum: `AUTO`, `PARTIALLY_AUTO`, `MANUAL`, `NOT_PARTICIPATING`, `RENEWED`, `RENEW_FAILED`, `MINIMUM_FOR_PROMOS`

PromoOfferAutoParticipatingDetailsDTO

有关自动产品添加到促销的信息。

在其他商店中没有自动添加产品的原因可以在促销页面上的市场上的卖家帐户中找到。

阅读有关产品自动和手动添加到促销活动的信息在市场对卖家的帮助.

Name

Description

campaignIds

Type: integer<int64>[]

产品自动添加到促销活动的商店的广告系列Id。

如果产品的状态是促销活动，则退款 — PARTIALLY_AUTO.
活动ID。

Min items: 1

Unique items

PromoOfferDiscountParamsDTO

促销中的产品参数与类型 DIRECT_DISCOUNT 或 BLUE_FLASH.

Name	Description
maxPromoPrice*	Type: integer<int64> 参与促销活动的最高可能价格。以卢布表示。所有产品都是退款的。
price	Type: integer<int64> 划掉的价格 — 促销前产品销售的价格。以卢布表示。只有当产品参与促销活动时，才会退款。
promoPrice	Type: integer<int64> 股票价格 — 你想卖产品的那个。以卢布表示。只有当产品参与促销活动时，才会退款。

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

错误的描述。

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

[*minimumForBestseller]：在方法 POST v2/businesses/{businessId}/offer-prices/updates.

这篇文章是否有用？

股份一览表

在促销中添加产品/更改价格