Information about balances and turnover

pathParams:
  - description: "The ID of the campaign (store) — The technical identifier that represents your store in the Yandex Market system when working through the API. It is uniquely linked to your store, but it is intended only for automated interaction.\n\nYou can find it using a query [GET\_v2/campaigns](../../reference/campaigns/getCampaigns.md) or find it in the seller's office on the Market. Click on your account icon → **Settings** and in the menu on the left, select **APIs and modules**:\n\n* block **Campaign ID**;\n* tab **Query log** → drop-down list in the block **Show logs**.\n\n⚠️ Do not confuse it with:\n- the store's identifier, which is displayed in the merchant's personal account.\n- advertising campaigns.\n"
    name: campaignId
    in: path
    required: true
    schema:
      type: integer
      format: int64
      minimum: 1
searchParams:
  - name: page_token
    description: >
      ID of the results page.


      If the parameter is omitted, the first page is returned.


      We recommend transmitting the value of the output parameter
      `nextPageToken`, received during the last request.


      If set `page_token` and the request has parameters
      `page` and `pageSize` they are ignored.
    in: query
    required: false
    example: eyBuZXh0SWQ6IDIzNDIgfQ==
    schema:
      type: string
  - name: limit
    description: |
      The number of values per page.
    in: query
    required: false
    example: 20
    schema:
      type: integer
      format: int32
      minimum: 1
headers: []
body: |-
  {
    "stocksWarehouseId": 1,
    "hasStocks": true,
    "withTurnover": false,
    "archived": true,
    "offerIds": [
      "example"
    ]
  }
schema:
  description: |
    Filters for requesting balances.
  type: object
  properties:
    stocksWarehouseId:
      description: "The warehouse ID.\n\nIf the parameter is specified, only the goods in the transferred warehouse are returned.\n\n**For the model FBY:** to get a list of Market warehouses, use the method [GET\_v2/warehouses](../../reference/warehouses/getFulfillmentWarehouses.md).\n"
      type: integer
      format: int64
      minimum: 1
    hasStocks:
      description: >
        **For the model only FBY**


        Filter by product availability. Use only together with
        `stocksWarehouseId`.


        Pass it on `false` to get information about products that
        are not available. With the value `true` The data about
        the goods that are in the specified warehouse is returned.
      type: boolean
    withTurnover:
      description: >
        **For the model only FBY**


        Whether to return the turnover information.


        Default value: `false`. If the information is needed,
        pass the value `true`.
      type: boolean
      default: false
    archived:
      description: >
        Filter by location in the archive.


        Pass it on `true` to get information about the remaining
        items that are archived. If the filter is not filled or passed
        `false` the response returns information about products
        that are not archived.
      type: boolean
    offerIds:
      description: "Filter by your SKU products.\n\nInformation about the remaining amounts of all transferred funds is returned. SKU, including items in the archive.\n\n{% note warning \"This list is returned only in its entirety.\" %}\n\nIf you are requesting information on specific SKU, do not fill in:\n\n* `page_token`\n* `limit`\n* `archived`\n* `stocksOnWarehouse`\n\n{% endnote %}\n\n\_\n"
      type: array
      uniqueItems: true
      minItems: 1
      maxItems: 500
      nullable: true
      items:
        description: "Your SKU —\_the product ID in your system.\n\nUsage rules SKU:\n\n* For each product SKU there must be one.\n\n* Already set SKU it cannot be released and reused for another product. Each product should receive a new identifier that has never been used in your catalog before.\n\nSKU The product can be changed in the seller's account on the Market. Read about how to do this. [in the Help of the Market for sellers](https://yandex.ru/support2/marketplace/ru/assortment/operations/edit-sku).\n\n{% note warning %}\n\nSpaces at the beginning and end of the value are automatically deleted. For example, `\"  SKU123  \"` and `\"SKU123\"` they will be treated as identical values.\n\n{% endnote %}\n\n[What is SKU and how to assign it](https://yandex.ru/support/marketplace/assortment/add/index.html#fields)\n"
        type: string
        pattern: ^(?=.*\S.*)[^\x00-\x08\x0A-\x1f\x7f]{1,255}$
        x-transform: trim
        minLength: 1
        maxLength: 255
bodyType: application/json
method: post
security:
  - type: apiKey
    name: 'Api-Key'
    in: header
  - type: oauth2
    x-inline: true
    flows:
      implicit:
        authorizationUrl: https://oauth.yandex.ru/authorize
        scopes:
          market:partner-api: API Яндекс.Маркета / Поиска по товарам для партнеров
path: v2/campaigns/{campaignId}/offers/stocks
host: https://api.partner.market.yandex.ru