POST api/sertcard/OrderForSale
Получение необходимого количества сертификатов и данных по ним для продажи во внешней системе
Request Information
URI Parameters
None.
Body Parameters
OrderForSaleRequestName | Description | Type | Additional information |
---|---|---|---|
Partner |
Идентификатор партнера |
integer |
None. |
PosCode |
Идентификатор торговой точки |
string |
None. |
Amount |
Количество номеров, которые нужно сгенерить |
integer |
None. |
CorpOrder |
Признак, что это корпоративный заказ |
boolean |
None. |
SalesChannel |
Наименование внешней системы, от которой пришёл запрос на выдачу сертификатов |
string |
None. |
Operator |
Идентификатор оператора программы лояльности |
integer |
None. |
Token |
Токен пользователя, который инициирует данный запрос |
integer |
None. |
SiteCode |
Уникальный код виджета по продаже подарочных сертификатов, который инициирует запрос |
string |
None. |
Request Formats
application/json, text/json
{ "Partner": 1, "PosCode": "sample string 1", "Amount": 1, "CorpOrder": true, "SalesChannel": "sample string 2", "Operator": 1, "Token": 1, "SiteCode": "sample string 3" }
application/xml, text/xml
<OrderForSaleRequest xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/LCManagerPartner.Implementation.Request.SertCardRequest"> <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 3</SiteCode> <Token xmlns="http://schemas.datacontract.org/2004/07/LCManagerPartner.Implementation.Abstractions">1</Token> <Amount>1</Amount> <CorpOrder>true</CorpOrder> <Partner>1</Partner> <PosCode>sample string 1</PosCode> <SalesChannel>sample string 2</SalesChannel> </OrderForSaleRequest>
application/x-www-form-urlencoded
Sample not available.
Response Information
Resource Description
OrderForSaleResponseName | Description | Type | Additional information |
---|---|---|---|
MinFreeNominal |
Минимальное значение свободного номинала сертификата |
integer |
None. |
MaxFreeNominal |
Максимально значение свободного номинала сертификата |
integer |
None. |
AllCountNumber |
Общее количество номеров, которые смогли вернуть |
integer |
None. |
ExpDays |
Количество дней после активации, через которое сертификаты переходят в статус "заблокирован" |
integer |
None. |
ExpDate |
Конкретная дата, в которую сертификаты переходят в статус "заблокирован" |
date |
None. |
Design |
Дизайны |
Collection of OrderForSaleDesign |
None. |
Nominal |
Номиналы |
Collection of OrderForSaleNominal |
None. |
Serts |
Сертификаты |
Collection of OrderForSaleSerts |
None. |
ErrorCode |
Код ошибки |
integer |
None. |
Message |
Сообщение об ошибке |
string |
None. |
Response Formats
application/json, text/json
{ "MinFreeNominal": 1, "MaxFreeNominal": 1, "AllCountNumber": 1, "ExpDays": 1, "ExpDate": "2025-02-06T16:42:01.2846238+03:00", "Design": [ { "UrlImage": "sample string 1", "Main": true }, { "UrlImage": "sample string 1", "Main": true } ], "Nominal": [ { "Nominal": 1.0, "Name": "sample string 1" }, { "Nominal": 1.0, "Name": "sample string 1" } ], "Serts": [ { "Number": "sample string 1", "SertCardStatus": 64, "AllowReuse": true, "AllowRefund": true }, { "Number": "sample string 1", "SertCardStatus": 64, "AllowReuse": true, "AllowRefund": true } ], "ErrorCode": 1, "Message": "sample string 2" }
application/xml, text/xml
<OrderForSaleResponse xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/LCManagerPartner.Implementation.Response.SertCardResponse"> <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> <AllCountNumber>1</AllCountNumber> <Design> <OrderForSaleResponse.OrderForSaleDesign> <Main>true</Main> <UrlImage>sample string 1</UrlImage> </OrderForSaleResponse.OrderForSaleDesign> <OrderForSaleResponse.OrderForSaleDesign> <Main>true</Main> <UrlImage>sample string 1</UrlImage> </OrderForSaleResponse.OrderForSaleDesign> </Design> <ExpDate>2025-02-06T16:42:01.2846238+03:00</ExpDate> <ExpDays>1</ExpDays> <MaxFreeNominal>1</MaxFreeNominal> <MinFreeNominal>1</MinFreeNominal> <Nominal> <OrderForSaleResponse.OrderForSaleNominal> <Name>sample string 1</Name> <Nominal>1</Nominal> </OrderForSaleResponse.OrderForSaleNominal> <OrderForSaleResponse.OrderForSaleNominal> <Name>sample string 1</Name> <Nominal>1</Nominal> </OrderForSaleResponse.OrderForSaleNominal> </Nominal> <Serts> <OrderForSaleResponse.OrderForSaleSerts> <AllowRefund>true</AllowRefund> <AllowReuse>true</AllowReuse> <Number>sample string 1</Number> <SertCardStatus>64</SertCardStatus> </OrderForSaleResponse.OrderForSaleSerts> <OrderForSaleResponse.OrderForSaleSerts> <AllowRefund>true</AllowRefund> <AllowReuse>true</AllowReuse> <Number>sample string 1</Number> <SertCardStatus>64</SertCardStatus> </OrderForSaleResponse.OrderForSaleSerts> </Serts> </OrderForSaleResponse>