Starting from December 31, push API methods will be unavailable. From October 1, they may be unstable.

Step-by-step instructions on how to work with balances via the API

Requesting information about balances

Deprecated

Which method should I use instead of the outdated one?

PUT v2/campaigns/{campaignId}/offers/stocks

Requests up-to-date information about the remaining items from the store.

We receive requests about each warehouse approximately once an hour.

You need to answer in 27 seconds. If you don't make it, yandex.Market will send you the request again. After several unrequited attempts, transfer the remaining funds via POST stocks it will turn off.

Up to 1,000 requests are received per request SKU. If there are more items in stock, requests for different items arrive at the same time.

Request

POST

/stocks

Body

application/json
{
  "warehouseId": 0.5,
  "skus": [
    "example"
  ]
}

Name

Description

skus

Type: string[]

A list of your SKU products for which information about the remaining balance needs to be transmitted.

Example
[
  "example"
]

warehouseId

Type: number

The warehouse ID.

The store's response must contain the same identifier.

Responses

200 OK

In the response, you need to send the Market the current balances for all the requested items.

Body

application/json
{
  "skus": [
    {
      "sku": "example",
      "warehouseId": 0,
      "items": [
        {
          "count": 0,
          "type": "FIT",
          "updatedAt": "2025-01-01T00:00:00Z"
        }
      ]
    }
  ]
}

Name

Description

skus
Type: object[]

items
Type: object[]

count

Type: integer

The quantity of the available product.

Min value: 0

Max value: 2000000000

type

Type: string

This parameter is not used yet. — always pass the value FIT.

  • FIT — the value that must always be passed.
  • ACTUAL — a value that is not in use yet.

Enum: FIT, ACTUAL

updatedAt

Type: string<date-time>

The date and time when information about the specified type of balances was last updated.

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

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

Information about the remaining goods in this warehouse.

Min items: 1

Max items: 1

Example
[
  {
    "count": 0,
    "type": "FIT",
    "updatedAt": "2025-01-01T00:00:00Z"
  }
]

sku

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

warehouseId

Type: integer

The warehouse ID.

You can find out the warehouse ID in the cabinet in the section Logistics → Warehouses. It is specified in the field Warehouse ID.

If you are responding to a Yandex.Market request, specify the ID that came in the request.

Information about the remaining items specified in the Yandex.Market request.

Example
[
  {
    "sku": "example",
    "warehouseId": 0,
    "items": [
      {
        "count": 0,
        "type": "FIT",
        "updatedAt": "2025-01-01T00:00:00Z"
      }
    ]
  }
]

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