Information about balances and turnover

The method is available for models: FBY, FBS, Express and DBS.

If you are using an API Key token, one of the accesses in the list is required to call the method

Returns data on product balances (for all models) and on turnover products (for the model FBY).

By default, the turnover data is not returned.

To have them in the response, send true in the field withTurnover.

For the model FBY: information about balances may be returned from several Market warehouses, which will have different warehouseId. To get a list of Market warehouses, use the method GET v2/warehouses.

For the model FBS: the response may include not only the partner warehouse, but also the Market's return warehouse. This is possible if the refund was received at the return point specified by the seller and was not picked up for a long time.

Restriction for the parameter limit

Do not pass a value greater than 200.

⚙️ Limit: 100,000 products per minute

Request

POST

https://api.partner.market.yandex.ru/v2/campaigns/{campaignId}/offers/stocks

Path parameters

Name

Description

campaignId

Type: integer

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.

You can find it using a query GET v2/campaigns 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:

  • block Campaign ID;
  • tab Query log → drop-down list in the block Show logs.

⚠️ Do not confuse it with:

  • the store's identifier, which is displayed in the merchant's personal account.
  • advertising campaigns.

Min value: 1

Query parameters

Name

Description

limit

Type: integer

The number of values per page.

Min value: 1

page_token

Type: string

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.

Example: eyBuZXh0SWQ6IDIzNDIgfQ==

Body

application/json
{
  "stocksWarehouseId": 1,
  "hasStocks": true,
  "withTurnover": false,
  "archived": true,
  "offerIds": [
    "example"
  ]
}

Name

Description

archived

Type: boolean

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.

hasStocks

Type: boolean

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.

offerIds

Type: string[] | null

Filter by your SKU products.

Information about the remaining amounts of all transferred funds is returned. SKU, including items in the archive.

This list is returned only in its entirety.

If you are requesting information on specific SKU, do not fill in:

  • page_token
  • limit
  • archived
  • stocksOnWarehouse

Min items: 1

Max items: 500

Unique items: true

Example
[
  "example"
]

stocksWarehouseId

Type: integer

The warehouse ID.

If the parameter is specified, only the goods in the transferred warehouse are returned.

For the model FBY: to get a list of Market warehouses, use the method GET v2/warehouses.

Min value: 1

withTurnover

Type: boolean

For the model only FBY

Whether to return the turnover information.

Default value: false. If the information is needed, pass the value true.

Default: false

Responses

200 OK

Remnants of goods in warehouses.

Body

application/json
{
  "status": "OK",
  "result": {
    "paging": {
      "nextPageToken": "example",
      "prevPageToken": "example"
    },
    "warehouses": [
      {
        "warehouseId": 0,
        "offers": [
          null
        ]
      }
    ]
  }
}

Type: object

All of 2 types
  • Type: object

    status

    Type: string

    The type of response. Possible values:

    • OK — There are no errors.
    • ERROR — an error occurred while processing the request.

    Enum: OK, ERROR

    The standard wrapper for server responses.

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

    result
    Type: object

    warehouses
    Type: object[]

    offers
    Type: object[]

    offerId

    Type: string

    Your SKU — the product ID in your system.

    Usage rules SKU:

    • For each product SKU there must be one.

    • 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.

    SKU 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.

    Warning

    Spaces at the beginning and end of the value are automatically deleted. For example, " SKU123 " and "SKU123" they will be treated as identical values.

    What is SKU and how to assign it

    Min length: 1

    Max length: 255

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

    Example: example

    stocks
    Type: object[]

    count

    Type: integer

    The value of the leftovers.

    type

    Type: string

    The type of remaining goods in the warehouse:

    • AVAILABLE (corresponds to the "Available to order" type in the "Stock balances" report in the seller's office on the Market) — an item available for sale.

    • DEFECT (corresponds to the "Marriage" type) — a defective product.

    • EXPIRED (corresponds to the "Overdue" type) — an expired product.

    • FIT (corresponds to the "Fit" type) — An item that is available for sale or has already been reserved.

    • FREEZE — the product that is reserved for orders.

    • QUARANTINE (corresponds to the "Quarantine" type) — An item that is temporarily unavailable for sale (for example, an item is being moved from one warehouse to another).

    • UTILIZATION — the product that will be disposed of.

    Enum: FIT, FREEZE, AVAILABLE, QUARANTINE, UTILIZATION, DEFECT, EXPIRED

    Information about balances.

    Example
    [
  {
    "type": "FIT",
    "count": 0
  }
]

    turnoverSummary
    Type: object

    turnover

    Type: string

    Evaluation of turnover.

    |enum|Turnover range|Comment| |-|-|-| |LOW|turnoverDays ≥ 120|| |ALMOST_LOW|100 ≤ turnoverDays < 120|| |HIGH|45 ≤ turnoverDays < 100|| |VERY_HIGH|0 ≤ turnoverDays < 45|| |NO_SALES|—|There are no sales.| |FREE_STORE|Any value.|There is no need to pay for the storage of goods in this category.|

    Enum: LOW, ALMOST_LOW, HIGH, VERY_HIGH, NO_SALES, FREE_STORE

    turnoverDays

    Type: number

    The value is in days.

    Information about the turnover of the product.

    Read more about the storage and turnover of goods in Yandex.Market Help for sellers.

    Example
    {
  "turnover": "LOW",
  "turnoverDays": 0.5
}

    updatedAt

    Type: string<date-time>

    The date and time of the last update of the balance information.

    Date and time format: ISO 8601 with an offset relative to UTC. For example, 2023-11-21T00:42:42+03:00.

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

    Information about balances.

    Example
    [
  {
    "offerId": "example",
    "turnoverSummary": {
      "turnover": "LOW",
      "turnoverDays": 0.5
    },
    "stocks": [
      {
        "type": "FIT",
        "count": 0
      }
    ],
    "updatedAt": "2025-01-01T00:00:00Z"
  }
]

    warehouseId

    Type: integer

    The warehouse ID.

    For the model FBY: the ID of the Market warehouse is returned.

    For the model FBS: the identifier of both the partner warehouse and the Market return warehouse can be returned.

    The warehouse list page.

    For the model FBY: may contain several Market warehouses.

    For the model FBS: can contain both a partner warehouse and a Market return warehouse.

    Example
    [
  {
    "warehouseId": 0,
    "offers": [
      {
        "offerId": "example",
        "turnoverSummary": {
          "turnover": "LOW",
          "turnoverDays": 0.5
        },
        "stocks": [
          {}
        ],
        "updatedAt": "2025-01-01T00:00:00Z"
      }
    ]
  }
]

    paging

    Type: object

    All of 2 types

    • Type: object

      nextPageToken

      Type: string

      ID of the next results page.

      Example: example

      The ID of the next page.

      Example
      {
  "nextPageToken": "example"
}

    • Type: object

      prevPageToken

      Type: string

      ID of the previous results page.

      Example: example
      Example
      {
  "prevPageToken": "example"
}

    Information about the result pages.

    Example
    {
  "nextPageToken": "example",
  "prevPageToken": "example"
}

    A list of warehouses with information about the balances on each of them.

    Example
    {
  "paging": {
    "nextPageToken": "example",
    "prevPageToken": "example"
  },
  "warehouses": [
    {
      "warehouseId": 0,
      "offers": [
        {
          "offerId": "example",
          "turnoverSummary": {},
          "stocks": [
            null
          ],
          "updatedAt": "2025-01-01T00:00:00Z"
        }
      ]
    }
  ]
}
    Example
    {
  "result": {
    "paging": {
      "nextPageToken": "example",
      "prevPageToken": "example"
    },
    "warehouses": [
      {
        "warehouseId": 0,
        "offers": [
          {}
        ]
      }
    ]
  }
}

400 Bad Request

The request contains incorrect data. More information about the error

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

      The type of response. Possible values:

      • OK — There are no errors.
      • ERROR — an error occurred while processing the request.

      Enum: OK, ERROR

      The standard wrapper for server responses.

      Example
      {
  "status": "OK"
}

    • Type: object

      errors
      Type: object[]

      code

      Type: string

      The error code.

      Example: example

      message

      Type: string

      Description of the error.

      Example: example

      A list of errors.

      Min items: 1

      Example
      [
  {
    "code": "example",
    "message": "example"
  }
]
      Example
      {
  "errors": [
    {
      "code": "example",
      "message": "example"
    }
  ]
}

    A standard wrapper for server errors.

    Example
    {
  "status": "OK",
  "errors": [
    {
      "code": "example",
      "message": "example"
    }
  ]
}

401 Unauthorized

The authorization data is not specified in the request. More information about the error

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

      The type of response. Possible values:

      • OK — There are no errors.
      • ERROR — an error occurred while processing the request.

      Enum: OK, ERROR

      The standard wrapper for server responses.

      Example
      {
  "status": "OK"
}

    • Type: object

      errors
      Type: object[]

      code

      Type: string

      The error code.

      Example: example

      message

      Type: string

      Description of the error.

      Example: example

      A list of errors.

      Min items: 1

      Example
      [
  {
    "code": "example",
    "message": "example"
  }
]
      Example
      {
  "errors": [
    {
      "code": "example",
      "message": "example"
    }
  ]
}

    A standard wrapper for server errors.

    Example
    {
  "status": "OK",
  "errors": [
    {
      "code": "example",
      "message": "example"
    }
  ]
}

403 Forbidden

The authorization data is incorrect or access to the resource is prohibited. More information about the error

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

      The type of response. Possible values:

      • OK — There are no errors.
      • ERROR — an error occurred while processing the request.

      Enum: OK, ERROR

      The standard wrapper for server responses.

      Example
      {
  "status": "OK"
}

    • Type: object

      errors
      Type: object[]

      code

      Type: string

      The error code.

      Example: example

      message

      Type: string

      Description of the error.

      Example: example

      A list of errors.

      Min items: 1

      Example
      [
  {
    "code": "example",
    "message": "example"
  }
]
      Example
      {
  "errors": [
    {
      "code": "example",
      "message": "example"
    }
  ]
}

    A standard wrapper for server errors.

    Example
    {
  "status": "OK",
  "errors": [
    {
      "code": "example",
      "message": "example"
    }
  ]
}

420 Method Failure

The resource access limit has been exceeded. More information about the error

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

      The type of response. Possible values:

      • OK — There are no errors.
      • ERROR — an error occurred while processing the request.

      Enum: OK, ERROR

      The standard wrapper for server responses.

      Example
      {
  "status": "OK"
}

    • Type: object

      errors
      Type: object[]

      code

      Type: string

      The error code.

      Example: example

      message

      Type: string

      Description of the error.

      Example: example

      A list of errors.

      Min items: 1

      Example
      [
  {
    "code": "example",
    "message": "example"
  }
]
      Example
      {
  "errors": [
    {
      "code": "example",
      "message": "example"
    }
  ]
}

    A standard wrapper for server errors.

    Example
    {
  "status": "OK",
  "errors": [
    {
      "code": "example",
      "message": "example"
    }
  ]
}

500 Internal Server Error

Internal error of Yandex. Market. More information about the error

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

      The type of response. Possible values:

      • OK — There are no errors.
      • ERROR — an error occurred while processing the request.

      Enum: OK, ERROR

      The standard wrapper for server responses.

      Example
      {
  "status": "OK"
}

    • Type: object

      errors
      Type: object[]

      code

      Type: string

      The error code.

      Example: example

      message

      Type: string

      Description of the error.

      Example: example

      A list of errors.

      Min items: 1

      Example
      [
  {
    "code": "example",
    "message": "example"
  }
]
      Example
      {
  "errors": [
    {
      "code": "example",
      "message": "example"
    }
  ]
}

    A standard wrapper for server errors.

    Example
    {
  "status": "OK",
  "errors": [
    {
      "code": "example",
      "message": "example"
    }
  ]
}

No longer supported, please use an alternative and newer version.

The average number of days for which the product is sold. Detailed information about turnover is provided in the Help of the Market for sellers.

Previous
Deleting from the archive
Next
Transfer of leftovers