POST api/sertcard/Order

Создание заказа или изменение ранее созданного заказа по продаже подарочных сертификатов

Request Information

URI Parameters

None.

Body Parameters

OrderRequest
NameDescriptionTypeAdditional information
SessionId

Идентфикатор сессии сайта, в рамках которой создаётся заказ

string

None.

PaymentStatus

Статус платежа от платёжного провайдера

string

None.

PaymentId

Идентификатор платежа

string

None.

OrderNumber

Номер заказа

string

None.

OrderDescription

Описание заказа, которое отправляли платёжному провайдеру

string

None.

ReceiptChequeNumber

Номер чека от онлайн-кассы

string

None.

SertCardownerId

Идентификатор владельца сертификата, которому создаём заказ

integer

None.

CardLoyalty

Номер карты лояльности, которая была применена к данному заказу

integer

None.

PhoneLoyalty

Номер телефона клиента лояльности, который был применён к заказу

integer

None.

Redeemed

Общее списание бонусов в заказе

decimal number

None.

Amount

Общая цена заказа

decimal number

None.

Quantity

Общее количество сертификатов, купленных в данном заказе

byte

None.

OrderStatus

Статус создаваемого заказа (1 = "Корзина", 2 = "Заказ")

byte

None.

ActionType

Тип действия, которое нужно совершить (create = создать заказ, update = изменить ранее созданный заказ по его идентификатору)

string

None.

SertCardOwner

Контактные данные владельца сертификата для его создания

OrderCreateSertCardOwner

None.

SertCardItems

Позиции заказа

Collection of OrderCreateSertCardItems

None.

Operator

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

integer

None.

Token

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

integer

None.

SiteCode

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

string

None.

Request Formats

application/json, text/json

Sample:
{
  "SessionId": "sample string 1",
  "PaymentStatus": "sample string 2",
  "PaymentId": "sample string 3",
  "OrderNumber": "sample string 4",
  "OrderDescription": "sample string 5",
  "ReceiptChequeNumber": "sample string 6",
  "SertCardownerId": 1,
  "CardLoyalty": 1,
  "PhoneLoyalty": 1,
  "Redeemed": 1.0,
  "Amount": 1.0,
  "Quantity": 64,
  "OrderStatus": 64,
  "ActionType": "sample string 7",
  "SertCardOwner": {
    "Name": "sample string 1",
    "Email": "sample string 2",
    "Phone": 1
  },
  "SertCardItems": [
    {
      "Id": 1,
      "Name": "sample string 2",
      "Quantity": 1,
      "Price": 1.0,
      "Amount": 1.0,
      "Image": "sample string 3",
      "Congratulation": "sample string 4",
      "Redeemed": 1.0,
      "CommunicationType": 64,
      "SertOwnerId": 1,
      "SertOwnerPhone": 1,
      "SertOwnerEmail": "sample string 5",
      "SertOwnerName": "sample string 6",
      "SendMessageTime": "2022-08-16T23:14:01.0883595+03:00"
    },
    {
      "Id": 1,
      "Name": "sample string 2",
      "Quantity": 1,
      "Price": 1.0,
      "Amount": 1.0,
      "Image": "sample string 3",
      "Congratulation": "sample string 4",
      "Redeemed": 1.0,
      "CommunicationType": 64,
      "SertOwnerId": 1,
      "SertOwnerPhone": 1,
      "SertOwnerEmail": "sample string 5",
      "SertOwnerName": "sample string 6",
      "SendMessageTime": "2022-08-16T23:14:01.0883595+03:00"
    }
  ],
  "Operator": 1,
  "Token": 1,
  "SiteCode": "sample string 8"
}

application/xml, text/xml

Sample:
<OrderRequest 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 8</SiteCode>
  <Token xmlns="http://schemas.datacontract.org/2004/07/LCManagerPartner.Implementation.Abstractions">1</Token>
  <ActionType>sample string 7</ActionType>
  <Amount>1</Amount>
  <CardLoyalty>1</CardLoyalty>
  <OrderDescription>sample string 5</OrderDescription>
  <OrderNumber>sample string 4</OrderNumber>
  <OrderStatus>64</OrderStatus>
  <PaymentId>sample string 3</PaymentId>
  <PaymentStatus>sample string 2</PaymentStatus>
  <PhoneLoyalty>1</PhoneLoyalty>
  <Quantity>64</Quantity>
  <ReceiptChequeNumber>sample string 6</ReceiptChequeNumber>
  <Redeemed>1</Redeemed>
  <SertCardItems>
    <OrderRequest.OrderCreateSertCardItems>
      <Amount>1</Amount>
      <CommunicationType>64</CommunicationType>
      <Congratulation>sample string 4</Congratulation>
      <Id>1</Id>
      <Image>sample string 3</Image>
      <Name>sample string 2</Name>
      <Price>1</Price>
      <Quantity>1</Quantity>
      <Redeemed>1</Redeemed>
      <SendMessageTime>2022-08-16T23:14:01.0883595+03:00</SendMessageTime>
      <SertOwnerEmail>sample string 5</SertOwnerEmail>
      <SertOwnerId>1</SertOwnerId>
      <SertOwnerName>sample string 6</SertOwnerName>
      <SertOwnerPhone>1</SertOwnerPhone>
    </OrderRequest.OrderCreateSertCardItems>
    <OrderRequest.OrderCreateSertCardItems>
      <Amount>1</Amount>
      <CommunicationType>64</CommunicationType>
      <Congratulation>sample string 4</Congratulation>
      <Id>1</Id>
      <Image>sample string 3</Image>
      <Name>sample string 2</Name>
      <Price>1</Price>
      <Quantity>1</Quantity>
      <Redeemed>1</Redeemed>
      <SendMessageTime>2022-08-16T23:14:01.0883595+03:00</SendMessageTime>
      <SertOwnerEmail>sample string 5</SertOwnerEmail>
      <SertOwnerId>1</SertOwnerId>
      <SertOwnerName>sample string 6</SertOwnerName>
      <SertOwnerPhone>1</SertOwnerPhone>
    </OrderRequest.OrderCreateSertCardItems>
  </SertCardItems>
  <SertCardOwner>
    <Email>sample string 2</Email>
    <Name>sample string 1</Name>
    <Phone>1</Phone>
  </SertCardOwner>
  <SertCardownerId>1</SertCardownerId>
  <SessionId>sample string 1</SessionId>
</OrderRequest>

application/x-www-form-urlencoded

Sample:

Sample not available.

Response Information

Resource Description

OrderResponse
NameDescriptionTypeAdditional information
OrderId

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

integer

None.

OrderNumber

Номер заказа из процессинга

string

None.

ErrorCode

Код ошибки

integer

None.

Message

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

string

None.

Response Formats

application/json, text/json

Sample:
{
  "OrderId": 1,
  "OrderNumber": "sample string 1",
  "ErrorCode": 2,
  "Message": "sample string 3"
}

application/xml, text/xml

Sample:
<OrderResponse 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">2</ErrorCode>
  <Message xmlns="http://schemas.datacontract.org/2004/07/LCManagerPartner.Implementation.Abstractions">sample string 3</Message>
  <OrderId>1</OrderId>
  <OrderNumber>sample string 1</OrderNumber>
</OrderResponse>