POST xpientSupportAPI/submitOrder
The SubmitOrder method.
This request sends the finalized order details.
The API will update the POS Business Date for the order and log the order details.
Request Information
URI Parameters
None.
Body Parameters
The SubmitOrderRequestModel object.
SubmitOrderRequestModelName | Description | Type | Additional information |
---|---|---|---|
posLoyaltySubmitOrderRequest |
This request sends the finalized order details. The API will update the POS Business Date for the order and log the order details. |
SubmitOrderRequest |
None. |
Request Formats
application/json, text/json
Sample:
{ "posLoyaltySubmitOrderRequest": { "header": { "operatorId": "sample string 1", "storeId": "sample string 2", "terminalId": "sample string 3", "posGroup": "sample string 4" }, "order": { "businessDate": "sample string 1", "destination": "sample string 2", "discounts": [ { "description": "sample string 1", "discountCode": "sample string 2", "id": "sample string 3", "price": "sample string 5", "reference": "sample string 6", "type": "sample string 7" }, { "description": "sample string 1", "discountCode": "sample string 2", "id": "sample string 3", "price": "sample string 5", "reference": "sample string 6", "type": "sample string 7" } ], "lineItems": [ { "childItems": [ { "description": "sample string 1", "id": "sample string 3", "price": "sample string 5", "quantity": "sample string 6" }, { "description": "sample string 1", "id": "sample string 3", "price": "sample string 5", "quantity": "sample string 6" } ], "description": "sample string 1", "id": "sample string 3", "price": "sample string 5", "quantity": "sample string 6" }, { "childItems": [ { "description": "sample string 1", "id": "sample string 3", "price": "sample string 5", "quantity": "sample string 6" }, { "description": "sample string 1", "id": "sample string 3", "price": "sample string 5", "quantity": "sample string 6" } ], "description": "sample string 1", "id": "sample string 3", "price": "sample string 5", "quantity": "sample string 6" } ], "posOrderId": "sample string 6" }, "shortCode": "sample string 1" } }
application/xml, text/xml
Sample:
<SubmitOrderRequestModel xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/OfferManagementPOSSupport.Models"> <POSLoyaltySubmitOrder> <Header> <OperatorId>sample string 1</OperatorId> <POSGroup>sample string 4</POSGroup> <StoreId>sample string 2</StoreId> <TerminalId>sample string 3</TerminalId> </Header> <Order> <BusinessDate>sample string 1</BusinessDate> <Destination>sample string 2</Destination> <Discounts> <POSLoyaltyOrderDiscount> <Description>sample string 1</Description> <DiscountCode>sample string 2</DiscountCode> <Id>sample string 3</Id> <Price>sample string 5</Price> <Reference>sample string 6</Reference> <Type>sample string 7</Type> </POSLoyaltyOrderDiscount> <POSLoyaltyOrderDiscount> <Description>sample string 1</Description> <DiscountCode>sample string 2</DiscountCode> <Id>sample string 3</Id> <Price>sample string 5</Price> <Reference>sample string 6</Reference> <Type>sample string 7</Type> </POSLoyaltyOrderDiscount> </Discounts> <LineItems> <POSLoyaltyOrderLineItem> <ChildItems> <POSLoyaltyOrderChildItem> <Description>sample string 1</Description> <Id>sample string 3</Id> <Price>sample string 5</Price> <Quantity>sample string 6</Quantity> </POSLoyaltyOrderChildItem> <POSLoyaltyOrderChildItem> <Description>sample string 1</Description> <Id>sample string 3</Id> <Price>sample string 5</Price> <Quantity>sample string 6</Quantity> </POSLoyaltyOrderChildItem> </ChildItems> <Description>sample string 1</Description> <Id>sample string 3</Id> <Price>sample string 5</Price> <Quantity>sample string 6</Quantity> </POSLoyaltyOrderLineItem> <POSLoyaltyOrderLineItem> <ChildItems> <POSLoyaltyOrderChildItem> <Description>sample string 1</Description> <Id>sample string 3</Id> <Price>sample string 5</Price> <Quantity>sample string 6</Quantity> </POSLoyaltyOrderChildItem> <POSLoyaltyOrderChildItem> <Description>sample string 1</Description> <Id>sample string 3</Id> <Price>sample string 5</Price> <Quantity>sample string 6</Quantity> </POSLoyaltyOrderChildItem> </ChildItems> <Description>sample string 1</Description> <Id>sample string 3</Id> <Price>sample string 5</Price> <Quantity>sample string 6</Quantity> </POSLoyaltyOrderLineItem> </LineItems> <POSOrderId>sample string 6</POSOrderId> </Order> <ShortCode>sample string 1</ShortCode> </POSLoyaltySubmitOrder> </SubmitOrderRequestModel>
application/x-www-form-urlencoded
Sample:
Response Information
Resource Description
SubmitOrderResponseModelName | Description | Type | Additional information |
---|---|---|---|
posLoyaltySubmitOrderResult |
A successful response is indicated by the return of a successful request status. |
SubmitOrderResponse |
None. |
Response Formats
application/json, text/json
Sample:
{ "posLoyaltySubmitOrderResult": { "statusCode": 1, "resultDescription": "sample string 2" } }
application/xml, text/xml
Sample:
<SubmitOrderResponseModel xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/OfferManagementPOSSupport.Models"> <POSLoyaltySubmitOrderResult> <ResultDescription>sample string 2</ResultDescription> <StatusCode>1</StatusCode> </POSLoyaltySubmitOrderResult> </SubmitOrderResponseModel>