有关放置在指定商店中的产品的信息
如果您使用API-Key令牌,调用该方法时需要具备列表中可用权限之一
返回放置在指定商店中的产品列表。 放置参数是为每个产品指定的。
**⚙️ 限额:**每分钟10,000件 |
---|
Request
POST
https://api.partner.market.yandex.ru/v2/campaigns/{campaignId}/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: |
page_token |
Type: string 结果页面的ID。 如果省略该参数,则返回第一页。 我们建议传输输出参数的值 如果设置 |
Body
application/json
{
"offerIds": [
"string"
],
"statuses": [
"PUBLISHED"
],
"categoryIds": [
0
],
"vendorNames": [
"string"
],
"tags": [
"string"
]
}
Name |
Description |
categoryIds |
Type: integer<int32>[] 在市场上按类别过滤。 Min value (exclusive): Min items: Unique items |
offerIds |
Type: string[] 需要信息的产品的Id。 此列表仅完整返回。 不要在同一时间使用此字段作为基于卡片状态、类别、品牌或标签的过滤器。 如果要使用过滤器,请将字段留空。 如果你要求提供特定的资料 SKU,不填写:
使用规则 SKU:
SKU 产品可以在市场上的卖方帐户中更改。 阅读如何做到这一点。 在市场对卖家的帮助. Min length: Max length: Pattern: Min items: Max items: Unique items |
statuses |
Type: OfferCampaignStatusType[] 按产品状态过滤。
Enum: Min items: Unique items |
tags |
Type: string[] 按标签过滤。 Min items: Unique items |
vendorNames |
Type: string[] 按品牌过滤。 Min items: Unique items |
OfferCampaignStatusType
产品状况:
PUBLISHED
-准备出售。CHECKING
-检查时。DISABLED_BY_PARTNER
-被你藏起来了REJECTED_BY_MARKET
-被拒绝。DISABLED_AUTOMATICALLY
-修正错误。CREATING_CARD
-正在创建一张卡片。NO_CARD
-我需要一张卡片NO_STOCKS
-没有存货。ARCHIVED
-在档案中。
Type |
Description |
Enum: |
Responses
200 OK
放置在指定商店中的产品列表。
Body
application/json
{
"status": "OK",
"result": {
"paging": {
"nextPageToken": "string",
"prevPageToken": "string"
},
"offers": [
{
"offerId": "string",
"quantum": {
"minQuantity": 0,
"stepQuantity": 0
},
"available": false,
"basicPrice": {
"value": 0,
"currencyId": "RUR",
"discountBase": 0,
"updatedAt": "2022-12-29T18:02:01Z"
},
"campaignPrice": {
"value": 0,
"discountBase": 0,
"currencyId": "RUR",
"vat": 0,
"updatedAt": "2022-12-29T18:02:01Z"
},
"status": "PUBLISHED",
"errors": [
{
"message": "string",
"comment": "string"
}
],
"warnings": [
{
"message": "string",
"comment": "string"
}
]
}
]
}
}
Name |
Description |
status* |
Type: ApiResponseStatusType 响应的类型。 可能的值:
Enum: |
result |
Type: GetCampaignOffersResultDTO 指定商店中的产品列表。 |
ApiResponseStatusType
响应的类型。 可能的值:
OK
-没有错误。ERROR
-处理请求时发生错误。
Type |
Description |
Enum: |
GetCampaignOffersResultDTO
指定商店中的产品列表。
Name |
Description |
offers* |
Type: GetCampaignOfferDTO[] 产品列表页。 |
paging |
Type: ScrollingPagerDTO 有关结果页的信息。 |
GetCampaignOfferDTO
商店中的产品放置参数。
Name |
Description |
offerId* |
Type: string 你的 SKU -系统中的产品ID。 使用规则 SKU:
SKU 产品可以在市场上的卖方帐户中更改。 阅读如何做到这一点。 在市场对卖家的帮助. Min length: Max length: Pattern: |
available ⦸
|
Type: boolean 相反,使用方法从展柜中隐藏商品。 品是否在售。 |
basicPrice |
Type: GetPriceWithDiscountDTO Цена товара для всех магазинов. |
campaignPrice |
Type: GetPriceWithVatDTO Цена, установленная в отдельном магазине. |
errors |
Type: OfferErrorDTO[] 阻止产品放置在展柜中的错误。
Min items: |
quantum ⦸
|
Type: QuantumDTO Настройка продажи квантами. Что это значит? |
status |
Type: OfferCampaignStatusType 产品状况:
Enum: |
warnings |
Type: OfferErrorDTO[] 不会阻止产品放置在展柜中的警告。
Min items: |
ScrollingPagerDTO
有关结果页的信息。
Name |
Description |
nextPageToken |
Type: string 下一个结果页面的ID。 |
prevPageToken |
Type: string 上一个结果页面的ID。 |
GetPriceWithDiscountDTO
价格包括货币、折扣和上次更新的时间.
Name |
Description |
updatedAt* |
Type: string<date-time> 上次更新的时间。 |
currencyId |
Type: CurrencyType Валюта. Enum: |
discountBase |
Type: number 划掉的价格。 数字必须是整数。 您可以指定折扣从5到99%的价格。 如果您提供产品折扣,则在每次更新价格时传递此参数。 Min value (exclusive): |
value |
Type: number 品的价格。 Min value (exclusive): |
GetPriceWithVatDTO
价格包括增值税和上次更新的时间。
Name |
Description |
updatedAt* |
Type: string<date-time> 上次更新的时间。 |
currencyId |
Type: CurrencyType Валюта, в которой указана цена товара. Enum: |
discountBase |
Type: number 划掉的价格。 数字必须是整数。 您可以指定折扣从5到99%的价格。 如果您提供产品折扣,则在每次更新价格时传递此参数。 Min value (exclusive): |
value |
Type: number 品的价格。 Min value (exclusive): |
vat |
Type: integer<int32> 用于产品的增值税标识符:
如果省略该参数,则使用机柜中设置的增值税。 卖家须知 Market Yandex Go不提供增值税的转让和收据。 |
OfferErrorDTO
与产品放置相关的错误消息。
Name |
Description |
comment |
Type: string 解释。 |
message |
Type: string 错误的类型。 |
QuantumDTO
建立量子销售。
要重置先前设置的值,请传递一个空参数 quantum
.
例子:
{
"offers": [
{
"offerId": "08e35dc1-89a2-11e3-8055-0015e9b8c48d",
"quantum": {}
}
]
}
Name |
Description |
minQuantity |
Type: integer<int32> 订单中产品单位的最小数量。 例如,如果您指定10,客户将能够将至少10个商品添加到购物车。 如果库存商品数量少于指定数量,则限制将不起作用,买方将能够订购。 Min value: |
stepQuantity |
Type: integer<int32> 由多少单位的买方将能够增加货物在篮子里的数量。 例如,如果您设置5,买方将能够添加只有5,10,15,。.. 订单的项目。 如果库存货物的数量没有达到数量,限制将不起作用,买方将能够订购数量不是数量的倍数。 Min value: Max value: |
CurrencyType
货币代码:
RUR
-俄罗斯卢布。UAH
-乌克兰格里夫纳。BYR
-白俄罗斯卢布。KZT
-哈萨克斯坦坚戈。UZS
-乌兹别克总和。
Type |
Description |
Enum: |
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.