POST api/pos/PosAction

Добавление, изменение, получение информации о точке продаж и её настройках

Request Information

URI Parameters

None.

Body Parameters

PosActionRequest
NameDescriptionTypeAdditional information
ActionType

Тип действия (Create, Update, Info)

string

None.

Partner

Идентификатор партнера, которому добавляем точку

integer

None.

PosId

Идентификатор изменяемой торговой точки (для Update)

integer

None.

Name

Наименование точки (для отображения в ЛК и мобильном приложении)

string

None.

Code

Код торговой точки

string

None.

City

Идентификатор города

integer

None.

Address

Адрес точки (без города)

string

None.

MapPosition

Координаты точки (долгота/широта)

string

None.

Phone

Номер телефона точки

string

None.

Shown

Признак отображать точку или нет (для ЛК и мобильного приложения)

boolean

None.

SetClientPassword

Признак, отправлять или нет пароль при регистрации в этой точке

boolean

None.

DiscountRule

Признак, что в этой точке работают дисконтные правила (если не проставлено, то по этой точке вообще не будут анализироваться дисконтные правила)

boolean

None.

RedeemRuleDisc

Признак, разрешено ли на точке списание при заданном дисконте

boolean

None.

DiscRedeemRule

Признк, разрешен ли дисконт на точке при заданном списании

boolean

None.

LandMark

Ориентир, по которому можной найти точку (для мобильного приложения)

string

None.

Description

Описание точки (для мобильного приложения)

string

None.

WorkDescription

График работы обычными словами, должно быть с переносом строки (для мобильного приложения)

string

None.

OpenTimeWeekday

Время открытия магазина (для мобильного приложения)

time interval

None.

ClosTimeWeekday

Время закрытия магазина (для мобильного приложения)

time interval

None.

OpenTimeSaturday

Время открытия_суббота

time interval

None.

ClosTimeSaturday

Время закрытия_суббота

time interval

None.

OpenTimeSunday

Время открытия_воскресенье

time interval

None.

ClosTimeSunday

Время закрытия_воскресенье

time interval

None.

PosInMobile

Признак, что это та самая одна точка партнера, которую нужно отображать в мобильном приложении

boolean

None.

LlcIpCompany

Наименование юридического лица или ИП точки продаж

string

None.

Operator

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

integer

None.

Token

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

integer

None.

SiteCode

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

string

None.

Request Formats

application/json, text/json

Sample:
{
  "ActionType": "sample string 1",
  "Partner": 1,
  "PosId": 1,
  "Name": "sample string 2",
  "Code": "sample string 3",
  "City": 1,
  "Address": "sample string 4",
  "MapPosition": "sample string 5",
  "Phone": "sample string 6",
  "Shown": true,
  "SetClientPassword": true,
  "DiscountRule": true,
  "RedeemRuleDisc": true,
  "DiscRedeemRule": true,
  "LandMark": "sample string 7",
  "Description": "sample string 8",
  "WorkDescription": "sample string 9",
  "OpenTimeWeekday": "00:00:00.1234567",
  "ClosTimeWeekday": "00:00:00.1234567",
  "OpenTimeSaturday": "00:00:00.1234567",
  "ClosTimeSaturday": "00:00:00.1234567",
  "OpenTimeSunday": "00:00:00.1234567",
  "ClosTimeSunday": "00:00:00.1234567",
  "PosInMobile": true,
  "LlcIpCompany": "sample string 10",
  "Operator": 1,
  "Token": 1,
  "SiteCode": "sample string 11"
}

application/xml, text/xml

Sample:
<PosActionRequest xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/LCManagerPartner.Implementation.Request">
  <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 11</SiteCode>
  <Token xmlns="http://schemas.datacontract.org/2004/07/LCManagerPartner.Implementation.Abstractions">1</Token>
  <ActionType>sample string 1</ActionType>
  <Address>sample string 4</Address>
  <City>1</City>
  <ClosTimeSaturday>PT0.1234567S</ClosTimeSaturday>
  <ClosTimeSunday>PT0.1234567S</ClosTimeSunday>
  <ClosTimeWeekday>PT0.1234567S</ClosTimeWeekday>
  <Code>sample string 3</Code>
  <Description>sample string 8</Description>
  <DiscRedeemRule>true</DiscRedeemRule>
  <DiscountRule>true</DiscountRule>
  <LandMark>sample string 7</LandMark>
  <LlcIpCompany>sample string 10</LlcIpCompany>
  <MapPosition>sample string 5</MapPosition>
  <Name>sample string 2</Name>
  <OpenTimeSaturday>PT0.1234567S</OpenTimeSaturday>
  <OpenTimeSunday>PT0.1234567S</OpenTimeSunday>
  <OpenTimeWeekday>PT0.1234567S</OpenTimeWeekday>
  <Partner>1</Partner>
  <Phone>sample string 6</Phone>
  <PosId>1</PosId>
  <PosInMobile>true</PosInMobile>
  <RedeemRuleDisc>true</RedeemRuleDisc>
  <SetClientPassword>true</SetClientPassword>
  <Shown>true</Shown>
  <WorkDescription>sample string 9</WorkDescription>
</PosActionRequest>

application/x-www-form-urlencoded

Sample:

Sample not available.

Response Information

Resource Description

PosActionResponse
NameDescriptionTypeAdditional information
Pos

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

integer

None.

Data

Массив итоговых данных

Collection of PosActionDataRow

None.

ErrorCode

Код ошибки

integer

None.

Message

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

string

None.

Response Formats

application/json, text/json

Sample:
{
  "Pos": 1,
  "Data": [
    {
      "Id": 1,
      "Code": "sample string 1",
      "Partner": 1,
      "PartnerName": "sample string 2",
      "City": 1,
      "CityName": "sample string 3",
      "Address": "sample string 4",
      "Name": "sample string 5",
      "MapPosition": "sample string 6",
      "Phone": "sample string 7",
      "Shown": true,
      "LandMark": "sample string 8",
      "Description": "sample string 9",
      "OpenTime": "00:00:00.1234567",
      "ClosTime": "00:00:00.1234567",
      "OpenTimeSaturday": "00:00:00.1234567",
      "ClosTimeSaturday": "00:00:00.1234567",
      "OpenTimeSunday": "00:00:00.1234567",
      "ClosTimeSunday": "00:00:00.1234567",
      "WorkDescription": "sample string 10",
      "UserId": 1,
      "UserStatus": 64,
      "UserStatusName": "sample string 11",
      "LlcIpCompany": "sample string 12"
    },
    {
      "Id": 1,
      "Code": "sample string 1",
      "Partner": 1,
      "PartnerName": "sample string 2",
      "City": 1,
      "CityName": "sample string 3",
      "Address": "sample string 4",
      "Name": "sample string 5",
      "MapPosition": "sample string 6",
      "Phone": "sample string 7",
      "Shown": true,
      "LandMark": "sample string 8",
      "Description": "sample string 9",
      "OpenTime": "00:00:00.1234567",
      "ClosTime": "00:00:00.1234567",
      "OpenTimeSaturday": "00:00:00.1234567",
      "ClosTimeSaturday": "00:00:00.1234567",
      "OpenTimeSunday": "00:00:00.1234567",
      "ClosTimeSunday": "00:00:00.1234567",
      "WorkDescription": "sample string 10",
      "UserId": 1,
      "UserStatus": 64,
      "UserStatusName": "sample string 11",
      "LlcIpCompany": "sample string 12"
    }
  ],
  "ErrorCode": 1,
  "Message": "sample string 2"
}

application/xml, text/xml

Sample:
<PosActionResponse xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/LCManagerPartner.Implementation.Response">
  <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>
  <Data>
    <PosActionResponse.PosActionDataRow>
      <Address>sample string 4</Address>
      <City>1</City>
      <CityName>sample string 3</CityName>
      <ClosTime>PT0.1234567S</ClosTime>
      <ClosTimeSaturday>PT0.1234567S</ClosTimeSaturday>
      <ClosTimeSunday>PT0.1234567S</ClosTimeSunday>
      <Code>sample string 1</Code>
      <Description>sample string 9</Description>
      <Id>1</Id>
      <LandMark>sample string 8</LandMark>
      <LlcIpCompany>sample string 12</LlcIpCompany>
      <MapPosition>sample string 6</MapPosition>
      <Name>sample string 5</Name>
      <OpenTime>PT0.1234567S</OpenTime>
      <OpenTimeSaturday>PT0.1234567S</OpenTimeSaturday>
      <OpenTimeSunday>PT0.1234567S</OpenTimeSunday>
      <Partner>1</Partner>
      <PartnerName>sample string 2</PartnerName>
      <Phone>sample string 7</Phone>
      <Shown>true</Shown>
      <UserId>1</UserId>
      <UserStatus>64</UserStatus>
      <UserStatusName>sample string 11</UserStatusName>
      <WorkDescription>sample string 10</WorkDescription>
    </PosActionResponse.PosActionDataRow>
    <PosActionResponse.PosActionDataRow>
      <Address>sample string 4</Address>
      <City>1</City>
      <CityName>sample string 3</CityName>
      <ClosTime>PT0.1234567S</ClosTime>
      <ClosTimeSaturday>PT0.1234567S</ClosTimeSaturday>
      <ClosTimeSunday>PT0.1234567S</ClosTimeSunday>
      <Code>sample string 1</Code>
      <Description>sample string 9</Description>
      <Id>1</Id>
      <LandMark>sample string 8</LandMark>
      <LlcIpCompany>sample string 12</LlcIpCompany>
      <MapPosition>sample string 6</MapPosition>
      <Name>sample string 5</Name>
      <OpenTime>PT0.1234567S</OpenTime>
      <OpenTimeSaturday>PT0.1234567S</OpenTimeSaturday>
      <OpenTimeSunday>PT0.1234567S</OpenTimeSunday>
      <Partner>1</Partner>
      <PartnerName>sample string 2</PartnerName>
      <Phone>sample string 7</Phone>
      <Shown>true</Shown>
      <UserId>1</UserId>
      <UserStatus>64</UserStatus>
      <UserStatusName>sample string 11</UserStatusName>
      <WorkDescription>sample string 10</WorkDescription>
    </PosActionResponse.PosActionDataRow>
  </Data>
  <Pos>1</Pos>
</PosActionResponse>