POST api/v2/Orders/CreateOrder
Request Information
URI Parameters
None.
Body Parameters
Multisponsor.NetCommerce.API.Models.V2.OrderV2| Name | Description | Type | Additional information |
|---|---|---|---|
| ProgramId | integer |
None. |
|
| CustomerId | string |
None. |
|
| ShippingInformation | Multisponsor.NetCommerce.API.Models.V2.ShippingInformationV2 |
None. |
|
| OrderSource | string |
None. |
|
| Cart | Collection of Multisponsor.NetCommerce.API.Models.V2.StoreCartApiV2 |
None. |
|
| ExtendedProperties | Collection of Multisponsor.NetCommerce.API.Models.V2.StoreOrderExtendedPropertyV2 |
None. |
Request Formats
application/json, text/json
Sample:
{
"ProgramId": 1,
"CustomerId": "sample string 2",
"ShippingInformation": {
"Guid": "sample string 1",
"CustomerId": "sample string 2",
"Address": "sample string 3",
"CityId": 4,
"PhoneNumber": "sample string 5",
"OptionalPhoneNumber": "sample string 6",
"Email": "sample string 7",
"AditionalInformation": "sample string 8",
"MobileOperator": "sample string 9",
"MobileNumber": "sample string 10",
"Active": true,
"IsNew": true
},
"OrderSource": "sample string 3",
"Cart": [
{
"Guid": "sample string 1",
"ReferenceGuid": "sample string 2",
"Quantity": 3,
"CustomerId": "sample string 4",
"ProgramId": 5,
"PointsUnitValue": 1.0,
"MoneyUnitValue": 1.0,
"PointsUnitShipping": 1.0,
"MoneyUnitShipping": 1.0,
"TaxPercent": 1.0,
"PointsPercent": 1.0,
"Sendable": true,
"RegisterDate": "2025-10-25T23:30:12.4424694+00:00"
},
{
"Guid": "sample string 1",
"ReferenceGuid": "sample string 2",
"Quantity": 3,
"CustomerId": "sample string 4",
"ProgramId": 5,
"PointsUnitValue": 1.0,
"MoneyUnitValue": 1.0,
"PointsUnitShipping": 1.0,
"MoneyUnitShipping": 1.0,
"TaxPercent": 1.0,
"PointsPercent": 1.0,
"Sendable": true,
"RegisterDate": "2025-10-25T23:30:12.4424694+00:00"
}
],
"ExtendedProperties": [
{
"Guid": "sample string 1",
"Name": "sample string 2",
"DisplayName": "sample string 3",
"ValueX": "sample string 4",
"Format": "sample string 5",
"OrderGuid": "sample string 6"
},
{
"Guid": "sample string 1",
"Name": "sample string 2",
"DisplayName": "sample string 3",
"ValueX": "sample string 4",
"Format": "sample string 5",
"OrderGuid": "sample string 6"
}
]
}
application/xml, text/xml
Sample:
<OrderV2 xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/Multisponsor.NetCommerce.API.Models.V2">
<Cart>
<StoreCartApiV2>
<CustomerId>sample string 4</CustomerId>
<Guid>sample string 1</Guid>
<MoneyUnitShipping>1</MoneyUnitShipping>
<MoneyUnitValue>1</MoneyUnitValue>
<PointsPercent>1</PointsPercent>
<PointsUnitShipping>1</PointsUnitShipping>
<PointsUnitValue>1</PointsUnitValue>
<ProgramId>5</ProgramId>
<Quantity>3</Quantity>
<ReferenceGuid>sample string 2</ReferenceGuid>
<RegisterDate>2025-10-25T23:30:12.4424694+00:00</RegisterDate>
<Sendable>true</Sendable>
<TaxPercent>1</TaxPercent>
</StoreCartApiV2>
<StoreCartApiV2>
<CustomerId>sample string 4</CustomerId>
<Guid>sample string 1</Guid>
<MoneyUnitShipping>1</MoneyUnitShipping>
<MoneyUnitValue>1</MoneyUnitValue>
<PointsPercent>1</PointsPercent>
<PointsUnitShipping>1</PointsUnitShipping>
<PointsUnitValue>1</PointsUnitValue>
<ProgramId>5</ProgramId>
<Quantity>3</Quantity>
<ReferenceGuid>sample string 2</ReferenceGuid>
<RegisterDate>2025-10-25T23:30:12.4424694+00:00</RegisterDate>
<Sendable>true</Sendable>
<TaxPercent>1</TaxPercent>
</StoreCartApiV2>
</Cart>
<CustomerId>sample string 2</CustomerId>
<ExtendedProperties>
<StoreOrderExtendedPropertyV2>
<DisplayName>sample string 3</DisplayName>
<Format>sample string 5</Format>
<Guid>sample string 1</Guid>
<Name>sample string 2</Name>
<OrderGuid>sample string 6</OrderGuid>
<ValueX>sample string 4</ValueX>
</StoreOrderExtendedPropertyV2>
<StoreOrderExtendedPropertyV2>
<DisplayName>sample string 3</DisplayName>
<Format>sample string 5</Format>
<Guid>sample string 1</Guid>
<Name>sample string 2</Name>
<OrderGuid>sample string 6</OrderGuid>
<ValueX>sample string 4</ValueX>
</StoreOrderExtendedPropertyV2>
</ExtendedProperties>
<OrderSource>sample string 3</OrderSource>
<ProgramId>1</ProgramId>
<ShippingInformation>
<Active>true</Active>
<Address>sample string 3</Address>
<AditionalInformation>sample string 8</AditionalInformation>
<CityId>4</CityId>
<CustomerId>sample string 2</CustomerId>
<Email>sample string 7</Email>
<Guid>sample string 1</Guid>
<IsNew>true</IsNew>
<MobileNumber>sample string 10</MobileNumber>
<MobileOperator>sample string 9</MobileOperator>
<OptionalPhoneNumber>sample string 6</OptionalPhoneNumber>
<PhoneNumber>sample string 5</PhoneNumber>
</ShippingInformation>
</OrderV2>
application/x-www-form-urlencoded
Sample:
Sample not available.
Response Information
Resource Description
Multisponsor.NetCommerce.API.Models.V2.ResponseV2OfMultisponsor.NetCommerce.Common.Models.Order.OrderResponse| Name | Description | Type | Additional information |
|---|---|---|---|
| Status | boolean |
None. |
|
| Message | Collection of Multisponsor.NetCommerce.API.Models.V2.MessageResultV2 |
None. |
|
| ObjectResponse | Multisponsor.NetCommerce.Common.Models.Order.OrderResponse |
None. |
Response Formats
application/json, text/json
Sample:
{
"Status": true,
"Message": [
{
"Message": "sample string 1"
},
{
"Message": "sample string 1"
}
],
"ObjectResponse": {
"OrderId": "sample string 1",
"DigitalProductCode": null
}
}
application/xml, text/xml
Sample:
<ResponseV2OfOrderResponserlNqZw4D xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/Multisponsor.NetCommerce.API.Models.V2">
<Message>
<MessageResultV2>
<Message>sample string 1</Message>
</MessageResultV2>
<MessageResultV2>
<Message>sample string 1</Message>
</MessageResultV2>
</Message>
<ObjectResponse xmlns:d2p1="http://schemas.datacontract.org/2004/07/Multisponsor.NetCommerce.Common.Models.Order">
<d2p1:DigitalProductCode i:nil="true" />
<d2p1:OrderId>sample string 1</d2p1:OrderId>
</ObjectResponse>
<Status>true</Status>
</ResponseV2OfOrderResponserlNqZw4D>