POST api/order/OrderInvoiceAction
Добавление нового статуса по заказу и накладной, а также сбрасывание всех применённых поощрений к заказу
Request Information
URI Parameters
None.
Body Parameters
OrderInvoiceActionRequestName | Description | Type | Additional information |
---|---|---|---|
PosCode |
Точка продаж |
string |
None. |
Client |
Клиент, который инициирует запрос |
integer |
None. |
ActionType |
Тип действия (Status, Promo, Payment) |
string |
None. |
IsMobile |
Признак, что запрос идёт из мобильного приложения |
boolean |
None. |
Invoice |
Признак, что действие нужно совершить по накладной конкретного заказа |
boolean |
None. |
CleanPromoValue |
Признак, что нужно скинуть все применённые поощрения к заказу |
boolean |
None. |
Number |
Номер заказа или накладной |
string |
None. |
Status |
Статус заказа или накладной |
string |
None. |
OrderGuid |
Гуид заказа, по которому внести изменения |
string |
None. |
InvoiceGuid |
Гуид накладной |
string |
None. |
StatusPayment |
Статус оплаты документа |
string |
None. |
Comment |
Комментарий пользователя при изменении статуса |
string |
None. |
ChequeId |
Идентификатор чека покупки в БД Mloyalty, который нужно привязать к заказу или накладной |
integer |
None. |
OrderId |
Идентификатор заказа |
integer |
None. |
InvoiceId |
Идентификатор накладной |
integer |
None. |
FullRefund |
Признак, что нужно сделать полный возврат заказа или накладной |
boolean |
None. |
PaymentType |
Тип оплаты (наличные = 1, безналичные = 2, смешаная оплата = 3) |
byte |
None. |
Operator |
Идентификатор оператора программы лояльности |
integer |
None. |
Token |
Токен пользователя, который инициирует данный запрос |
integer |
None. |
SiteCode |
Уникальный код виджета по продаже подарочных сертификатов, который инициирует запрос |
string |
None. |
Request Formats
application/json, text/json
{ "PosCode": "sample string 1", "Client": 1, "ActionType": "sample string 2", "IsMobile": true, "Invoice": true, "CleanPromoValue": true, "Number": "sample string 3", "Status": "sample string 4", "OrderGuid": "sample string 5", "InvoiceGuid": "sample string 6", "StatusPayment": "sample string 7", "Comment": "sample string 8", "ChequeId": 1, "OrderId": 1, "InvoiceId": 1, "FullRefund": true, "PaymentType": 64, "Operator": 1, "Token": 1, "SiteCode": "sample string 9" }
application/xml, text/xml
<OrderInvoiceActionRequest 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 9</SiteCode> <Token xmlns="http://schemas.datacontract.org/2004/07/LCManagerPartner.Implementation.Abstractions">1</Token> <ActionType>sample string 2</ActionType> <ChequeId>1</ChequeId> <CleanPromoValue>true</CleanPromoValue> <Client>1</Client> <Comment>sample string 8</Comment> <FullRefund>true</FullRefund> <Invoice>true</Invoice> <InvoiceGuid>sample string 6</InvoiceGuid> <InvoiceId>1</InvoiceId> <IsMobile>true</IsMobile> <Number>sample string 3</Number> <OrderGuid>sample string 5</OrderGuid> <OrderId>1</OrderId> <PaymentType>64</PaymentType> <PosCode>sample string 1</PosCode> <Status>sample string 4</Status> <StatusPayment>sample string 7</StatusPayment> </OrderInvoiceActionRequest>
application/x-www-form-urlencoded
Sample not available.
Response Information
Resource Description
OrderInvoiceActionResponseName | Description | Type | Additional information |
---|---|---|---|
ErrorCode |
Код ошибки |
integer |
None. |
Message |
Сообщение об ошибке |
string |
None. |
Response Formats
application/json, text/json
{ "ErrorCode": 1, "Message": "sample string 2" }
application/xml, text/xml
<OrderInvoiceActionResponse 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> </OrderInvoiceActionResponse>