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

方法适用于所有模式.

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

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

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

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

例如, maxPromoPrice.

设定的价格不会改变。 — pricepromoPrice.

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

Request

POST

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

Path parameters

Name

Description

businessId

Type: integer

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

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

Min value: 1

Query parameters

Name

Description

limit

Type: integer

每页的值数。

Min value: 1

page_token

Type: string

结果页面的ID。

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

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

如果设置 page_token 并且请求有参数 pagepageSize 它们被忽略了。

Example: eyBuZXh0SWQ6IDIzNDIgfQ==

Body

application/json
{
  "promoId": "example",
  "statusType": "MANUALLY_ADDED",
  "statuses": [
    "MANUALLY_ADDED"
  ]
}

Name

Description

promoId

Type: string

促销的ID。

Example: example

statuses

Type: string[] | null

筛选可参与促销的产品。 您可以设置多个值。

Min items: 1

Unique items: true

Example
[
  "MANUALLY_ADDED"
]

statusType

Type: string

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

  • MANUALLY_ADDED — 手动添加的产品。

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

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

Enum: MANUALLY_ADDED, NOT_MANUALLY_ADDED

Responses

200 OK

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

Body

application/json
{
  "status": "OK",
  "result": {
    "offers": [
      {
        "offerId": "example",
        "status": "AUTO",
        "params": {},
        "autoParticipatingDetails": {}
      }
    ],
    "paging": {
      "nextPageToken": "example"
    }
  }
}

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[]

    offerId

    Type: string

    你的 SKU — 系统中的产品ID。

    使用规则 SKU:

    • 对于每个产品 SKU 一定有一个。

    • 已经设置 SKU 它不能被释放并重新用于另一个产品。 每个产品都应该收到一个以前从未在目录中使用过的新标识符。

    SKU 产品可以在市场上的卖方帐户中更改。 阅读如何做到这一点。 在市场对卖家的帮助.

    重要

    值开头和结尾的空格会自动删除。 例如, " SKU123 ""SKU123" 它们将被视为相同的值。

    什么是 SKU 以及如何分配它

    Min length: 1

    Max length: 255

    Pattern: ^(?=.*\S.*)[^\x00-\x08\x0A-\x1f\x7f]{1,255}$

    Example: example

    params

    Type: object

    discountParams

    Type: object

    maxPromoPrice

    Type: integer

    参与促销活动的最高可能价格。

    以卢布表示。

    所有产品都是退款的。

    price

    Type: integer

    划掉的价格 — 促销前产品销售的价格。

    以卢布表示。

    只有当产品参与促销活动时,才会退款。

    promoPrice

    Type: integer

    股票价格 — 你想卖产品的那个。

    以卢布表示。

    只有当产品参与促销活动时,才会退款。

    促销中的产品参数与类型 DIRECT_DISCOUNTBLUE_FLASH.

    Example
    {
      "price": 0,
      "promoPrice": 0,
      "maxPromoPrice": 0
    }
    

    推广中的产品参数。

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

    Example
    {
      "discountParams": {
        "price": 0,
        "promoPrice": 0,
        "maxPromoPrice": 0
      }
    }
    

    status

    Type: string

    促销中的产品状态:

    • 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: object

    campaignIds

    Type: integer[] | null

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

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

    Min items: 1

    Unique items: true

    Example
    [
      1
    ]
    

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

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

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

    Example
    {
      "campaignIds": [
        1
      ]
    }
    

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

    Example
    [
      {
        "offerId": "example",
        "status": "AUTO",
        "params": {
          "discountParams": {
            "price": 0,
            "promoPrice": 0,
            "maxPromoPrice": 0
          }
        },
        "autoParticipatingDetails": {
          "campaignIds": [
            1
          ]
        }
      }
    ]
    

    paging

    Type: object

    nextPageToken

    Type: string

    下一个结果页面的ID。

    Example: example

    下一页的ID。

    Example
    {
      "nextPageToken": "example"
    }
    

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

    Example
    {
      "offers": [
        {
          "offerId": "example",
          "status": "AUTO",
          "params": {
            "discountParams": {
              "price": 0,
              "promoPrice": 0,
              "maxPromoPrice": 0
            }
          },
          "autoParticipatingDetails": {
            "campaignIds": [
              1
            ]
          }
        }
      ],
      "paging": {
        "nextPageToken": "example"
      }
    }
    
    Example
    {
      "result": {
        "offers": [
          {
            "offerId": "example",
            "status": "AUTO",
            "params": {
              "discountParams": {}
            },
            "autoParticipatingDetails": {
              "campaignIds": [
                null
              ]
            }
          }
        ],
        "paging": {
          "nextPageToken": "example"
        }
      }
    }
    

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: example

      message

      Type: string

      错误的描述。

      Example: example

      错误列表。

      Min items: 1

      Example
      [
        {
          "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: example

      message

      Type: string

      错误的描述。

      Example: example

      错误列表。

      Min items: 1

      Example
      [
        {
          "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: example

      message

      Type: string

      错误的描述。

      Example: example

      错误列表。

      Min items: 1

      Example
      [
        {
          "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: example

      message

      Type: string

      错误的描述。

      Example: example

      错误列表。

      Min items: 1

      Example
      [
        {
          "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: example

      message

      Type: string

      错误的描述。

      Example: example

      错误列表。

      Min items: 1

      Example
      [
        {
          "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: example

      message

      Type: string

      错误的描述。

      Example: example

      错误列表。

      Min items: 1

      Example
      [
        {
          "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.

[*minimumForBestseller]:在方法 职位 v2/businesses/{businessId}/offer-prices/updates.