POST api/order/OrderInvoice

Создание/изменение/отмена заказа участника программы лояльности

Request Information

URI Parameters

None.

Body Parameters

OrderInvoiceRequest
NameDescriptionTypeAdditional information
PosCode

Точка продаж

 string

None.
ActionType

Тип действия, которое нужно совершить: Create, Update, Cancel,

 string

None.
Invoice

Признак, что действие нужно совершить по накладной конкретного заказа

 boolean

None.
Number

Номер заказа или накладной

 string

None.
Status

Статус заказа

 string

None.
OrderGuid

Гуид заказа

 string

None.
InvoiceGuid

Гуид накладной

 string

None.
OrderBarcode

Номер штрих-кода заказа

 integer

None.
InvoiceBarcode

Номер штрих-кода накладной

 integer

None.
SourceUrl

Адрес сайта, с которого создают заказ

 string

None.
ClientIShop

Идентификатор клиента в БД интернет-магазина

 integer

None.
Client

Идентификатор клиента в БД Mloyalty

 integer

None.
Phone

Номер телефона участника программы

 integer

None.
Card

Номер карты участника

 integer

None.
Amount

Общая сумма заказа/накладной

 decimal number

None.
ChequeTime

Дата и время создания заказа на кассе или cms интернет-магазина,

 date

None.
SertCard

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

 integer

None.
Coupon

Купон-промокод, который был использован в заказе

 string

None.
StatusPayment

Статус оплаты документа

 string

None.
SourceType

Тип источника создания заказа/накладной (1 = моб. приложение; 2 = интернет-магазин; 3 = учётная система магазина)

 byte

None.
Refund

Признак, что это возврат (работает для заказа и накладной)

 boolean

None.
BasketId

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

 integer

None.
SertCecretCode

Пин-код сертификата, который был использован в заказе

 string

None.
Cashier

Наименование учётной записи кассира/пользователя, который создал заказ (для ИМ и 1С)

 string

None.
IsMobile

Признак, что запрос инициирует мобильное приложение

 boolean

None.
OrderId

Идентификатор созданного заказа в БД Mloyalty

 integer

None.
InvoiceId

Идентификатор созданной накладной в БД Mloyalty

 integer

None.
PaymentType

Тип оплаты (наличные = 1, безналичные = 2, смешаная оплата = 3)

 byte

None.
BonusHoldId

Идентификатор холдирования бонусов (для его отмены или расхолдирования)

 integer

None.
SertHoldId

Идентификатор холдирования средств на сертификате (для его отмены или расхолдирования)

 integer

None.
OrderIdOut

Текстовый идентификатор заказа в БД интернет-магазина

 string

None.
OrderItems

Массив позиций заказа/накладной

 Collection of OrderInvoiceOrderItem

None.
Operator

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

 integer

None.
Token

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

 integer

None.
SiteCode

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

 string

None.

Request Formats

application/json, text/json

Sample: 
{
  "PosCode": "sample string 1",
  "ActionType": "sample string 2",
  "Invoice": true,
  "Number": "sample string 3",
  "Status": "sample string 4",
  "OrderGuid": "sample string 5",
  "InvoiceGuid": "sample string 6",
  "OrderBarcode": 1,
  "InvoiceBarcode": 1,
  "SourceUrl": "sample string 7",
  "ClientIShop": 1,
  "Client": 1,
  "Phone": 1,
  "Card": 1,
  "Amount": 1.0,
  "ChequeTime": "2024-04-20T12:07:42.6354229+03:00",
  "SertCard": 1,
  "Coupon": "sample string 8",
  "StatusPayment": "sample string 9",
  "SourceType": 64,
  "Refund": true,
  "BasketId": 1,
  "SertCecretCode": "sample string 10",
  "Cashier": "sample string 11",
  "IsMobile": true,
  "OrderId": 1,
  "InvoiceId": 1,
  "PaymentType": 64,
  "BonusHoldId": 1,
  "SertHoldId": 1,
  "OrderIdOut": "sample string 12",
  "OrderItems": [
    {
      "Id": 1,
      "Position": 1,
      "Price": 1.0,
      "MinPrice": 1.0,
      "Quantity": 1.0,
      "Amount": 1.0,
      "ItemArticle": "sample string 1",
      "Code": "sample string 2",
      "Guid": "sample string 3",
      "Name": "sample string 4",
      "Redeemed": 1.0,
      "SertRedeemed": 1.0,
      "Discount": 1.0,
      "GoodId": 1,
      "NomenclatureType": "sample string 5",
      "NomenclatureSpecies": "sample string 6"
    },
    {
      "Id": 1,
      "Position": 1,
      "Price": 1.0,
      "MinPrice": 1.0,
      "Quantity": 1.0,
      "Amount": 1.0,
      "ItemArticle": "sample string 1",
      "Code": "sample string 2",
      "Guid": "sample string 3",
      "Name": "sample string 4",
      "Redeemed": 1.0,
      "SertRedeemed": 1.0,
      "Discount": 1.0,
      "GoodId": 1,
      "NomenclatureType": "sample string 5",
      "NomenclatureSpecies": "sample string 6"
    }
  ],
  "Operator": 1,
  "Token": 1,
  "SiteCode": "sample string 13"
}

application/xml, text/xml

Sample: 
<OrderInvoiceRequest xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/LCManagerPartner.Implementation.Request.OrderRequest">
  <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 13</SiteCode>
  <Token xmlns="http://schemas.datacontract.org/2004/07/LCManagerPartner.Implementation.Abstractions">1</Token>
  <ActionType>sample string 2</ActionType>
  <Amount>1</Amount>
  <BasketId>1</BasketId>
  <BonusHoldId>1</BonusHoldId>
  <Card>1</Card>
  <Cashier>sample string 11</Cashier>
  <ChequeTime>2024-04-20T12:07:42.6354229+03:00</ChequeTime>
  <Client>1</Client>
  <ClientIShop>1</ClientIShop>
  <Coupon>sample string 8</Coupon>
  <Invoice>true</Invoice>
  <InvoiceBarcode>1</InvoiceBarcode>
  <InvoiceGuid>sample string 6</InvoiceGuid>
  <InvoiceId>1</InvoiceId>
  <IsMobile>true</IsMobile>
  <Number>sample string 3</Number>
  <OrderBarcode>1</OrderBarcode>
  <OrderGuid>sample string 5</OrderGuid>
  <OrderId>1</OrderId>
  <OrderIdOut>sample string 12</OrderIdOut>
  <OrderItems>
    <OrderInvoiceRequest.OrderInvoiceOrderItem>
      <Amount>1</Amount>
      <Code>sample string 2</Code>
      <Discount>1</Discount>
      <GoodId>1</GoodId>
      <Guid>sample string 3</Guid>
      <Id>1</Id>
      <ItemArticle>sample string 1</ItemArticle>
      <MinPrice>1</MinPrice>
      <Name>sample string 4</Name>
      <NomenclatureSpecies>sample string 6</NomenclatureSpecies>
      <NomenclatureType>sample string 5</NomenclatureType>
      <Position>1</Position>
      <Price>1</Price>
      <Quantity>1</Quantity>
      <Redeemed>1</Redeemed>
      <SertRedeemed>1</SertRedeemed>
    </OrderInvoiceRequest.OrderInvoiceOrderItem>
    <OrderInvoiceRequest.OrderInvoiceOrderItem>
      <Amount>1</Amount>
      <Code>sample string 2</Code>
      <Discount>1</Discount>
      <GoodId>1</GoodId>
      <Guid>sample string 3</Guid>
      <Id>1</Id>
      <ItemArticle>sample string 1</ItemArticle>
      <MinPrice>1</MinPrice>
      <Name>sample string 4</Name>
      <NomenclatureSpecies>sample string 6</NomenclatureSpecies>
      <NomenclatureType>sample string 5</NomenclatureType>
      <Position>1</Position>
      <Price>1</Price>
      <Quantity>1</Quantity>
      <Redeemed>1</Redeemed>
      <SertRedeemed>1</SertRedeemed>
    </OrderInvoiceRequest.OrderInvoiceOrderItem>
  </OrderItems>
  <PaymentType>64</PaymentType>
  <Phone>1</Phone>
  <PosCode>sample string 1</PosCode>
  <Refund>true</Refund>
  <SertCard>1</SertCard>
  <SertCecretCode>sample string 10</SertCecretCode>
  <SertHoldId>1</SertHoldId>
  <SourceType>64</SourceType>
  <SourceUrl>sample string 7</SourceUrl>
  <Status>sample string 4</Status>
  <StatusPayment>sample string 9</StatusPayment>
</OrderInvoiceRequest>

application/x-www-form-urlencoded

Sample:

Sample not available.

Response Information

Resource Description

OrderInvoiceResponse
NameDescriptionTypeAdditional information
OrderId

Идентификатор созданного заказа в БД Mloyalty

 integer

None.
InvoiceId

Идентификатор созданной накладной в БД Mloyalty

 integer

None.
ErrorCode

Код ошибки

 integer

None.
Message

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

 string

None.

Response Formats

application/json, text/json

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

application/xml, text/xml

Sample: 
<OrderInvoiceResponse xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/LCManagerPartner.Implementation.Response.OrderResponse">
  <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>
  <InvoiceId>1</InvoiceId>
  <OrderId>1</OrderId>
</OrderInvoiceResponse>