POST api/goods/ItemListAction

Добавление/изменение статического списка кодов товаров и получение информации о товарах в списке

Request Information

URI Parameters

None.

Body Parameters

ItemListActionRequest
NameDescriptionTypeAdditional information
Name

Наименование списка товаров (для Create и Update)

string

None.

ActionType

Тип действия, которое необходимо произвести (Create, Update, Info, Delete)

string

None.

Active

Признак активации списка (для Update, Create)

boolean

None.

NoActive

Признак деактивации списка (для Update, Create)

boolean

None.

ItemCodeList

Массив кодов товаров с наименованиями (для Update, Delete, Create)

Collection of ItemListActionItemCode

None.

Exclude

Признак "исключения из условий действия правила" на списке кодов товаров (для Create, Update)

boolean

None.

ItemListId

Идентификатор списка который будут менять или в котором будут произодить изменения (для Update, Delete, Info)

integer

None.

Detail

Входной фильтр: признак, что нужно вернуть селект с детализацией по товарам (для Info, Create)

boolean

None.

Start

Пагинация: от какой записи возвращать данные, включая указанную (для Info c Detail = 1)

integer

None.

Length

Пагинация: количество записей, которые нужно вернуть (для Info c Detail = 1)

integer

None.

ItemListCode

Входнйо фильтр: код товара

string

None.

ItemListCodeName

Входной фильтр: наименование товара в списке кодов товаров (для Info c Detail = 1)

string

None.

ItemListExclude

Входной фильтр: признак "исключения из условий действия правила" на списке кодов товаров

boolean

None.

Operator

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

integer

None.

Token

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

integer

None.

SiteCode

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

string

None.

Request Formats

application/json, text/json

Sample:
{
  "Name": "sample string 1",
  "ActionType": "sample string 2",
  "Active": true,
  "NoActive": true,
  "ItemCodeList": [
    {
      "Id": 1,
      "Code": "sample string 1",
      "CodeName": "sample string 2"
    },
    {
      "Id": 1,
      "Code": "sample string 1",
      "CodeName": "sample string 2"
    }
  ],
  "Exclude": true,
  "ItemListId": 1,
  "Detail": true,
  "Start": 1,
  "Length": 1,
  "ItemListCode": "sample string 3",
  "ItemListCodeName": "sample string 4",
  "ItemListExclude": true,
  "Operator": 1,
  "Token": 1,
  "SiteCode": "sample string 5"
}

application/xml, text/xml

Sample:
<ItemListActionRequest xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/LCManagerPartner.Implementation.Request.GoodsRequest">
  <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 5</SiteCode>
  <Token xmlns="http://schemas.datacontract.org/2004/07/LCManagerPartner.Implementation.Abstractions">1</Token>
  <ActionType>sample string 2</ActionType>
  <Active>true</Active>
  <Detail>true</Detail>
  <Exclude>true</Exclude>
  <ItemCodeList>
    <ItemListActionRequest.ItemListActionItemCode>
      <Code>sample string 1</Code>
      <CodeName>sample string 2</CodeName>
      <Id>1</Id>
    </ItemListActionRequest.ItemListActionItemCode>
    <ItemListActionRequest.ItemListActionItemCode>
      <Code>sample string 1</Code>
      <CodeName>sample string 2</CodeName>
      <Id>1</Id>
    </ItemListActionRequest.ItemListActionItemCode>
  </ItemCodeList>
  <ItemListCode>sample string 3</ItemListCode>
  <ItemListCodeName>sample string 4</ItemListCodeName>
  <ItemListExclude>true</ItemListExclude>
  <ItemListId>1</ItemListId>
  <Length>1</Length>
  <Name>sample string 1</Name>
  <NoActive>true</NoActive>
  <Start>1</Start>
</ItemListActionRequest>

application/x-www-form-urlencoded

Sample:

Sample not available.

Response Information

Resource Description

ItemListActionResponse
NameDescriptionTypeAdditional information
ItemList

Идентификатор созданного списка кодов товаров (для Create)

integer

None.

ListName

Наименование списка товара

string

None.

ListCountCode

Количество товаров в списке

integer

None.

ListProcTime

Дата и время создания списка

date

None.

ListActive

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

boolean

None.

ListExclude

Признак "исключения из условий действия правила" на списке кодов товаров

boolean

None.

TotalRows

Количество записей всего (для Info c Detail = 1)

integer

None.

TotalRowsSelect

Количество записей в запросе (для Info c Detail = 1)

integer

None.

ItemCodeListOut

Массив кодов товаров с наименованиями

Collection of ItemListActionItemCodeOut

None.

ErrorCode

Код ошибки

integer

None.

Message

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

string

None.

Response Formats

application/json, text/json

Sample:
{
  "ItemList": 1,
  "ListName": "sample string 1",
  "ListCountCode": 1,
  "ListProcTime": "2024-06-16T11:50:06.1933666+03:00",
  "ListActive": true,
  "ListExclude": true,
  "TotalRows": 1,
  "TotalRowsSelect": 1,
  "ItemCodeListOut": [
    {
      "Id": 1,
      "Code": "sample string 1",
      "CodeName": "sample string 2"
    },
    {
      "Id": 1,
      "Code": "sample string 1",
      "CodeName": "sample string 2"
    }
  ],
  "ErrorCode": 2,
  "Message": "sample string 3"
}

application/xml, text/xml

Sample:
<ItemListActionResponse xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/LCManagerPartner.Implementation.Response.GoodsResponse">
  <ErrorCode xmlns="http://schemas.datacontract.org/2004/07/LCManagerPartner.Implementation.Abstractions">2</ErrorCode>
  <Message xmlns="http://schemas.datacontract.org/2004/07/LCManagerPartner.Implementation.Abstractions">sample string 3</Message>
  <ItemCodeListOut>
    <ItemListActionResponse.ItemListActionItemCodeOut>
      <Code>sample string 1</Code>
      <CodeName>sample string 2</CodeName>
      <Id>1</Id>
    </ItemListActionResponse.ItemListActionItemCodeOut>
    <ItemListActionResponse.ItemListActionItemCodeOut>
      <Code>sample string 1</Code>
      <CodeName>sample string 2</CodeName>
      <Id>1</Id>
    </ItemListActionResponse.ItemListActionItemCodeOut>
  </ItemCodeListOut>
  <ItemList>1</ItemList>
  <ListActive>true</ListActive>
  <ListCountCode>1</ListCountCode>
  <ListExclude>true</ListExclude>
  <ListName>sample string 1</ListName>
  <ListProcTime>2024-06-16T11:50:06.1933666+03:00</ListProcTime>
  <TotalRows>1</TotalRows>
  <TotalRowsSelect>1</TotalRowsSelect>
</ItemListActionResponse>