POST api/OrderRequest

Create order call with using objects, instead of parameters. Use StoreRequest and CustomerRequest before calling this method

Request Information

URI Parameters

None.

Body Parameters

OrderRequest
NameDescriptionTypeAdditional information
OrderGUID

globally unique identifier

None.

Application

string

None.

OrderType

string

None.

OrderNumber

string

None.

DateOrdered

date

None.

OrderETA

date

None.

isPromo

boolean

None.

Promotion

string

None.

SendNotification

boolean

None.

StoreID

integer

None.

CustomerGuid

globally unique identifier

None.

Request Formats

application/json, text/json

Sample:
{
  "OrderGUID": "68a2e595-9118-4664-8192-bc6728b0e51e",
  "Application": "sample string 2",
  "OrderType": "sample string 3",
  "OrderNumber": "sample string 4",
  "DateOrdered": "2025-12-10T12:49:52.341998+02:00",
  "OrderETA": "2025-12-10T12:49:52.341998+02:00",
  "isPromo": true,
  "Promotion": "sample string 7",
  "SendNotification": true,
  "StoreID": 9,
  "CustomerGuid": "300c73af-87b0-4d39-adb0-a6f95c02583b"
}

application/xml, text/xml

Sample:
<OrderRequest xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/Communication.Module.Data.Models">
  <Application>sample string 2</Application>
  <CustomerGuid>300c73af-87b0-4d39-adb0-a6f95c02583b</CustomerGuid>
  <DateOrdered>2025-12-10T12:49:52.341998+02:00</DateOrdered>
  <OrderETA>2025-12-10T12:49:52.341998+02:00</OrderETA>
  <OrderGUID>68a2e595-9118-4664-8192-bc6728b0e51e</OrderGUID>
  <OrderNumber>sample string 4</OrderNumber>
  <OrderType>sample string 3</OrderType>
  <Promotion>sample string 7</Promotion>
  <SendNotification>true</SendNotification>
  <StoreID>9</StoreID>
  <isPromo>true</isPromo>
</OrderRequest>

application/x-www-form-urlencoded

Sample:

Failed to generate the sample for media type 'application/x-www-form-urlencoded'. Cannot use formatter 'JQueryMvcFormUrlEncodedFormatter' to write type 'OrderRequest'.

Response Information

Resource Description

ReturnObject
NameDescriptionTypeAdditional information
Success

boolean

None.

Id

integer

None.

Message

string

None.

ExceptionMessage

string

None.

OrderGUID

globally unique identifier

None.

OrderNumber

string

None.

AdditionalData_1

string

None.

Response Formats

application/json, text/json

Sample:
{
  "Success": true,
  "Id": 2,
  "Message": "sample string 3",
  "ExceptionMessage": "sample string 4",
  "OrderGUID": "e10b9d65-56ee-47e1-8ef1-4d3dc6179277",
  "OrderNumber": "sample string 6",
  "AdditionalData_1": "sample string 7"
}

application/xml, text/xml

Sample:
<ReturnObject xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/Communication.Module.TransferLayer.Models">
  <AdditionalData_1>sample string 7</AdditionalData_1>
  <ExceptionMessage>sample string 4</ExceptionMessage>
  <Id>2</Id>
  <Message>sample string 3</Message>
  <OrderGUID>e10b9d65-56ee-47e1-8ef1-4d3dc6179277</OrderGUID>
  <OrderNumber>sample string 6</OrderNumber>
  <Success>true</Success>
</ReturnObject>