获取股票列表

方法适用于所有模式.

目前不适用于卖家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

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

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

Min value: 1

Body

application/json
{
  "participation": "PARTICIPATING_NOW",
  "mechanics": "DIRECT_DISCOUNT"
}

Name

Description

mechanics

Type: string

推广类别:

  • DIRECT_DISCOUNT — 直接折扣。

  • BLUE_FLASH — 一个闪光的促销。

  • MARKET_PROMOCODE — 通过促销代码折扣.

Enum: DIRECT_DISCOUNT, BLUE_FLASH, MARKET_PROMOCODE

participation

Type: string

在不指定过滤器的情况下,将返回卖家参与或可能参与的促销活动。

指定过滤器时将返回哪些共享:

  • PARTICIPATING_NOW — 卖方参与的当前促销活动。

  • PARTICIPATED — 完成了卖家在过去一年中参与的促销活动。 如果一年内少于15股,则响应将始终显示最后15股。

Enum: PARTICIPATING_NOW, PARTICIPATED

Responses

200 OK

的市场份额列表。

Body

application/json
{
  "status": "OK",
  "result": {
    "promos": [
      {
        "id": "example",
        "name": "example",
        "period": {},
        "participating": true,
        "assortmentInfo": {},
        "mechanicsInfo": {},
        "bestsellerInfo": {},
        "channels": [
          null
        ],
        "constraints": {}
      }
    ]
  }
}

Type: object

All of 2 types
  • Type: object

    status

    Type: string

    响应的类型。 可能的值:

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

    Enum: OK, ERROR

    服务器响应的标准包装器。

    Example
    {
      "status": "OK"
    }
    
  • Type: object

    result

    Type: object

    promos

    Type: object[]

    assortmentInfo

    Type: object

    activeOffers

    Type: integer

    参与或参与促销的产品数量。

    自动添加的产品不计算在内。

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

    potentialOffers

    Type: integer

    促销中可用产品的数量。

    该参数仅针对当前和未来的促销活动返回。

    processing

    Type: boolean

    产品范围是否有任何尚未应用的变化? 保存更改需要一些时间。

    该参数仅针对当前和未来的促销活动返回。

    有关促销中的产品的信息。

    Example
    {
      "activeOffers": 0,
      "potentialOffers": 0,
      "processing": true
    }
    

    bestsellerInfo

    Type: object

    bestseller

    Type: boolean

    促销是"市场畅销书"吗? 阅读更多有关此推广活动的资料 在市场对卖家的帮助.

    entryDeadline

    Type: string<date-time>

    我可以在什么日期将商品添加到"市场畅销书"促销活动中?

    该参数仅用于当前和未来的畅销书市场促销。

    Example: 2025-01-01T00:00:00Z

    renewalEnabled

    Type: boolean

    是否启用了"市场畅销书"促销之间的分类自动转移。 阅读它是如何工作的。 在市场对卖家的帮助.

    该参数仅用于当前和未来的畅销书市场促销。

    有关"市场畅销书"促销的信息。

    Example
    {
      "bestseller": true,
      "entryDeadline": "2025-01-01T00:00:00Z",
      "renewalEnabled": true
    }
    

    id

    Type: string

    促销的ID。

    Example: example

    mechanicsInfo

    Type: object

    type

    Type: string

    推广类别:

    • DIRECT_DISCOUNT — 直接折扣。

    • BLUE_FLASH — 一个闪光的促销。

    • MARKET_PROMOCODE — 通过促销代码折扣.

    Enum: DIRECT_DISCOUNT, BLUE_FLASH, MARKET_PROMOCODE

    promocodeInfo

    Type: object

    discount

    Type: integer

    促销代码的折扣百分比。

    promocode

    Type: string

    促销代码。

    Example: example

    类型的信息 MARKET_PROMOCODE.

    该参数仅针对此类型的提升填写。

    Example
    {
      "promocode": "example",
      "discount": 0
    }
    

    促销类型的信息。

    Example
    {
      "type": "DIRECT_DISCOUNT",
      "promocodeInfo": {
        "promocode": "example",
        "discount": 0
      }
    }
    

    name

    Type: string

    促销的名称。

    Example: example

    participating

    Type: boolean

    无论卖家是否参与此促销活动。

    对于当前和未来的促销,它将随值返回 true 如果促销中有手动添加的产品。 如果产品未包含在促销中或已自动添加到促销中,则将随值返回参数 false.

    对于过去的促销活动,它始终与值一起返回 true.

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

    period

    Type: object

    dateTimeFrom

    Type: string<date-time>

    促销开始的日期和时间。

    Example: 2025-01-01T00:00:00Z

    dateTimeTo

    Type: string<date-time>

    促销结束的日期和时间。

    Example: 2025-01-01T00:00:00Z

    促销的时间。

    Example
    {
      "dateTimeFrom": "2025-01-01T00:00:00Z",
      "dateTimeTo": "2025-01-01T00:00:00Z"
    }
    

    channels

    Type: string[] | null

    品推广渠道列表。

    Min items: 1

    Unique items: true

    Example
    [
      "PUSH"
    ]
    

    constraints

    Type: object

    warehouseIds

    Type: integer[] | null

    促销有效的仓库id。 储存在其他仓库的货物将不会在促销活动下出售。

    仅当促销条款中存在库存限制时,才返回该参数。

    Min items: 1

    Unique items: true

    Example
    [
      0
    ]
    

    促销活动的限制。

    Example
    {
      "warehouseIds": [
        0
      ]
    }
    

    燕基科斯. 市场推广。

    Example
    [
      {
        "id": "example",
        "name": "example",
        "period": {
          "dateTimeFrom": "2025-01-01T00:00:00Z",
          "dateTimeTo": "2025-01-01T00:00:00Z"
        },
        "participating": true,
        "assortmentInfo": {
          "activeOffers": 0,
          "potentialOffers": 0,
          "processing": true
        },
        "mechanicsInfo": {
          "type": "DIRECT_DISCOUNT",
          "promocodeInfo": {
            "promocode": "example",
            "discount": 0
          }
        },
        "bestsellerInfo": {
          "bestseller": true,
          "entryDeadline": "2025-01-01T00:00:00Z",
          "renewalEnabled": true
        },
        "channels": [
          "PUSH"
        ],
        "constraints": {
          "warehouseIds": [
            0
          ]
        }
      }
    ]
    

    有关市场促销的信息。

    Example
    {
      "promos": [
        {
          "id": "example",
          "name": "example",
          "period": {
            "dateTimeFrom": "2025-01-01T00:00:00Z",
            "dateTimeTo": "2025-01-01T00:00:00Z"
          },
          "participating": true,
          "assortmentInfo": {
            "activeOffers": 0,
            "potentialOffers": 0,
            "processing": true
          },
          "mechanicsInfo": {
            "type": "DIRECT_DISCOUNT",
            "promocodeInfo": {
              "promocode": "example",
              "discount": 0
            }
          },
          "bestsellerInfo": {
            "bestseller": true,
            "entryDeadline": "2025-01-01T00:00:00Z",
            "renewalEnabled": true
          },
          "channels": [
            "PUSH"
          ],
          "constraints": {
            "warehouseIds": [
              0
            ]
          }
        }
      ]
    }
    
    Example
    {
      "result": {
        "promos": [
          {
            "id": "example",
            "name": "example",
            "period": {
              "dateTimeFrom": "2025-01-01T00:00:00Z",
              "dateTimeTo": "2025-01-01T00:00:00Z"
            },
            "participating": true,
            "assortmentInfo": {
              "activeOffers": 0,
              "potentialOffers": 0,
              "processing": true
            },
            "mechanicsInfo": {
              "type": "DIRECT_DISCOUNT",
              "promocodeInfo": {}
            },
            "bestsellerInfo": {
              "bestseller": true,
              "entryDeadline": "2025-01-01T00:00:00Z",
              "renewalEnabled": true
            },
            "channels": [
              "PUSH"
            ],
            "constraints": {
              "warehouseIds": [
                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: 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.