Service Order Open API

"note": [
  {
    "text": "String"
  }
]

"relatedParty": [
  {
    "id": "String",
    "name": "String",
    "@referredType": "String",
    "@type": "String"
  }
]

"serviceOrderItem:" [
  {
    "action": "String",
    "actionReason": "String",
    "committedDueDate": "String",
    "externalProductInventory": [Array],
    "id": "String",
    "serviceOrderItemRelationship": [Array],
    "place": {Object},
    "quantity": "Number",
    "relatedParty": {Object},
    "service": {Object},
    "@type": "String",
    "version": "String"
  }
]

"externalProductInventory": [
  {
    "externalProductInventoryId": "String"
  }
]

"serviceOrderItemRelationship:" [
  {
    "id": "String",
    "relationshipType": "String"
  }
]

"place:" {
  "id": "String",
  "@type": "String"
}

"relatedParty:" {
  "email": "String",
  "firstName": "String",
  "lastName": "String",
  "phone": "String",
  "@referredType": "String",
  "@type": "String"
}

"service:" {
  "id": "String",
  "serviceCharacteristic": [Array],
  "serviceRelationship": [Array],
  "serviceSpecification": {Object},
  "@type": "String"
}

"serviceCharacteristic:" [ 
 {
  "name": "String",
  "previousValue": "String",
  "value": "String",
  "valueType": "String"
 }
]

"serviceSpecification:" {
  "id": "String",
  "name": "String",
  "@type": "String"
}

"serviceOrder": {
  "id": "String",
  "href": "String",
  "@referredType": "String"
}

"note": [
  {
    "text": "String"
  }
]

"relatedParty": [
  {
    "id": "String",
    "name": "String",
    "@referredType": "String",
    "@type": "String"
  }
]

"serviceOrderItem:" [
  {
    "action": "String",
    "actionReason": "String",
    "committedDueDate": "String",
    "externalProductInventory": [Array],
    "id": "String",
    "serviceOrderItemRelationship": [Array],
    "place": {Object},
    "quantity": "Number",
    "relatedParty": {Object},
    "service": {Object},
    "@type": "String",
    "version": "String"
  }
]

"externalProductInventory": [
  {
    "externalProductInventoryId": "String"
  }
]

"serviceOrderItemRelationship:" [
  {
    "id": "String",
    "relationshipType": "String"
  }
]

"place:" {
  "id": "String",
  "@type": "String"
}

</td></tr><tr><td>

serviceOrderItem.relatedParty.email

</td><td>

Email address of the contact. Data type: String

</td></tr><tr><td>

serviceOrderItem.relatedParty.firstName

</td><td>

First name of the contact. Data type: String

</td></tr><tr><td>

serviceOrderItem.relatedParty.lastName

</td><td>

Last name of the contact. Data type: String

</td></tr><tr><td>

serviceOrderItem.relatedParty.phone

</td><td>

Business phone number of the contact. Data type: String

</td></tr><tr><td>

serviceOrderItem.relatedParty.@referredType

</td><td>

Required. Type of customer. Possible value: OrderLineItemContact

 Data type: String

</td></tr><tr><td>

serviceOrderItem.relatedParty.@type

</td><td>

Part of TMF Open API standard. Annotation for order line item contact. This value is always `RelatedParty`. This information is not stored. Data type: String

</td></tr><tr><td>

serviceOrderItem.service

</td><td>

Required. Description of the instance details of the service purchased by the customer. Data type: Object

Table/field updated: sn\_ind\_tmt\_orm\_order\_line\_item

</td></tr><tr><td>

serviceOrderItem.service.id

</td><td>

Unique identifier of the service sold. This value can be the sys\_id or external ID in the Product Inventory \[sn\_ind\_tmt\_orm\_product\_inventory\] table. This value is only used for change/disconnect orders.Data type: String

</td></tr><tr><td>

serviceOrderItem.service.serviceCharacteristic

</td><td><p>Conditional. If supplied, each entry requires <strong>serviceOrderItem.service.serviceCharacteristic</strong>. List that describes the characteristics of the associated service. Only service characteristics with a current <strong>value</strong> different from the <strong>previousValue</strong> are returned.</p>
<p>Data type: Array</p>
<p><code>"serviceCharacteristic:" [ 
 {
  "name": "String",
  "previousValue": "String",
  "value": "String",
  "valueType": "String"
 }
]</code></p></td></tr><tr><td>

serviceOrderItem.service.serviceCharacteristic.name

</td><td>

Required for each characteristic entry. Name of the characteristic record to associated with the service. Located in the Characteristic \[sn\_prd\_pm\_characteristic\] table. Data type: String

</td></tr><tr><td>

serviceOrderItem.service.serviceCharacteristic.previousValue

</td><td>Previous characteristic option values if the update is for change order. The request is a change order if the <strong>serviceOrderItem.action</strong> parameter is other than <code>add</code>. For additional information on characteristic option values, see <a href="../../../order-management/som-product-config-add-characteristics/">Create product characteristics and characteristic options</a>. Data type: String</td></tr><tr><td>

serviceOrderItem.service.serviceCharacteristic.value

</td><td>

Characteristic option values associated with the service. For additional information on characteristic option values, see <a href="../../../order-management/som-product-config-add-characteristics/">Create product characteristics and characteristic options</a>. Data type: String

</td></tr><tr><td>

serviceOrderItem.service.serviceCharacteristic.valueType

</td><td>

Type of characteristic value.Possible values:

-   Array.Date
-   Array.Datetime
-   Array.Decimal
-   Array.Integer
-   Array.Object
-   Array.Single Line Test
-   Checkbox
-   Choice
-   Date, Address
-   Email
-   Integer, Date/Time
-   Object
-   Single Line Text
-   Yes/No

Data type: String

</td></tr><tr><td>

serviceOrderItem.service.serviceRelationship

</td><td>

List of product inventories related to the service.Data type: Array of Objects

</td></tr><tr><td>

serviceOrderItem.service.serviceRelationship.id

</td><td>

Sys\_id or sn\_prd\_invt\_external\_id of the product inventory.Data type: String

Table: In the sys\_id or sn\_prd\_invt\_external\_id field of the Product Inventory \[sn\_prd\_invt\_product\_inventory\] table.

</td></tr><tr><td>

serviceOrderItem.service.serviceRelationship.relationshipType

</td><td>

Type of relationship between the service and the product inventory. Possible value: Requires

Data type: String

</td></tr><tr><td>

serviceOrderItem.service.serviceSpecification

</td><td><p>Conditional. When supplied, <strong>serviceSpecification.id</strong> is required. Description of the service specification associated with the service. <strong>Note:</strong> Change orders (<strong>serviceOrderItem.action</strong> is <code>change</code>) are processed differently based on the value of the <strong>sn_ind_tmt_orm.allowSpecVersionUpdateInChangeOrder</strong> system property.</p>
<ul>
<li>When the property is set to true (default), if the service is a different version than indicated in the order, the service is automatically upgraded to the version in the order by changing the referenced service specification. This allows the order to be successfully processed.</li>
<li>When the property is set to false, if the service is a different version than indicated in the order, the order fails due to the version mismatch.</li>
</ul>
<p>Data type: Object</p>
<p><code>"serviceSpecification:" {
  "id": "String",
  "internalVersion": "String",
  "name": "String",
  "version": "String",
  "@type": "String"
}</code></p>
<p>Stored in: The service_specification field of the Order Line Item [sn_ind_tmt_orm_order_line_item] table.</p></td></tr><tr><td>

serviceOrderItem.service.serviceSpecification.id

</td><td>Required when <strong>serviceSpecification</strong> is present. Initial_version or external_id of the service specification. The initial_version is the sys_id of the first version of the specification. Located in the sys_id or external_id field of the Service Specification [sn_prd_pm_service_specification] table. Data type: String</td></tr><tr><td>

serviceOrderItem.service.serviceSpecification.internalVersion

</td><td>

Version of the service specification.Data type: String

Table: Service Specification \[sn\_prd\_pm\_service\_specification\]

</td></tr><tr><td>

serviceOrderItem.service.serviceSpecification.name

</td><td>

Required. Name of the service specification. Located in the Service Specification \[sn\_prd\_pm\_service\_specification\] table. Data type: String

</td></tr><tr><td>

serviceOrderItem.service.serviceSpecification.version

</td><td>

External\_version of the service specification.Data type: String

Table: Service Specification \[sn\_prd\_pm\_service\_specification\]

</td></tr><tr><td>

serviceOrderItem.service.serviceSpecification.@type

</td><td>

Part of the TMF Open API standard. This value is always `ServiceSpecificationRef`. This information is not stored. Data type: String

</td></tr><tr><td>

serviceOrderItem.@type

</td><td>

Part of the TMF Open API standard. This value is always `ServiceOrderItem`. This information is not stored. Data type: String

</td></tr><tr><td>

@type

</td><td>

Part of the TMF Open API standard. This value is always `ServiceOrder`. This information is not stored.Data type: String

</td></tr></tbody>
</table>

### Headers

The following request and response headers apply to this HTTP action only, or apply to this action in a distinct way. For a list of general headers used in the REST API, see [Supported REST API headers](../rest-api-explorer/c_RESTAPI.md).

|Header|Description|
|------|-----------|
|Accept|Data format of the response body. Only supports **application/json**.|

|Header|Description|
|------|-----------|
|Content-Type|Data format of the response body. Only supports **application/json**.|

### Status codes

The following status codes apply to this HTTP action. For a list of possible status codes used in the REST API, see [REST API HTTP response codes](../rest-api-explorer/c_RESTAPI.md).

<table id="table_kmf_3jm_gqb"><thead><tr><th>

Status code

</th><th>

Description

</th></tr></thead><tbody><tr><td>

200

</td><td id="entry-200-status-code">

Successful. The request was successfully processed.

</td></tr><tr><td>

201

</td><td><p>Successful. If there are any issues with the characteristics or characteristics option information, the endpoint stores the following comments in the work notes fields of the associated Customer Order Line Item record:</p>
<ul>
<li>The following Order Item characteristics does not exist: Review specification &lt;<strong>specification.name</strong>&gt; and correct the characteristic and characteristic option in the order line item prior to approving the order.</li>
<li>Order Item characteristic: &lt;<strong>characteristic.name</strong>&gt; with characteristic value: &lt;<strong>characteristic.value</strong>&gt; is invalid. Correct the characteristic values before approving the order.</li>
</ul></td></tr><tr><td>

202

</td><td>Accepted. Successful request for an order in asynchronous mode. That is, the request was made with the <strong>mode</strong> parameter set to <code>async</code> and the record is scheduled to be processed in the Inbound Queue [sn_tmt_core_inbound_queue] table.</td></tr><tr><td>

400

</td><td>Bad Request. Could be any of the following reasons:-   Invalid payload: Consumer does not exist - The specified related party consumer does not exist in the instance.
-   Invalid payload: Customer Account does not exist. – The related party customer provided in payload is not present in the system.
-   Invalid payload: Customer Account or Consumer is missing - The related party customer or consumer object is missing from the payload.
-   Invalid payload: Order creation failed. - Not able to create the requested order.
-   Invalid payload: Product Inventory does not exist. - In a change or delete order (i.e., action = change or delete), the sold service sent is not present in the system.
-   Invalid payload: Product inventory ID is missing. – In a change or delete order, the Sold Product ID is missing from the payload.
-   Invalid payload: Request body missing. - Payload was not passed in the request body.
-   Invalid payload: serviceOrderItem action is missing. – The service object or JSON is missing from the payload.
-   Invalid payload: serviceOrderItem ID is missing. – The ID is missing from the service order line item.
-   Invalid payload: serviceOrderItem missing. - Service order line item object or JSON is missing.
-   Invalid payload: serviceOrderItem service is missing. – The service property is missing from the service order line item.
-   Invalid payload: Service specification does not exist. - The service specification in the service order line item is not valid.
-   Invalid payload: serviceSpecification ID is missing. - The <strong>id</strong> parameter in the service order line item of the service specification object is missing from the payload.
-   Invalid payload: serviceSpecification is missing. - The service specification object or JSON in the service order line item is missing from the payload.
-   Invalid payload: Sold Product is inactive. – In a change or delete order, the Sold Product sent in the payload is not in active state.</td></tr><tr><td>

404

</td><td id="entry-404-status-code">

Not found. The requested item wasn't found.

</td></tr></tbody>
</table>

### Response body parameters \(JSON\)

<table><thead><tr><th>

Name

</th><th>

Description

</th></tr></thead><tbody><tr><td>

committedDueDate

</td><td><p>Date and time when the action must be performed on the order.</p>
<p>This value must be the same as or later than the <strong>committedDueDate</strong> values for each order line item.</p>
<p>Data type: String</p></td></tr><tr><td>

externalId

</td><td>

Unique order number for the external service order. Data type: String

</td></tr><tr><td>

href

</td><td>

Relative link to the resource record.Data type: String

Default: Blank string

</td></tr><tr><td>

id

</td><td>

Sys\_id of the service order.Data type: String

</td></tr><tr><td>

note

</td><td>

Optional. List of additional notes made by the customer when ordering. Data type: Array

</td></tr><tr><td>

note.text

</td><td>

Additional notes/comments made by the customer while ordering. Data type: String

</td></tr><tr><td>

orderDate

</td><td>

Date and timestamp of the order.Format: YYYY-MM-DD HH:MM:SS

Data type: String

Default: Blank string

</td></tr><tr><td>

orderId

</td><td><p>Sys_id of the order to be created. Upon succussful request, the order is added to the Inbound Queue [sn_tmt_core_inbound_queue] table on a schedule to be processed.<strong>Note:</strong> This value is the only result if the order is created asynchronously using the <strong>mode</strong> query parameter.</p>
<div class="highlight"><pre><span></span><code>{
 &quot;orderId&quot;: &quot;b0fc877ac3ab5110856d73ce3640dde0&quot;
}
</code></pre></div>
<p>Data type: String</p></td></tr><tr><td>

relatedParty

</td><td>

Optional. List of contacts for the order.Data type: Array of Objects

</td></tr><tr><td>

relatedParty.id

</td><td>

Sys\_id or external\_id of the account, customer or consumer contact associated with the order. Located in the Account \[customer\_account\], Contact \[customer\_contact\], or Consumer \[csm\_consumer\] table. Data type: String

</td></tr><tr><td>

relatedParty.name

</td><td>

Name of the account, customer, or consumer. Data type: String

</td></tr><tr><td>

relatedParty.@referredType

</td><td>

Type of customer. Possible values:

-   Customer
-   CustomerContact
-   Consumer

Data type: String

</td></tr><tr><td>

relatedParty.@type

</td><td>

Part of TMF Open API standard. Annotation for order line item contact. This value is always `RelatedParty`. This information is not stored. Data type: String

</td></tr><tr><td>

requestedCompletionDate

</td><td>

Optional. Delivery date requested by the customer. Data type: String

</td></tr><tr><td>

requestedStartDate

</td><td>

Optional. Order start date requested by the customer. Data type: String

</td></tr><tr><td>

serviceOrderItem

</td><td>

Required. List of line items in the service order and their associated action. Data type: Array

</td></tr><tr><td>

serviceOrderItem.action

</td><td>

Required. Action to perform on the service order item. Possible actions are defined on the Choice List tab in the Action Dictionary Entry field of the sn\_ind\_tmt\_orm\_order\_line\_item table. Possible values:

-   add
-   change
-   delete
-   no-change
-   resume
-   suspend

For details, see <a href="../../../order-management/order-mgt-customer-order-types/">Action types for customer and service orders</a>.

Data type: String

</td></tr><tr><td>

ServiceOrderItem.actionReason

</td><td>

Description of the reason for adding the line item.Data type: String

Table: Order Line Item \[sn\_ind\_tmt\_orm\_order\_line\_item\]

</td></tr><tr><td>

serviceOrderItem.committedDueDate

</td><td>

Optional. Date and time when the action must be performed on the order line item.

Data type: String

</td></tr><tr><td>

serviceOrderItem.externalProductInventory

</td><td><p>Conditional. List of external IDs mapped to the product inventories created for the order. If supplied, each entry requires <strong>externalProductInventoryId</strong>.Data type: Array of Objects</p>
<div class="highlight"><pre><span></span><code>&quot;externalProductInventory&quot;: [
  {
    &quot;externalProductInventoryId&quot;: &quot;String&quot;
  }
]
</code></pre></div></td></tr><tr><td>

serviceOrderItem.externalProductInventory.externalProductInventoryId

</td><td>

External ID mapped to the product inventory.Data type: String

</td></tr><tr><td>

serviceOrderItem.id

</td><td>

Unique identifier of the line item. Located in the sn\_ind\_tmt\_orm\_external\_id field of the Order Line Item \[sn\_ind\_tmt\_orm\_order\_line\_item\] table. Data type: String

</td></tr><tr><td>

serviceOrderItem.serviceOrderItemRelationship

</td><td><p>Conditional. Item-level relationships. If supplied, each entry requires an <strong>id</strong> and <strong>relationshipType</strong>. Data type: Array</p>
<div class="highlight"><pre><span></span><code>&quot;serviceOrderItemRelationship:&quot; [
  {
    &quot;id&quot;: &quot;String&quot;,
    &quot;relationshipType&quot;: &quot;String&quot;
  }
]
</code></pre></div></td></tr><tr><td>

serviceOrderItem.serviceOrderItemRelationship.id

</td><td>

Required. Unique identifier of the related line item. Located in the sn\_ind\_tmt\_orm\_external\_id field of the Order Line Item \[sn\_ind\_tmt\_orm\_order\_line\_item\] table. Data type: String

</td></tr><tr><td>

serviceOrderItem.serviceOrderItemRelationship.relationshipType

</td><td>

Required. Type of relationship between the two line items. This information is used to identify the relationship hierarchy. Possible values:

-   HasChild
-   HasParent
-   Requires

`HasChild` and `HasParent` are used for parent/child relationships. `Requires` is used for horizontal relationships \(a line item requires another line item\).

Data type: String

</td></tr><tr><td>

serviceOrderItem.place

</td><td><p>Optional. Map of the locations on which to install the service. Requires <strong>serviceOrderItem.place.id</strong> if present.Data type: Object</p>
<div class="highlight"><pre><span></span><code>&quot;place:&quot; {
  &quot;id&quot;: &quot;String&quot;,
  &quot;@type&quot;: &quot;String&quot;
}
</code></pre></div></td></tr><tr><td>

serviceOrderItem.place.id

</td><td>Sys_id of the associated location record in the Location [cmn_location] table. When employing the change action on a product order item (via the<strong>productOrderItem.action</strong> parameter), updating the request with a new place sys_id creates a move order, where the order is not changed but is fulfilled in a new location. Data type: String</td></tr><tr><td>

serviceOrderItem.place.@type

</td><td>

Part of TMF Open API standard. Annotation for order line item contact. This value is always `Place`. This information is not stored. Data type: String

</td></tr><tr><td>

serviceOrderItem.quantity

</td><td>

Number of line items ordered.Data type: Number

</td></tr><tr><td>

serviceOrderItem.relatedParty

</td><td>

Optional. List of contacts for line items. Data type: Array

</td></tr><tr><td>

serviceOrderItem.relatedParty.email

</td><td>

Email address of the contact. Data type: String

</td></tr><tr><td>

serviceOrderItem.relatedParty.firstName

</td><td>

First name of the contact. Data type: String

</td></tr><tr><td>

serviceOrderItem.relatedParty.lastName

</td><td>

Last name of the contact. Data type: String

</td></tr><tr><td>

serviceOrderItem.relatedParty.phone

</td><td>

Business phone number of the contact. Data type: String

</td></tr><tr><td>

serviceOrderItem.relatedParty.@referredType

</td><td>

Required. Type of customer. Possible value: OrderLineItemContact

Data type: String

</td></tr><tr><td>

serviceOrderItem.relatedParty.@type

</td><td>

Part of TMF Open API standard. Annotation for order line item contact. This value is always `RelatedParty`. This information is not stored. Data type: String

</td></tr><tr><td>

serviceOrderItem.service

</td><td>

Required. Description of the instance details of the service purchased by the customer. Data type: Object

</td></tr><tr><td>

serviceOrderItem.service.id

</td><td>

Unique identifier of the service sold. This value can be the sys\_id or external ID in the Product Inventory \[sn\_ind\_tmt\_orm\_product\_inventory\] table. This value is only returned for change/disconnect orders.Data type: String

</td></tr><tr><td>

serviceOrderItem.service.serviceCharacteristic

</td><td><p>Conditional. If supplied, each entry requires <strong>serviceOrderItem.service.serviceCharacteristic</strong>. List that describes the characteristics of the associated service. Only service characteristics with a current <strong>value</strong> different from the <strong>previousValue</strong> are returned.</p>
<p>Data type: Array</p>
<div class="highlight"><pre><span></span><code>&quot;serviceCharacteristic:&quot; [ 
 {
  &quot;name&quot;: &quot;String&quot;,
  &quot;previousValue&quot;: &quot;String&quot;,
  &quot;value&quot;: &quot;String&quot;,
  &quot;valueType&quot;: &quot;String&quot;
 }
]
</code></pre></div></td></tr><tr><td>

serviceOrderItem.service.serviceCharacteristic.name

</td><td>

Required for each characteristic entry. Name of the characteristic record to associated with the service. Located in the Characteristic \[sn\_prd\_pm\_characteristic\] table. Data type: String

</td></tr><tr><td>

serviceOrderItem.service.serviceCharacteristic.previousValue

</td><td>Previous characteristic option values if the update is for change order. The request is a change order if the <strong>serviceOrderItem.action</strong> parameter is other than <code>add</code>. For additional information on characteristic option values, see <a href="../../../order-management/som-product-config-add-characteristics/">Create product characteristics and characteristic options</a>. Data type: String</td></tr><tr><td>

serviceOrderItem.service.serviceCharacteristic.value

</td><td>

Characteristic option values associated with the service. For additional information on characteristic option values, see <a href="../../../order-management/som-product-config-add-characteristics/">Create product characteristics and characteristic options</a>. Data type: String

</td></tr><tr><td>

serviceOrderItem.service.serviceCharacteristic.valueType

</td><td>

Type of characteristic value.Possible values:

-   Array.Date
-   Array.Datetime
-   Array.Decimal
-   Array.Integer
-   Array.Object
-   Array.Single Line Test
-   Checkbox
-   Choice
-   Date, Address
-   Email
-   Integer, Date/Time
-   Object
-   Single Line Text
-   Yes/No

Data type: String

</td></tr><tr><td>

serviceOrderItem.service.serviceRelationship

</td><td>

List of product inventories related to the service.Data type: Array of Objects

</td></tr><tr><td>

serviceOrderItem.service.serviceRelationship.id

</td><td>

Sys\_id or sn\_prd\_invt\_external\_id of the product inventory.Data type: String

Table: In the sys\_id or sn\_prd\_invt\_external\_id field of the Product Inventory \[sn\_prd\_invt\_product\_inventory\] table.

</td></tr><tr><td>

serviceOrderItem.service.serviceRelationship.relationshipType

</td><td>

Type of relationship between the service and the product inventory. Possible value: Requires

Data type: String

</td></tr><tr><td>

serviceOrderItem.service.serviceSpecification

</td><td><p>Conditional. When supplied, <strong>serviceSpecification.id</strong> is required. Description of the service specification associated with the service. Data type: Object</p>
<div class="highlight"><pre><span></span><code>&quot;serviceSpecification:&quot; {
  &quot;id&quot;: &quot;String&quot;,
  &quot;internalId&quot;: &quot;String&quot;,
  &quot;internalVersion&quot;: &quot;String&quot;,
  &quot;name&quot;: &quot;String&quot;,
  &quot;version&quot;: &quot;String&quot;,
  &quot;@type&quot;: &quot;String&quot;
}
</code></pre></div></td></tr><tr><td>

serviceOrderItem.service.serviceSpecification.id

</td><td>Required when <strong>serviceSpecification</strong> is present. Initial_version or external_id of the service specification. The initial_version is the sys_id of the first version of the specification. Located in the sys_id or external_id field of the Service Specification [sn_prd_pm_service_specification] table. Data type: String</td></tr><tr><td>

serviceOrderItem.service.serviceSpecification.internalId

</td><td>

Initial version of the service specification.Data type: String

Table: In the sys\_id field of the Service Specification \[sn\_prd\_pm\_service\_specification\] table.

</td></tr><tr><td>

serviceOrderItem.service.serviceSpecification.internalVersion

</td><td>

Version of the service specification.Data type: String

Table: Service Specification \[sn\_prd\_pm\_service\_specification\]

</td></tr><tr><td>

serviceOrderItem.service.serviceSpecification.name

</td><td>

Name of the service specification. Located in the Service Specification \[sn\_prd\_pm\_service\_specification\] table. Data type: String

</td></tr><tr><td>

serviceOrderItem.service.serviceSpecification.version

</td><td>

External\_version of the service specification.Data type: String

Table: Service Specification \[sn\_prd\_pm\_service\_specification\]

</td></tr><tr><td>

serviceOrderItem.service.serviceSpecification.@type

</td><td>

Part of the TMF Open API standard. This value is always `ServiceSpecificationRef`. This information is not stored. Data type: String

</td></tr><tr><td>

serviceOrderItem.state

</td><td>

State of the service order item. For example, new.Data type: String

</td></tr><tr><td>

serviceOrderItem.@type

</td><td>

Part of the TMF Open API standard. This value is always `ServiceOrderItem`. This information is not stored.Data type: String

</td></tr><tr><td>

state

</td><td>

State of the service order. For more information, see<a href="../../../order-management/service-order-mgt-state-values/">Service order states</a>.Data type: String

</td></tr><tr><td>

@type

</td><td id="type-entry-tmf641">

Part of the TMF Open API standard. This value is always `ServiceOrder`. This information is not stored.Data type: String

</td></tr></tbody>
</table>

### Processing asynchronously

This example shows how to use the **mode** query parameter to create an order asynchronously. The order is added to the Inbound Queue \[sn\_tmt\_core\_inbound\_queue\] table on a schedule to be created.

Response body.

### Processing synchronously \(default\)

The following example shows how to create a service order by setting the **serviceOrderItem.action** property to `add`.

Response body:

### cURL request

The following example updates a service order by setting the **serviceOrderItem.action** property to `change`.

Response body.

### cURL request

The following example deletes a service order line item by setting the **serviceOrderItem.action** property to `delete`.

Response body.

## Service Order Open API – POST /sn\_tmf\_api/order/serviceOrder/outboundresponse

Updates the fulfillment state for the specified domain order records in the Outbound Request \[sn\_tmt\_core\_outbound\_request\] table.

To use this method, the Outbound Request table must contain the specified domain order record. Also, the method validation throws an error if the records or states specified in the request body are not located in the existing outbound record.

**Note:** You can't create new records in this table using this endpoint.

For additional information on domain orders, see [Install Order Management](../../order-management/order-mgt-install-providers.md).

### URL format

`/api/sn_tmf_api/order/serviceOrder/outboundresponse`

### Supported request parameters

|Name|Description|
|----|-----------|
|None| |

|Name|Description|
|----|-----------|
|None| |

<table class="rest_api_request_body"><thead><tr><th>

Name

</th><th>

Description

</th></tr></thead><tbody><tr><td>

externalId

</td><td>

Optional. Outbound request identifier of the domain orders record sent for fulfillment.Data type: String

Table: In the request\_id field in the Outbound Request \[sn\_tmt\_core\_outbound\_request\] table.

</td></tr><tr><td>

disableCharValueValidation

</td><td>

Flag that indicates how to control characteristic value validation behavior for choice-type characteristics.Valid values:

-   true: Validation is disabled and `characteristic_option_value` is set directly from the request payload without generating work notes.
-   false: Validates characteristic values against allowed choices and adds a work note to the record for any invalid value.

Default: false

To disable validation, create a system property named `sn_ind_tmt_orm.disableCharValueValidation` and set the value to `true`. When disabled, the value is set directly from the request payload and no work notes are generated. The property isn't shipped by default.

</td></tr><tr><td>

serviceOrderItem

</td><td>

Required. List of domain orders whose external fulfillment state needs to be updated. Data type: Array of Objects

</td></tr><tr><td>

serviceOrderItem.id

</td><td>

Required. Sys\_id of a domain order record for which to update the external fulfillment state.Data type: String

Table: Domain Order \[sn\_ind\_tmt\_orm\_domain\_order\]

</td></tr><tr><td>

serviceOrderItem.state

</td><td>

Required. External fulfillment state of the domain order.Valid values:

-   error
-   fulfilled
-   pending

Data type: String

</td></tr></tbody>
</table>

### Headers

The following request and response headers apply to this HTTP action only, or apply to this action in a distinct way. For a list of general headers used in the REST API, see [Supported REST API headers](../rest-api-explorer/c_RESTAPI.md).

|Header|Description|
|------|-----------|
|Accept|Data format of the response body. Only supports **application/json**.|
|Content-Type|Data format of the request body. Only supports **application/json**.|

|Header|Description|
|------|-----------|
|None| |

### Status codes

The following status codes apply to this HTTP action. For a list of possible status codes used in the REST API, see [REST API HTTP response codes](../rest-api-explorer/c_RESTAPI.md).

<table><thead><tr><th>

Status code

</th><th>

Description

</th></tr></thead><tbody><tr><td>

201

</td><td>

Successful. The request was successfully processed.

</td></tr><tr><td>

400

</td><td>Bad Request. Could be any of the following reasons:-   <code>Invalid payload: externalId is missing</code>: Indicates that the external ID (<strong>externalId</strong>) was not passed.
-   <code>Invalid payload: serviceOrderItem state is missing:</code> Indicates that the external fulfillment state (<strong>ServiceOrderItem.state</strong>) was not passed in one or more domain orders.
-   <code>Invalid external id. Please pass the correct external id</code>: Indicates that the passed external ID (<strong>externalId</strong>) is not present in system.
-   <code>Invalid domain order id. Please pass the correct domain order id</code>: Indicates that the passed domain order ID (<strong>ServiceOrderItem.id</strong>) is not present in the system.
-   <code>Domain order id passed is not associated with external id</code>: Indicates that the external ID (<strong>externalId</strong>) is not associated with any domain orders. The system only updates domain orders that are associated with an external ID passed in the payload.
-   <code>Invalid fulfilment state: Please provide correct fulfilment state</code>: Indicates that the passed fulfilment state (<strong>ServiceOrderItem.state</strong>) for one or more domain orders is not valid.</td></tr><tr><td>

500

</td><td id="entry-500-status-code">

Internal server error. An unexpected error occurred while processing the request. The response contains additional information about the error.

</td></tr></tbody>
</table>

### Response body parameters \(JSON\)

<table id="table_y44_214_21c"><thead><tr><th>

Name

</th><th>

Description

</th></tr></thead><tbody><tr><td>

externalId

</td><td>

Outbound request identifier of the domain orders record sent for fulfillment.Data type: String

Table: In the request\_id field in the Outbound Request \[sn\_tmt\_core\_outbound\_request\] table.

</td></tr><tr><td>

href

</td><td>

Relative link to the resource record.Data type: String

Default: Blank string

</td></tr><tr><td>

orderDate

</td><td>

Date and timestamp of the order.Format: YYYY-MM-DD HH:MM:SS

Data type: String

Default: Blank string

</td></tr><tr><td>

serviceOrderItem

</td><td>

List of domain orders whose external fulfillment state needs to be updated. Data type: Array of Objects

</td></tr><tr><td>

serviceOrderItem.id

</td><td>

Sys\_id of a domain order record for which to update the external fulfillment state.Data type: String

Table: Domain Order \[sn\_ind\_tmt\_orm\_domain\_order\]

</td></tr><tr><td>

serviceOrderItem.state

</td><td>

External fulfillment state of the domain order.Possible values:

-   error
-   fulfilled
-   pending

Data type: String

</td></tr></tbody>
</table>

### cURL request

The following code example shows how to call this endpoint.

Response: