POST api/marketing/CampaignCreate

Создание маркетинговой кампании/акции определённого типа

Request Information

URI Parameters

None.

Body Parameters

CampaignCreateRequest
NameDescriptionTypeAdditional information
CampaignType

Идентификатор типа акции (1 = Акция, 2 = Оффер)

byte

None.

Name

Наименование

string

None.

Active

Статус активности

boolean

None.

StartDate

Дата начала действия

date

None.

EndDate

Дата окончания действия

date

None.

Description

Описание

string

None.

Logo

Ссылка на изображение

string

None.

BigLogo

Ссылка на большое изображение

string

None.

Title

Заголовок

string

None.

SubTitle

Подзаголовок

string

None.

MarketList

Маркетиновый список, которому отображается акция как доступная

integer

None.

Partner

Партнер, у которого действует акция

integer

None.

Pos

Точка продаж, в которой действует акция

integer

None.

PosList

Список точек продаж, в которых действует акция

integer

None.

NoPoses

Признак, что акция действует не в точках продаж и не нужно выводить список точек

boolean

None.

New

Признак, что эта акция "новинка" (для тегов и фильтрации)

boolean

None.

Recommended

Признак, что эта акция "рекомендуемая" (для тегов и фильтрации)

boolean

None.

MainPage

Признак, что эту акцию нужно отобразить на гл. странице сайта/гл. экране моб. приложения

boolean

None.

OfferType

Тип оффера по акции (1 = промокод, 2 = промоссылка)

byte

None.

OfferUrl

Ссылка, по которой будет доступен оффер (пользователь должен по этой ссылке перейти)

string

None.

Price

Цена оффера по акции

decimal number

None.

OldPrice

Старая цена оффера по акции

decimal number

None.

ExpireDaysBefore

За сколько дней до окончания срока действия оффера по акции отображать признак "сгорающая акция"

byte

None.

Operator

Идентификатор оператора программы лояльности

integer

None.

Token

Токен пользователя, который инициирует данный запрос

integer

None.

SiteCode

Уникальный код виджета по продаже подарочных сертификатов, который инициирует запрос

string

None.

Request Formats

application/json, text/json

Sample:
{
  "CampaignType": 64,
  "Name": "sample string 1",
  "Active": true,
  "StartDate": "2022-08-14T16:16:24.6121516+03:00",
  "EndDate": "2022-08-14T16:16:24.6121516+03:00",
  "Description": "sample string 2",
  "Logo": "sample string 3",
  "BigLogo": "sample string 4",
  "Title": "sample string 5",
  "SubTitle": "sample string 6",
  "MarketList": 1,
  "Partner": 1,
  "Pos": 1,
  "PosList": 1,
  "NoPoses": true,
  "New": true,
  "Recommended": true,
  "MainPage": true,
  "OfferType": 64,
  "OfferUrl": "sample string 7",
  "Price": 1.0,
  "OldPrice": 1.0,
  "ExpireDaysBefore": 64,
  "Operator": 1,
  "Token": 1,
  "SiteCode": "sample string 8"
}

application/xml, text/xml

Sample:
<CampaignCreateRequest xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/LCManagerPartner.Implementation.Request.MarketingRequest">
  <Operator xmlns="http://schemas.datacontract.org/2004/07/LCManagerPartner.Implementation.Abstractions">1</Operator>
  <SiteCode xmlns="http://schemas.datacontract.org/2004/07/LCManagerPartner.Implementation.Abstractions">sample string 8</SiteCode>
  <Token xmlns="http://schemas.datacontract.org/2004/07/LCManagerPartner.Implementation.Abstractions">1</Token>
  <Active>true</Active>
  <BigLogo>sample string 4</BigLogo>
  <CampaignType>64</CampaignType>
  <Description>sample string 2</Description>
  <EndDate>2022-08-14T16:16:24.6121516+03:00</EndDate>
  <ExpireDaysBefore>64</ExpireDaysBefore>
  <Logo>sample string 3</Logo>
  <MainPage>true</MainPage>
  <MarketList>1</MarketList>
  <Name>sample string 1</Name>
  <New>true</New>
  <NoPoses>true</NoPoses>
  <OfferType>64</OfferType>
  <OfferUrl>sample string 7</OfferUrl>
  <OldPrice>1</OldPrice>
  <Partner>1</Partner>
  <Pos>1</Pos>
  <PosList>1</PosList>
  <Price>1</Price>
  <Recommended>true</Recommended>
  <StartDate>2022-08-14T16:16:24.6121516+03:00</StartDate>
  <SubTitle>sample string 6</SubTitle>
  <Title>sample string 5</Title>
</CampaignCreateRequest>

application/x-www-form-urlencoded

Sample:

Sample not available.

Response Information

Resource Description

CampaignCreateResponse
NameDescriptionTypeAdditional information
Id

Идентификатор созданной акции

integer

None.

ErrorCode

Код ошибки

integer

None.

Message

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

string

None.

Response Formats

application/json, text/json

Sample:
{
  "Id": 1,
  "ErrorCode": 1,
  "Message": "sample string 2"
}

application/xml, text/xml

Sample:
<CampaignCreateResponse xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/LCManagerPartner.Implementation.Response.MarketingResponse">
  <ErrorCode xmlns="http://schemas.datacontract.org/2004/07/LCManagerPartner.Implementation.Abstractions">1</ErrorCode>
  <Message xmlns="http://schemas.datacontract.org/2004/07/LCManagerPartner.Implementation.Abstractions">sample string 2</Message>
  <Id>1</Id>
</CampaignCreateResponse>