Search
API docs by Redocly

Marketing and Promotions (promotion)

Campaign Management, bid settings, financial data accounting, and settings for automatic and media campaigns.

Data synchronization from the database occurs every 3 minutes. Status changes occur every 1 minute. The bid change occurs every 30 seconds. The latest changes are saved within the intervals

Marketing and Promotions

Campaign Management, bid settings, financial data accounting, and settings for automatic and media campaigns.

Data synchronization from the database occurs every 3 minutes. Status changes occur every 1 minute. The bid change occurs every 30 seconds. The latest changes are saved within the intervals

Promotions Calendar

To access the methods, use a token for the Prices and Discounts category

Using these methods, you can obtain information about promotions and participate in them.

Promotions List{{ /api/v1/calendar/promotions }}

Описание метода

Returns a promotions list with dates and times of occurrence

Maximum of 10 requests per 6 seconds for all methods in the Promotions Calendar per one seller's account
Authorizations:
HeaderApiKey
query Parameters
startDateTime
required
string <RFC3339>
Example: startDateTime=2023-09-01T00:00:00Z

Period start, format YYYY-MM-DDTHH:MM:SSZ

endDateTime
required
string <RFC3339>
Example: endDateTime=2024-08-01T23:59:59Z

Period end, format YYYY-MM-DDTHH:MM:SSZ

allPromo
required
boolean
Default: false

Show promotions:

  • false — available for participating
  • true — all promotion
limit
integer <uint> [ 1 .. 1000 ]
Example: limit=10

Number of requested promotions

offset
integer <uint> >= 0
Example: offset=0

From which element to start outputting data

Responses

Response samples

Content type
application/json
{
  • "data": {
    }
}

Promotions Details{{ /api/v1/calendar/promotions/details }}

Описание метода

Returns detailed information about the selected promotions

Maximum of 10 requests per 6 seconds for all methods in the Promotions Calendar per one seller's account
Authorizations:
HeaderApiKey
query Parameters
promotionIDs
required
string [ 1 .. 100 ] items unique
Example: promotionIDs=1&promotionIDs=3&promotionIDs=64

IDs of the promotions for which information should be returned

Responses

Response samples

Content type
application/json
{
  • "data": {
    }
}

Products List for Participating in the Promotion{{ /api/v1/calendar/promotions/nomenclatures }}

Описание метода

Returns a list of products suitable for participation in the promotion.

Not applicable for auto promotions

Maximum of 10 requests per 6 seconds for all methods in the Promotions Calendar per one seller's account
Authorizations:
HeaderApiKey
query Parameters
promotionID
required
integer
Example: promotionID=1

Promotion ID

inAction
required
boolean
Default: false
Example: inAction=true

Participates in the promotion:

  • true — yes
  • false — no
limit
integer <uint> [ 1 .. 1000 ]
Example: limit=10

Number of requested products

offset
integer <uint> >= 0
Example: offset=0

From which element to start outputting data

Responses

Response samples

Content type
application/json
{
  • "data": {
    }
}

Add Product to the Promotion{{ /api/v1/calendar/promotions/upload }}

Описание метода

Creates a product upload for the promotion.
The upload status can be checked using separate methods.

Not applicable for auto promotions

Maximum of 10 requests per 6 seconds for all methods in the Promotions Calendar per one seller's account
Authorizations:
HeaderApiKey
Request Body schema: application/json
required
object

Responses

Request samples

Content type
application/json
{
  • "data": {
    }
}

Response samples

Content type
application/json
{
  • "data": {
    }
}

Campaigns

To access the methods, use a token for the Promotion category

Campaigns lists{{ /adv/v1/promotion/count }}

Описание метода

Method allows to get campaigns lists grouped by type and status with information about last campaign change date.

Maximum of 5 requests per second
Authorizations:
HeaderApiKey

Responses

Response samples

Content type
application/json
{
  • "adverts": [
    ],
  • "all": 3
}

Campaigns information{{ /adv/v1/promotion/adverts }}

Описание метода

The method allows to retrieve information about campaigns via query parameters, or by a list of campaign IDs.

Maximum of 5 requests per second
Authorizations:
HeaderApiKey
query Parameters
status
integer
Enum: -1 4 7 8 9 11
Campaign status:
-1 - the campaign is in the process of being deleted
4 - ready to be launched
7 - campaign completed
8 - declined
9 - displays are ongoing
11 - campaign is paused
Campaign in the process of deletion. The status means that the campaign has been deleted and will disappear from the method's response within 3-10 minutes.
type
integer
Enum: 4 5 6 7 8 9
Campaign type:
4 - campaign in catalog (deprecated type)
5 - campaign in content (deprecated type)
6 - campaign in search (deprecated type)
7 - campaign in recommendations on the main page (deprecated type)
8 - automatic campaign
9 - Auction
order
string
Enum: "create" "change" "id"
Order:
create (by the time of campaign creation)
change (by the time of the last change to the campaign)
id (by the campaign identifier)
direction
string
Enum: "desc" "asc"
Direction:
desc (from greater to lesser)
asc (from lesser to greater)

For example: /adv/v1/promotion/adverts?type=6&order=change&direction=asc
Request Body schema: application/json
required
Array
integer

List of campaign IDs. A Maximum of of 50.

You can get campaign IDs using the Campaign Lists method.

Responses

Request samples

Content type
application/json
[
  • 1234567,
  • 63453471
]

Response samples

Content type
application/json
Example
[
  • {
    }
]

Campaigns Creation

To access the methods, use a token for the Promotion category

Promotional configuration values{{ /adv/v0/config }}

Описание метода

The method provides acceptable values for the main configuration parameters of campaigns

Maximum of 1 request per minute per one seller's account
Authorizations:
HeaderApiKey

Responses

Response samples

Content type
application/json
{
  • "config": [
    ]
}

Creating automatic campaign{{ /adv/v1/save-ad }}

Описание метода

Creates an automatic campaign.

Maximum of 1 request per 20 seconds
Authorizations:
HeaderApiKey
Request Body schema: application/json
required
type
integer
Type of automatic campaign:
8
name
string

Campaign name (max. 128 characters)

subjectId
integer

ID of the item for which the campaign is created.
Seller's existing IDs can be received by "Content / View - "Nomenclature list" method, response field is subjectID.

sum
integer

Top-up amount

btype
integer
Type of write-off.
0 - Account
1 - Balance
3 - Bonuses
on_pause
boolean
After creating campaign:
true - Will be suspended.
The campaign launch will be available within 3 minutes after the campaign is created.
false - Will be launched
nms
Array of integers

WB articles array.
Maximum of 100 articles

cpm
integer

Bid.
If a bid is specified that is less than the allowed size, the bid of the minimum allowed size will be automatically set.

Responses

Request samples

Content type
application/json
{
  • "type": 8,
  • "name": "Парашюты",
  • "subjectId": 270,
  • "sum": 500,
  • "btype": 1,
  • "on_pause": true,
  • "nms": [
    ],
  • "cpm": 10
}

Response samples

Content type
text/plain
9008917

Create Auction campaign{{ /adv/v2/seacat/save-ad }}

Описание метода

Creates Auction campaign.

Maximum of 5 requests per minute
Authorizations:
HeaderApiKey
Request Body schema: application/json
campaignName
string

Campaign name

nms
Array of integers

Nomenclature for this campaign. You can available nomenclatures with Nomenclatures for campaigns method. Maximum of 50 products (nm)

Responses

Request samples

Content type
application/json
{
  • "name": "Телефоны",
  • "nms": [
    ]
}

Response samples

Content type
text/plain
Нет доступных категорий для рк. Создайте новую кампанию для попадания в текущие категории

Subjects for campaigns{{ /adv/v1/supplier/subjects }}

Описание метода

Returns subjects nomenclatures from which are available for all campaigns

Maximum of 1 request per 12 seconds
Authorizations:
HeaderApiKey

Responses

Response samples

Content type
application/json
Example
[
  • {
    }
]

Nomenclatures for campaigns{{ /adv/v2/supplier/nms }}

Описание метода

Returns nomenclatures that are available for all campaigns.

Maximum of 5 requests per minute
Authorizations:
HeaderApiKey
Request Body schema: application/json

ID of subjects to get nomenclatures

Array
integer

Responses

Request samples

Content type
application/json
[
  • 123,
  • 456,
  • 765,
  • 321
]

Response samples

Content type
application/json
[
  • {
    }
]

Campaigns Management

To access the methods, use a token for the Promotion category

Campaign bid update{{ /adv/v0/cpm }}

Описание метода

The changed bid will appear in the campaign information within 3 minutes.

If the rate to be set is less than the allowable rate, the status code 422 (Rate size not changed) will be returned.

The procedure for filling in the parameters type, instrument, param when changing the rate for a campaign with type 9 (Auction):
For 'type' it is necessary to specify the value 9 (always).
A value of 4 or 6 should be specified for instrument, depending on whether the rate is to be changed in the catalogue (deprecated campaign type) or in the search (deprecated campaign type).
For 'param' it is necessary to specify the value of the id field from the subject structure response of the Information about campaign method.

Maximum of 5 requests per second
Authorizations:
HeaderApiKey
Request Body schema: application/json
required
advertId
required
integer

Campaign ID where the bid is changing

type
required
integer
Enum: 5 6 7 8 9
Campaign type to change the price:
5 - campaign in content (deprecated type)
6 - campaign in search (deprecated type)
7 - campaign on main page recommendations (deprecated type)
8 - automatic campaign
9 - Auction campaign
cpm
required
integer

New bid value

param
required
integer

The parameter for which the change will be made is the value of subjectId (for search and recommendation campaigns (deprecated campaign types)), setId (for product card campaigns (deprecated campaign type)), or menuId (for catalog campaigns (deprecated campaign type)).
For automated campaigns, this parameter is not required.

instrument
integer

Campaign type for bid change in Auction

Responses

Request samples

Content type
application/json
{
  • "advertId": 789,
  • "type": 5,
  • "cpm": 456,
  • "param": 23,
  • "instrument": 4
}

Response samples

Content type
text/plain
Example
Incorrect value for parameter `param`

Delete campaign{{ /adv/v0/delete }}

Описание метода

The method allows to delete campaigns in the status 4 - ready to launch.

After deleting, the campaign will be in -1 status for a while.

It takes between 3 and 10 minutes to completely delete the campaign.

Maximum of 5 requests per second
Authorizations:
HeaderApiKey
query Parameters
id
required
integer

Campaign ID

Responses

Response samples

Content type
application/json

Invalid campaign identifier

{
  • "error": "Invalid campaign identifier"
}

Rename campaign{{ /adv/v0/rename }}

Описание метода

The method allows to rename a campaign.

Maximum of 5 requests per second
Authorizations:
HeaderApiKey
Request Body schema: application/json
advertId
required
integer

ID of the campaign that has the name change

name
required
string

New name (max 100 characters)

Responses

Request samples

Content type
application/json
{
  • "advertId": 2233344,
  • "name": "newnmame"
}

Response samples

Content type
text/plain
Example
Incorrect campaign identifier (RC ID)

Launch campaign{{ /adv/v0/start }}

Описание метода

The method allows to run campaigns that are in statuses 4 - ready to launch or 11 - paused campaign.

To run an ad campaign with status 11, it must have a replenished budget.

To run a campaign with status 4, it is necessary to do following (the order of actions does not matter):
1. After creating a campaign in the WB. Promotion cabinet click the `Apply changes` button.
2. Set the budget.
Maximum of 5 requests per second
Authorizations:
HeaderApiKey
query Parameters
id
required
integer
Example: id=1234

Campaign ID

Responses

Response samples

Content type
text/plain
Example
Incorrect campaign identifier (RC ID)

Pause campaign{{ /adv/v0/pause }}

Описание метода

Campaign in status 9 - active - can be paused

Maximum of 5 requests per second
Authorizations:
HeaderApiKey
query Parameters
id
required
integer
Example: id=1234

Campaign ID

Responses

Response samples

Content type
text/plain
Example
Incorrect campaign identifier (RC ID)

Stop campaign{{ /adv/v0/stop }}

Описание метода

The method allows to end campaigns that are in status 9, 11 or 4.

Maximum of 5 requests per second
Authorizations:
HeaderApiKey
query Parameters
id
required
integer
Example: id=1234

Campaign ID

Responses

Response samples

Content type
text/plain
Example
Incorrect campaign identifier (RC ID)

Finances

To access the methods, use a token for the Promotion category

Balance{{ /adv/v1/balance }}

Описание метода

The method allows to get information about the seller's net, balance and bonuses

Maximum of 1 request per second
Authorizations:
HeaderApiKey

Responses

Response samples

Content type
application/json
{
  • "balance": 11083,
  • "net": 0,
  • "bonus": 15187
}

Campaign budget{{ /adv/v1/budget }}

Описание метода

The method allows to get information about the budget of a campaign.

Maximum of 4 requests per second
Authorizations:
HeaderApiKey
query Parameters
id
required
integer
Example: id=1

Campaign ID

Responses

Response samples

Content type
application/json
{
  • "cash": 0,
  • "netting": 0,
  • "total": 500
}

Top-up of the campaign budget{{ /adv/v1/budget/deposit }}

Описание метода

The method allows to top up the budget of the campaign.

Maximum of 1 request per second
Authorizations:
HeaderApiKey
query Parameters
id
required
integer
Example: id=1234567

Campaign ID

Request Body schema: application/json
required
sum
integer

Top-up amount

type
integer
Type of top-up source:
0 - Account
1 - Balance
3 - Bonuses
return
boolean

Response return flag (true means updated campaign budget size will be returned in the response, false or empty means nothing will be returned).

Responses

Request samples

Content type
application/json
{
  • "sum": 5000,
  • "type": 1,
  • "return": true
}

Response samples

Content type
application/json

Response when return is true

{
  • "total": 500
}

Campaigns Parameters

To access the methods, use a token for the Promotion category

Managing the activity of fixed phrases{{ /adv/v1/search/set-plus }}

Описание метода

The method allows to change the activity of fixed phrases. Only for Auction campaigns.

Maximum of 1 request per 500 milliseconds
Authorizations:
HeaderApiKey
query Parameters
id
required
integer
Example: id=1234567

Campaign ID

fixed
boolean

New state (false - make inactive, true - make active)

Responses

Response samples

Content type
application/json
{
  • "title": "unauthorized",
  • "detail": "token problem; token is malformed: could not base64 decode signature: illegal base64 data at input byte 84",
  • "code": "07e4668e--a53a3d31f8b0-[UK-oWaVDUqNrKG]; 03bce=277; 84bd353bf-75",
  • "requestId": "7b80742415072fe8b6b7f7761f1d1211",
  • "origin": "s2s-api-auth-catalog",
  • "status": 401,
  • "statusText": "Unauthorized",
  • "timestamp": "2024-09-30T06:52:38Z"
}

Setting/deleting fixed phrases{{ /adv/v1/search/set-plus }}

Описание метода

The method allows to set and delete fixed phrases.Only for Auction campaigns.

Sending an empty array removes all fixed phrases and disables fixed phrase activity in the campaign.

Maximum of 1 request per 500 milliseconds
Authorizations:
HeaderApiKey
query Parameters
id
required
integer
Example: id=1234567

Campaign ID

Request Body schema: application/json
required
pluse
Array of strings

Fixed phrase list (max. 100)

Responses

Request samples

Content type
application/json
{
  • "pluse": [
    ]
}

Response samples

Content type
text/plain
[
  "Фраза 1",
  "Фраза 2"
]

Setting/removing minus-phrases of phrase matching{{ /adv/v1/search/set-phrase }}

Описание метода

Sets/removes minus-phrases of a phrase match. Only for Auction campaigns.

The Maximum of allowed number of minus-phrases in a campaign is 1000 pcs.
Posting an empty array removes all minus-phrase of phrase matching from the campaign.

Maximum of 2 requests per second
Authorizations:
HeaderApiKey
query Parameters
id
required
integer
Example: id=1234567

Campaign ID

Request Body schema: application/json
required
phrase
Array of strings

Minus-phrases (max. 1000 pcs.)

Responses

Request samples

Content type
application/json
{
  • "phrase": [
    ]
}

Response samples

Content type
application/json
{
  • "title": "unauthorized",
  • "detail": "token problem; token is malformed: could not base64 decode signature: illegal base64 data at input byte 84",
  • "code": "07e4668e--a53a3d31f8b0-[UK-oWaVDUqNrKG]; 03bce=277; 84bd353bf-75",
  • "requestId": "7b80742415072fe8b6b7f7761f1d1211",
  • "origin": "s2s-api-auth-catalog",
  • "status": 401,
  • "statusText": "Unauthorized",
  • "timestamp": "2024-09-30T06:52:38Z"
}

Setting/removing minus of exact match phrases{{ /adv/v1/search/set-strong }}

Описание метода

Sets/removes minus-phrases of exact match. Only for Auction campaigns.

The Maximum of allowed number of minus-phrases in a campaign is 1000 pcs.

Sending an empty array removes all minus-phrases of the exact match from the ad campaign.

Maximum of 2 requests per second
Authorizations:
HeaderApiKey
query Parameters
id
required
integer
Example: id=1234567

Campaign ID

Request Body schema: application/json
required
strong
Array of strings

Minus-phrases (max. 1000 pcs.)

Responses

Request samples

Content type
application/json
{
  • "strong": [
    ]
}

Response samples

Content type
application/json
{
  • "title": "unauthorized",
  • "detail": "token problem; token is malformed: could not base64 decode signature: illegal base64 data at input byte 84",
  • "code": "07e4668e--a53a3d31f8b0-[UK-oWaVDUqNrKG]; 03bce=277; 84bd353bf-75",
  • "requestId": "7b80742415072fe8b6b7f7761f1d1211",
  • "origin": "s2s-api-auth-catalog",
  • "status": 401,
  • "statusText": "Unauthorized",
  • "timestamp": "2024-09-30T06:52:38Z"
}

Setting/removing minus phrases from search{{ /adv/v1/search/set-excluded }}

Описание метода

Sets/removes minus-phrases for search. Only for Auction campaigns.

The Maximum of allowed number of minus-phrases in a campaign is 1000 pcs.
Sending an empty array removes all minus-phrases from the Search ad campaign.

Maximum of 2 requests per second
Authorizations:
HeaderApiKey
query Parameters
id
required
integer
Example: id=1234567

Campaign ID

Request Body schema: application/json
required
excluded
Array of strings

Minus-phrases (max. 1000 pcs.)

Responses

Request samples

Content type
application/json
{
  • "excluded": [
    ]
}

Response samples

Content type
application/json
{
  • "title": "unauthorized",
  • "detail": "token problem; token is malformed: could not base64 decode signature: illegal base64 data at input byte 84",
  • "code": "07e4668e--a53a3d31f8b0-[UK-oWaVDUqNrKG]; 03bce=277; 84bd353bf-75",
  • "requestId": "7b80742415072fe8b6b7f7761f1d1211",
  • "origin": "s2s-api-auth-catalog",
  • "status": 401,
  • "statusText": "Unauthorized",
  • "timestamp": "2024-09-30T06:52:38Z"
}

Setting/removing minus-phrases for automatic campaigns{{ /adv/v1/auto/set-excluded }}

Описание метода

The method allows to set or remove minus phrases.
Sending an empty array removes all minus phrases from the campaign.

Maximum of 1 request per 6 seconds
Authorizations:
HeaderApiKey
query Parameters
id
required
integer
Example: id=1234567

Campaign ID

Request Body schema: application/json
required
excluded
Array of strings

List of phrases (Maximum of 1000 pcs.)

Responses

Request samples

Content type
application/json
Example

Setting minus phrases

{
  • "excluded": [
    ]
}

Response samples

Content type
application/json
{
  • "title": "unauthorized",
  • "detail": "token problem; token is malformed: could not base64 decode signature: illegal base64 data at input byte 84",
  • "code": "07e4668e--a53a3d31f8b0-[UK-oWaVDUqNrKG]; 03bce=277; 84bd353bf-75",
  • "requestId": "7b80742415072fe8b6b7f7761f1d1211",
  • "origin": "s2s-api-auth-catalog",
  • "status": 401,
  • "statusText": "Unauthorized",
  • "timestamp": "2024-09-30T06:52:38Z"
}

List of nomenclatures for automatic campaign{{ /adv/v1/auto/getnmtoadd }}

Описание метода

The method allows to get the list of nomenclatures available for adding to the campaign.

Maximum of 1 request per second
Authorizations:
HeaderApiKey
query Parameters
id
required
integer
Example: id=1

Campaign ID

Responses

Response samples

Content type
text/plain
[
  1111111111,
  2222222222,
  3333333333,
  4444444444
]

Changing the list of nomenclatures in an automatic campaign{{ /adv/v1/auto/updatenm }}

Описание метода

The method allows you to add and remove nomenclatures.

It is possible to add only those nomenclatures that will be returned in the method response List of nomenclatures in an automatic campaign.
You cannot delete a one single nomenclature from a campaign.

There is no validation by the delete parameter.

If you receive a response with a status code of 200 and no change has occurred, check the request for documentation compliance

Maximum of 60 requests per minute per one seller's account
Authorizations:
HeaderApiKey
query Parameters
id
required
integer
Example: id=1

Campaign ID

Request Body schema: application/json
required
add
Array of integers

The nomenclatures that need to be added

delete
Array of integers

The nomenclatures that need to be deleted

Responses

Request samples

Content type
application/json
{
  • "add": [
    ],
  • "delete": [
    ]
}

Response samples

Content type
application/json
{
  • "error": "Not found"
}

Media

To access the methods, use a token for the Promotion category

Media campaigns number{{ /adv/v1/count }}

Описание метода

Method allows you to get the number of the seller's media campaigns.

Maximum of 10 requests per second per one seller's account
Authorizations:
HeaderApiKey

Responses

Response samples

Content type
application/json
{
  • "all": 6,
  • "adverts": [
    ]
}

List of media campaigns{{ /adv/v1/adverts }}

Описание метода

The method allows to get the list of media campaigns of the seller

Maximum of 10 requests per second per one seller's account
Authorizations:
HeaderApiKey
query Parameters
status
integer
Example: status=1
Media campaign status:
1 — template
2 — moderation
3 — rejected (with the possibility to resubmit for moderation)
4 — approved
5 — scheduled
6 — running
7 — completed
8 — refused
9 — paused by seller
10 — paused due to daily limit
11 — paused due to budget limit
type
integer
Example: type=1
Media campaign type:
1 — daily basis
2 — views basis
limit
integer
Example: limit=1

Number of campaigns in the response

offset
integer
Example: offset=1

Offset relative to the first media campaign

order
string
Example: order=id
The order in which the response is displayed:
create — by time of media campaign creation
id — by ID of media campaign creation
direction
string
Example: direction=desc
Sorting order:
desc — upward
asc — smaller to larger

Responses

Response samples

Content type
application/json
[
  • {
    },
  • {
    }
]

Information about media campaign{{ /adv/v1/advert }}

Описание метода

The method allows to get information about a single media campaign

Maximum of 10 requests per second per one seller's account
Authorizations:
HeaderApiKey
query Parameters
id
required
integer
Example: id=23569

Media campaign ID

Responses

Response samples

Content type
application/json
{
  • "advertId": 23569,
  • "name": "Реклама денег принеси",
  • "brand": "Plank",
  • "type": 2,
  • "status": 11,
  • "createTime": "2023-07-19T11:13:41.195138+03:00",
  • "extended": {
    },
  • "items": [
    ]
}

Change banner bid{{ /adv/v1/item/cpm/change }}

Описание метода

The method allows you to change the banner bid in the items structure.
Changes are only possible for campaigns in one of the following statuses: 4, 5, 6, 9, 10, 11.

Maximum of 10 requests per minute per one seller's account
Authorizations:
HeaderApiKey
Request Body schema: application/json
required
advert_id
required
integer

Media campaign ID

item_id
required
integer

Banner ID

cpm
required
string

New bid

Responses

Request samples

Content type
application/json
{
  • "advert_id": 80474,
  • "item_id": 41573,
  • "cpm": 300
}

Response samples

Content type
text/plain
Example
"Error in getting items: {x}", Error details

Launch media campaign{{ /adv/v1/advert/start }}

Описание метода

Method allows to run paused media campaigns.
After the campaign is launched, it will remain in status 4 for 2-5 minutes, after which the status will be updated to reflect the current configuration of the media campaign.

Statuses in which the media campaign can be launched:
9 - paused by the seller
11 - paused due to budget limit
Maximum of 10 requests per minute per one seller's account
Authorizations:
HeaderApiKey
Request Body schema: application/json
required
advert_id
required
integer

Media campaign ID

reason
string

Description of the starting reason

Responses

Request samples

Content type
application/json
{
  • "advert_id": 123456,
  • "reason": "Причина запуска"
}

Response samples

Content type
text/plain
Example
Campaign not found

Pause media campaign{{ /adv/v1/advert/pause }}

Описание метода

Method allows to pause media campaign.
Transfers the paused media campaign to status 9.

Statuses in which the media campaign can be paused:
4 — approved
5 — scheduled
6 — running
10 — paused due to daily limit
11 — paused due to budget limit
The media campaign can be paused no more than 10 times a day. The day is counted from midnight Moscow time.
Maximum of 10 requests per minute per one seller's account
Authorizations:
HeaderApiKey
Request Body schema: application/json
required
advert_id
required
integer

Media campaign ID

reason
string

Description of the pausing reason

Responses

Request samples

Content type
application/json
{
  • "advert_id": 123456,
  • "reason": "Описание причины приостановки"
}

Response samples

Content type
application/json
{
  • "title": "unauthorized",
  • "detail": "token problem; token is malformed: could not base64 decode signature: illegal base64 data at input byte 84",
  • "code": "07e4668e--a53a3d31f8b0-[UK-oWaVDUqNrKG]; 03bce=277; 84bd353bf-75",
  • "requestId": "7b80742415072fe8b6b7f7761f1d1211",
  • "origin": "s2s-api-auth-catalog",
  • "status": 401,
  • "statusText": "Unauthorized",
  • "timestamp": "2024-09-30T06:52:38Z"
}

Stop media campaign{{ /adv/v1/advert/stop }}

Описание метода

The method concludes the media campaign - it changes its status to 7.

Statuses in which a media campaign can be concluded:
1 — template
3 — rejected (with the possibility to resubmit for moderation)
4 — approved
5 — scheduled
6 — running
8 — refused
9 — paused by seller
10 — paused due to daily limit
11 — paused due to budget limit
Maximum of 10 requests per minute per one seller's account
Authorizations:
HeaderApiKey
Request Body schema: application/json
required
advert_id
required
integer

Media campaign ID

reason
string

Description of the reason for conclusion

Responses

Request samples

Content type
application/json
{
  • "advert_id": 123456,
  • "reason": "Description of the reason for conclusion"
}

Response samples

Content type
text/plain
Changing status is not possible