POST api/Services/AddServiceOrder
Add Service Order
Request Information
URI Parameters
None.
Body Parameters
ServiceOrder| Name | Description | Type | Additional information |
|---|---|---|---|
| ServiceLocationId | integer |
None. |
|
| ServiceLocationOlsonTimeZone | string |
None. |
|
| ServiceProviderId | integer |
None. |
|
| ServiceOrderId | integer |
None. |
|
| ServiceOrderDetailId | integer |
None. |
|
| ServiceMenuId | integer |
None. |
|
| Description | string |
None. |
|
| CreatedDate | date |
None. |
|
| DeliveryLocation | string |
None. |
|
| PickupInstructions | string |
None. |
|
| DeliveryFlag | boolean |
None. |
|
| DeliveryOrStartDateUtc | date |
None. |
|
| EndDateUtc | date |
None. |
|
| DeliveryOrStartDateLocal | date |
None. |
|
| EndDateLocal | date |
None. |
|
| ReservationId | integer |
None. |
|
| SeriesId | integer |
None. |
|
| UserId | integer |
None. |
|
| ContactName | string |
None. |
|
| ContactEmail | string |
None. |
|
| ContactDepartment | string |
None. |
|
| ContactAccountCode | string |
None. |
|
| ContactPhone | string |
None. |
|
| StatusId | integer |
None. |
|
| Phase | ServiceOrderPhase |
None. |
|
| Notes | string |
None. |
|
| FulfilledById | integer |
None. |
|
| DecidedById | integer |
None. |
|
| SurchargeAmount | decimal number |
None. |
|
| TaxAmount | decimal number |
None. |
|
| GratuityAmount | decimal number |
None. |
|
| TotalAmount | decimal number |
None. |
|
| AdjustmentAmount | decimal number |
None. |
|
| BillingName | string |
None. |
|
| BillingEmail | string |
None. |
|
| BillingDepartment | string |
None. |
|
| BillingAccountCode | string |
None. |
|
| BillingPhone | string |
None. |
|
| OrderedFor | string |
None. |
|
| ServiceOrderItemList | Collection of ServiceOrderItem |
None. |
|
| UdfList | Collection of Udf |
None. |
|
| LastModified | date |
None. |
|
| Error | string |
None. |
|
| ErrorId | integer |
None. |
|
| AcceptedByFullName | string |
None. |
|
| IsWithinLeadFixedTime | boolean |
None. |
Request Formats
application/json, text/json
Sample:
{
"ServiceLocationId": 1,
"ServiceLocationOlsonTimeZone": "sample string 2",
"ServiceProviderId": 3,
"ServiceOrderId": 4,
"ServiceOrderDetailId": 5,
"ServiceMenuId": 6,
"Description": "sample string 7",
"CreatedDate": "2026-04-04T08:01:44.4000601-04:00",
"DeliveryLocation": "sample string 9",
"PickupInstructions": "sample string 10",
"DeliveryFlag": true,
"DeliveryOrStartDateUtc": "2026-04-04T08:01:44.4000601-04:00",
"EndDateUtc": "2026-04-04T08:01:44.4000601-04:00",
"DeliveryOrStartDateLocal": "2026-04-04T08:01:44.4000601-04:00",
"EndDateLocal": "2026-04-04T08:01:44.4000601-04:00",
"ReservationId": 16,
"SeriesId": 17,
"UserId": 18,
"ContactName": "sample string 19",
"ContactEmail": "sample string 20",
"ContactDepartment": "sample string 21",
"ContactAccountCode": "sample string 22",
"ContactPhone": "sample string 23",
"StatusId": 24,
"Phase": 0,
"Notes": "sample string 25",
"FulfilledById": 26,
"DecidedById": 27,
"SurchargeAmount": 28.0,
"TaxAmount": 29.0,
"GratuityAmount": 30.0,
"TotalAmount": 31.0,
"AdjustmentAmount": 32.0,
"BillingName": "sample string 33",
"BillingEmail": "sample string 34",
"BillingDepartment": "sample string 35",
"BillingAccountCode": "sample string 36",
"BillingPhone": "sample string 37",
"OrderedFor": "sample string 38",
"ServiceOrderItemList": [
{
"ServiceOrderItemId": 1,
"ServiceMenuItemId": 2,
"ServiceProviderId": 3,
"ServiceProviderName": "sample string 4",
"ServiceMenuId": 5,
"ServiceMenuName": "sample string 6",
"ServiceDeliveryOptions": 1,
"Name": "sample string 7",
"ItemId": 8,
"Quantity": 9,
"Cost": 10.0,
"Price": 11.0,
"Total": 12.0,
"Notes": "sample string 13",
"MarketPrice": true,
"AssetId": [
1,
2
],
"AssetTag": [
"sample string 1",
"sample string 2"
],
"AllowEditingAccepted": 15,
"ServiceItemOptionList": [
{
"serviceItemId": 1,
"serviceOptionId": 2,
"serviceItemTypeId": 3,
"serviceOptionName": "sample string 4",
"serviceItemTypeName": "sample string 5",
"serviceOptionLimit": 6
},
{
"serviceItemId": 1,
"serviceOptionId": 2,
"serviceItemTypeId": 3,
"serviceOptionName": "sample string 4",
"serviceItemTypeName": "sample string 5",
"serviceOptionLimit": 6
}
]
},
{
"ServiceOrderItemId": 1,
"ServiceMenuItemId": 2,
"ServiceProviderId": 3,
"ServiceProviderName": "sample string 4",
"ServiceMenuId": 5,
"ServiceMenuName": "sample string 6",
"ServiceDeliveryOptions": 1,
"Name": "sample string 7",
"ItemId": 8,
"Quantity": 9,
"Cost": 10.0,
"Price": 11.0,
"Total": 12.0,
"Notes": "sample string 13",
"MarketPrice": true,
"AssetId": [
1,
2
],
"AssetTag": [
"sample string 1",
"sample string 2"
],
"AllowEditingAccepted": 15,
"ServiceItemOptionList": [
{
"serviceItemId": 1,
"serviceOptionId": 2,
"serviceItemTypeId": 3,
"serviceOptionName": "sample string 4",
"serviceItemTypeName": "sample string 5",
"serviceOptionLimit": 6
},
{
"serviceItemId": 1,
"serviceOptionId": 2,
"serviceItemTypeId": 3,
"serviceOptionName": "sample string 4",
"serviceItemTypeName": "sample string 5",
"serviceOptionLimit": 6
}
]
}
],
"UdfList": [
{
"Id": 1,
"Name": "sample string 2",
"Value": "sample string 3",
"UdfValue": "sample string 4",
"UdfValue2": "sample string 5",
"DefaultQuery": "sample string 6",
"SpecialNotes": "sample string 7",
"InputType": 8,
"DisplayOrder": 9,
"Required": true,
"AdminOnly": true,
"UdfTypeId": 12,
"UdfTypeDescription": "sample string 13",
"ShowOnEvents": true,
"Searchable": true,
"ParentUdfId": 16,
"Type": 17,
"RequestTabId": 18,
"EntryId": 19
},
{
"Id": 1,
"Name": "sample string 2",
"Value": "sample string 3",
"UdfValue": "sample string 4",
"UdfValue2": "sample string 5",
"DefaultQuery": "sample string 6",
"SpecialNotes": "sample string 7",
"InputType": 8,
"DisplayOrder": 9,
"Required": true,
"AdminOnly": true,
"UdfTypeId": 12,
"UdfTypeDescription": "sample string 13",
"ShowOnEvents": true,
"Searchable": true,
"ParentUdfId": 16,
"Type": 17,
"RequestTabId": 18,
"EntryId": 19
}
],
"LastModified": "2026-04-04T08:01:44.4000601-04:00",
"Error": "sample string 40",
"ErrorId": 41,
"AcceptedByFullName": "sample string 42",
"IsWithinLeadFixedTime": true
}
application/xml, text/xml
Sample:
<ServiceOrder xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/RSMCP.Entities">
<AcceptedByFullName>sample string 42</AcceptedByFullName>
<AdjustmentAmount>32</AdjustmentAmount>
<BillingAccountCode>sample string 36</BillingAccountCode>
<BillingDepartment>sample string 35</BillingDepartment>
<BillingEmail>sample string 34</BillingEmail>
<BillingName>sample string 33</BillingName>
<BillingPhone>sample string 37</BillingPhone>
<ContactAccountCode>sample string 22</ContactAccountCode>
<ContactDepartment>sample string 21</ContactDepartment>
<ContactEmail>sample string 20</ContactEmail>
<ContactName>sample string 19</ContactName>
<ContactPhone>sample string 23</ContactPhone>
<CreatedDate>2026-04-04T08:01:44.4000601-04:00</CreatedDate>
<DecidedById>27</DecidedById>
<DeliveryFlag>true</DeliveryFlag>
<DeliveryLocation>sample string 9</DeliveryLocation>
<DeliveryOrStartDateLocal>2026-04-04T08:01:44.4000601-04:00</DeliveryOrStartDateLocal>
<DeliveryOrStartDateUtc>2026-04-04T08:01:44.4000601-04:00</DeliveryOrStartDateUtc>
<Description>sample string 7</Description>
<EndDateLocal>2026-04-04T08:01:44.4000601-04:00</EndDateLocal>
<EndDateUtc>2026-04-04T08:01:44.4000601-04:00</EndDateUtc>
<Error>sample string 40</Error>
<ErrorId>41</ErrorId>
<FulfilledById>26</FulfilledById>
<GratuityAmount>30</GratuityAmount>
<IsWithinLeadFixedTime>true</IsWithinLeadFixedTime>
<LastModified>2026-04-04T08:01:44.4000601-04:00</LastModified>
<Notes>sample string 25</Notes>
<OrderedFor>sample string 38</OrderedFor>
<Phase>Pending</Phase>
<PickupInstructions>sample string 10</PickupInstructions>
<ReservationId>16</ReservationId>
<SeriesId>17</SeriesId>
<ServiceLocationId>1</ServiceLocationId>
<ServiceLocationOlsonTimeZone>sample string 2</ServiceLocationOlsonTimeZone>
<ServiceMenuId>6</ServiceMenuId>
<ServiceOrderDetailId>5</ServiceOrderDetailId>
<ServiceOrderId>4</ServiceOrderId>
<ServiceOrderItemList>
<ServiceOrderItem>
<AllowEditingAccepted>15</AllowEditingAccepted>
<AssetId xmlns:d4p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
<d4p1:int>1</d4p1:int>
<d4p1:int>2</d4p1:int>
</AssetId>
<AssetTag xmlns:d4p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
<d4p1:string>sample string 1</d4p1:string>
<d4p1:string>sample string 2</d4p1:string>
</AssetTag>
<Cost>10</Cost>
<ItemId>8</ItemId>
<MarketPrice>true</MarketPrice>
<Name>sample string 7</Name>
<Notes>sample string 13</Notes>
<Price>11</Price>
<Quantity>9</Quantity>
<ServiceDeliveryOptions>Both</ServiceDeliveryOptions>
<ServiceItemOptionList>
<ServiceItemOption>
<ServiceItemId>1</ServiceItemId>
<ServiceItemTypeId>3</ServiceItemTypeId>
<ServiceItemTypeName>sample string 5</ServiceItemTypeName>
<ServiceOptionId>2</ServiceOptionId>
<ServiceOptionLimit>6</ServiceOptionLimit>
<ServiceOptionName>sample string 4</ServiceOptionName>
</ServiceItemOption>
<ServiceItemOption>
<ServiceItemId>1</ServiceItemId>
<ServiceItemTypeId>3</ServiceItemTypeId>
<ServiceItemTypeName>sample string 5</ServiceItemTypeName>
<ServiceOptionId>2</ServiceOptionId>
<ServiceOptionLimit>6</ServiceOptionLimit>
<ServiceOptionName>sample string 4</ServiceOptionName>
</ServiceItemOption>
</ServiceItemOptionList>
<ServiceMenuId>5</ServiceMenuId>
<ServiceMenuItemId>2</ServiceMenuItemId>
<ServiceMenuName>sample string 6</ServiceMenuName>
<ServiceOrderItemId>1</ServiceOrderItemId>
<ServiceProviderId>3</ServiceProviderId>
<ServiceProviderName>sample string 4</ServiceProviderName>
<Total>12</Total>
</ServiceOrderItem>
<ServiceOrderItem>
<AllowEditingAccepted>15</AllowEditingAccepted>
<AssetId xmlns:d4p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
<d4p1:int>1</d4p1:int>
<d4p1:int>2</d4p1:int>
</AssetId>
<AssetTag xmlns:d4p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
<d4p1:string>sample string 1</d4p1:string>
<d4p1:string>sample string 2</d4p1:string>
</AssetTag>
<Cost>10</Cost>
<ItemId>8</ItemId>
<MarketPrice>true</MarketPrice>
<Name>sample string 7</Name>
<Notes>sample string 13</Notes>
<Price>11</Price>
<Quantity>9</Quantity>
<ServiceDeliveryOptions>Both</ServiceDeliveryOptions>
<ServiceItemOptionList>
<ServiceItemOption>
<ServiceItemId>1</ServiceItemId>
<ServiceItemTypeId>3</ServiceItemTypeId>
<ServiceItemTypeName>sample string 5</ServiceItemTypeName>
<ServiceOptionId>2</ServiceOptionId>
<ServiceOptionLimit>6</ServiceOptionLimit>
<ServiceOptionName>sample string 4</ServiceOptionName>
</ServiceItemOption>
<ServiceItemOption>
<ServiceItemId>1</ServiceItemId>
<ServiceItemTypeId>3</ServiceItemTypeId>
<ServiceItemTypeName>sample string 5</ServiceItemTypeName>
<ServiceOptionId>2</ServiceOptionId>
<ServiceOptionLimit>6</ServiceOptionLimit>
<ServiceOptionName>sample string 4</ServiceOptionName>
</ServiceItemOption>
</ServiceItemOptionList>
<ServiceMenuId>5</ServiceMenuId>
<ServiceMenuItemId>2</ServiceMenuItemId>
<ServiceMenuName>sample string 6</ServiceMenuName>
<ServiceOrderItemId>1</ServiceOrderItemId>
<ServiceProviderId>3</ServiceProviderId>
<ServiceProviderName>sample string 4</ServiceProviderName>
<Total>12</Total>
</ServiceOrderItem>
</ServiceOrderItemList>
<ServiceProviderId>3</ServiceProviderId>
<StatusId>24</StatusId>
<SurchargeAmount>28</SurchargeAmount>
<TaxAmount>29</TaxAmount>
<TotalAmount>31</TotalAmount>
<UdfList>
<Udf>
<AdminOnly>true</AdminOnly>
<DefaultQuery>sample string 6</DefaultQuery>
<DisplayOrder>9</DisplayOrder>
<EntryId>19</EntryId>
<Id>1</Id>
<InputType>8</InputType>
<Name>sample string 2</Name>
<ParentUdfId>16</ParentUdfId>
<RequestTabId>18</RequestTabId>
<Required>true</Required>
<Searchable>true</Searchable>
<ShowOnEvents>true</ShowOnEvents>
<SpecialNotes>sample string 7</SpecialNotes>
<Type>17</Type>
<UdfTypeDescription>sample string 13</UdfTypeDescription>
<UdfTypeId>12</UdfTypeId>
<UdfValue>sample string 4</UdfValue>
<UdfValue2>sample string 5</UdfValue2>
<Value>sample string 3</Value>
</Udf>
<Udf>
<AdminOnly>true</AdminOnly>
<DefaultQuery>sample string 6</DefaultQuery>
<DisplayOrder>9</DisplayOrder>
<EntryId>19</EntryId>
<Id>1</Id>
<InputType>8</InputType>
<Name>sample string 2</Name>
<ParentUdfId>16</ParentUdfId>
<RequestTabId>18</RequestTabId>
<Required>true</Required>
<Searchable>true</Searchable>
<ShowOnEvents>true</ShowOnEvents>
<SpecialNotes>sample string 7</SpecialNotes>
<Type>17</Type>
<UdfTypeDescription>sample string 13</UdfTypeDescription>
<UdfTypeId>12</UdfTypeId>
<UdfValue>sample string 4</UdfValue>
<UdfValue2>sample string 5</UdfValue2>
<Value>sample string 3</Value>
</Udf>
</UdfList>
<UserId>18</UserId>
</ServiceOrder>
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. |