有关放置在指定商店中的产品的信息
方法适用于模式:FBY, FBS, Express 和 DBS.
如果您使用API-Key令牌,调用该方法时需要具备列表中可用权限之一
返回放置在指定商店中的产品列表。 放置参数是为每个产品指定的。
| ⚙️ 限制: 每分钟10,000件物品 |
|---|
Request
POST
https://api.partner.market.yandex.ru/v2/campaigns/{campaignId}/offers
Path parameters
|
Name |
Description |
|
campaignId |
Type: integer 广告系列(商店)的ID — 通过API工作时,代表您在Yandex市场系统中的商店的技术标识符。 它与您的商店唯一链接,但仅用于自动交互。 您可以使用查询找到它 GET v2/campaigns 或者在市场上的卖家办公室找到它。 点击您的帐户图标→ 设置 在左边的菜单中,选择 Api和模块:
⚠️ 不要把它与:
Min value: |
Query parameters
|
Name |
Description |
|
limit |
Type: integer 每页的值数。 Min value: |
|
page_token |
Type: string 结果页面的ID。 如果省略该参数,则返回第一页。 我们建议传输输出参数的值 如果设置 Example: |
Body
application/json
{
"offerIds": [
"example"
],
"statuses": [
"PUBLISHED"
],
"categoryIds": [
0
],
"vendorNames": [
"example"
],
"tags": [
"example"
]
}
|
Name |
Description |
|
categoryIds |
Type: integer[] | null 在市场上按类别过滤。 Min items: Unique items: Example
|
|
offerIds |
Type: string[] | null 需要信息的产品的Id。 此列表仅完整返回。 不要在同一时间使用此字段作为基于卡片状态、类别、品牌或标签的过滤器。 如果要使用过滤器,请将字段留空。 如果你要求提供特定的资料 SKU,不填写:
Min items: Max items: Unique items: Example
|
|
statuses |
Type: string[] | null 按产品状态过滤。 Min items: Unique items: Example
|
|
tags |
Type: string[] | null 按标签过滤。 Min items: Unique items: Example
|
|
vendorNames |
Type: string[] | null 按品牌过滤。 Min items: Unique items: Example
|
Responses
200 OK
放置在指定商店中的产品列表。
Body
application/json
{
"status": "OK",
"result": {
"paging": {
"nextPageToken": "example",
"prevPageToken": "example"
},
"offers": [
{}
]
}
}
Type: object
All of 2 types
-
Type: object
status
Type: string
响应的类型。 可能的值:
OK— 没有错误。ERROR— 处理请求时出错。
Enum:
OK,ERROR服务器响应的标准包装器。
Example
{ "status": "OK" } -
Type: object
result
Type: object
offers
Type: object[]
产品列表页。
Example
[ { "offerId": "example", "quantum": { "minQuantity": 1, "stepQuantity": 1 }, "available": true, "basicPrice": { "updatedAt": "2025-01-01T00:00:00Z" }, "campaignPrice": { "value": 0, "discountBase": 0, "currencyId": "RUR", "vat": 0, "updatedAt": "2025-01-01T00:00:00Z" }, "status": "PUBLISHED", "errors": [ { "message": "example", "comment": "example" } ], "warnings": [ { "message": "example", "comment": "example" } ] } ]paging
Type: object
All of 2 types
-
Type: object
nextPageToken
Type: string
下一个结果页面的ID。
Example:
example下一页的ID。
Example
{ "nextPageToken": "example" } -
Type: object
prevPageToken
Type: string
上一个结果页面的ID。
Example:
exampleExample
{ "prevPageToken": "example" }
有关结果页的信息。
Example
{ "nextPageToken": "example", "prevPageToken": "example" }指定商店中的产品列表。
Example
{ "paging": { "nextPageToken": "example", "prevPageToken": "example" }, "offers": [ { "offerId": "example", "quantum": { "minQuantity": 1, "stepQuantity": 1 }, "available": true, "basicPrice": {}, "campaignPrice": {}, "status": "PUBLISHED", "errors": [ {} ], "warnings": [ {} ] } ] }Example
{ "result": { "paging": { "nextPageToken": "example", "prevPageToken": "example" }, "offers": [ { "offerId": "example", "quantum": {}, "available": true, "basicPrice": {}, "campaignPrice": {}, "status": "PUBLISHED", "errors": [ null ], "warnings": [ null ] } ] } } -
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:
examplemessage
Type: string
错误的描述。
Example:
example错误列表。
Min items:
1Example
[ { "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:
examplemessage
Type: string
错误的描述。
Example:
example错误列表。
Min items:
1Example
[ { "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:
examplemessage
Type: string
错误的描述。
Example:
example错误列表。
Min items:
1Example
[ { "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:
examplemessage
Type: string
错误的描述。
Example:
example错误列表。
Min items:
1Example
[ { "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:
examplemessage
Type: string
错误的描述。
Example:
example错误列表。
Min items:
1Example
[ { "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:
examplemessage
Type: string
错误的描述。
Example:
example错误列表。
Min items:
1Example
[ { "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.