POST api/Orders/POST
Request Information
URI Parameters
None.
Body Parameters
Order| Name | Description | Type | Additional information |
|---|---|---|---|
| Key | string |
None. |
|
| CreatedOn | date |
None. |
|
| OrderNumber | string |
None. |
|
| Note | string |
None. |
|
| UserKey | string |
None. |
|
| Repeat | boolean |
None. |
|
| PromoCode | string |
None. |
|
| DeliveryFee | decimal number |
None. |
|
| OrderAttachment | string |
None. |
|
| CourierName | string |
None. |
|
| CourierPhoneNumber | string |
None. |
|
| Orderstatereason | string |
None. |
|
| InternalNote | string |
None. |
|
| ShippingAddress | ShippingAddress |
None. |
|
| OrderItems | Collection of OrderItem |
None. |
|
| AssignedEntities | Collection of AssignedEntity |
None. |
|
| OrderStateTypeId | integer |
None. |
|
| PaymentMethodKey | string |
None. |
Request Formats
application/json, text/json
Sample:
{
"Key": "sample string 1",
"CreatedOn": "2026-02-10T15:23:25.5356363+02:00",
"OrderNumber": "sample string 3",
"Note": "sample string 4",
"UserKey": "sample string 5",
"Repeat": true,
"PromoCode": "sample string 7",
"DeliveryFee": 8.1,
"OrderAttachment": "sample string 9",
"CourierName": "sample string 10",
"CourierPhoneNumber": "sample string 11",
"Orderstatereason": "sample string 12",
"InternalNote": "sample string 13",
"ShippingAddress": {
"Key": "sample string 1",
"CompleteAddress": "sample string 2",
"Landmark": "sample string 3",
"Label": "sample string 4",
"Detail": "sample string 5",
"Longitude": 6.0,
"Latitude": 7.0,
"RecipientName": "sample string 8",
"RecipientNumber": "sample string 9",
"OrderKey": "sample string 10"
},
"OrderItems": [
{
"Key": "sample string 1",
"Quantity": 2,
"Price": 3.1,
"ProductKey": "sample string 4",
"Note": "sample string 5",
"ProductShapeId": 6,
"productShapeTypeId": 7
},
{
"Key": "sample string 1",
"Quantity": 2,
"Price": 3.1,
"ProductKey": "sample string 4",
"Note": "sample string 5",
"ProductShapeId": 6,
"productShapeTypeId": 7
}
],
"AssignedEntities": [
{
"Key": "sample string 1",
"EntityTypeId": 2,
"EntityId": "sample string 3",
"CreatedOn": "2026-02-10T15:23:25.5356363+02:00"
},
{
"Key": "sample string 1",
"EntityTypeId": 2,
"EntityId": "sample string 3",
"CreatedOn": "2026-02-10T15:23:25.5356363+02:00"
}
],
"OrderStateTypeId": 14,
"PaymentMethodKey": "sample string 15"
}
application/xml, text/xml
Sample:
<Order xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/VezeetaCrmApi.Models">
<AssignedEntities>
<AssignedEntity>
<CreatedOn>2026-02-10T15:23:25.5356363+02:00</CreatedOn>
<EntityId>sample string 3</EntityId>
<EntityTypeId>2</EntityTypeId>
<Key>sample string 1</Key>
</AssignedEntity>
<AssignedEntity>
<CreatedOn>2026-02-10T15:23:25.5356363+02:00</CreatedOn>
<EntityId>sample string 3</EntityId>
<EntityTypeId>2</EntityTypeId>
<Key>sample string 1</Key>
</AssignedEntity>
</AssignedEntities>
<CourierName>sample string 10</CourierName>
<CourierPhoneNumber>sample string 11</CourierPhoneNumber>
<CreatedOn>2026-02-10T15:23:25.5356363+02:00</CreatedOn>
<DeliveryFee>8.1</DeliveryFee>
<InternalNote>sample string 13</InternalNote>
<Key>sample string 1</Key>
<Note>sample string 4</Note>
<OrderAttachment>sample string 9</OrderAttachment>
<OrderItems>
<OrderItem>
<Key>sample string 1</Key>
<Note>sample string 5</Note>
<Price>3.1</Price>
<ProductKey>sample string 4</ProductKey>
<ProductShapeId>6</ProductShapeId>
<Quantity>2</Quantity>
<productShapeTypeId>7</productShapeTypeId>
</OrderItem>
<OrderItem>
<Key>sample string 1</Key>
<Note>sample string 5</Note>
<Price>3.1</Price>
<ProductKey>sample string 4</ProductKey>
<ProductShapeId>6</ProductShapeId>
<Quantity>2</Quantity>
<productShapeTypeId>7</productShapeTypeId>
</OrderItem>
</OrderItems>
<OrderNumber>sample string 3</OrderNumber>
<OrderStateTypeId>14</OrderStateTypeId>
<Orderstatereason>sample string 12</Orderstatereason>
<PaymentMethodKey>sample string 15</PaymentMethodKey>
<PromoCode>sample string 7</PromoCode>
<Repeat>true</Repeat>
<ShippingAddress>
<CompleteAddress>sample string 2</CompleteAddress>
<Detail>sample string 5</Detail>
<Key>sample string 1</Key>
<Label>sample string 4</Label>
<Landmark>sample string 3</Landmark>
<Latitude>7</Latitude>
<Longitude>6</Longitude>
<OrderKey>sample string 10</OrderKey>
<RecipientName>sample string 8</RecipientName>
<RecipientNumber>sample string 9</RecipientNumber>
</ShippingAddress>
<UserKey>sample string 5</UserKey>
</Order>
application/x-www-form-urlencoded
Sample:
Sample not available.
Response Information
Resource Description
HttpResponseMessage| Name | Description | Type | Additional information |
|---|---|---|---|
| Version | Version |
None. |
|
| Content | HttpContent |
None. |
|
| StatusCode | HttpStatusCode |
None. |
|
| ReasonPhrase | string |
None. |
|
| Headers | Collection of Object |
None. |
|
| RequestMessage | HttpRequestMessage |
None. |
|
| IsSuccessStatusCode | boolean |
None. |