Calling methods

Requests to Yandex Market API transmitted over HTTPS, timeout — 10 seconds, Keep-Alive is not supported.

<http_method> https://api.partner.market.yandex.ru/<version>/<resource>.<format>?<query_parameters>

Where:

• <http_method> ― DELETE, GET, POST or PUT.

• <version> ― the version of the specific method (v1, v2, v3, ...).

  • The versions of the different methods are independent.

  • The current version is listed on the page of this method.

  • The version is specified in the path URL and it is mandatory.

    Be sure to specify the version if you haven't done this before.

    We will soon disable the ability to work with queries without specifying the version.

• <resource> ― URL the resource that the action is being performed on. The names of the resources are given in the description of the corresponding methods.

  Path parameters are passed here — data that differs depending on the store or cabinet.

  Example

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

  /{campaignId} — the path parameter where you specify your campaign ID.

• <format> ― this is an optional part of the request that affects the way the response is presented. The response format can be specified in the HTTP header. Accept. The data is transmitted in JSON format. The description of each method contains examples of requests and responses.

• <query_parameters> ― required and optional request parameters.

  This is where the key and its value are transmitted, which are needed to refine the request, filter and sort incoming information, and paginate.

  The request parameters are separated from URL A question mark is used, and an ampersand (&) is used between the key-value pairs.

  Example

  https://api.partner.market.yandex.ru/v2/reports/shows-sales/generate?format=CSV
  

  ?format=CSV — request parameter.

For sellers of the Yandex Go Market: also read instructions.

If an error occurs, processing of the request is stopped and information about it is returned. Types of errors and what to do about them

How method versioning works

The version refers to a specific method. Different methods may have different current versions (for example, one — v1, other — v3).

Examples of the same method in different versions

GET https://api.partner.market.yandex.ru/v1/campaigns
GET https://api.partner.market.yandex.ru/v2/campaigns

Here v1 and v2 — versions of the same method .../campaigns. They may differ in the composition of fields, validation rules, and available parameters.

How to select and fix a version

• Open the page of the required method in the documentation — it shows the current version and the status of the previous ones.
• Fix a specific version in the client and URL (do not use the "latest by default").
• Keep track of announcements about new versions and plans to decommission old ones on the method page.

Migration between versions

1. Examine the changes on the method page (what was added/changed/deleted).
2. Update the request/response schema and parameters for the new version.
3. Test your changes.
4. Switch the version to URL to a new one.
5. Monitor errors and metrics; if necessary, temporarily switch back to the previous version.

Frequent questions

• What happens if you specify a non-existent version? — The error will return 404 Not Found. Specify a lowercase letter v, capital letter V It will also result in an error. 404.
• Where can I see which version is currently in use? — In URL your request: segment v1/v2/v3 on the way.
• Does the version of all methods change at once? — No. Each method is independently versioned.