Применение промокода к кампании

Позволяет применить промокод к созданной рекламной кампании

Request

POST

https://geoadv-api.yandex.ru/priority/v1/apply-promocode

Body

application/json
{
  "promocode": "example",
  "campaignId": 0.5
}

Name

Description

campaignId

Type: number

ID рекламной кампании

promocode

Type: string

Код промокода.

Example: example

Responses

200 OK

Возращает все цены по всем продуктам.

Body

application/json
{
  "data": {
    "promocode": "example",
    "applicable": true
  },
  "error": {
    "code": 0.5,
    "message": "example",
    "businessCode": "example",
    "businessData": {
      "promocode": "example",
      "nonApplicableReasonCode": "example",
      "nonApplicableReasonText": "example"
    }
  }
}

Name

Description

data

Type: ApplyPromocodeAnswerData

Example
{
  "promocode": "example",
  "applicable": true
}

error

Type: ApplyPromocodeAnswerError

Example
{
  "code": 0.5,
  "message": "example",
  "businessCode": "example",
  "businessData": {
    "promocode": "example",
    "nonApplicableReasonCode": "example",
    "nonApplicableReasonText": "example"
  }
}

ApplyPromocodeAnswerData

Name

Description

applicable

Type: boolean

Применился промокод или нет

promocode

Type: string

Код промокода.

Example: example

Example
{
  "promocode": "example",
  "applicable": true
}

ApplyPromocodeAnswerErrorBusinessData

Name

Description

nonApplicableReasonCode

Type: string

Код ошибки

Example: example

nonApplicableReasonText

Type: string

Код ошибки

Example: example

promocode

Type: string

Код ошибки

Example: example

Example
{
  "promocode": "example",
  "nonApplicableReasonCode": "example",
  "nonApplicableReasonText": "example"
}

ApplyPromocodeAnswerError

Name

Description

businessCode

Type: string

Сообщение ошибки

Example: example

businessData

Type: ApplyPromocodeAnswerErrorBusinessData

Example
{
  "promocode": "example",
  "nonApplicableReasonCode": "example",
  "nonApplicableReasonText": "example"
}

code

Type: number

Код ошибки

message

Type: string

Сообщение ошибки

Example: example

Example
{
  "code": 0.5,
  "message": "example",
  "businessCode": "example",
  "businessData": {
    "promocode": "example",
    "nonApplicableReasonCode": "example",
    "nonApplicableReasonText": "example"
  }
}