Overview of methods
Cabinet-level methods
Some of the methods from the list — for example, product catalog managers — they work at the level of cabinet regardless of which models are connected and used. What is a cabinet?
The cabinet ID is passed in the path parameters. — businessId. Example: POST v2/businesses/{businessId}/settings
Methods at the store level
There are methods that work with individual shops inside the office. What is a store on the Market?
To call them, you need a campaign ID. campaignId. Example: GET v2/campaigns/{campaignId}/orders/{orderId}
Some of these methods are listed in the general list some work only for certain placement models:
Comparison of methods by models
Methods for getting reports
Resource reports allows you to request and receive reports on your work on the Market. Example: POST v2/reports/shows-sales/generate
Depending on the type of report, you may need both businessId, so and campaignId. How to get
For example, to start generating a turnover report — POST v2/reports/goods-turnover/generate, the campaign ID is required — campaignId.
Reference methods
No identifiers are required in queries that provide general information that is not specific to a particular business. businessId orcampaignId.
| Shared resources | The information they return |
|---|---|
auth |
information about Api-Key-the token |
categories |
Market categories |
models |
product models |
regions |
how the region is represented in the geobase of the Market |
tariffs |
Yandex.Market rates |
warehouses |
Market warehouses |
How to get cabinet and campaign IDs
To get the IDs businessId and campaignId, make a request GET v2/campaigns. It returns all the IDs that the specified authorization token allows access to.
The campaign ID can also be found in the merchant's account 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.