--- sourceDocument: Xanadu API Reference sourceDocumentLink: https://servicenow-prod.fluidtopics.net/r/xanadu/api-reference Release : - xanadu ft:locale : - en-US ft:publication_title : - Xanadu API Reference ft:clusterId : - crapiref bundleId : - crapiref workflow : - Creator --- # Product Order Open API # Product Order Open API {#ariaid-title1} * Release version: Xanadu * * Updated August 1, 2024 * * ![](https://www.servicenow.com/docs/portal-asset/ico-clock) 142 minutes to read The Product Order Open API provides endpoints that enable a standardized mechanism for placing product orders. A product order is created based on a product offering that is defined and published in a product catalog. The product offering identifies the product or set of products that are available to a customer and includes the relevant product characteristics that capture the unique options of a product, and other relevant attributes such as pricing, contract terms, and availability. To access this API, the Order Management for Telecommunications (sn_ind_tmt_orm) plugin must be activated. This API is provided within the `sn_ind_tmt_orm` namespace. The calling user must have the sn_ind_tmt_orm.order_integrator role. This API can be extended to make customizations around required parameters, request body validation, additional REST operations, and field mappings. For more information, see the [Product Order Open API Developer Guide](https://servicenow-prod.fluidtopics.net/koK87WuCqxW0JJgipaftOQ#product-order_dev-guide "Use the Product Order Open API to create, update, and retrieve product order information."). The Product Order Open API is a ServiceNow® implementation of TM Forum TMF622 Product Ordering Management API REST Specification and is conformance certified by TM Forum. ## Product Order Open API - GET /sn_ind_tmt_orm/order/productOrder {#ariaid-title2} Retrieves all product orders. This endpoint retrieves order information from the following tables: * Customer Order \[sn_ind_tmt_orm_order\] * Order Line Item \[sn_ind_tmt_orm_order_line_item\] * Order Characteristic \[sn_ind_tmt_orm_order_characteristic_value\] * Order Line Item Contact \[sn_ind_tmt_orm_order_line_item_contact\] * Order Line Related Items \[sn_ind_tmt_orm_order_line_related_items\] {#tmf_prod_order-GET-ord-productOrder__ul_lxc_kxm_t4b} ### URL format {#tmf_prod_order-GET-ord-productOrder__section_mbm_2ct_t4b} Default URL: /api/sn_ind_tmt_orm/order/productOrder ### Supported request parameters {#tmf_prod_order-GET-ord-productOrder__table_ofr_vgy_fsb__entry__2} | Name | Description | |-|-| | None | | [Table 1. Path parameters] {#tmf_prod_order-GET-ord-productOrder__table_ofr_vgy_fsb} {#tmf_prod_order-GET-ord-productOrder__table_pfr_vgy_fsb__entry__2} | Name | Description | |-|-| | fields | List of fields to return in the response. Invalid fields are ignored. If this parameter is not used, all fields are returned. Data type: String | | limit | Maximum number of records to return. For requests that exceed this number of records, use the offset parameter to paginate record retrieval. Default: 20 Maximum: 100 Data type: Number | | offset | Starting index at which to begin retrieving records. Use this value to paginate record retrieval. This functionality enables the retrieval of all records, regardless of the number of records, in small manageable chunks. Default: 0 Data type: Number | | state | Filter orders by state. Only orders with a state matching the value of this parameter are returned in the response. Data type: String | [Table 2. Query parameters] {#tmf_prod_order-GET-ord-productOrder__table_pfr_vgy_fsb} {#tmf_prod_order-GET-ord-productOrder__table_xcm_cvr_nsb__entry__2} | Name | Description | |-|-| | None | | [Table 3. Request body parameters (JSON)] {#tmf_prod_order-GET-ord-productOrder__table_xcm_cvr_nsb} ### 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](https://servicenow-prod.fluidtopics.net/2vuQj3~2s_niNXyXhrbRZA "REST (REpresentational State Transfer) is a simple stateless architecture that provides standards between computer systems on the web, making it easier for them to communicate with each other."). {#tmf_prod_order-GET-ord-productOrder__table_kqy_wgy_fsb__entry__2} | Header | Description | |-|-| | None | | [Table 4. Request headers] {#tmf_prod_order-GET-ord-productOrder__table_kqy_wgy_fsb} {#tmf_prod_order-GET-ord-productOrder__table_h4r_fxr_nsb__entry__2}{#tmf_prod_order-GET-ord-productOrder__content-range-row}{#tmf_prod_order-GET-ord-productOrder__content-type-row}{#tmf_prod_order-GET-ord-productOrder__links-pagination-row}{#tmf_prod_order-GET-ord-productOrder__x-total-count-descr} | Header | Description | |-|-| | Content-Range | Specifies the range of content returned in a paginated call. For example, if `offset=2` and `limit=3`, the value of the Content-Range header is `items 3-5`. | | Content-Type | Data format of the response body. Only supports application/json. | | Link | Contains the following links to navigate through query results. * first * last * next * previous {#tmf_prod_order-GET-ord-productOrder__ul_zzk_sdm_lsb} | | X-Total-Count | For paginated queries, this header specifies the total number of records available on the server. | [Table 5. Response headers] {#tmf_prod_order-GET-ord-productOrder__table_h4r_fxr_nsb} ### 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](https://servicenow-prod.fluidtopics.net/2vuQj3~2s_niNXyXhrbRZA "REST (REpresentational State Transfer) is a simple stateless architecture that provides standards between computer systems on the web, making it easier for them to communicate with each other."). {#tmf_prod_order-GET-ord-productOrder__table_wdl_3xr_nsb__entry__2}{#tmf_prod_order-GET-ord-productOrder__tmf-get-status-200-p}{#tmf_prod_order-GET-ord-productOrder__tmf-get-status-206-entry}{#tmf_prod_order-GET-ord-productOrder__tmf-get-status-400-entry}{#tmf_prod_order-GET-ord-productOrder__tmf-get-status-404-entry} | Status code | Description | |-|-| | 200 | Request successfully processed. Full resource returned in response (no pagination). | | 206 | Partial resource returned in response (with pagination). | | 400 | Bad request. Possible reasons: * Invalid path parameter * Invalid URI {#tmf_prod_order-GET-ord-productOrder__ul_rys_1gy_fsb} | | 404 | Record not found. No records matching the query parameters are found in the table. | [Table 6. Status codes] {#tmf_prod_order-GET-ord-productOrder__table_wdl_3xr_nsb} ### Response body parameters (JSON) {#tmf_prod_order-GET-ord-productOrder__section_hnf_kxr_nsb} {#tmf_prod_order-GET-ord-productOrder__table_inf_kxr_nsb__entry__2}{#tmf_prod_order-GET-ord-productOrder__externalProdInv-resp-descr}{#tmf_prod_order-GET-ord-productOrder__externalProdInvId-resp-descr} | Name | Description | |-|-| | channel | Array of objects that describe the channels to use for selling the products. Data type: Array "channel": [ { "id": "String", "name": "String" } ] | | channel.id | Unique identifier of the channel to use to sell the associated products. Channel ID values are located in the external_id field of the Distribution Channel \[sn_prd_pm_distribution_channel\] table. Data type: String | | channel.name | Name of the channel to use to sell the associated products. Data type: String | | committedDueDate | Date and time when the action must be performed on the order. This value must be the same as or later than the committedDueDate values for each order line item. Data type: String | | expectedCompletionDate | Date on which the order will be completed. Data type: String | | href | Relative link to the product order record. Data type: String | | id | Sys_id of the product order. Data type: String | | note | Array of objects that describe additional notes made by the customer when ordering. Data type: Array "note": [ { "author": "String", "date": "String", "text": "String" } ] | | note.author | User name of the person that authored the associated note. Data type: String | | note.date | Date that the note was created. Data type: String | | note.text | Additional notes/comments made by the customer while ordering. Data type: String | | orderCurrency | Currency code for the order and order line items. Data type: String | | ponr | Flag that indicates whether the point of no return for the order has been reached. Valid values: * true: The point of no return for the order has been reached. * false: The point of no return for the order has not been reached. {#tmf_prod_order-GET-ord-productOrder__ul_tdq_rw1_hqb} Data type: Boolean | | productOrderItem | List that describes items associated with the product order and their associated action. Data type: Array "productOrderItem:" [ { "action": "String", "committedDueDate": "String", "externalProductInventory": [Array], "id": "String", "itemPrice": [Array], "product": {Object}, "productOffering": {Object}, "productOrderItemReleationship": [Array], "quantity": Number, "state": "String", "@type": "String" } ] | | productOrderItem.action | Action to carry out on the product. Possible actions are defined on the Choice List tab in the Action Dictionary Entry of the sn_ind_tmt_orm_order_line_item table. Data type: String | | productOrderItem.actionReason | The reason for adding the order line item. Data type: String Table/field updated: sn_ind_tmt_orm_order_line_item/action_reason | | productOrderItem.committedDueDate | Date and time when the action must be performed on the order line item. Data type: String | | productOrderItem.externalProductInventory | Array of objects containing external ids mapped to the product inventories created for the order. Data type: Array "externalProductInventory": [ { "externalProductInventoryId": "String" } ] | | productOrderItem.externalProductInventory.externalProductInventoryId | External id mapped to the product inventory. Data type: String | | productOrderItem.id | 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 | | productOrderItem.itemPrice | Array of objects that describe the price associated with the product. Data type: Array "itemPrice": [ { "price": {Object}, "priceType": "String", "recurringChargePeriod": "String" } ] | | productOrderItem.itemPrice.price | Description of the price of the associated product. Data type: Object "price": { "taxIncludedAmount": {Object} } | | productOrderItem.itemPrice.price.taxIncludedAmount | Description of the price of the associated product, including the tax. Data type: Object "taxIncludedAmount": { "unit": "String", "value": Number } | | productOrderItem.itemPrice.price.taxIncludedAmount.unit | Currency code in which the price is depicted. Data type: String | | productOrderItem.itemPrice.price.taxIncludedAmount.value | Price of product, including any tax. Data type: Number | | productOrderItem.itemPrice.priceType | Type of item price, recurring or non-recurring. Data type: String | | productOrderItem.itemPrice.recurringChargePeriod | If the price is recurring, the recurring period, such as month. Data type: String | | productOrderItem.ponr | Flag that indicates whether the point of no return for the order has been reached. Valid values: * true: The point of no return for the order has been reached. * false: The point of no return for the order has not been reached. {#tmf_prod_order-GET-ord-productOrder__d3046e2596} Data type: Boolean | | productOrderItem.product | Description of the instance details of the product purchased by the customer. Data type: Object "product:" { "place": {Object}, "productCharacteristic": [Array], "productRelationship": [Array], "productSpecification": {Object}, "relatedParty": {Object}, "@type": "String" } | | productOrderItem.product.place | Maps of the locations on which to install the product. Data type: Object "place": { "id": "String", "@type": "String" } | | productOrderItem.product.place.id | Sys_id of the associated location record in the Location \[cmn_location\] table. Data type: String | | productOrderItem.product.place.@type | 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 | | productOrderItem.product.productCharacteristic | Array of objects that describe the characteristics of the associated product. Only product characteristics whose value are different than the previousValue are returned. Data type: Array "productCharacteristic": [ { "name": "String", "previousValue": "String", "value": "String" } ] | | productOrderItem.product.productCharacteristic.name | Name of the characteristic record to associate with the product. Located in the Characteristic \[sn_prd_pm_characteristic\] table. Data type: String | | productOrderItem.product.productCharacteristic.previousValue | Previous characteristic option values if the update is for a change order. The request is a change order if the productOrderItem.action parameter is other than add. For additional information on characteristic option values, see [Create product characteristics and characteristic options](https://www.servicenow.com/docs/access?context=som-product-config-add-characteristics&version=xanadu&pubname=xanadu-order-management&ft:locale=en-US). Data type: String | | productOrderItem.product.productCharacteristic.value | Characteristic option values associated with the product. For additional information on characteristic option values, see [Create product characteristics and characteristic options](https://www.servicenow.com/docs/access?context=som-product-config-add-characteristics&version=xanadu&pubname=xanadu-order-management&ft:locale=en-US). Data type: String | | productOrderItem.product.productRelationship | List of product relationship details for an order line item. Data type: Array "productRelationship": [ { "id": "String", "relationshipType": "String" } ] | | productOrderItem.product.productRelationship.id | Sys_id or sn_prd_invt_external_id of the product inventory. Located in the sys_id or sn_prd_invt_external_id field of the Product Inventory \[sn_prd_invt_product_inventory\] table. Data type: String | | productOrderItem.product.productRelationship.relationshipType | Type of relationship between the order line item and the product inventory. Possible value: Requires Data type: String | | productOrderItem.product.productSpecification | Description of the product specification associated with the product. Data type: Object "productSpecification:" { "id": "String", "internalId": "String", "internalVersion": "String", "name": "String", "version": "String", "@type": "String" } | | productOrderItem.product.productSpecification.id | Initial_version or external_id of the product 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 Product Specification \[sn_prd_pm_product_specification\] table. Data type: String | | productOrderItem.product.productSpecification.internalId | Initial_version of the product specification. The initial_version is the sys_id of the first version of the specification. Located in the Product Specification \[sn_prd_pm_product_specification\] table. Data type: String | | productOrderItem.product.productSpecification.internalVersion | Version of the product specification. Located in the Product Specification \[sn_prd_pm_product_specification\] table. Data type: String | | productOrderItem.product.productSpecification.name | Name of the product specification. Located in the Product Specification \[sn_prd_pm_product_specification\] table. Data type: String | | productOrderItem.product.productSpecification.version | External_version of the product specification. Located in the Product Specification \[sn_prd_pm_product_specification\] table. Data type: String | | productOrderItem.product.productSpecification.@type | Part of the TMF Open API standard. This value is always ProductSpecificationRef. This information is not stored. Data type: String | | productOrderItem.product.relatedParty | List of contacts for line items. Data type: Array "relatedParty:" [ { "email": "String", "firstName": "String", "id": "String", "lastName": "String", "phone": "String", "@referredType": "String", "@type": "String" } ] | | productOrderItem.product.relatedParty.email | Email address of the contact. Data type: String | | productOrderItem.product.relatedParty.firstName | First name of the contact. Data type: String | | productOrderItem.product.relatedParty.id | Sys_id of the line item contact associated with the order line item. Located in the Order Line Item Contact \[sn_ind_tmt_orm_order_line_item_contact\] table. Data type: String | | productOrderItem.product.relatedParty.lastName | Last name of the contact. Data type: String Data type: String | | productOrderItem.product.relatedParty.phone | Business phone number of the contact. Data type: String | | productOrderItem.product.relatedParty.@referredType | Type of customer. Possible value: OrderLineItemContact Data type: String | | productOrderItem.product.relatedParty.@type | 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 | | productOrderItem.productOffering | Description of the product offering associated with the product. Data type: Object "productOffering:" { "id": "String", "internalId": "String", "internalVersion": "String", "name": "String", "version": "String" } | | productOrderItem.productOffering.id | Initial_version or external_id of the product offering. The initial_version is the sys_id of the first version of the offering. Located in the sys_id or external_id field of the Product Offering \[sn_prd_pm_product_offering\] table. Data type: String | | productOrderItem.productOffering.internalId | Initial_version of the product offering. The initial_version is the sys_id of the first version of the offering. Located in the Product Offering \[sn_prd_pm_product_offering\] table. Data type: String | | productOrderItem.productOffering.internalVersion | Version of the product offering. Located in the Product Offering \[sn_prd_pm_product_offering\] table. Data type: String | | productOrderItem.productOffering.name | Name of the product offering. Located in the Product Offering \[sn_prd_pm_product_offering\] table. Data type: String | | productOrderItem.productOffering.version | External_version of the product offering. Located in the Product Offering \[sn_prd_pm_product_offering\] table. Data type: String | | productOrderItem.quantity | Number of product items purchased. Data type: Number | | productOrderItem.productOrderItemRelationship | Array of objects that describe the relationships between order line items. Data type: Array "productOrderItemRelationship": [ { "id": "String", "relationshipType": "String" } ] | | productOrderItem.productOrderItemRelationship.id | 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 | | productOrderItem.productOrderItemRelationship.relationshipType | Type of relationship between the two line items. This information is used to identify the relationship hierarchy. Possible values: * HasChild * HasParent * Requires {#tmf_prod_order-GET-ord-productOrder__ul_yqf_2ty_54b} `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 | | productOrderItem.state | State of the order of the associated product item. Data type: String | | productOrderItem.version | Order version. Data type: String | | productOrderItem.@type | Part of TMF Open API standard. Annotation for the product. This value is always ProductOrderItem. This information is not stored. Data type: String | | relatedParty | List of contacts for the order. Each contact is an object in the array. Must list at least one item which contains customer account or consumer account information. Data type: Array "relatedParty:" [ { "id": "String", "name": "String", "@referredType": "String", "@type": "String" } ] | | relatedParty.id | Sys_id or external_id of the account, customer contact, or consumer associated with the order. Located in the Account \[customer_account\], Contact \[customer_contact\] table, or Consumer \[csm_consumer\] table. Data type: String | | relatedParty.name | Name of the account, customer, or consumer. Data type: String | | relatedParty.@referredType | Type of customer. Possible values: * Consumer * Customer * CustomerContact {#tmf_prod_order-GET-ord-productOrder__ul_lcq_jwm_t4b} Data type: String | | relatedParty.@type | Part of TMF Open API standard. Annotation for the product. This value is always RelatedParty. This information is not stored. Data type: String | | requestedCompletionDate | Delivery date requested by the customer. Data type: String | | requestedStartDate | Order start date requested by the customer. Data type: String | | state | Current state of the order. Data type: String | | version | Order version. Data type: String | | @type | Part of TMF Open API standard. Annotation for the product. This value is always ProductOrder. This information is not stored. Data type: String | [ ] {#tmf_prod_order-GET-ord-productOrder__table_inf_kxr_nsb} ### cURL request This example retrieves all product orders. curl --location --request GET 'https://instance.service-now.com/api/sn_ind_tmt_orm/order/productOrder' \ --user 'username':'password' Response body. [ { "id": "8d75939453126010a795ddeeff7b126a", "href": "/api/sn_ind_tmt_orm/order/productOrder/8d75939453126010a795ddeeff7b126a", "ponr": "false", "orderCurrency": "USD", "expectedCompletionDate": "2021-05-02T08:13:59.000Z", "requestedCompletionDate": "2021-05-02T08:13:59.000Z", "requestedStartDate": "2020-05-03T08:13:59.000Z", "channel": [ { "id": "1", "name": "Agent Assist" } ], "note": [ { "author": "System Administrator", "date": "2021-02-25T14:22:07.000Z", "text": "This is a TMF product order illustration no 2" }, { "author": "System Administrator", "date": "2021-02-25T14:22:06.000Z", "text": "This is a TMF product order illustration" } ], "productOrderItem": [ { "id": "POI130", "ponr": "false", "quantity": 1, "action": "add", "actionReason": "adding service package OLI", "itemPrice": [ { "priceType": "recurring", "price": { "taxIncludedAmount": { "unit": "USD", "value": 20 } } }, { "priceType": "nonRecurring", "price": { "taxIncludedAmount": { "unit": "INR", "value": 0 } } } ], "product": { "@type": "Product", "productCharacteristic": [ { "name": "Security Type", "valueType": "Choice", "value": "Base", "previousValue": "" } ], "productSpecification": { "id": "a6514bd3534560102f18ddeeff7b1247", "name": "SD-WAN Security", "version": "v1", "internalVersion": "1", "internalId": "a6514bd3534560102f18ddeeff7b1247", "@type": "ProductSpecificationRef" }, "relatedParty": [ { "id": "4175939453126010a795ddeeff7b127d", "name": "John Smith", "email": "abc2@example.com", "phone": "32456768", "@type": "RelatedParty", "@referredType": "OrderLineItemContact" }, { "id": "c175939453126010a795ddeeff7b127c", "name": "Joe Doe", "email": "abc@example.com", "phone": "1234567890", "@type": "RelatedParty", "@referredType": "OrderLineItemContact" } ] }, "productOffering": { "id": "69017a0f536520103b6bddeeff7b127d", "name": "Premium SD-WAN Offering", "version": "v1", "internalId": "69017a0f536520103b6bddeeff7b127d", "internalVersion": "1" }, "productOrderItemRelationship": [ { "id": "POI100", "relationshipType": "HasParent" } ], "state": "in_progress", "version": "1", "@type": "ProductOrderItem" }, { "id": "POI100", "ponr": "false", "quantity": 1, "action": "add", "itemPrice": [ { "priceType": "recurring", "price": { "taxIncludedAmount": { "unit": "INR", "value": 0 } } }, { "priceType": "nonRecurring", "price": { "taxIncludedAmount": { "unit": "INR", "value": 0 } } } ], "product": { "@type": "Product", "productSpecification": { "id": "cfe5ef6a53702010cd6dddeeff7b12f6", "name": "SD-WAN Service Package", "version": "v1", "internalVersion": "1", "internalId": "cfe5ef6a53702010cd6dddeeff7b12f6", "@type": "ProductSpecificationRef" } }, "productOffering": { "id": "69017a0f536520103b6bddeeff7b127d", "name": "Premium SD-WAN Offering", "version": "v1", "internalId": "69017a0f536520103b6bddeeff7b127d", "internalVersion": "1" }, "productOrderItemRelationship": [ { "id": "POI130", "relationshipType": "HasChild" }, { "id": "POI120", "relationshipType": "HasChild" }, { "id": "POI110", "relationshipType": "HasChild" } ], "state": "in_progress", "version": "1", "@type": "ProductOrderItem" }, { "id": "POI120", "ponr": "false", "quantity": 1, "action": "add", "itemPrice": [ { "priceType": "recurring", "price": { "taxIncludedAmount": { "unit": "USD", "value": 20 } } }, { "priceType": "nonRecurring", "price": { "taxIncludedAmount": { "unit": "INR", "value": 0 } } } ], "product": { "@type": "Product", "productCharacteristic": [ { "name": "CPE Type", "valueType": "Choice", "value": "Physical", "previousValue": "" }, { "name": "WAN Optimization", "valueType": "Choice", "value": "Advance", "previousValue": "" }, { "name": "Routing", "valueType": "Choice", "value": "Premium", "previousValue": "" }, { "name": "CPE Model", "valueType": "Choice", "value": "ASR", "previousValue": "" } ], "productSpecification": { "id": "39b627aa53702010cd6dddeeff7b1202", "name": "SD-WAN Edge Device", "version": "v1", "internalVersion": "1", "internalId": "39b627aa53702010cd6dddeeff7b1202", "@type": "ProductSpecificationRef" }, "productRelationship": [ { "id": "326d13f45b5620102dff5e92dc81c785", "relationshipType": "Requires" } ] }, "productOffering": { "id": "69017a0f536520103b6bddeeff7b127d", "name": "Premium SD-WAN Offering", "version": "v1", "internalVersion": "1", "internalId": "69017a0f536520103b6bddeeff7b127d" }, "productOrderItemRelationship": [ { "id": "POI100", "relationshipType": "HasParent" }, { "id": "POI110", "relationshipType": "Requires" } ], "state": "in_progress", "version": "1", "@type": "ProductOrderItem" }, { "id": "POI110", "ponr": "false", "quantity": 1, "action": "add", "itemPrice": [ { "priceType": "recurring", "price": { "taxIncludedAmount": { "unit": "INR", "value": 0 } } }, { "priceType": "nonRecurring", "price": { "taxIncludedAmount": { "unit": "USD", "value": 5 } } } ], "product": { "@type": "Product", "productCharacteristic": [ { "name": "Tenancy", "valueType": "Choice", "value": "Base (10 site)", "previousValue": "" } ], "productSpecification": { "id": "216663aa53702010cd6dddeeff7b12b5", "name": "SD-WAN Controller", "version": "v1", "internalVersion": "1", "internalId": "216663aa53702010cd6dddeeff7b12b5", "@type": "ProductSpecificationRef" }, "place": { "id": "25ab9c4d0a0a0bb300f7dabdc0ca7c1c", "@type": "Place" } }, "productOffering": { "id": "69017a0f536520103b6bddeeff7b127d", "name": "Premium SD-WAN Offering", "version": "v1", "internalId": "69017a0f536520103b6bddeeff7b127d", "internalVersion": "1" }, "productOrderItemRelationship": [ { "id": "POI100", "relationshipType": "HasParent" } ], "state": "in_progress", "version": "1", "@type": "ProductOrderItem" } ], "relatedParty": [ { "id": "eaf68911c35420105252716b7d40ddde", "name": "Sally Thomas", "@type": "RelatedParty", "@referredType": "CustomerContact" }, { "id": "ffc68911c35420105252716b7d40dd55", "name": "Funco Intl", "@type": "RelatedParty", "@referredType": "Customer" }, { "id": "59f16de1c3b67110ff00ed23a140dd9e", "name": "Funco External", "@type": "RelatedParty", "@referredType": "Consumer" } ], "state": "in_progress", "version": "1", "@type": "ProductOrder" } ] ## Product Order Open API - GET /sn_ind_tmt_orm/order/productOrder/{id} {#ariaid-title3} Retrieves the specified product order. This endpoint retrieves order information from the following tables: * Customer Order \[sn_ind_tmt_orm_order\] * Order Characteristic \[sn_ind_tmt_orm_order_characteristic_value\] * Order Line Item \[sn_ind_tmt_orm_order_line_item\] * Order Line Item Contact \[sn_ind_tmt_orm_order_line_item_contact\] * Order Line Related Items \[sn_ind_tmt_orm_order_line_related_items\] {#tmf_prod_order-GET-ord-productOrder-id__ul_lxc_kxm_t4b} ### URL format {#tmf_prod_order-GET-ord-productOrder-id__section_mbm_2ct_t4b} Default URL: /api/sn_ind_tmt_orm/order/productOrder/{id} ### Supported request parameters {#tmf_prod_order-GET-ord-productOrder-id__entry__2} | Name | Description | |-|-| | id | Sys_id or external_id of the customer order to retrieve. Located in the Customer Order \[sn_ind_tmt_orm_order\] table. Data type: String | [Table 7. Path parameters] {#tmf_prod_order-GET-ord-productOrder-id__entry__6} | Name | Description | |-|-| | None | | [Table 8. Query parameters] {#tmf_prod_order-GET-ord-productOrder-id__entry__10} | Name | Description | |-|-| | None | | [Table 9. Request body parameters (JSON)] ### 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](https://servicenow-prod.fluidtopics.net/2vuQj3~2s_niNXyXhrbRZA "REST (REpresentational State Transfer) is a simple stateless architecture that provides standards between computer systems on the web, making it easier for them to communicate with each other."). {#tmf_prod_order-GET-ord-productOrder-id__table_kqy_wgy_fsb__entry__2} | Header | Description | |-|-| | None | | [Table 10. Request headers] {#tmf_prod_order-GET-ord-productOrder-id__table_kqy_wgy_fsb} {#tmf_prod_order-GET-ord-productOrder-id__table_tzy_thy_ksb__entry__2} | Header | Description | |-|-| | Content-Type | Data format of the response body. Only supports application/json. | [Table 11. Response headers] {#tmf_prod_order-GET-ord-productOrder-id__table_tzy_thy_ksb} ### 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](https://servicenow-prod.fluidtopics.net/2vuQj3~2s_niNXyXhrbRZA "REST (REpresentational State Transfer) is a simple stateless architecture that provides standards between computer systems on the web, making it easier for them to communicate with each other."). {#tmf_prod_order-GET-ord-productOrder-id__tmf-get-list-status-codes__entry__2} | Status code | Description | |-|-| | 200 | Request successfully processed. Full resource returned in response (no pagination). The response returns successful with an error message if the selected order has processing issues. * A 200 OK response happens if the order is in the Inbound Queue \[sn_tmt_core_inbound_queue\] table waiting for the scheduler to pick the record to be processed. The error message field includes details for the record. For example: { "code": 102, "reason": "Request in queue", "message": "Request in queue", "details": [ { "message": "This Order is still in the inbound queue table waiting to be processed.", "datapath": "" } ] } * A 200 OK response happens if an order creation fails and the record in the Inbound Queue \[sn_tmt_core_inbound_queue\] table is in an error state. The error message field includes details in for the inbound queue table record. For example: { "code": 23, "reason": "Missing body field", "message": "Missing body field", "details": [ { "message": "Invalid payload: orderCurrency is missing", "datapath": "/" } ] } {#tmf_prod_order-GET-ord-productOrder-id__ul_kdw_y4w_fwb} | | 206 | Partial resource returned in response (with pagination). | | 400 | Bad request. Possible reasons: * Invalid path parameter * Invalid URI {#tmf_prod_order-GET-ord-productOrder-id__ul_rys_1gy_fsb} | | 404 | Record not found. No records matching the query parameters are found in the table. | [Table 12. Status codes] {#tmf_prod_order-GET-ord-productOrder-id__tmf-get-list-status-codes} ### Response body parameters (JSON) {#tmf_prod_order-GET-ord-productOrder-id__entry__32}{#tmf_prod_order-GET-ord-productOrder-id__externalProdInv-resp-descr}{#tmf_prod_order-GET-ord-productOrder-id__externalProdInvId-resp-descr} | Name | Description | |-|-| | channel | Array of objects that describe the channels to use for selling the products. Data type: Array "channel": [ { "id": "String", "name": "String" } ] | | channel.id | Unique identifier of the channel to use to sell the associated products. Channel ID values are located in the external_id field of the Distribution Channel \[sn_prd_pm_distribution_channel\] table. Data type: String | | channel.name | Name of the channel to use to sell the associated products. Data type: String | | committedDueDate | Date and time when the action must be performed on the order. This value must be the same as or later than the committedDueDate values for each order line item. Data type: String | | expectedCompletionDate | Date on which the order will be completed. Data type: String | | href | Relative link to the product order record. Data type: String | | id | Sys_id of the product order. Data type: String | | note | Array of objects that describe additional notes made by the customer when ordering. Data type: Array "note": [ { "author": "String", "date": "String", "text": "String" } ] | | note.author | User name of the person that authored the associated note. Data type: String | | note.date | Date that the note was created. Data type: String | | note.text | Additional notes/comments made by the customer while ordering. Data type: String | | orderCurrency | Currency code for the order and order line items. Data type: String | | ponr | Flag that indicates whether the point of no return for the order has been reached. Valid values: * true: The point of no return for the order has been reached. * false: The point of no return for the order has not been reached. {#tmf_prod_order-GET-ord-productOrder-id__ul_tdq_rw1_hqb} Data type: Boolean | | productOrderItem | List that describes items associated with the product order and their associated action. Data type: Array "productOrderItem:" [ { "action": "String", "actionReason": "String", "committedDueDate": "String", "externalProductInventory": [Array], "id": "String", "itemPrice": [Array], "product": {Object}, "productOffering": {Object}, "productOrderItemReleationship": [Array], "quantity": Number, "state": "String", "@type": "String" } ] | | productOrderItem.action | Action to carry out on the product. Possible actions are defined on the Choice List tab in the Action Dictionary Entry of the sn_ind_tmt_orm_order_line_item table. Data type: String | | productOrderItem.actionReason | The reason for adding the order line item. Data type: String Table/field updated: sn_ind_tmt_orm_order_line_item/action_reason | | productOrderItem.committedDueDate | Date and time when the action must be performed on the order line item. Data type: String | | productOrderItem.externalProductInventory | Array of objects containing external ids mapped to the product inventories created for the order. Data type: Array "externalProductInventory": [ { "externalProductInventoryId": "String" } ] | | productOrderItem.externalProductInventory.externalProductInventoryId | External id mapped to the product inventory. Data type: String | | productOrderItem.id | 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 | | productOrderItem.itemPrice | Array of objects that describe the price associated with the product. Data type: Array "itemPrice": [ { "price": {Object}, "priceType": "String", "recurringChargePeriod": "String" } ] | | productOrderItem.itemPrice.price | Description of the price of the associated product. Data type: Object "price": { "taxIncludedAmount": {Object} } | | productOrderItem.itemPrice.price.taxIncludedAmount | Description of the price of the associated product, including the tax. Data type: Object "taxIncludedAmount": { "unit": "String", "value": Number } | | productOrderItem.itemPrice.price.taxIncludedAmount.unit | Currency code in which the price is depicted. Data type: String | | productOrderItem.itemPrice.price.taxIncludedAmount.value | Price of product, including any tax. Data type: Number | | productOrderItem.itemPrice.priceType | Type of item price, recurring or non-recurring. Data type: String | | productOrderItem.itemPrice.recurringChargePeriod | If the price is recurring, the recurring period, such as month. Data type: String | | productOrderItem.ponr | Flag that indicates whether the point of no return for the order has been reached. Valid values: * true: The point of no return for the order has been reached. * false: The point of no return for the order has not been reached. {#tmf_prod_order-GET-ord-productOrder-id__d3046e2596} Data type: Boolean | | productOrderItem.product | Description of the instance details of the product purchased by the customer. Data type: Object "product:" { "place": {Object}, "productCharacteristic": [Array], "productRelationship": [Array], "productSpecification": {Object}, "relatedParty": {Object}, "@type": "String" } | | productOrderItem.product.place | Maps of the locations on which to install the product. Data type: Object "place": { "id": "String", "@type": "String" } | | productOrderItem.product.place.id | Sys_id of the associated location record in the Location \[cmn_location\] table. Data type: String | | productOrderItem.product.place.@type | 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 | | productOrderItem.product.productCharacteristic | Array of objects that describe the characteristics of the associated product. Only product characteristics whose value are different than the previousValue are returned. Data type: Array "productCharacteristic": [ { "name": "String", "previousValue": "String", "value": "String" } ] | | productOrderItem.product.productCharacteristic.name | Name of the characteristic record to associate with the product. Located in the Characteristic \[sn_prd_pm_characteristic\] table. Data type: String | | productOrderItem.product.productCharacteristic.previousValue | Previous characteristic option values if the update is for a change order. The request is a change order if the productOrderItem.action parameter is other than add. For additional information on characteristic option values, see [Create product characteristics and characteristic options](https://www.servicenow.com/docs/access?context=som-product-config-add-characteristics&version=xanadu&pubname=xanadu-order-management&ft:locale=en-US). Data type: String | | productOrderItem.product.productCharacteristic.value | Characteristic option values associated with the product. For additional information on characteristic option values, see [Create product characteristics and characteristic options](https://www.servicenow.com/docs/access?context=som-product-config-add-characteristics&version=xanadu&pubname=xanadu-order-management&ft:locale=en-US). Data type: String | | productOrderItem.product.productRelationship | List of product relationship details for an order line item. Data type: Array "productRelationship": [ { "id": "String", "relationshipType": "String" } ] | | productOrderItem.product.productRelationship.id | Sys_id or sn_prd_invt_external_id of the product inventory. Located in the sys_id or sn_prd_invt_external_id field of the Product Inventory \[sn_prd_invt_product_inventory\] table. Data type: String | | productOrderItem.product.productRelationship.relationshipType | Type of relationship between the order line item and the product inventory. Possible value: Requires Data type: String | | productOrderItem.product.productSpecification | Description of the product specification associated with the product. Data type: Object "productSpecification:" { "id": "String", "internalId": "String", "internalVersion": "String", "name": "String", "version": "String", "@type": "String" } | | productOrderItem.product.productSpecification.id | Initial_version or external_id of the product 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 Product Specification \[sn_prd_pm_product_specification\] table. Data type: String | | productOrderItem.product.productSpecification.internalId | Initial_version of the product specification. The initial_version is the sys_id of the first version of the specification. Located in the Product Specification \[sn_prd_pm_product_specification\] table. Data type: String | | productOrderItem.product.productSpecification.internalVersion | Version of the product specification. Located in the Product Specification \[sn_prd_pm_product_specification\] table. Data type: String | | productOrderItem.product.productSpecification.name | Name of the product specification. Located in the Product Specification \[sn_prd_pm_product_specification\] table. Data type: String | | productOrderItem.product.productSpecification.version | External_version of the product specification. Located in the Product Specification \[sn_prd_pm_product_specification\] table. Data type: String | | productOrderItem.product.productSpecification.@type | Part of the TMF Open API standard. This value is always ProductSpecificationRef. This information is not stored. Data type: String | | productOrderItem.product.relatedParty | List of contacts for line items. Data type: Array "relatedParty:" { "email": "String", "firstName": "String", "id": "String", "lastName": "String", "phone": "String", "@referredType": "String", "@type": "String" } | | productOrderItem.product.relatedParty.email | Email address of the contact. Data type: String | | productOrderItem.product.relatedParty.firstName | First name of the contact. Data type: String | | productOrderItem.product.relatedParty.id | Sys_id of the line item contact associated with the order line item. Located in the Order Line Item Contact \[sn_ind_tmt_orm_order_line_item_contact\] table. Data type: String | | productOrderItem.product.relatedParty.lastName | Last name of the contact. Data type: String Data type: String | | productOrderItem.product.relatedParty.phone | Business phone number of the contact. Data type: String | | productOrderItem.product.relatedParty.@referredType | Type of customer. Possible value: OrderLineItemContact Data type: String | | productOrderItem.product.relatedParty.@type | 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 | | productOrderItem.productOffering | Description of the product offering associated with the product. Data type: Object "productOffering:" { "id": "String", "internalId": "String", "internalVersion": "String", "name": "String", "version": "String" } | | productOrderItem.productOffering.id | Initial_version or external_id of the product offering. The initial_version is the sys_id of the first version of the offering. Located in the sys_id or external_id field of the Product Offering \[sn_prd_pm_product_offering\] table. Data type: String | | productOrderItem.productOffering.internalId | Initial_version of the product offering. The initial_version is the sys_id of the first version of the offering. Located in the Product Offering \[sn_prd_pm_product_offering\] table. Data type: String | | productOrderItem.productOffering.internalVersion | Version of the product offering. Located in the Product Offering \[sn_prd_pm_product_offering\] table. Data type: String | | productOrderItem.productOffering.name | Name of the product offering. Located in the Product Offering \[sn_prd_pm_product_offering\] table. Data type: String | | productOrderItem.productOffering.version | External_version of the product offering. Located in the Product Offering \[sn_prd_pm_product_offering\] table. Data type: String | | productOrderItem.quantity | Number of product items purchased. Data type: Number | | productOrderItem.productOrderItemRelationship | Array of objects that describe the relationships between order line items. Data type: Array "productOrderItemRelationship": [ { "id": "String", "relationshipType": "String" } ] | | productOrderItem.productOrderItemRelationship.id | 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 | | productOrderItem.productOrderItemRelationship.relationshipType | Type of relationship between the two line items. This information is used to identify the relationship hierarchy. Possible values: * HasChild * HasParent * Requires {#tmf_prod_order-GET-ord-productOrder-id__ul_yqf_2ty_54b} `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 | | productOrderItem.state | State of the order of the associated product item. Data type: String | | productOrderItem.version | Order version. Data type: String | | productOrderItem.@type | Part of TMF Open API standard. Annotation for the product. This value is always ProductOrderItem. This information is not stored. Data type: String | | relatedParty | List of contacts for the order. Each contact is an object in the array. Must list at least one item which contains customer account or consumer account information. Data type: Array "relatedParty:" [ { "id": "String", "name": "String", "@referredType": "String", "@type": "String" } ] | | relatedParty.id | Sys_id or external_id of the account, customer contact, or consumer associated with the order. Located in the Account \[customer_account\], Contact \[customer_contact\] table, or Consumer \[csm_consumer\] table. Data type: String | | relatedParty.name | Name of the account, customer, or consumer. Data type: String | | relatedParty.@referredType | Type of customer. Possible values: * Consumer * Customer * CustomerContact {#tmf_prod_order-GET-ord-productOrder-id__ul_lcq_jwm_t4b} Data type: String | | relatedParty.@type | Part of TMF Open API standard. Annotation for the product. This value is always RelatedParty. This information is not stored. Data type: String | | requestedCompletionDate | Delivery date requested by the customer. Data type: String | | requestedStartDate | Order start date requested by the customer. Data type: String | | state | Current state of the order. Data type: String | | version | Order version. Data type: String | | @type | Part of TMF Open API standard. Annotation for the product. This value is always ProductOrder. This information is not stored. Data type: String | [ ] ### cURL request This example retrieves a specified product order. curl -X GET "https://instance.service-now.com/api/sn_ind_tmt_orm/order/productOrder/8d75939453126010a795ddeeff7b126a" \ -u "username":"password" Response body. { "id": "8d75939453126010a795ddeeff7b126a", "href": "/api/sn_ind_tmt_orm/order/productOrder/8d75939453126010a795ddeeff7b126a", "ponr": "false", "orderCurrency": "USD", "expectedCompletionDate": "2021-05-02T08:13:59.000Z", "requestedCompletionDate": "2021-05-02T08:13:59.000Z", "requestedStartDate": "2020-05-03T08:13:59.000Z", "channel": [ { "id": "1", "name": "Agent Assist" } ], "note": [ { "author": "System Administrator", "date": "2021-02-25T14:22:07.000Z", "text": "This is a TMF product order illustration no 2" }, { "author": "System Administrator", "date": "2021-02-25T14:22:06.000Z", "text": "This is a TMF product order illustration" } ], "productOrderItem": [ { "id": "POI130", "ponr": "false", "quantity": 1, "action": "add", "actionReason": "adding service package OLI", "itemPrice": [ { "priceType": "recurring", "price": { "taxIncludedAmount": { "unit": "USD", "value": 20 } } }, { "priceType": "nonRecurring", "price": { "taxIncludedAmount": { "unit": "INR", "value": 0 } } } ], "product": { "@type": "Product", "productCharacteristic": [ { "name": "Security Type", "valueType": "Choice", "value": "Base", "previousValue": "" } ], "productSpecification": { "id": "a6514bd3534560102f18ddeeff7b1247", "name": "SD-WAN Security", "version": "v1", "internalVersion": "1", "internalId": "a6514bd3534560102f18ddeeff7b1247", "@type": "ProductSpecificationRef" }, "relatedParty": [ { "id": "4175939453126010a795ddeeff7b127d", "name": "John Smith", "email": "abc2@example.com", "phone": "32456768", "@type": "RelatedParty", "@referredType": "OrderLineItemContact" }, { "id": "c175939453126010a795ddeeff7b127c", "name": "Joe Doe", "email": "abc@example.com", "phone": "1234567890", "@type": "RelatedParty", "@referredType": "OrderLineItemContact" } ] }, "productOffering": { "id": "69017a0f536520103b6bddeeff7b127d", "name": "Premium SD-WAN Offering", "version": "v1", "internalId": "69017a0f536520103b6bddeeff7b127d", "internalVersion": "1" }, "productOrderItemRelationship": [ { "id": "POI100", "relationshipType": "HasParent" } ], "state": "in_progress", "version": "1", "@type": "ProductOrderItem" }, { "id": "POI100", "ponr": "false", "quantity": 1, "action": "add", "actionReason":"adding service package OLI", "itemPrice": [ { "priceType": "recurring", "price": { "taxIncludedAmount": { "unit": "INR", "value": 0 } } }, { "priceType": "nonRecurring", "price": { "taxIncludedAmount": { "unit": "INR", "value": 0 } } } ], "product": { "@type": "Product", "productSpecification": { "id": "cfe5ef6a53702010cd6dddeeff7b12f6", "name": "SD-WAN Service Package", "version": "v1", "internalVersion": "1", "internalId": "cfe5ef6a53702010cd6dddeeff7b12f6", "@type": "ProductSpecificationRef" } }, "productOffering": { "id": "69017a0f536520103b6bddeeff7b127d", "name": "Premium SD-WAN Offering", "version": "v1", "internalId": "69017a0f536520103b6bddeeff7b127d", "internalVersion": "1" }, "productOrderItemRelationship": [ { "id": "POI130", "relationshipType": "HasChild" }, { "id": "POI120", "relationshipType": "HasChild" }, { "id": "POI110", "relationshipType": "HasChild" } ], "state": "in_progress", "version": "1", "@type": "ProductOrderItem" }, { "id": "POI120", "ponr": "false", "quantity": 1, "action": "add", "actionReason": "adding service package OLI", "itemPrice": [ { "priceType": "recurring", "price": { "taxIncludedAmount": { "unit": "USD", "value": 20 } } }, { "priceType": "nonRecurring", "price": { "taxIncludedAmount": { "unit": "INR", "value": 0 } } } ], "product": { "@type": "Product", "productCharacteristic": [ { "name": "CPE Type", "valueType": "Choice", "value": "Physical", "previousValue": "" }, { "name": "WAN Optimization", "valueType": "Choice", "value": "Advance", "previousValue": "" }, { "name": "Routing", "valueType": "Choice", "value": "Premium", "previousValue": "" }, { "name": "CPE Model", "valueType": "Choice", "value": "ASR", "previousValue": "" } ], "productSpecification": { "id": "39b627aa53702010cd6dddeeff7b1202", "name": "SD-WAN Edge Device", "version": "v1", "internalVersion": "1", "internalId": "39b627aa53702010cd6dddeeff7b1202", "@type": "ProductSpecificationRef" }, "productRelationship": [ { "id": "326d13f45b5620102dff5e92dc81c785", "relationshipType": "Requires" } ] }, "productOffering": { "id": "69017a0f536520103b6bddeeff7b127d", "name": "Premium SD-WAN Offering", "version": "v1", "internalVersion": "1", "internalId": "69017a0f536520103b6bddeeff7b127d" }, "productOrderItemRelationship": [ { "id": "POI100", "relationshipType": "HasParent" }, { "id": "POI110", "relationshipType": "Requires" } ], "state": "in_progress", "version": "1", "@type": "ProductOrderItem" }, { "id": "POI110", "ponr": "false", "quantity": 1, "action": "add", "actionReason": "adding service package OLI", "itemPrice": [ { "priceType": "recurring", "price": { "taxIncludedAmount": { "unit": "INR", "value": 0 } } }, { "priceType": "nonRecurring", "price": { "taxIncludedAmount": { "unit": "USD", "value": 5 } } } ], "product": { "@type": "Product", "productCharacteristic": [ { "name": "Tenancy", "valueType": "Choice", "value": "Base (10 site)", "previousValue": "" } ], "productSpecification": { "id": "216663aa53702010cd6dddeeff7b12b5", "name": "SD-WAN Controller", "version": "v1", "internalVersion": "1", "internalId": "216663aa53702010cd6dddeeff7b12b5", "@type": "ProductSpecificationRef" }, "place": { "id": "25ab9c4d0a0a0bb300f7dabdc0ca7c1c", "@type": "Place" } }, "productOffering": { "id": "69017a0f536520103b6bddeeff7b127d", "name": "Premium SD-WAN Offering", "version": "v1", "internalId": "69017a0f536520103b6bddeeff7b127d", "internalVersion": "1" }, "productOrderItemRelationship": [ { "id": "POI100", "relationshipType": "HasParent" } ], "state": "in_progress", "version": "1", "@type": "ProductOrderItem" } ], "relatedParty": [ { "id": "eaf68911c35420105252716b7d40ddde", "name": "Sally Thomas", "@type": "RelatedParty", "@referredType": "CustomerContact" }, { "id": "ffc68911c35420105252716b7d40dd55", "name": "Funco Intl", "@type": "RelatedParty", "@referredType": "Customer" }, { "id": "59f16de1c3b67110ff00ed23a140dd9e", "name": "Funco External", "@type": "RelatedParty", "@referredType": "Consumer" } ], "state": "in_progress", "version": "1", "@type": "ProductOrder" } ## Product Order Open API - GET /sn_ind_tmt_orm/productorder {#ariaid-title4} Retrieves all product orders. Important: Starting with the Tokyo release, this endpoint is deprecated. The new version of this endpoint is [Product Order Open API - GET /sn_ind_tmt_orm/order/productOrder](https://servicenow-prod.fluidtopics.net/lU3_sIIHvtqhkTfEEUFOCw#tmf_prod_order-GET-ord-productOrder "Retrieves all product orders."). This endpoint retrieves order information from the following tables: * Customer Order \[sn_ind_tmt_orm_order\] * Order Characteristic \[sn_ind_tmt_orm_order_characteristic_value\] * Order Line Item \[sn_ind_tmt_orm_order_line_item\] * Order Line Item Contact \[sn_ind_tmt_orm_order_line_item_contact\] {#tmf_prod_order-GET-productorder__ul_lxc_kxm_t4b} ### URL format {#tmf_prod_order-GET-productorder__section_mbm_2ct_t4b} Default URL: /api/sn_ind_tmt_orm/productorder ### Supported request parameters {#tmf_prod_order-GET-productorder__table_ofr_vgy_fsb__entry__2} | Name | Description | |-|-| | None | | [Table 13. Path parameters] {#tmf_prod_order-GET-productorder__table_ofr_vgy_fsb} {#tmf_prod_order-GET-productorder__table_pfr_vgy_fsb__entry__2} | Name | Description | |-|-| | fields | List of fields to return in the response. Invalid fields are ignored. Data type: String Default: All fields returned. | | limit | Maximum number of records to return. For requests that exceed this number of records, use the offset parameter to paginate record retrieval. Default: 20 Maximum: 100 Data type: Number | | offset | Starting index at which to begin retrieving records. Use this value to paginate record retrieval. This functionality enables the retrieval of all records, regardless of the number of records, in small manageable chunks. Default: 0 Data type: Number | | state | Filter orders by state. Only orders with a state matching the value of this parameter are returned in the response. Data type: String Default: All states returned. | [Table 14. Query parameters] {#tmf_prod_order-GET-productorder__table_pfr_vgy_fsb} {#tmf_prod_order-GET-productorder__table_xcm_cvr_nsb__entry__2} | Name | Description | |-|-| | None | | [Table 15. Request body parameters (JSON)] {#tmf_prod_order-GET-productorder__table_xcm_cvr_nsb} ### 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](https://servicenow-prod.fluidtopics.net/2vuQj3~2s_niNXyXhrbRZA "REST (REpresentational State Transfer) is a simple stateless architecture that provides standards between computer systems on the web, making it easier for them to communicate with each other."). {#tmf_prod_order-GET-productorder__table_kqy_wgy_fsb__entry__2} | Header | Description | |-|-| | None | | [Table 16. Request headers] {#tmf_prod_order-GET-productorder__table_kqy_wgy_fsb} {#tmf_prod_order-GET-productorder__table_h4r_fxr_nsb__entry__2}{#tmf_prod_order-GET-productorder__content-range-row}{#tmf_prod_order-GET-productorder__content-type-row}{#tmf_prod_order-GET-productorder__links-pagination-row}{#tmf_prod_order-GET-productorder__x-total-count-descr} | Header | Description | |-|-| | Content-Range | Specifies the range of content returned in a paginated call. For example, if `offset=2` and `limit=3`, the value of the Content-Range header is `items 3-5`. | | Content-Type | Data format of the response body. Only supports application/json. | | Link | Contains the following links to navigate through query results. * first * last * next * previous {#tmf_prod_order-GET-productorder__ul_zzk_sdm_lsb} | | X-Total-Count | For paginated queries, this header specifies the total number of records available on the server. | [Table 17. Response headers] {#tmf_prod_order-GET-productorder__table_h4r_fxr_nsb} ### 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](https://servicenow-prod.fluidtopics.net/2vuQj3~2s_niNXyXhrbRZA "REST (REpresentational State Transfer) is a simple stateless architecture that provides standards between computer systems on the web, making it easier for them to communicate with each other."). {#tmf_prod_order-GET-productorder__table_wdl_3xr_nsb__entry__2}{#tmf_prod_order-GET-productorder__tmf-get-status-200-p}{#tmf_prod_order-GET-productorder__tmf-get-status-206-entry}{#tmf_prod_order-GET-productorder__tmf-get-status-400-entry}{#tmf_prod_order-GET-productorder__tmf-get-status-404-entry} | Status code | Description | |-|-| | 200 | Request successfully processed. Full resource returned in response (no pagination). | | 206 | Partial resource returned in response (with pagination). | | 400 | Bad request. Possible reasons: * Invalid path parameter * Invalid URI {#tmf_prod_order-GET-productorder__ul_rys_1gy_fsb} | | 404 | Record not found. No records matching the query parameters are found in the table. | [Table 18. Status codes] {#tmf_prod_order-GET-productorder__table_wdl_3xr_nsb} ### Response body parameters (JSON) {#tmf_prod_order-GET-productorder__section_hnf_kxr_nsb} {#tmf_prod_order-GET-productorder__table_inf_kxr_nsb__entry__2} | Name | Description | |-|-| | channel | Array of objects that describe the channels to use for selling the products. Data type: Array "channel": [ { "id": "String", "name": "String" } ] | | channel.id | Unique identifier of the channel to use to sell the associated products. Channel ID values are located in the external_id field of the Distribution Channel \[sn_prd_pm_distribution_channel\] table. Data type: String | | channel.name | Name of the channel to use to sell the associated products. Data type: String | | expectedCompletionDate | Date on which the order will be completed. Data type: String | | note | Array of objects that describe additional notes made by the customer when ordering. Data type: Array "note": { "author": "String", "date": "String", "text": "String" } | | note.author | User name of the person that authored the associated note. Data type: String | | note.date | Date that the note was created. Data type: String | | note.text | Additional notes/comments made by the customer while ordering. Data type: String | | ponr | Flag that indicates whether the point of no return for the order has been reached. Valid values: * true: The point of no return for the order has been reached. * false: The point of no return for the order has not been reached. {#tmf_prod_order-GET-productorder__ul_tdq_rw1_hqb} Data type: Boolean | | productOrderItem | List that describes items associated with the product order and their associated action. Data type: Array "productOrderItem:" [ { "action": "String", "actionReason": "String", "id": "String", "itemPrice": [Array], "product": {Object}, "productOffering": {Object}, "productOrderItemReleationship": [Array], "quantity": Number, "state": "String", "@type": "String" } ] | | productOrderItem.action | Action to carry out on the product. Possible actions are defined on the Choice List tab in the Action Dictionary Entry of the sn_ind_tmt_orm_order_line_item table. Data type: String | | productOrderItem.actionReason | The reason for adding the order line item. Data type: String Table/field updated: sn_ind_tmt_orm_order_line_item/action_reason | | productOrderItem.id | 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 | | productOrderItem.itemPrice | Array of objects that describe the price associated with the product. Data type: Array "itemPrice": [ { "price": {Object}, "priceType": "String", "recurringChargePeriod": "String" } ] | | productOrderItem.itemPrice.price | Description of the price of the associated product. Data type: Object "price": { "taxIncludedAmount": {Object} } | | productOrderItem.itemPrice.price.taxIncludedAmount | Description of the price of the associated product, including the tax. Data type: Object "taxIncludedAmount": { "unit": "String", "value": Number } | | productOrderItem.itemPrice.price.taxIncludedAmount.unit | Currency code in which the price is depicted. Data type: String | | productOrderItem.itemPrice.price.taxIncludedAmount.value | Price of product, including any tax. Data type: Number | | productOrderItem.itemPrice.priceType | Type of item price, recurring or non-recurring. Data type: String | | productOrderItem.itemPrice.recurringChargePeriod | If the price is recurring, the recurring period, such as month. Data type: String | | productOrderItem.ponr | Flag that indicates whether the point of no return for the order has been reached. Valid values: * true: The point of no return for the order has been reached. * false: The point of no return for the order has not been reached. {#tmf_prod_order-GET-productorder__d3046e2596} Data type: Boolean | | productOrderItem.product | Description of the instance details of the product purchased by the customer. Data type: Object "product:" { "place": {Object}, "productCharacteristic": [Array], "productSpecification": {Object}, "relatedParty": {Object}, "@type": "String" } | | productOrderItem.product.place | Maps of the locations on which to install the product. Data type: Object "place": { "id": "String", "@type": "String" } | | productOrderItem.product.place.id | Sys_id of the associated location record in the Location \[cmn_location\] table. Data type: String | | productOrderItem.product.place.@type | 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 | | productOrderItem.product.productCharacteristic | Array of objects that describe the characteristics of the associated product. Only product characteristics whose value are different than the previousValue are returned. Data type: Array "productCharacteristic": [ { "name": "String", "previousValue": "String", "value": "String" } ] | | productOrderItem.product.productCharacteristic.name | Name of the characteristic record to associate with the product. Located in the Characteristic \[sn_prd_pm_characteristic\] table. Data type: String | | productOrderItem.product.productCharacteristic.previousValue | Previous characteristic option values if the update is for a change order. The request is a change order if the productOrderItem.action parameter is other than add. For additional information on characteristic option values, see [Create product characteristics and characteristic options](https://www.servicenow.com/docs/access?context=som-product-config-add-characteristics&version=xanadu&pubname=xanadu-order-management&ft:locale=en-US). Data type: String | | productOrderItem.product.productCharacteristic.value | Characteristic option values associated with the product. For additional information on characteristic option values, see [Create product characteristics and characteristic options](https://www.servicenow.com/docs/access?context=som-product-config-add-characteristics&version=xanadu&pubname=xanadu-order-management&ft:locale=en-US). Data type: String | | productOrderItem.product.productSpecification | Description of the product specification associated with the product. Data type: Object "productSpecification:" { "id": "String", "name": "String", "@type": "String" } | | productOrderItem.product.productSpecification.id | Initial_version or external_id of the product 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 Product Specification \[sn_prd_pm_product_specification\] table. Data type: String | | productOrderItem.product.productSpecification.name | Name of the product specification. Located in the Product Specification \[sn_prd_pm_product_specification\] table. Data type: String | | productOrderItem.product.productSpecification.@type | Part of the TMF Open API standard. This value is always ProductSpecificationRef. This information is not stored. Data type: String | | productOrderItem.product.relatedParty | List of contacts for line items. Data type: Array "relatedParty:" { "email": "String", "firstName": "String", "id": "String", "lastName": "String", "phone": "String", "@referredType": "String", "@type": "String" } | | productOrderItem.product.relatedParty.email | Email address of the contact. Data type: String | | productOrderItem.product.relatedParty.firstName | First name of the contact. Data type: String | | productOrderItem.product.relatedParty.id | Sys_id of the line item contact associated with the order line item. Located in the Order Line Item Contact \[sn_ind_tmt_orm_order_line_item_contact\] table. Data type: String | | productOrderItem.product.relatedParty.lastName | Last name of the contact. Data type: String Data type: String | | productOrderItem.product.relatedParty.phone | Business phone number of the contact. Data type: String | | productOrderItem.product.relatedParty.@referredType | Type of customer. Possible value: OrderLineItemContact Data type: String | | productOrderItem.product.relatedParty.@type | 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 | | productOrderItem.productOffering | Description of the product offering associated with the product. Data type: Object "productOffering": { "id": "String", "internalVersion": "String", "name": "String", "version": "String" } | | productOrderItem.productOffering.id | Initial_version or external_id of the product offering. The initial_version is the sys_id of the first version of the offering. Located in the sys_id or external_id field of the Product Offering \[sn_prd_pm_product_offering\] table. Data type: String | | productOrderItem.productOffering.name | Name of the product offering. Located in the Product Offering \[sn_prd_pm_product_offering\] table. Data type: String | | productOrderItem.quantity | Number of product items purchased. Data type: Number | | productOrderItem.productOrderItemRelationship | Array of objects that describe the relationships between order line items. Data type: Array "productOrderItemRelationship": [ { "id": "String", "relationshipType": "String" } ] | | productOrderItem.productOrderItemRelationship.id | 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 | | productOrderItem.productOrderItemRelationship.relationshipType | Type of relationship between the two line items. This information is used to identify the relationship hierarchy. Possible values: * HasChild * HasParent * Requires {#tmf_prod_order-GET-productorder__ul_yqf_2ty_54b} `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 | | productOrderItem.state | State of the order of the associated product item. Data type: String | | productOrderItem.version | Order version. Data type: String | | productOrderItem.@type | Part of TMF Open API standard. Annotation for the product. This value is always ProductOrderItem. This information is not stored. Data type: String | | relatedParty | List of contacts for the order. Each contact is an object in the array. Must list at least one item which contains customer account or consumer account information. Data type: Array "relatedParty:" [ { "id": "String", "name": "String", "@referredType": "String", "@type": "String" } ] | | relatedParty.id | Sys_id or external_id of the account, customer contact, or consumer associated with the order. Located in the Account \[customer_account\], Contact \[customer_contact\] table, or Consumer \[csm_consumer\] table. Data type: String | | relatedParty.name | Name of the account, customer, or consumer. Data type: String | | relatedParty.@referredType | Type of customer. Possible values: * Consumer * Customer * CustomerContact {#tmf_prod_order-GET-productorder__ul_lcq_jwm_t4b} Data type: String | | relatedParty.@type | Part of TMF Open API standard. Annotation for the product. This value is always RelatedParty. This information is not stored. Data type: String | | requestedCompletionDate | Delivery date requested by the customer. Data type: String | | requestedStartDate | Order start date requested by the customer. Data type: String | | state | Current state of the order. Data type: String | | version | Order version. Data type: String | | @type | Part of TMF Open API standard. Annotation for the product. This value is always ProductOrder. This information is not stored. Data type: String | [ ] {#tmf_prod_order-GET-productorder__table_inf_kxr_nsb} ### cURL request This example retrieves all product orders. curl --location --request GET 'https://instance.servicenow.com/api/sn_ind_tmt_orm/productorder' \ --user 'username':'password' Response body. [ { "id": "8d75939453126010a795ddeeff7b126a", "ponr": "false", "expectedCompletionDate": "2021-05-02T08:13:59.000Z", "requestedCompletionDate": "2021-05-02T08:13:59.000Z", "requestedStartDate": "2020-05-03T08:13:59.000Z", "channel": [ { "id": "1", "name": "Agent Assist" } ], "note": [ { "author": "System Administrator", "date": "2021-02-25T14:22:07.000Z", "text": "This is a TMF product order illustration no 2" }, { "author": "System Administrator", "date": "2021-02-25T14:22:06.000Z", "text": "This is a TMF product order illustration" } ], "productOrderItem": [ { "id": "POI130", "ponr": "false", "quantity": 1, "action": "add", "actionReason": "adding service package OLI", "itemPrice": [ { "priceType": "recurring", "price": { "taxIncludedAmount": { "unit": "USD", "value": 20 } } }, { "priceType": "nonRecurring", "price": { "taxIncludedAmount": { "unit": "INR", "value": 0 } } } ], "product": { "@type": "Product", "productCharacteristic": [ { "name": "Security Type", "valueType": "Choice", "value": "Base", "previousValue": "" } ], "productSpecification": { "id": "a6514bd3534560102f18ddeeff7b1247", "name": "SD-WAN Security", "@type": "ProductSpecificationRef" }, "relatedParty": [ { "id": "4175939453126010a795ddeeff7b127d", "name": "John Smith", "email": "abc2@example.com", "phone": "32456768", "@type": "RelatedParty", "@referredType": "OrderLineItemContact" }, { "id": "c175939453126010a795ddeeff7b127c", "name": "Joe Doe", "email": "abc@example.com", "phone": "1234567890", "@type": "RelatedParty", "@referredType": "OrderLineItemContact" } ] }, "productOffering": { "id": "69017a0f536520103b6bddeeff7b127d", "name": "Premium SD-WAN Offering" }, "productOrderItemRelationship": [ { "id": "POI100", "relationshipType": "HasParent" } ], "state": "in_progress", "version": "1", "@type": "ProductOrderItem" }, { "id": "POI100", "ponr": "false", "quantity": 1, "action": "add", "itemPrice": [ { "priceType": "recurring", "price": { "taxIncludedAmount": { "unit": "INR", "value": 0 } } }, { "priceType": "nonRecurring", "price": { "taxIncludedAmount": { "unit": "INR", "value": 0 } } } ], "product": { "@type": "Product", "productSpecification": { "id": "cfe5ef6a53702010cd6dddeeff7b12f6", "name": "SD-WAN Service Package", "@type": "ProductSpecificationRef" } }, "productOffering": { "id": "69017a0f536520103b6bddeeff7b127d", "name": "Premium SD-WAN Offering" }, "productOrderItemRelationship": [ { "id": "POI130", "relationshipType": "HasChild" }, { "id": "POI120", "relationshipType": "HasChild" }, { "id": "POI110", "relationshipType": "HasChild" } ], "state": "in_progress", "version": "1", "@type": "ProductOrderItem" }, { "id": "POI120", "ponr": "false", "quantity": 1, "action": "add", "actionReason":"adding service package OLI", "itemPrice": [ { "priceType": "recurring", "price": { "taxIncludedAmount": { "unit": "USD", "value": 20 } } }, { "priceType": "nonRecurring", "price": { "taxIncludedAmount": { "unit": "INR", "value": 0 } } } ], "product": { "@type": "Product", "productCharacteristic": [ { "name": "CPE Type", "valueType": "Choice", "value": "Physical", "previousValue": "" }, { "name": "WAN Optimization", "valueType": "Choice", "value": "Advance", "previousValue": "" }, { "name": "Routing", "valueType": "Choice", "value": "Premium", "previousValue": "" }, { "name": "CPE Model", "valueType": "Choice", "value": "ASR", "previousValue": "" } ], "productSpecification": { "id": "39b627aa53702010cd6dddeeff7b1202", "name": "SD-WAN Edge Device", "@type": "ProductSpecificationRef" } }, "productOffering": { "id": "69017a0f536520103b6bddeeff7b127d", "name": "Premium SD-WAN Offering" }, "productOrderItemRelationship": [ { "id": "POI100", "relationshipType": "HasParent" } ], "state": "in_progress", "version": "1", "@type": "ProductOrderItem" }, { "id": "POI110", "ponr": "false", "quantity": 1, "action": "add", "actionReason": "adding service package OLI", "itemPrice": [ { "priceType": "recurring", "price": { "taxIncludedAmount": { "unit": "INR", "value": 0 } } }, { "priceType": "nonRecurring", "price": { "taxIncludedAmount": { "unit": "USD", "value": 5 } } } ], "product": { "@type": "Product", "productCharacteristic": [ { "name": "Tenancy", "valueType": "Choice", "value": "Base (10 site)", "previousValue": "" } ], "productSpecification": { "id": "216663aa53702010cd6dddeeff7b12b5", "name": "SD-WAN Controller", "@type": "ProductSpecificationRef" }, "place": { "id": "25ab9c4d0a0a0bb300f7dabdc0ca7c1c", "@type": "Place" } }, "productOffering": { "id": "69017a0f536520103b6bddeeff7b127d", "name": "Premium SD-WAN Offering" }, "productOrderItemRelationship": [ { "id": "POI100", "relationshipType": "HasParent" } ], "state": "in_progress", "version": "1", "@type": "ProductOrderItem" } ], "relatedParty": [ { "id": "eaf68911c35420105252716b7d40ddde", "name": "Sally Thomas", "@type": "RelatedParty", "@referredType": "CustomerContact" }, { "id": "ffc68911c35420105252716b7d40dd55", "name": "Funco Intl", "@type": "RelatedParty", "@referredType": "Customer" }, { "id": "59f16de1c3b67110ff00ed23a140dd9e", "name": "Funco External", "@type": "RelatedParty", "@referredType": "Consumer" } ], "state": "in_progress", "version": "1", "@type": "ProductOrder" } ] ## Product Order Open API - GET /sn_ind_tmt_orm/productorder/{id} {#ariaid-title5} Retrieves the specified product order. Important: Starting with the Tokyo release, this endpoint is deprecated. The new version of this endpoint is [Product Order Open API - GET /sn_ind_tmt_orm/order/productOrder/{id}](https://servicenow-prod.fluidtopics.net/lU3_sIIHvtqhkTfEEUFOCw#tmf_prod_order-GET-ord-productOrder-id "Retrieves the specified product order."). This endpoint retrieves order information from the following tables: * Customer Order \[sn_ind_tmt_orm_order\] * Order Characteristic \[sn_ind_tmt_orm_order_characteristic_value\] * Order Line Item \[sn_ind_tmt_orm_order_line_item\] * Order Line Item Contact \[sn_ind_tmt_orm_order_line_item_contact\] {#tmf_prod_order-GET-productOrder-id__ul_lxc_kxm_t4b} ### URL format {#tmf_prod_order-GET-productOrder-id__section_mbm_2ct_t4b} Default URL: /api/sn_ind_tmt_orm/productorder/{id} ### Supported request parameters {#tmf_prod_order-GET-productOrder-id__entry__2} | Name | Description | |-|-| | id | Sys_id or external_id of the customer order to retrieve. Located in the Customer Order \[sn_ind_tmt_orm_order\] table. Data type: String | [Table 19. Path parameters] {#tmf_prod_order-GET-productOrder-id__entry__6} | Name | Description | |-|-| | None | | [Table 20. Query parameters] {#tmf_prod_order-GET-productOrder-id__entry__10} | Name | Description | |-|-| | None | | [Table 21. Request body parameters (JSON)] ### 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](https://servicenow-prod.fluidtopics.net/2vuQj3~2s_niNXyXhrbRZA "REST (REpresentational State Transfer) is a simple stateless architecture that provides standards between computer systems on the web, making it easier for them to communicate with each other."). {#tmf_prod_order-GET-productOrder-id__table_kqy_wgy_fsb__entry__2} | Header | Description | |-|-| | None | | [Table 22. Request headers] {#tmf_prod_order-GET-productOrder-id__table_kqy_wgy_fsb} {#tmf_prod_order-GET-productOrder-id__table_tzy_thy_ksb__entry__2} | Header | Description | |-|-| | Content-Type | Data format of the response body. Only supports application/json. | [Table 23. Response headers] {#tmf_prod_order-GET-productOrder-id__table_tzy_thy_ksb} ### 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](https://servicenow-prod.fluidtopics.net/2vuQj3~2s_niNXyXhrbRZA "REST (REpresentational State Transfer) is a simple stateless architecture that provides standards between computer systems on the web, making it easier for them to communicate with each other."). {#tmf_prod_order-GET-productOrder-id__entry__22}{#tmf_prod_order-GET-productOrder-id__entry-404-status-code} | Status code | Description | |-|-| | 201 | Successful. The request was successfully processed. | | 400 | Bad Request. Can be for any of the following reasons: * Missing query parameter * Invalid URI | | 404 | Not found. The requested item wasn't found. | [Table 24. Status codes] ### Response body parameters (JSON) {#tmf_prod_order-GET-productOrder-id__entry__30} | Name | Description | |-|-| | channel | Array of objects that describe the channels to use for selling the products. Data type: Array "channel": [ { "id": "String", "name": "String" } ] | | channel.id | Unique identifier of the channel to use to sell the associated products. Channel ID values are located in the external_id field of the Distribution Channel \[sn_prd_pm_distribution_channel\] table. Data type: String | | channel.name | Name of the channel to use to sell the associated products. Data type: String | | expectedCompletionDate | Date on which the order will be completed. Data type: String | | note | Array of objects that describe additional notes made by the customer when ordering. Data type: Array "note": { "author": "String", "date": "String", "text": "String" } | | note.author | User name of the person that authored the associated note. Data type: String | | note.date | Date that the note was created. Data type: String | | note.text | Additional notes/comments made by the customer while ordering. Data type: String | | ponr | Flag that indicates whether the point of no return for the order has been reached. Valid values: * true: The point of no return for the order has been reached. * false: The point of no return for the order has not been reached. {#tmf_prod_order-GET-productOrder-id__ul_tdq_rw1_hqb} Data type: Boolean | | productOrderItem | List that describes items associated with the product order and their associated action. Data type: Array "productOrderItem:" [ { "action": "String", "actionReason": "String", "id": "String", "itemPrice": [Array], "product": {Object}, "productOffering": {Object}, "productOrderItemReleationship": [Array], "quantity": Number, "state": "String", "@type": "String" } ] | | productOrderItem.action | Action to carry out on the product. Possible actions are defined on the Choice List tab in the Action Dictionary Entry of the sn_ind_tmt_orm_order_line_item table. Data type: String | | productOrderItem.actionReason | The reason for adding the order line item. Data type: String Table/field updated: sn_ind_tmt_orm_order_line_item/action_reason | | productOrderItem.id | 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 | | productOrderItem.itemPrice | Array of objects that describe the price associated with the product. Data type: Array "itemPrice": [ { "price": {Object}, "priceType": "String", "recurringChargePeriod": "String" } ] | | productOrderItem.itemPrice.price | Description of the price of the associated product. Data type: Object "price": { "taxIncludedAmount": {Object} } | | productOrderItem.itemPrice.price.taxIncludedAmount | Description of the price of the associated product, including the tax. Data type: Object "taxIncludedAmount": { "unit": "String", "value": Number } | | productOrderItem.itemPrice.price.taxIncludedAmount.unit | Currency code in which the price is depicted. Data type: String | | productOrderItem.itemPrice.price.taxIncludedAmount.value | Price of product, including any tax. Data type: Number | | productOrderItem.itemPrice.priceType | Type of item price, recurring or non-recurring. Data type: String | | productOrderItem.itemPrice.recurringChargePeriod | If the price is recurring, the recurring period, such as month. Data type: String | | productOrderItem.ponr | Flag that indicates whether the point of no return for the order has been reached. Valid values: * true: The point of no return for the order has been reached. * false: The point of no return for the order has not been reached. {#tmf_prod_order-GET-productOrder-id__d3046e2596} Data type: Boolean | | productOrderItem.product | Description of the instance details of the product purchased by the customer. Data type: Object "product:" { "place": {Object}, "productCharacteristic": [Array], "productSpecification": {Object}, "relatedParty": {Object}, "@type": "String" } | | productOrderItem.product.place | Maps of the locations on which to install the product. Data type: Object "place": { "id": "String", "@type": "String" } | | productOrderItem.product.place.id | Sys_id of the associated location record in the Location \[cmn_location\] table. Data type: String | | productOrderItem.product.place.@type | 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 | | productOrderItem.product.productCharacteristic | Array of objects that describe the characteristics of the associated product. Only product characteristics whose value are different than the previousValue are returned. Data type: Array "productCharacteristic": [ { "name": "String", "previousValue": "String", "value": "String" } ] | | productOrderItem.product.productCharacteristic.name | Name of the characteristic record to associate with the product. Located in the Characteristic \[sn_prd_pm_characteristic\] table. Data type: String | | productOrderItem.product.productCharacteristic.previousValue | Previous characteristic option values if the update is for a change order. The request is a change order if the productOrderItem.action parameter is other than add. For additional information on characteristic option values, see [Create product characteristics and characteristic options](https://www.servicenow.com/docs/access?context=som-product-config-add-characteristics&version=xanadu&pubname=xanadu-order-management&ft:locale=en-US). Data type: String | | productOrderItem.product.productCharacteristic.value | Characteristic option values associated with the product. For additional information on characteristic option values, see [Create product characteristics and characteristic options](https://www.servicenow.com/docs/access?context=som-product-config-add-characteristics&version=xanadu&pubname=xanadu-order-management&ft:locale=en-US). Data type: String | | productOrderItem.product.productSpecification | Description of the product specification associated with the product. Data type: Object "productSpecification:" { "id": "String", "name": "String", "@type": "String" } | | productOrderItem.product.productSpecification.id | Initial_version or external_id of the product 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 Product Specification \[sn_prd_pm_product_specification\] table. Data type: String | | productOrderItem.product.productSpecification.name | Name of the product specification. Located in the Product Specification \[sn_prd_pm_product_specification\] table. Data type: String | | productOrderItem.product.productSpecification.@type | Part of the TMF Open API standard. This value is always ProductSpecificationRef. This information is not stored. Data type: String | | productOrderItem.product.relatedParty | List of contacts for line items. Data type: Array "relatedParty:" { "email": "String", "firstName": "String", "id": "String", "lastName": "String", "phone": "String", "@referredType": "String", "@type": "String" } | | productOrderItem.product.relatedParty.email | Email address of the contact. Data type: String | | productOrderItem.product.relatedParty.firstName | First name of the contact. Data type: String | | productOrderItem.product.relatedParty.id | Sys_id of the line item contact associated with the order line item. Located in the Order Line Item Contact \[sn_ind_tmt_orm_order_line_item_contact\] table. Data type: String | | productOrderItem.product.relatedParty.lastName | Last name of the contact. Data type: String | | productOrderItem.product.relatedParty.phone | Business phone number of the contact. Data type: String | | productOrderItem.product.relatedParty.@referredType | Type of customer. Possible value: OrderLineItemContact Data type: String | | productOrderItem.product.relatedParty.@type | 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 | | productOrderItem.productOffering | Description of the product offering associated with the product. Data type: Object "productOffering": { "id": "String", "internalVersion": "String", "name": "String", "version": "String" } | | productOrderItem.productOffering.id | Initial_version or external_id of the product offering. The initial_version is the sys_id of the first version of the offering. Located in the sys_id or external_id field of the Product Offering \[sn_prd_pm_product_offering\] table. Data type: String | | productOrderItem.productOffering.name | Name of the product offering. Located in the Product Offering \[sn_prd_pm_product_offering\] table. Data type: String | | productOrderItem.quantity | Number of product items purchased. Data type: Number | | productOrderItem.productOrderItemRelationship | Array of objects that describe the relationships between order line items. Data type: Array "productOrderItemRelationship": [ { "id": "String", "relationshipType": "String" } ] | | productOrderItem.productOrderItemRelationship.id | 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 | | productOrderItem.productOrderItemRelationship.relationshipType | Type of relationship between the two line items. This information is used to identify the relationship hierarchy. Possible values: * HasChild * HasParent * Requires {#tmf_prod_order-GET-productOrder-id__ul_yqf_2ty_54b} `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 | | productOrderItem.state | State of the order of the associated product item. Data type: String | | productOrderItem.version | Order version. Data type: String | | productOrderItem.@type | Part of TMF Open API standard. Annotation for the product. This value is always ProductOrderItem. This information is not stored. Data type: String | | relatedParty | List of contacts for the order. Each contact is an object in the array. Must list at least one item which contains customer account or consumer account information. Data type: Array "relatedParty:" [ { "id": "String", "name": "String", "@referredType": "String", "@type": "String" } ] | | relatedParty.id | Sys_id or external_id of the account, customer contact, or consumer associated with the order. Located in the Account \[customer_account\], Contact \[customer_contact\] table, or Consumer \[csm_consumer\] table. Data type: String | | relatedParty.name | Name of the account, customer, or consumer. Data type: String | | relatedParty.@referredType | Type of customer. Possible values: * Consumer * Customer * CustomerContact {#tmf_prod_order-GET-productOrder-id__ul_lcq_jwm_t4b} Data type: String | | relatedParty.@type | Part of TMF Open API standard. Annotation for the product. This value is always RelatedParty. This information is not stored. Data type: String | | requestedCompletionDate | Delivery date requested by the customer. Data type: String | | requestedStartDate | Order start date requested by the customer. Data type: String | | state | Current state of the order. Data type: String | | version | Order version. Data type: String | | @type | Part of TMF Open API standard. Annotation for the product. This value is always ProductOrder. This information is not stored. Data type: String | [ ] ### cURL request The following code example requests an existing customer order. curl -X GET "https://servicenow-instance/api/sn_ind_tmt_orm/productorder/8d75939453126010a795ddeeff7b126a" \ -u "username":"password" Response body. { "id": "8d75939453126010a795ddeeff7b126a", "ponr": "false", "expectedCompletionDate": "2021-05-02T08:13:59.000Z", "requestedCompletionDate": "2021-05-02T08:13:59.000Z", "requestedStartDate": "2020-05-03T08:13:59.000Z", "channel": [ { "id": "1", "name": "Agent Assist" } ], "note": [ { "author": "System Administrator", "date": "2021-02-25T14:22:07.000Z", "text": "This is a TMF product order illustration no 2" }, { "author": "System Administrator", "date": "2021-02-25T14:22:06.000Z", "text": "This is a TMF product order illustration" } ], "productOrderItem": [ { "id": "POI130", "ponr": "false", "quantity": 1, "action": "add", "actionReason":"adding service package OLI", "itemPrice": [ { "priceType": "recurring", "price": { "taxIncludedAmount": { "unit": "USD", "value": 20 } } }, { "priceType": "nonRecurring", "price": { "taxIncludedAmount": { "unit": "INR", "value": 0 } } } ], "product": { "@type": "Product", "productCharacteristic": [ { "name": "Security Type", "valueType": "Choice", "value": "Base", "previousValue": "" } ], "productSpecification": { "id": "a6514bd3534560102f18ddeeff7b1247", "name": "SD-WAN Security", "@type": "ProductSpecificationRef" }, "relatedParty": [ { "id": "4175939453126010a795ddeeff7b127d", "name": "John Smith", "email": "abc2@example.com", "phone": "32456768", "@type": "RelatedParty", "@referredType": "OrderLineItemContact" }, { "id": "c175939453126010a795ddeeff7b127c", "name": "Joe Doe", "email": "abc@example.com", "phone": "1234567890", "@type": "RelatedParty", "@referredType": "OrderLineItemContact" } ] }, "productOffering": { "id": "69017a0f536520103b6bddeeff7b127d", "name": "Premium SD-WAN Offering" }, "productOrderItemRelationship": [ { "id": "POI100", "relationshipType": "HasParent" } ], "state": "in_progress", "version": "1", "@type": "ProductOrderItem" }, { "id": "POI100", "ponr": "false", "quantity": 1, "action": "add", "itemPrice": [ { "priceType": "recurring", "price": { "taxIncludedAmount": { "unit": "INR", "value": 0 } } }, { "priceType": "nonRecurring", "price": { "taxIncludedAmount": { "unit": "INR", "value": 0 } } } ], "product": { "@type": "Product", "productSpecification": { "id": "cfe5ef6a53702010cd6dddeeff7b12f6", "name": "SD-WAN Service Package", "@type": "ProductSpecificationRef" } }, "productOffering": { "id": "69017a0f536520103b6bddeeff7b127d", "name": "Premium SD-WAN Offering" }, "productOrderItemRelationship": [ { "id": "POI130", "relationshipType": "HasChild" }, { "id": "POI120", "relationshipType": "HasChild" }, { "id": "POI110", "relationshipType": "HasChild" } ], "state": "in_progress", "version": "1", "@type": "ProductOrderItem" }, { "id": "POI120", "ponr": "false", "quantity": 1, "action": "add", "itemPrice": [ { "priceType": "recurring", "price": { "taxIncludedAmount": { "unit": "USD", "value": 20 } } }, { "priceType": "nonRecurring", "price": { "taxIncludedAmount": { "unit": "INR", "value": 0 } } } ], "product": { "@type": "Product", "productCharacteristic": [ { "name": "CPE Type", "valueType": "Choice", "value": "Physical", "previousValue": "" }, { "name": "WAN Optimization", "valueType": "Choice", "value": "Advance", "previousValue": "" }, { "name": "Routing", "valueType": "Choice", "value": "Premium", "previousValue": "" }, { "name": "CPE Model", "valueType": "Choice", "value": "ASR", "previousValue": "" } ], "productSpecification": { "id": "39b627aa53702010cd6dddeeff7b1202", "name": "SD-WAN Edge Device", "@type": "ProductSpecificationRef" } }, "productOffering": { "id": "69017a0f536520103b6bddeeff7b127d", "name": "Premium SD-WAN Offering" }, "productOrderItemRelationship": [ { "id": "POI100", "relationshipType": "HasParent" } ], "state": "in_progress", "version": "1", "@type": "ProductOrderItem" }, { "id": "POI110", "ponr": "false", "quantity": 1, "action": "add", "actionReason":"adding service package OLI", "itemPrice": [ { "priceType": "recurring", "price": { "taxIncludedAmount": { "unit": "INR", "value": 0 } } }, { "priceType": "nonRecurring", "price": { "taxIncludedAmount": { "unit": "USD", "value": 5 } } } ], "product": { "@type": "Product", "productCharacteristic": [ { "name": "Tenancy", "valueType": "Choice", "value": "Base (10 site)", "previousValue": "" } ], "productSpecification": { "id": "216663aa53702010cd6dddeeff7b12b5", "name": "SD-WAN Controller", "@type": "ProductSpecificationRef" }, "place": { "id": "25ab9c4d0a0a0bb300f7dabdc0ca7c1c", "@type": "Place" } }, "productOffering": { "id": "69017a0f536520103b6bddeeff7b127d", "name": "Premium SD-WAN Offering" }, "productOrderItemRelationship": [ { "id": "POI100", "relationshipType": "HasParent" } ], "state": "in_progress", "version": "1", "@type": "ProductOrderItem" } ], "relatedParty": [ { "id": "eaf68911c35420105252716b7d40ddde", "name": "Sally Thomas", "@type": "RelatedParty", "@referredType": "CustomerContact" }, { "id": "ffc68911c35420105252716b7d40dd55", "name": "Funco Intl", "@type": "RelatedParty", "@referredType": "Customer" }, { "id": "59f16de1c3b67110ff00ed23a140dd9e", "name": "Funco External", "@type": "RelatedParty", "@referredType": "Consumer" } ], "state": "in_progress", "version": "1", "@type": "ProductOrder" } ## Product Order Open API - PATCH /sn_ind_tmt_orm/order/productOrder/{id} {#ariaid-title6} Updates the specified customer order. ### URL format Default URL: /api/sn_ind_tmt_orm/order/productOrder/{id} ### Supported request parameters {#tmf_prod_order-PATCH-ord-productOrder-id__entry__2} | Name | Description | |-|-| | id | Sys_id of the customer order to update. Located in the Customer Order \[sn_ind_tmt_orm_order\] table. Data type: String | [Table 25. Path parameters] {#tmf_prod_order-PATCH-ord-productOrder-id__entry__6} | Name | Description | |-|-| | None | | [Table 26. Query parameters] {#tmf_prod_order-PATCH-ord-productOrder-id__id_vk2_p5n_t4b__entry__2}{#tmf_prod_order-PATCH-ord-productOrder-id__channel-ph-tmf622}{#tmf_prod_order-PATCH-ord-productOrder-id__channel_id-ph-tmf622}{#tmf_prod_order-PATCH-ord-productOrder-id__channel_name-ph-tmf622}{#tmf_prod_order-PATCH-ord-productOrder-id__due-date-PATCH}{#tmf_prod_order-PATCH-ord-productOrder-id__externalId-ph-tmf622}{#tmf_prod_order-PATCH-ord-productOrder-id__note-ph-tmf622}{#tmf_prod_order-PATCH-ord-productOrder-id__note_text-ph-tmf622}{#tmf_prod_order-PATCH-ord-productOrder-id__prodOrdItem-ph-tmf622}{#tmf_prod_order-PATCH-ord-productOrder-id__prodOrdItem_action-ph-tmf622}{#tmf_prod_order-PATCH-ord-productOrder-id__prodOrdItem_actionReason-response-tmf622}{#tmf_prod_order-PATCH-ord-productOrder-id__due-date-item-PATCH}{#tmf_prod_order-PATCH-ord-productOrder-id__externalProdInv-descr-PATCH}{#tmf_prod_order-PATCH-ord-productOrder-id__externalProdInvId-decsr}{#tmf_prod_order-PATCH-ord-productOrder-id__prodOrdItem_id-ph-tmf622}{#tmf_prod_order-PATCH-ord-productOrder-id__itemPrice-ph-tmf622}{#tmf_prod_order-PATCH-ord-productOrder-id__itemPrice_price-ph-tmf622}{#tmf_prod_order-PATCH-ord-productOrder-id__itemPrice_price_taxIncludedAmt-ph-tmf622}{#tmf_prod_order-PATCH-ord-productOrder-id__itemPrice_price_taxIncludedAmt_unit-ph-tmf622}{#tmf_prod_order-PATCH-ord-productOrder-id__itemPrice_price_taxIncludedAmt_value-ph-tmf622}{#tmf_prod_order-PATCH-ord-productOrder-id__itemPrice_priceType_data_type-p-tmf622}{#tmf_prod_order-PATCH-ord-productOrder-id__itemPrice_recurringChargePeriod_data_type-p-tmf622}{#tmf_prod_order-PATCH-ord-productOrder-id__product-p-tmf622}{#tmf_prod_order-PATCH-ord-productOrder-id__product_id-ph-tmf622}{#tmf_prod_order-PATCH-ord-productOrder-id__product_place-ph-tmf622}{#tmf_prod_order-PATCH-ord-productOrder-id__product_place_id-ph-tmf622}{#tmf_prod_order-PATCH-ord-productOrder-id__product_place_type_data_type-p-tmf622}{#tmf_prod_order-PATCH-ord-productOrder-id__prod_prodChar-ph-tmf622}{#tmf_prod_order-PATCH-ord-productOrder-id__prod_prodChar_name-ph-tmf622}{#tmf_prod_order-PATCH-ord-productOrder-id__prod_prodChar_previousValue-ph-tmf622}{#tmf_prod_order-PATCH-ord-productOrder-id__prod_prodChar_value-ph-tmf622}{#tmf_prod_order-PATCH-ord-productOrder-id__prod_prodSpec-ph-tmf622}{#tmf_prod_order-PATCH-ord-productOrder-id__prod_prodSpec_id_data_type-p-tmf622}{#tmf_prod_order-PATCH-ord-productOrder-id__prod_prodSpec_name_data_type-p-tmf622}{#tmf_prod_order-PATCH-ord-productOrder-id__prod_prodSpec_type_data_type-p-tmf622}{#tmf_prod_order-PATCH-ord-productOrder-id__prod_relParty-ph-tmf622}{#tmf_prod_order-PATCH-ord-productOrder-id__prod_relParty_email-ph-tmf622}{#tmf_prod_order-PATCH-ord-productOrder-id__prod_relParty_firstName-ph-tmf622}{#tmf_prod_order-PATCH-ord-productOrder-id__prod_relParty_id-ph-tmf622}{#tmf_prod_order-PATCH-ord-productOrder-id__prod_relParty_lastName-ph-tmf622}{#tmf_prod_order-PATCH-ord-productOrder-id__prod_relParty_phone-ph-tmf622}{#tmf_prod_order-PATCH-ord-productOrder-id__prod_relParty_refType_data_type-p-tmf622}{#tmf_prod_order-PATCH-ord-productOrder-id__product_relatedParty_type_data_type-row-tmf622}{#tmf_prod_order-PATCH-ord-productOrder-id__product_type_data_type-p-tmf622}{#tmf_prod_order-PATCH-ord-productOrder-id__productOffer-ph-tmf622}{#tmf_prod_order-PATCH-ord-productOrder-id__prodOffer_id_data_type-p-tmf622}{#tmf_prod_order-PATCH-ord-productOrder-id__prodOffer_name_data_type-p-tmf622}{#tmf_prod_order-PATCH-ord-productOrder-id__prodOrdItem_quantity-ph-tmf622}{#tmf_prod_order-PATCH-ord-productOrder-id__prodOrderItemRel-ph-tmf622}{#tmf_prod_order-PATCH-ord-productOrder-id__prodOrderItemRel_id-ph-tmf622}{#tmf_prod_order-PATCH-ord-productOrder-id__prodOrderItemRel_relType_data_type-p-tmf622}{#tmf_prod_order-PATCH-ord-productOrder-id__prodOrdItem_type-entry-tmf622}{#tmf_prod_order-PATCH-ord-productOrder-id__relatedParty-ph-tmf622}{#tmf_prod_order-PATCH-ord-productOrder-id__relatedParty_id_data_type-p-tmf622}{#tmf_prod_order-PATCH-ord-productOrder-id__relatedParty_name_data_type-p-tmf622}{#tmf_prod_order-PATCH-ord-productOrder-id__relatedParty_refType_data_type-p-tmf622}{#tmf_prod_order-PATCH-ord-productOrder-id__relatedParty_type_data_type-p-tmf622}{#tmf_prod_order-PATCH-ord-productOrder-id__requestedCompletionDate-ph-tmf622}{#tmf_prod_order-PATCH-ord-productOrder-id__reqStartDate-ph-tmf622}{#tmf_prod_order-PATCH-ord-productOrder-id__type-entry-tmf622} | Name | Description | |-|-| | channel | Array of objects that describe the channels to use for selling the products. Data type: Array{#tmf_prod_order-PATCH-ord-productOrder-id__channel_data_type-p-tmf622} "channel": [ { "id": "String", "name": "String" } ] {#tmf_prod_order-PATCH-ord-productOrder-id__channel_obj_def-codeblock-tmf622} Table/field updated: sn_ind_tmt_orm_order | | channel.id | Required if the channel parameter is used. Unique identifier of the channel to use to sell the associated products. Channel ID values are located in the external_id field of the Distribution Channel \[sn_prd_pm_distribution_channel\] table. Data type: String{#tmf_prod_order-PATCH-ord-productOrder-id__channel_id_data_type-p-tmf622} Table/field updated: sn_ind_tmt_orm_order/channel Default: Blank string | | channel.name | Name of the channel to use to sell the associated products. Possible channel names are defined on the Choice List tab in the Channel Dictionary Entry of the sn_ind_tmt_orm_order table. Data type: String{#tmf_prod_order-PATCH-ord-productOrder-id__channel_name_data_type-p-tmf622} Default: Blank string | | committedDueDate | Date and time when the action must be performed on the order. This value must be the same as or later than the committedDueDate values for each order line item. If the action for order line items is suspend or resume, this parameter can't be updated. Data type: String Table/field updated: sn_ind_tmt_orm_order/committed_due_date | | externalId | Unique identifier for the customer order. This value is determined by an external system. Data type: String{#tmf_prod_order-PATCH-ord-productOrder-id__externalId_data_type-p-tmf622} Table/field updated: sn_ind_tmt_orm_order/external_id Default: Blank string | | note | Array of objects that describe additional notes made by the customer when ordering. Data type: Array{#tmf_prod_order-PATCH-ord-productOrder-id__note_data_type-p-tmf622} "note": [ { "text": "String" } ] {#tmf_prod_order-PATCH-ord-productOrder-id__note-codeblock-tmf622} Table/field updated: sn_ind_tmt_orm_order | | note.text | Additional notes/comments made by the customer while ordering. Data type: String{#tmf_prod_order-PATCH-ord-productOrder-id__note_text_data_type-p-tmf622} Table/field updated: sn_ind_tmt_orm_order/comments Default: Blank string | | orderCurrency | Currency code for the order and order line items. Updating the currency code of an existing order is not supported. Providing any value other than the currency code already associated with the order causes the update to be rejected. Data type: String | | productOrderItem | List that describes items associated with the product order and their associated action. Data type: Array{#tmf_prod_order-PATCH-ord-productOrder-id__prodOrdItem_data_type-p-tmf622} "productOrderItem": [ { "action": "String", "actionReason": "String", "committedDueDate": "String", "externalProductInventory": [Array], "id": "String", "itemPrice": [Array], "product": {Object}, "productOffering": {Object}, "productOrderItemRelationship": [Array], "quantity": Number, "revisionOperation": "String", "@type": "String" } ] {#tmf_prod_order-PATCH-ord-productOrder-id__prodOrdItem-codeblock-tmf622} Table/field updated: sn_ind_tmt_orm_order_line_item | | productOrderItem.action | Required if the productOrderItem parameter is used. Action to carry out on the product. Possible actions are defined on the Choice List tab in the Action Dictionary Entry of the sn_ind_tmt_orm_order_line_item table. Possible values: * add * change * delete * no-change * resume * suspend {#tmf_prod_order-PATCH-ord-productOrder-id__ul_zwn_nxp_ysb} Data type: String{#tmf_prod_order-PATCH-ord-productOrder-id__prodOrdItem_action_data_type-p-tmf622} Table/field updated: sn_ind_tmt_orm_order_line_item/action Default: add | | productOrderItem.actionReason | The reason for adding the order line item. Data type: String Table/field updated: sn_ind_tmt_orm_order_line_item/action_reason | | productOrderItem.committedDueDate | Date and time when the action must be performed on the order line item. If the action for the item is suspend or resume, this parameter can't be updated. Data type: String Table/field updated: sn_ind_tmt_orm_order_line_item/committed_due_date | | productOrderItem.externalProductInventory | Array of objects containing external ids to map to the product inventories created for the order. Data type: Array "externalProductInventory": [ { "externalProductInventoryId": "String" } ] Note: Previously, when creating a PATCH order with an external product inventory ID that already existed, the operation was aborted and returned an error. With the Xanadu release, this parameter is simply ignored when an existing external product inventory ID is supplied and an error is not thrown. | | productOrderItem.externalProductInventory.externalProductInventoryId | External id to map to the product inventory. Data type: String Table/field updated: sn_ind_tmt_orm_order_line_item/external_inventory_id and sn_prd_invt_product_inventory/sn_prd_invt_external_id | | productOrderItem.id | Required if the productOrderItem parameter is used. 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{#tmf_prod_order-PATCH-ord-productOrder-id__prodOrdItem_id_data_type-p-tmf622} Table/field updated: sn_ind_tmt_orm_order_line_item/external_id Maximum length: 40 Default: Blank string | | productOrderItem.itemPrice | Array of objects that describe the price associated with the product. Data type: Array{#tmf_prod_order-PATCH-ord-productOrder-id__itemPrice_data_type-p-tmf622} "itemPrice": [ { "price": {Object}, "priceType": "String", "recurringChargePeriod": "String" } ] {#tmf_prod_order-PATCH-ord-productOrder-id__itemPrice-codeblock-tmf622} Table updated: sn_ind_tmt_orm_order Default: Blank string | | productOrderItem.itemPrice.price | Description of the price of the associated product. Data type: Object{#tmf_prod_order-PATCH-ord-productOrder-id__itemPrice_price_data_type-p-tmf622} "price": { "taxIncludedAmount": {Object} } {#tmf_prod_order-PATCH-ord-productOrder-id__itemPrice_price-codeblock-tmf622} Table updated: sn_ind_tmt_orm_order_line_item Default: Blank string | | productOrderItem.itemPrice.price.taxIncludedAmount | Description of the price of the associated product, including the tax. Data type: Object{#tmf_prod_order-PATCH-ord-productOrder-id__itemPrice_price_taxIncludedAmt_data_type-p-tmf622} "taxIncludedAmount": { "unit": "String", "value": Number } {#tmf_prod_order-PATCH-ord-productOrder-id__itemPrice_price_taxIncludedAmt-codeblock-tmf622} Table updated: sn_ind_tmt_orm_order_line_item | | productOrderItem.itemPrice.price.taxIncludedAmount.unit | Currency code in which the price is depicted. Data type: String{#tmf_prod_order-PATCH-ord-productOrder-id__itemPrice_price_taxIncludedAmt_unit_data_type-p-tmf622} Table/field updated: sn_ind_tmt_orm_order_line_item/mrc or nrc | | productOrderItem.itemPrice.price.taxIncludedAmount.value | Price of product, including any tax. Data type: Number{#tmf_prod_order-PATCH-ord-productOrder-id__itemPrice_price_taxIncludedAmt_value_data_type-p-tmf622} Table/field updated: sn_ind_tmt_orm_order_line_item/mrc or nrc | | productOrderItem.itemPrice.priceType | Type of item price, recurring or non-recurring. Data type: String | | productOrderItem.itemPrice.recurringChargePeriod | If the price is recurring, the recurring period, such as month. Data type: String | | productOrderItem.product | Required if productOrderItem.action is change or delete. Description of the instance details of the product purchased by the customer. Data type: Object{#tmf_prod_order-PATCH-ord-productOrder-id__product_data_type-p-tmf622} "product": { "id": "String", "place": {Object}, "productCharacteristic": [Array], "productSpecification": {Object}, "relatedParty": {Object}, "@type": "String" } {#tmf_prod_order-PATCH-ord-productOrder-id__product-codeblock-tmf622} Table/field updated: sn_ind_tmt_orm_order_line_item | | productOrderItem.product.id | Required if productOrderItem.action is change or delete. Unique identifier of the product sold. Located in the sys_id or sn_ind_tmt_orm_external_id field of the Product Inventory \[sn_ind_tmt_orm_product_inventory\] table. Data type: String{#tmf_prod_order-PATCH-ord-productOrder-id__product_id_data_type-p-tmf622} Default: Blank string | | productOrderItem.product.place | Maps of the locations on which to install the product. Data type: Object{#tmf_prod_order-PATCH-ord-productOrder-id__product_place_data_type-p-tmf622} "place": { "id": "String", "@type": "String" } {#tmf_prod_order-PATCH-ord-productOrder-id__product_place-codeblock-tmf622} Table/field updated: sn_ind_tmt_orm_order_line_item | | productOrderItem.product.place.id | Required if the productOrderItem.product.place parameter is used. Sys_id of the associated location record in the Location \[cmn_location\] table. Data type: String{#tmf_prod_order-PATCH-ord-productOrder-id__product_place_id_data_type-p-tmf622} Table/field updated: sn_ind_tmt_orm_order_line_item/location Default: Blank string | | productOrderItem.product.place.@type | 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 | | productOrderItem.product.productCharacteristic | Array of objects that describe the characteristics of the associated product. Data type: Array{#tmf_prod_order-PATCH-ord-productOrder-id__prod_prodChar_data_type-p-tmf622} "productCharacteristic": [ { "name": "String", "previousValue": "String", "value": "String" } ] {#tmf_prod_order-PATCH-ord-productOrder-id__prod_prodChar-codeblock-tmf622} Table/field updated: sn_ind_tmt_orm_order_characteristic_value | | productOrderItem.product.productCharacteristic.name | Name of the characteristic record to associate with the product. Located in the Characteristic \[sn_prd_pm_characteristic\] table. Data type: String{#tmf_prod_order-PATCH-ord-productOrder-id__prod_prodChar_name_data_type-p-tmf622} Table/field updated: sn_ind_tmt_orm_order_characteristic_value/characteristics Default: Blank string | | productOrderItem.product.productCharacteristic.previousValue | Previous characteristic option values if the update is for a change order. The request is a change order if the productOrderItem.action parameter is other than add. For additional information on characteristic option values, see [Create product characteristics and characteristic options](https://www.servicenow.com/docs/access?context=som-product-config-add-characteristics&version=xanadu&pubname=xanadu-order-management&ft:locale=en-US). Data type: String{#tmf_prod_order-PATCH-ord-productOrder-id__prod_prodChar_previousValue_data_type-p-tmf622} Table/field updated: sn_ind_tmt_orm_order_characteristic_value/previous_characteristic_option_value Default: Blank string | | productOrderItem.product.productCharacteristic.value | Characteristic option values associated with the product. For additional information on characteristic option values, see [Create product characteristics and characteristic options](https://www.servicenow.com/docs/access?context=som-product-config-add-characteristics&version=xanadu&pubname=xanadu-order-management&ft:locale=en-US). Data type: String{#tmf_prod_order-PATCH-ord-productOrder-id__prod_prodChar_value_data_type-p-tmf622} Table/field updated: sn_ind_tmt_orm_order_characteristic_value/characteristic_option_value Default: Blank string | | productOrderItem.product.productSpecification | Description of the product specification associated with the product. Note: Change orders (productOrderItem.action is `change`) are processed differently based on the value of the sn_ind_tmt_orm.allowSpecVersionUpdateInChangeOrder system property. The value of this system property determines how the order is processed if the product inventory is a different version than indicated in the order. * When this system property is set to true (default), the product inventory is automatically upgraded to the version in the order by changing the referenced product specification. This allows the order to be successfully processed. * When this system property is set to false, if the product inventory is a different version than indicated in the order, the order fails due to the version mismatch. {#tmf_prod_order-PATCH-ord-productOrder-id__ul_sgb_q5y_hbc} Data type: Object{#tmf_prod_order-PATCH-ord-productOrder-id__prod_prodSpec_data_type-p-tmf622} "productSpecification": { "id": "String", "internalVersion": "String", "name": "String", "version": "String", "@type": "String" } {#tmf_prod_order-PATCH-ord-productOrder-id__prod_prodSpec-codeblock-tmf622} Table/field updated: sn_ind_tmt_orm_order_line_item | | productOrderItem.product.productSpecification.id | Required if the productOrderItem.product.productSpecification parameter is used. Initial_version or external_id of the product 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 Product Specification \[sn_prd_pm_product_specification\] table. Data type: String | | productOrderItem.product.productSpecification.internalVersion | Version of the product specification. Located in the Product Specification \[sn_prd_pm_product_specification\] table. Data type: String | | productOrderItem.product.productSpecification.name | Name of the product specification. Located in the Product Specification \[sn_prd_pm_product_specification\] table. Data type: String | | productOrderItem.product.productSpecification.version | External_version of the product specification. Located in the Product Specification \[sn_prd_pm_product_specification\] table. Data type: String | | productOrderItem.product.productSpecification.@type | Part of the TMF Open API standard. This value is always ProductSpecificationRef. This information is not stored. Data type: String | | productOrderItem.product.relatedParty | List of contacts for line items. Data type: Array{#tmf_prod_order-PATCH-ord-productOrder-id__prod_relParty_data_type-p-tmf622} "relatedParty": [ { "email": "String", "firstName": "String", "id": "String", "lastName": "String", "phone": "String", "@referredType": "String", "@type": "String" } ] {#tmf_prod_order-PATCH-ord-productOrder-id__prod_relParty-codeblock-tmf622} Table/field updated: sn_ind_tmt_orm_order_line_item_contact | | productOrderItem.product.relatedParty.email | Email address of the contact. Data type: String{#tmf_prod_order-PATCH-ord-productOrder-id__prod_relParty_email_data_type-p-tmf622} Table/field updated: sn_ind_tmt_orm_order_line_item_contact/email Default: Blank string | | productOrderItem.product.relatedParty.firstName | First name of the contact. Data type: String{#tmf_prod_order-PATCH-ord-productOrder-id__prod_relParty_firstName_data_type-p-tmf622} Table/field updated: sn_ind_tmt_orm_order_line_item_contact/first_name Default: Blank string | | productOrderItem.product.relatedParty.id | Sys_id of the line item contact associated with the order line item. Located in the Order Line Item Contact \[sn_ind_tmt_orm_order_line_item_contact\] table. Data type: String{#tmf_prod_order-PATCH-ord-productOrder-id__prod_relParty_id_data_type-p-tmf622} Table/field updated: sn_ind_tmt_orm_order_line_item_contact/sys_id Default: Blank string | | productOrderItem.product.relatedParty.lastName | Last name of the contact. Data type: String{#tmf_prod_order-PATCH-ord-productOrder-id__prod_relParty_lastName_data_type-p-tmf622} Table/field updated: sn_ind_tmt_orm_order_line_item_contact/lastName Default: Blank string | | productOrderItem.product.relatedParty.phone | Business phone number of the contact. Data type: String{#tmf_prod_order-PATCH-ord-productOrder-id__prod_relParty_phone_data_type-p-tmf622} Table/field updated: sn_ind_tmt_orm_order_line_item_contact/business_phone Default: Blank string | | productOrderItem.product.relatedParty.@referredType | Type of customer. Possible value: OrderLineItemContact{#tmf_prod_order-PATCH-ord-productOrder-id__prod_relParty_refType-p-tmf622} Data type: String | | productOrderItem.product.relatedParty.@type | 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 | | productOrderItem.product.@type | Part of TMF Open API standard. Annotation for the product. This value is always Product. This information is not stored. Data type: String | | productOrderItem.productOffering | Description of the product offering associated with the product. Data type: Object{#tmf_prod_order-PATCH-ord-productOrder-id__prodOffer_data_type-p-tmf622} "productOffering": { "id": "String", "internalVersion": "String", "name": "String", "version": "String" } {#tmf_prod_order-PATCH-ord-productOrder-id__prodOffer-codeblock-tmf622} Table updated: sn_ind_tmt_orm_order_line_item | | productOrderItem.productOffering.id | Required if the productOrderItem.productOffering parameter is used. Initial_version or external_id of the product offering. The initial_version is the sys_id of the first version of the offering. Located in the sys_id or external_id field of the Product Offering \[sn_prd_pm_product_offering\] table. Data type: String | | productOrderItem.productOffering.internalVersion | Version of the product offering. Located in the Product Offering \[sn_prd_pm_product_offering\] table. Data type: String | | productOrderItem.productOffering.name | Name of the product offering. Located in the Product Offering \[sn_prd_pm_product_offering\] table. Data type: String | | productOrderItem.productOffering.version | External_version of the product offering. Located in the Product Offering \[sn_prd_pm_product_offering\] table. Data type: String | | productOrderItem.productOrderItem.quantity | Number of the associated items to order. Data type: Number{#tmf_prod_order-PATCH-ord-productOrder-id__prodOrdItem_quantity_data_type-p-tmf622} Table/field updated: sn_ind_tmt_orm_order/quantity Default: null | | productOrderItem.productOrderItemRelationship | Array of objects that describe the relationships between order line items. Data type: Array{#tmf_prod_order-PATCH-ord-productOrder-id__prodOrderItemRel_data_type-p-tmf622} "productOrderItemRelationship": [ { "id": "String", "relationshipType": "String" } ] {#tmf_prod_order-PATCH-ord-productOrder-id__prodOrderItemRel-codeblock-tmf622} Table/field updated: sn_ind_tmt_orm_order_line_item | | productOrderItem.productOrderItemRelationship.id | Required if the productOrderItem.productOrderItemRelationship parameter is used. 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{#tmf_prod_order-PATCH-ord-productOrder-id__prodOrderItemRel_id_data_type-p-tmf622} Table/field updated: sn_ind_tmt_orm_order_line_item/parent_line_item Default: Blank string | | productOrderItem.productOrderItemRelationship.relationshipType | Type of relationship between the two line items. This information is used to identify the relationship hierarchy. Possible values: * HasChild * HasParent * Requires {#tmf_prod_order-PATCH-ord-productOrder-id__ul_yqf_2ty_54b} `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 | | productOrderItem.quantity | Number of items ordered. Data type: Number Table/field updated: sn_ind_tmt_orm_order/quantity Default: Blank string | | productOrderItem.revisionOperation | Type of update to perform on the line item. If this value is empty, the existing line item is updated, or a new line item is added if it does not already exist. If this value is cancel, the line item is canceled. Data type: String Default: Blank string | | productOrderItem.@type | Part of TMF Open API standard. Annotation for the product. This value is always ProductOrderItem. This information is not stored. Data type: String | | relatedParty | List of contacts for the order. Each contact is an object in the array. Must list at least one item which contains customer account or consumer account information. Data type: Array{#tmf_prod_order-PATCH-ord-productOrder-id__relatedParty_data_type-p-tmf622} "relatedParty": [ { "id": "String", "name": "String", "@referredType": "String", "@type": "String" } ] {#tmf_prod_order-PATCH-ord-productOrder-id__relatedParty-codeblock-tmf622} | | relatedParty.id | Sys_id or external_id of the account, customer contact, or consumer associated with the order. Located in the Account \[customer_account\], Contact \[customer_contact\] table, or Consumer \[csm_consumer\] table. Data type: String | | relatedParty.name | Name of the account, customer, or consumer. Data type: String | | relatedParty.@referredType | Type of customer. Possible values: * Consumer * Customer * CustomerContact {#tmf_prod_order-PATCH-ord-productOrder-id__ul_lcq_jwm_t4b} Data type: String | | relatedParty.@type | Part of TMF Open API standard. Annotation for the product. This value is always RelatedParty. This information is not stored. Data type: String | | requestedCompletionDate | Delivery date requested by the customer. Data type: String{#tmf_prod_order-PATCH-ord-productOrder-id__reqCompDate_data_type-p-tmf622} Table/field updated: sn_ind_tmt_orm_order/expected_end_date Default: Blank string | | requestedStartDate | Order start date requested by the customer. Data type: String{#tmf_prod_order-PATCH-ord-productOrder-id__reqStartDate_data_type-p-tmf622} Table/field updated: sn_ind_tmt_orm_order/expected_start_date Default: Blank string | | @type | Part of TMF Open API standard. Annotation for the product. This value is always ProductOrder. This information is not stored. Data type: String | [Table 27. Request body parameters (JSON)] {#tmf_prod_order-PATCH-ord-productOrder-id__id_vk2_p5n_t4b} ### 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](https://servicenow-prod.fluidtopics.net/2vuQj3~2s_niNXyXhrbRZA "REST (REpresentational State Transfer) is a simple stateless architecture that provides standards between computer systems on the web, making it easier for them to communicate with each other."). {#tmf_prod_order-PATCH-ord-productOrder-id__table_omb_dvk_5rb__entry__2}{#tmf_prod_order-PATCH-ord-productOrder-id__accept-JSON-only-entry-RESTAPI}{#tmf_prod_order-PATCH-ord-productOrder-id__content_type-JSON-only-entry-RESTAPI} | 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. | [Table 28. Request headers] {#tmf_prod_order-PATCH-ord-productOrder-id__table_omb_dvk_5rb} {#tmf_prod_order-PATCH-ord-productOrder-id__table_tzy_thy_ksb__entry__2} | Header | Description | |-|-| | Content-Type | Data format of the response body. Only supports application/json. | [Table 29. Response headers] {#tmf_prod_order-PATCH-ord-productOrder-id__table_tzy_thy_ksb} ### 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](https://servicenow-prod.fluidtopics.net/2vuQj3~2s_niNXyXhrbRZA "REST (REpresentational State Transfer) is a simple stateless architecture that provides standards between computer systems on the web, making it easier for them to communicate with each other."). {#tmf_prod_order-PATCH-ord-productOrder-id__table_xfv_2vk_5rb__entry__2} | Status code | Description | |-|-| | 201 | 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: * The following Order Item characteristics does not exist: Review specification \ and correct the characteristic and characteristic option in the order line item prior to approving the order. * Order Item characteristic: \ with characteristic value: \is invalid. Correct the characteristic values before approving the order. {#tmf_prod_order-PATCH-ord-productOrder-id__ul_xtx_xym_t4b} | | 400 | Bad Request. Could be any of the following reasons: * Invalid payload: Request body missing - Payload was not passed in the request body. * Invalid payload: productOrderItem is missing - Product order line item object or JSON is missing. * Invalid payload: productOrderItem id is missing - The id parameter is missing in the product order line item of the payload. * Invalid payload: productOrderItem action is missing - The action parameter is missing in the product order line item of the payload. * Invalid payload: productOrderItem productOffering is missing - The product offering object or JSON is missing from the product order line item in the payload. * Invalid payload: productOffering id is missing - The id parameter is missing in the product order line item of the product offering object in the payload. * Invalid payload: Product offering does not exist - The product offering in the product order line item is not valid. * Invalid payload: productOrderItem product is missing - The product object or JSON in the product order line item is missing from the payload. * Invalid payload: product productSpecification is missing - The product specification object or JSON in the product order line item is missing from the payload. * Invalid payload: productSpecification id is missing - The id parameter in the product order line item of the product specification object is missing from the payload. * Invalid payload: Product specification does not exist - The product specification in the product order line item is not valid. * Invalid payload: Product Inventory does not exist - In a change order (action = change), the quantity of an item is greater than what is in stock. * Invalid payload: Product inventory ID is missing - In a change order, the product.id is missing in the payload. * Invalid payload: Sold Product is inactive - In a change order, a product specified in the payload is inactive. * Invalid payload: relatedParty is missing - The related party object is missing from the payload. * Customer Account or Consumer is missing - The related party customer or consumer object is missing from the payload. * Invalid payload: Consumer does not exist - The specified related party consumer does not exist in the ServiceNow instance. * Invalid payload: Customer Account does not exist - The specified related party customer does not exist in the ServiceNow instance. * Invalid payload: Order creation failed - Not able to create the requested order. * In-flight revision to order currency not supported - The orderCurrency parameter can't be updated after the order is created. * This order is yet to be created in customer order table. Please check in inbound queue for more details. -- The order ID provided is not in the customer order table. * Patch request cannot be made as the order's fulfillment type is not 'deliver. -- The patch request was made on an order which has a fulfillment type other than deliver. {#tmf_prod_order-PATCH-ord-productOrder-id__ul_g2v_rzm_t4b} | [Table 30. Status codes] {#tmf_prod_order-PATCH-ord-productOrder-id__table_xfv_2vk_5rb} ### Response body parameters (JSON) {#tmf_prod_order-PATCH-ord-productOrder-id__section_b1v_xpk_5rb} {#tmf_prod_order-PATCH-ord-productOrder-id__table_c1v_xpk_5rb__entry__2}{#tmf_prod_order-PATCH-ord-productOrder-id__d3046e1602}{#tmf_prod_order-PATCH-ord-productOrder-id__externalProdInvId-resp-descr} | Name | Description | |-|-| | channel | Array of objects that describe the channels to use for selling the products. Data type: Array "channel": [ { "id": "String", "name": "String" } ] | | channel.id | Unique identifier of the channel to use to sell the associated products. Channel ID values are located in the external_id field of the Distribution Channel \[sn_prd_pm_distribution_channel\] table. Data type: String | | channel.name | Name of the channel to use to sell the associated products. Data type: String | | committedDueDate | Date and time when the action must be performed on the order. This value must be the same as or later than the committedDueDate values for each order line item. Data type: String | | externalId | External identifier for the customer order, such as a purchase order number. Data type: String | | href | Relative link to the product order record. Data type: String | | id | Sys_id of the customer order updated for this request. Data type: String | | note | Array of objects that describe additional notes made by the customer when ordering. Data type: Array "note": [ { "text": "String" } ] | | note.text | Additional notes/comments made by the customer while ordering. Data type: String | | orderCurrency | Currency code for the order and order line items. Data type: String | | productOrderItem | List that describes items associated with the product order and their associated action. Data type: Array "productOrderItem:" [ { "action": "String", "committedDueDate": "String", "externalProductInventory": [Array], "id": "String", "itemPrice": [Array], "product": {Object}, "productOffering": {Object}, "productOrderItemReleationship": [Array], "quantity": Number, "state": "String", "@type": "String" } ] | | productOrderItem.action | Action to carry out on the product. Possible actions are defined on the Choice List tab in the Action Dictionary Entry of the sn_ind_tmt_orm_order_line_item table. Data type: String | | productOrderItem.actionReason | The reason for adding the order line item. Data type: String Table/field updated: sn_ind_tmt_orm_order_line_item/action_reason | | productOrderItem.committedDueDate | Date and time when the action must be performed on the order line item. Data type: String | | productOrderItem.externalProductInventory | Array of objects containing external ids to map to the product inventories created for the order. Data type: Array "externalProductInventory": [ { "externalProductInventoryId": "String" } ] Note: Previously, when creating a PATCH order with an external product inventory ID that already existed, the operation was aborted and returned an error. With the Xanadu release, this parameter is simply ignored when an existing external product inventory ID is supplied and an error is not thrown. | | productOrderItem.externalProductInventory.externalProductInventoryId | External id mapped to the product inventory. Data type: String | | productOrderItem.id | 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 | | productOrderItem.itemPrice | Array of objects that describe the price associated with the product. Data type: Array "itemPrice": [ { "price": {Object}, "priceType": "String", "recurringChargePeriod": "String" } ] | | productOrderItem.itemPrice.price | Description of the price of the associated product. Data type: Object "price": { "taxIncludedAmount": {Object} } | | productOrderItem.itemPrice.price.taxIncludeAmount | Description of the price of the associated product, including the tax. Data type: Object "taxIncludedAmount": { "unit": "String", "value": Number } | | productOrderItem.itemPrice.price.taxIncludeAmount.unit | Currency code in which the price is depicted. Data type: String | | productOrderItem.itemPrice.price.taxIncludeAmount.value | Price of product, including any tax. Data type: Number | | productOrderItem.itemPrice.priceType | Type of item price, recurring or non-recurring. Data type: String | | productOrderItem.itemPrice.recurringChargePeriod | If the price is recurring, the recurring period, such as month. Data type: String | | productOrderItem.product | Description of the instance details of the product purchased by the customer. Data type: Object "product": { "id": "String", "place": {Object}, "productCharacteristic": [Array], "productSpecification": {Object}, "relatedParty": {Object}, "@type": "String" } | | productOrderItem.product.id | Unique identifier of the product sold. Located in the sys_id or sn_ind_tmt_orm_external_id field of the Product Inventory \[sn_ind_tmt_orm_product_inventory\] table. Data type: String | | productOrderItem.product.place | Maps of the locations on which to install the product. Data type: Object "place": { "id": "String", "@type": "String" } | | productOrderItem.product.place.id | Sys_id of the associated location record in the Location \[cmn_location\] table. Data type: String | | productOrderItem.product.productCharacteristic | Array of objects that describe the characteristics of the associated product. Data type: Array "productCharacteristic": [ { "name": "String", "previousValue": "String", "value": "String" } ] | | productOrderItem.product.productCharacteristic.name | Name of the characteristic record to associate with the product. Located in the Characteristic \[sn_prd_pm_characteristic\] table. Data type: String | | productOrderItem.product.productCharacteristic.previousValue | Previous characteristic option values if the update is for a change order. The request is a change order if the productOrderItem.action parameter is other than add. For additional information on characteristic option values, see [Create product characteristics and characteristic options](https://www.servicenow.com/docs/access?context=som-product-config-add-characteristics&version=xanadu&pubname=xanadu-order-management&ft:locale=en-US). Data type: String | | productOrderItem.product.productCharacteristic.value | Characteristic option values associated with the product. For additional information on characteristic option values, see [Create product characteristics and characteristic options](https://www.servicenow.com/docs/access?context=som-product-config-add-characteristics&version=xanadu&pubname=xanadu-order-management&ft:locale=en-US). Data type: String | | productOrderItem.product.productSpecification | Description of the product specification associated with the product. Data type: Object "productSpecification:" { "id": "String", "internalId": "String", "internalVersion": "String", "name": "String", "version": "String", "@type": "String" } | | productOrderItem.product.productSpecification.id | Initial_version or external_id of the product 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 Product Specification \[sn_prd_pm_product_specification\] table. Data type: String | | productOrderItem.product.productSpecification.internalId | Initial_version of the product specification. The initial_version is the sys_id of the first version of the specification. Located in the Product Specification \[sn_prd_pm_product_specification\] table. Data type: String | | productOrderItem.product.productSpecification.internalVersion | Version of the product specification. Located in the Product Specification \[sn_prd_pm_product_specification\] table. Data type: String | | productOrderItem.product.productSpecification.name | Name of the product specification. Located in the Product Specification \[sn_prd_pm_product_specification\] table. Data type: String | | productOrderItem.product.productSpecification.version | External_version of the product specification. Located in the Product Specification \[sn_prd_pm_product_specification\] table. Data type: String | | productOrderItem.product.productSpecification.@type | Part of the TMF Open API standard. This value is always ProductSpecificationRef. This information is not stored. Data type: String | | productOrderItem.product.relatedParty | List of contacts for line items. Data type: Array "relatedParty": [ { "email": "String", "firstName": "String", "id": "String", "lastName": "String", "phone": "String", "@referredType": "String", "@type": "String" } ] | | productOrderItem.product.relatedParty.email | Email address of the contact. Data type: String | | productOrderItem.product.relatedParty.firstName | First name of the contact. Data type: String | | productOrderItem.product.relatedParty.id | Sys_id of the line item contact associated with the order line item. Located in the Order Line Item Contact \[sn_ind_tmt_orm_order_line_item_contact\] table. Data type: String | | productOrderItem.product.relatedParty.lastName | Last name of the contact. Data type: String | | productOrderItem.product.relatedParty.phone | Business phone number of the contact. Data type: String | | productOrderItem.product.relatedParty.@referredType | Type of customer. Possible value: OrderLineItemContact Data type: String | | productOrderItem.product.relatedParty.@type | 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 | | productOrderItem.product.@type | Part of TMF Open API standard. Annotation for the product. This value is always Product. This information is not stored. Data type: String | | productOrderItem.productOffering | Description of the product offering associated with the product. Data type: Object "productOffering:" { "id": "String", "internalId": "String", "internalVersion": "String", "name": "String", "version": "String" } | | productOrderItem.productOffering.id | Initial_version or external_id of the product offering. The initial_version is the sys_id of the first version of the offering. Located in the sys_id or external_id field of the Product Offering \[sn_prd_pm_product_offering\] table. Data type: String | | productOrderItem.productOffering.internalId | Initial_version of the product offering. The initial_version is the sys_id of the first version of the offering. Located in the Product Offering \[sn_prd_pm_product_offering\] table. Data type: String | | productOrderItem.productOffering.internalVersion | Version of the product offering. Located in the Product Offering \[sn_prd_pm_product_offering\] table. Data type: String | | productOrderItem.productOffering.name | Name of the product offering. Located in the Product Offering \[sn_prd_pm_product_offering\] table. Data type: String | | productOrderItem.productOffering.version | External_version of the product offering. Located in the Product Offering \[sn_prd_pm_product_offering\] table. Data type: String | | productOrderItem.productOrderItemRelationship | Array of objects that describe the relationships between order line items. Data type: Array "productOrderItemRelationship": [ { "id": "String", "relationshipType": "String" } ] | | productOrderItem.productOrderItemRelationship.id | 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 | | productOrderItem.productOrderItemRelationship.relationshipType | Type of relationship between the two line items. This information is used to identify the relationship hierarchy. Data type: String | | productOrderItem.quantity | Number of the associated items to order. Data type: Number | | productOrderItem.state | Current state of the product order item. Data type: String | | productOrderItem.@type | Part of TMF Open API standard. Annotation for the product. This value is always ProductOrderItem. This information is not stored. Data type: String | | relatedParty | List of contacts for the order. Each contact is an object in the array. Must list at least one item which contains customer account or consumer account information. Data type: Array "relatedParty": [ { "id": "String", "name": "String", "@referredType": "String", "@type": "String" } ] | | relatedParty.id | Sys_id or external_id of the account, customer contact, or consumer associated with the order. Located in the Account \[customer_account\], Contact \[customer_contact\] table, or Consumer \[csm_consumer\] table. Data type: String | | relatedParty.name | Name of the account, customer, or consumer. Data type: String | | relatedParty.type | Type of customer. Possible values: * Consumer * Customer * CustomerContact {#tmf_prod_order-PATCH-ord-productOrder-id__d3046e2459} Data type: String | | requestedCompletionDate | Delivery date requested by the customer. Data type: String | | requestedStartDate | Order start date requested by the customer. Data type: String | | state | Current state of the order. Data type: String | | @type | Part of TMF Open API standard. Annotation for the product. This value is always ProductOrder. This information is not stored. Data type: String | [ ] {#tmf_prod_order-PATCH-ord-productOrder-id__table_c1v_xpk_5rb} ### cURL request {#tmf_prod_order-PATCH-ord-productOrder-id__example_jsc_1dc_vrb} This example updates the channel for a product order. curl -X PATCH "https://instance.service-now.com/api/sn_ind_tmt_orm/order/productOrder/8d75939453126010a795ddeeff7b126a" \ -H "Accept: application/json" \ -H "Content-Type: application/json" \ -u "username":"password" \ -d { "channel": [ { "id": "1", "name": "Agent Assist" } ] } Response body. { "id": "8d75939453126010a795ddeeff7b126a", "href": "/api/sn_ind_tmt_orm/order/productOrder/8d75939453126010a795ddeeff7b126a", "expectedCompletionDate": "2021-05-02T08:13:59.000Z", "requestedCompletionDate": "2021-05-02T08:13:59.000Z", "requestedStartDate": "2020-05-03T08:13:59.000Z", "externalId": "PO-456", "orderCurrency": "USD", "channel": [ { "id": "1", "name": "Agent Assist" } ], "note": [ { "author": "System Administrator", "date": "2021-02-25T14:22:07.000Z", "text": "This is a TMF product order illustration no 2" }, { "author": "System Administrator", "date": "2021-02-25T14:22:06.000Z", "text": "This is a TMF product order illustration" } ], "productOrderItem": [ { "id": "POI130", "ponr": "false", "quantity": 1, "action": "add", "actionReason": "adding service package OLI", "itemPrice": [ { "priceType": "recurring", "price": { "taxIncludedAmount": { "unit": "USD", "value": 20 } } }, { "priceType": "nonRecurring", "price": { "taxIncludedAmount": { "unit": "INR", "value": 0 } } } ], "product": { "@type": "Product", "productCharacteristic": [ { "name": "Security Type", "valueType": "Choice", "value": "Base", "previousValue": "" } ], "productSpecification": { "id": "a6514bd3534560102f18ddeeff7b1247", "name": "SD-WAN Security", "version": "v1", "internalVersion": "1", "internalId": "a6514bd3534560102f18ddeeff7b1247", "@type": "ProductSpecificationRef" }, "relatedParty": [ { "id": "4175939453126010a795ddeeff7b127d", "name": "John Smith", "email": "abc2@example.com", "phone": "32456768", "@type": "RelatedParty", "@referredType": "OrderLineItemContact" }, { "id": "c175939453126010a795ddeeff7b127c", "name": "Joe Doe", "email": "abc@example.com", "phone": "1234567890", "@type": "RelatedParty", "@referredType": "OrderLineItemContact" } ] }, "productOffering": { "id": "69017a0f536520103b6bddeeff7b127d", "name": "Premium SD-WAN Offering", "version": "v1", "internalId": "69017a0f536520103b6bddeeff7b127d", "internalVersion": "1" }, "productOrderItemRelationship": [ { "id": "POI100", "relationshipType": "HasParent" } ], "state": "in_progress", "version": "1", "@type": "ProductOrderItem" }, { "id": "POI100", "ponr": "false", "quantity": 1, "action": "add", "itemPrice": [ { "priceType": "recurring", "price": { "taxIncludedAmount": { "unit": "INR", "value": 0 } } }, { "priceType": "nonRecurring", "price": { "taxIncludedAmount": { "unit": "INR", "value": 0 } } } ], "product": { "@type": "Product", "productSpecification": { "id": "cfe5ef6a53702010cd6dddeeff7b12f6", "name": "SD-WAN Service Package", "version": "v1", "internalVersion": "1", "internalId": "cfe5ef6a53702010cd6dddeeff7b12f6", "@type": "ProductSpecificationRef" } }, "productOffering": { "id": "69017a0f536520103b6bddeeff7b127d", "name": "Premium SD-WAN Offering", "version": "v1", "internalId": "69017a0f536520103b6bddeeff7b127d", "internalVersion": "1" }, "productOrderItemRelationship": [ { "id": "POI130", "relationshipType": "HasChild" }, { "id": "POI120", "relationshipType": "HasChild" }, { "id": "POI110", "relationshipType": "HasChild" } ], "state": "in_progress", "version": "1", "@type": "ProductOrderItem" }, { "id": "POI120", "ponr": "false", "quantity": 1, "action": "add", "actionReason": "adding service package OLI", "itemPrice": [ { "priceType": "recurring", "price": { "taxIncludedAmount": { "unit": "USD", "value": 20 } } }, { "priceType": "nonRecurring", "price": { "taxIncludedAmount": { "unit": "INR", "value": 0 } } } ], "product": { "@type": "Product", "productCharacteristic": [ { "name": "CPE Type", "valueType": "Choice", "value": "Physical", "previousValue": "" }, { "name": "WAN Optimization", "valueType": "Choice", "value": "Advance", "previousValue": "" }, { "name": "Routing", "valueType": "Choice", "value": "Premium", "previousValue": "" }, { "name": "CPE Model", "valueType": "Choice", "value": "ASR", "previousValue": "" } ], "productSpecification": { "id": "39b627aa53702010cd6dddeeff7b1202", "name": "SD-WAN Edge Device", "version": "v1", "internalVersion": "1", "internalId": "39b627aa53702010cd6dddeeff7b1202", "@type": "ProductSpecificationRef" } }, "productOffering": { "id": "69017a0f536520103b6bddeeff7b127d", "name": "Premium SD-WAN Offering", "version": "v1", "internalVersion": "1", "internalId": "69017a0f536520103b6bddeeff7b127d" }, "productOrderItemRelationship": [ { "id": "POI100", "relationshipType": "HasParent" } ], "state": "in_progress", "version": "1", "@type": "ProductOrderItem" }, { "id": "POI110", "ponr": "false", "quantity": 1, "action": "add", "actionReason":"adding service package OLI", "itemPrice": [ { "priceType": "recurring", "price": { "taxIncludedAmount": { "unit": "INR", "value": 0 } } }, { "priceType": "nonRecurring", "price": { "taxIncludedAmount": { "unit": "USD", "value": 5 } } } ], "product": { "@type": "Product", "productCharacteristic": [ { "name": "Tenancy", "valueType": "Choice", "value": "Base (10 site)", "previousValue": "" } ], "productSpecification": { "id": "216663aa53702010cd6dddeeff7b12b5", "name": "SD-WAN Controller", "version": "v1", "internalVersion": "1", "internalId": "216663aa53702010cd6dddeeff7b12b5", "@type": "ProductSpecificationRef" }, "place": { "id": "25ab9c4d0a0a0bb300f7dabdc0ca7c1c", "@type": "Place" } }, "productOffering": { "id": "69017a0f536520103b6bddeeff7b127d", "name": "Premium SD-WAN Offering", "version": "v1", "internalId": "69017a0f536520103b6bddeeff7b127d", "internalVersion": "1" }, "productOrderItemRelationship": [ { "id": "POI100", "relationshipType": "HasParent" } ], "state": "in_progress", "version": "1", "@type": "ProductOrderItem" } ], "relatedParty": [ { "id": "eaf68911c35420105252716b7d40ddde", "name": "Sally Thomas", "@type": "RelatedParty", "@referredType": "CustomerContact" }, { "id": "ffc68911c35420105252716b7d40dd55", "name": "Funco Intl", "@type": "RelatedParty", "@referredType": "Customer" }, { "id": "59f16de1c3b67110ff00ed23a140dd9e", "name": "Funco External", "@type": "RelatedParty", "@referredType": "Consumer" } ], "state": "in_progress", "@type": "ProductOrder" } ## Product Order Open API - PATCH /sn_ind_tmt_orm/productorder/{id} {#ariaid-title7} Updates the specified customer order. Important: Starting with the Tokyo release, this endpoint is deprecated. The new version of this endpoint is [Product Order Open API - PATCH /sn_ind_tmt_orm/order/productOrder/{id}](https://servicenow-prod.fluidtopics.net/lU3_sIIHvtqhkTfEEUFOCw#tmf_prod_order-PATCH-ord-productOrder-id "Updates the specified customer order."). ### URL format Default URL: /api/sn_ind_tmt_orm/productorder/{id} ### Supported request parameters {#tmf_prod_order-PATCH-productorder-id__entry__2} | Name | Description | |-|-| | id | Sys_id of the customer order to update. Located in the Customer Order \[sn_ind_tmt_orm_order\] table. Data type: String | [Table 31. Path parameters] {#tmf_prod_order-PATCH-productorder-id__entry__6} | Name | Description | |-|-| | None | | [Table 32. Query parameters] {#tmf_prod_order-PATCH-productorder-id__id_vk2_p5n_t4b__entry__2}{#tmf_prod_order-PATCH-productorder-id__channel-ph-tmf622}{#tmf_prod_order-PATCH-productorder-id__channel_id-ph-tmf622}{#tmf_prod_order-PATCH-productorder-id__channel_name-ph-tmf622}{#tmf_prod_order-PATCH-productorder-id__due-date-PATCH}{#tmf_prod_order-PATCH-productorder-id__externalId-ph-tmf622}{#tmf_prod_order-PATCH-productorder-id__note-ph-tmf622}{#tmf_prod_order-PATCH-productorder-id__note_text-ph-tmf622}{#tmf_prod_order-PATCH-productorder-id__prodOrdItem-ph-tmf622}{#tmf_prod_order-PATCH-productorder-id__prodOrdItem_action-ph-tmf622}{#tmf_prod_order-PATCH-productorder-id__prodOrdItem_actionReason-response-tmf622}{#tmf_prod_order-PATCH-productorder-id__due-date-item-PATCH}{#tmf_prod_order-PATCH-productorder-id__externalProdInv-descr-PATCH}{#tmf_prod_order-PATCH-productorder-id__externalProdInvId-decsr}{#tmf_prod_order-PATCH-productorder-id__prodOrdItem_id-ph-tmf622}{#tmf_prod_order-PATCH-productorder-id__itemPrice-ph-tmf622}{#tmf_prod_order-PATCH-productorder-id__itemPrice_price-ph-tmf622}{#tmf_prod_order-PATCH-productorder-id__itemPrice_price_taxIncludedAmt-ph-tmf622}{#tmf_prod_order-PATCH-productorder-id__itemPrice_price_taxIncludedAmt_unit-ph-tmf622}{#tmf_prod_order-PATCH-productorder-id__itemPrice_price_taxIncludedAmt_value-ph-tmf622}{#tmf_prod_order-PATCH-productorder-id__itemPrice_priceType_data_type-p-tmf622}{#tmf_prod_order-PATCH-productorder-id__itemPrice_recurringChargePeriod_data_type-p-tmf622}{#tmf_prod_order-PATCH-productorder-id__product-p-tmf622}{#tmf_prod_order-PATCH-productorder-id__product_id-ph-tmf622}{#tmf_prod_order-PATCH-productorder-id__product_place-ph-tmf622}{#tmf_prod_order-PATCH-productorder-id__product_place_id-ph-tmf622}{#tmf_prod_order-PATCH-productorder-id__product_place_type_data_type-p-tmf622}{#tmf_prod_order-PATCH-productorder-id__prod_prodChar-ph-tmf622}{#tmf_prod_order-PATCH-productorder-id__prod_prodChar_name-ph-tmf622}{#tmf_prod_order-PATCH-productorder-id__prod_prodChar_previousValue-ph-tmf622}{#tmf_prod_order-PATCH-productorder-id__prod_prodChar_value-ph-tmf622}{#tmf_prod_order-PATCH-productorder-id__prod_prodSpec-ph-tmf622}{#tmf_prod_order-PATCH-productorder-id__prod_prodSpec_id_data_type-p-tmf622}{#tmf_prod_order-PATCH-productorder-id__prod_prodSpec_name_data_type-p-tmf622}{#tmf_prod_order-PATCH-productorder-id__prod_prodSpec_type_data_type-p-tmf622}{#tmf_prod_order-PATCH-productorder-id__prod_relParty-ph-tmf622}{#tmf_prod_order-PATCH-productorder-id__prod_relParty_email-ph-tmf622}{#tmf_prod_order-PATCH-productorder-id__prod_relParty_firstName-ph-tmf622}{#tmf_prod_order-PATCH-productorder-id__prod_relParty_id-ph-tmf622}{#tmf_prod_order-PATCH-productorder-id__prod_relParty_lastName-ph-tmf622}{#tmf_prod_order-PATCH-productorder-id__prod_relParty_phone-ph-tmf622}{#tmf_prod_order-PATCH-productorder-id__prod_relParty_refType_data_type-p-tmf622}{#tmf_prod_order-PATCH-productorder-id__product_relatedParty_type_data_type-row-tmf622}{#tmf_prod_order-PATCH-productorder-id__product_type_data_type-p-tmf622}{#tmf_prod_order-PATCH-productorder-id__productOffer-ph-tmf622}{#tmf_prod_order-PATCH-productorder-id__prodOffer_id_data_type-p-tmf622}{#tmf_prod_order-PATCH-productorder-id__prodOffer_name_data_type-p-tmf622}{#tmf_prod_order-PATCH-productorder-id__prodOrdItem_quantity-ph-tmf622}{#tmf_prod_order-PATCH-productorder-id__prodOrderItemRel-ph-tmf622}{#tmf_prod_order-PATCH-productorder-id__prodOrderItemRel_id-ph-tmf622}{#tmf_prod_order-PATCH-productorder-id__prodOrderItemRel_relType_data_type-p-tmf622}{#tmf_prod_order-PATCH-productorder-id__prodOrdItem_type-entry-tmf622}{#tmf_prod_order-PATCH-productorder-id__relatedParty-ph-tmf622}{#tmf_prod_order-PATCH-productorder-id__relatedParty_id_data_type-p-tmf622}{#tmf_prod_order-PATCH-productorder-id__relatedParty_name_data_type-p-tmf622}{#tmf_prod_order-PATCH-productorder-id__relatedParty_refType_data_type-p-tmf622}{#tmf_prod_order-PATCH-productorder-id__relatedParty_type_data_type-p-tmf622}{#tmf_prod_order-PATCH-productorder-id__requestedCompletionDate-ph-tmf622}{#tmf_prod_order-PATCH-productorder-id__reqStartDate-ph-tmf622}{#tmf_prod_order-PATCH-productorder-id__type-entry-tmf622} | Name | Description | |-|-| | channel | Array of objects that describe the channels to use for selling the products. Data type: Array{#tmf_prod_order-PATCH-productorder-id__channel_data_type-p-tmf622} "channel": [ { "id": "String", "name": "String" } ] {#tmf_prod_order-PATCH-productorder-id__channel_obj_def-codeblock-tmf622} Table/field updated: sn_ind_tmt_orm_order | | channel.id | Required if the channel parameter is used. Unique identifier of the channel to use to sell the associated products. Channel ID values are located in the external_id field of the Distribution Channel \[sn_prd_pm_distribution_channel\] table. Data type: String{#tmf_prod_order-PATCH-productorder-id__channel_id_data_type-p-tmf622} Table/field updated: sn_ind_tmt_orm_order/channel Default: Blank string | | channel.name | Name of the channel to use to sell the associated products. Possible channel names are defined on the Choice List tab in the Channel Dictionary Entry of the sn_ind_tmt_orm_order table. Data type: String{#tmf_prod_order-PATCH-productorder-id__channel_name_data_type-p-tmf622} Default: Blank string | | committedDueDate | Date and time when the action must be performed on the order. This value must be the same as or later than the committedDueDate values for each order line item. If the action for order line items is suspend or resume, this parameter can't be updated. Data type: String Table/field updated: sn_ind_tmt_orm_order/committed_due_date | | externalId | Unique identifier for the customer order. This value is determined by an external system. Data type: String{#tmf_prod_order-PATCH-productorder-id__externalId_data_type-p-tmf622} Table/field updated: sn_ind_tmt_orm_order/external_id Default: Blank string | | note | Array of objects that describe additional notes made by the customer when ordering. Data type: Array{#tmf_prod_order-PATCH-productorder-id__note_data_type-p-tmf622} "note": [ { "text": "String" } ] {#tmf_prod_order-PATCH-productorder-id__note-codeblock-tmf622} Table/field updated: sn_ind_tmt_orm_order | | note.text | Additional notes/comments made by the customer while ordering. Data type: String{#tmf_prod_order-PATCH-productorder-id__note_text_data_type-p-tmf622} Table/field updated: sn_ind_tmt_orm_order/comments Default: Blank string | | orderCurrency | Currency code for the order and order line items. Updating the currency code of an existing order is not supported. Providing any value other than the currency code already associated with the order causes the update to be rejected. Data type: String | | productOrderItem | List that describes items associated with the product order and their associated action. Data type: Array{#tmf_prod_order-PATCH-productorder-id__prodOrdItem_data_type-p-tmf622} "productOrderItem": [ { "action": "String", "actionReason": "String", "committedDueDate": "String", "externalProductInventory": [Array], "id": "String", "itemPrice": [Array], "product": {Object}, "productOffering": {Object}, "productOrderItemRelationship": [Array], "quantity": Number, "revisionOperation": "String", "@type": "String" } ] {#tmf_prod_order-PATCH-productorder-id__prodOrdItem-codeblock-tmf622} Table/field updated: sn_ind_tmt_orm_order_line_item | | productOrderItem.action | Required if the productOrderItem parameter is used. Action to carry out on the product. Possible actions are defined on the Choice List tab in the Action Dictionary Entry of the sn_ind_tmt_orm_order_line_item table. Possible values: * add * change * delete * no-change * resume * suspend {#tmf_prod_order-PATCH-productorder-id__ul_zwn_nxp_ysb} Data type: String{#tmf_prod_order-PATCH-productorder-id__prodOrdItem_action_data_type-p-tmf622} Table/field updated: sn_ind_tmt_orm_order_line_item/action Default: add | | productOrderItem.actionReason | The reason for adding the order line item. Data type: String Table/field updated: sn_ind_tmt_orm_order_line_item/action_reason | | productOrderItem.committedDueDate | Date and time when the action must be performed on the order line item. If the action for the item is suspend or resume, this parameter can't be updated. Data type: String Table/field updated: sn_ind_tmt_orm_order_line_item/committed_due_date | | productOrderItem.externalProductInventory | Array of objects containing external ids to map to the product inventories created for the order. Data type: Array "externalProductInventory": [ { "externalProductInventoryId": "String" } ] Note: Previously, when creating a PATCH order with an external product inventory ID that already existed, the operation was aborted and returned an error. With the Xanadu release, this parameter is simply ignored when an existing external product inventory ID is supplied and an error is not thrown. | | productOrderItem.externalProductInventory.externalProductInventoryId | External id to map to the product inventory. Data type: String Table/field updated: sn_ind_tmt_orm_order_line_item/external_inventory_id and sn_prd_invt_product_inventory/sn_prd_invt_external_id | | productOrderItem.id | Required if the productOrderItem parameter is used. 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{#tmf_prod_order-PATCH-productorder-id__prodOrdItem_id_data_type-p-tmf622} Table/field updated: sn_ind_tmt_orm_order_line_item/external_id Maximum length: 40 Default: Blank string | | productOrderItem.itemPrice | Array of objects that describe the price associated with the product. Data type: Array{#tmf_prod_order-PATCH-productorder-id__itemPrice_data_type-p-tmf622} "itemPrice": [ { "price": {Object}, "priceType": "String", "recurringChargePeriod": "String" } ] {#tmf_prod_order-PATCH-productorder-id__itemPrice-codeblock-tmf622} Table updated: sn_ind_tmt_orm_order Default: Blank string | | productOrderItem.itemPrice.price | Description of the price of the associated product. Data type: Object{#tmf_prod_order-PATCH-productorder-id__itemPrice_price_data_type-p-tmf622} "price": { "taxIncludedAmount": {Object} } {#tmf_prod_order-PATCH-productorder-id__itemPrice_price-codeblock-tmf622} Table updated: sn_ind_tmt_orm_order_line_item Default: Blank string | | productOrderItem.itemPrice.price.taxIncludedAmount | Description of the price of the associated product, including the tax. Data type: Object{#tmf_prod_order-PATCH-productorder-id__itemPrice_price_taxIncludedAmt_data_type-p-tmf622} "taxIncludedAmount": { "unit": "String", "value": Number } {#tmf_prod_order-PATCH-productorder-id__itemPrice_price_taxIncludedAmt-codeblock-tmf622} Table updated: sn_ind_tmt_orm_order_line_item | | productOrderItem.itemPrice.price.taxIncludedAmount.unit | Currency code in which the price is depicted. Data type: String{#tmf_prod_order-PATCH-productorder-id__itemPrice_price_taxIncludedAmt_unit_data_type-p-tmf622} Table/field updated: sn_ind_tmt_orm_order_line_item/mrc or nrc | | productOrderItem.itemPrice.price.taxIncludedAmount.value | Price of product, including any tax. Data type: Number{#tmf_prod_order-PATCH-productorder-id__itemPrice_price_taxIncludedAmt_value_data_type-p-tmf622} Table/field updated: sn_ind_tmt_orm_order_line_item/mrc or nrc | | productOrderItem.itemPrice.priceType | Type of item price, recurring or non-recurring. Data type: String | | productOrderItem.itemPrice.recurringChargePeriod | If the price is recurring, the recurring period, such as month. Data type: String | | productOrderItem.product | Required if productOrderItem.action is change or delete. Description of the instance details of the product purchased by the customer. Data type: Object{#tmf_prod_order-PATCH-productorder-id__product_data_type-p-tmf622} "product": { "id": "String", "place": {Object}, "productCharacteristic": [Array], "productSpecification": {Object}, "relatedParty": {Object}, "@type": "String" } {#tmf_prod_order-PATCH-productorder-id__product-codeblock-tmf622} Table/field updated: sn_ind_tmt_orm_order_line_item | | productOrderItem.product.id | Required if productOrderItem.action is change or delete. Unique identifier of the product sold. Located in the sys_id or sn_ind_tmt_orm_external_id field of the Product Inventory \[sn_ind_tmt_orm_product_inventory\] table. Data type: String{#tmf_prod_order-PATCH-productorder-id__product_id_data_type-p-tmf622} Default: Blank string | | productOrderItem.product.place | Maps of the locations on which to install the product. Data type: Object{#tmf_prod_order-PATCH-productorder-id__product_place_data_type-p-tmf622} "place": { "id": "String", "@type": "String" } {#tmf_prod_order-PATCH-productorder-id__product_place-codeblock-tmf622} Table/field updated: sn_ind_tmt_orm_order_line_item | | productOrderItem.product.place.id | Required if the productOrderItem.product.place parameter is used. Sys_id of the associated location record in the Location \[cmn_location\] table. Data type: String{#tmf_prod_order-PATCH-productorder-id__product_place_id_data_type-p-tmf622} Table/field updated: sn_ind_tmt_orm_order_line_item/location Default: Blank string | | productOrderItem.product.place.@type | 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 | | productOrderItem.product.productCharacteristic | Array of objects that describe the characteristics of the associated product. Data type: Array{#tmf_prod_order-PATCH-productorder-id__prod_prodChar_data_type-p-tmf622} "productCharacteristic": [ { "name": "String", "previousValue": "String", "value": "String" } ] {#tmf_prod_order-PATCH-productorder-id__prod_prodChar-codeblock-tmf622} Table/field updated: sn_ind_tmt_orm_order_characteristic_value | | productOrderItem.product.productCharacteristic.name | Name of the characteristic record to associate with the product. Located in the Characteristic \[sn_prd_pm_characteristic\] table. Data type: String{#tmf_prod_order-PATCH-productorder-id__prod_prodChar_name_data_type-p-tmf622} Table/field updated: sn_ind_tmt_orm_order_characteristic_value/characteristics Default: Blank string | | productOrderItem.product.productCharacteristic.previousValue | Previous characteristic option values if the update is for a change order. The request is a change order if the productOrderItem.action parameter is other than add. For additional information on characteristic option values, see [Create product characteristics and characteristic options](https://www.servicenow.com/docs/access?context=som-product-config-add-characteristics&version=xanadu&pubname=xanadu-order-management&ft:locale=en-US). Data type: String{#tmf_prod_order-PATCH-productorder-id__prod_prodChar_previousValue_data_type-p-tmf622} Table/field updated: sn_ind_tmt_orm_order_characteristic_value/previous_characteristic_option_value Default: Blank string | | productOrderItem.product.productCharacteristic.value | Characteristic option values associated with the product. For additional information on characteristic option values, see [Create product characteristics and characteristic options](https://www.servicenow.com/docs/access?context=som-product-config-add-characteristics&version=xanadu&pubname=xanadu-order-management&ft:locale=en-US). Data type: String{#tmf_prod_order-PATCH-productorder-id__prod_prodChar_value_data_type-p-tmf622} Table/field updated: sn_ind_tmt_orm_order_characteristic_value/characteristic_option_value Default: Blank string | | productOrderItem.product.productSpecification | Description of the product specification associated with the product. Note: Change orders (productOrderItem.action is `change`) are processed differently based on the value of the sn_ind_tmt_orm.allowSpecVersionUpdateInChangeOrder system property. The value of this system property determines how the order is processed if the product inventory is a different version than indicated in the order. * When this system property is set to true (default), the product inventory is automatically upgraded to the version in the order by changing the referenced product specification. This allows the order to be successfully processed. * When this system property is set to false, if the product inventory is a different version than indicated in the order, the order fails due to the version mismatch. {#tmf_prod_order-PATCH-productorder-id__ul_sgb_q5y_hbc} Data type: Object{#tmf_prod_order-PATCH-productorder-id__prod_prodSpec_data_type-p-tmf622} "productSpecification": { "id": "String", "internalVersion": "String", "name": "String", "version": "String", "@type": "String" } {#tmf_prod_order-PATCH-productorder-id__prod_prodSpec-codeblock-tmf622} Table/field updated: sn_ind_tmt_orm_order_line_item | | productOrderItem.product.productSpecification.id | Required if the productOrderItem.product.productSpecification parameter is used. Initial_version or external_id of the product 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 Product Specification \[sn_prd_pm_product_specification\] table. Data type: String | | productOrderItem.product.productSpecification.internalVersion | Version of the product specification. Located in the Product Specification \[sn_prd_pm_product_specification\] table. Data type: String | | productOrderItem.product.productSpecification.name | Name of the product specification. Located in the Product Specification \[sn_prd_pm_product_specification\] table. Data type: String | | productOrderItem.product.productSpecification.version | External_version of the product specification. Located in the Product Specification \[sn_prd_pm_product_specification\] table. Data type: String | | productOrderItem.product.productSpecification.@type | Part of the TMF Open API standard. This value is always ProductSpecificationRef. This information is not stored. Data type: String | | productOrderItem.product.relatedParty | List of contacts for line items. Data type: Array{#tmf_prod_order-PATCH-productorder-id__prod_relParty_data_type-p-tmf622} "relatedParty": [ { "email": "String", "firstName": "String", "id": "String", "lastName": "String", "phone": "String", "@referredType": "String", "@type": "String" } ] {#tmf_prod_order-PATCH-productorder-id__prod_relParty-codeblock-tmf622} Table/field updated: sn_ind_tmt_orm_order_line_item_contact | | productOrderItem.product.relatedParty.email | Email address of the contact. Data type: String{#tmf_prod_order-PATCH-productorder-id__prod_relParty_email_data_type-p-tmf622} Table/field updated: sn_ind_tmt_orm_order_line_item_contact/email Default: Blank string | | productOrderItem.product.relatedParty.firstName | First name of the contact. Data type: String{#tmf_prod_order-PATCH-productorder-id__prod_relParty_firstName_data_type-p-tmf622} Table/field updated: sn_ind_tmt_orm_order_line_item_contact/first_name Default: Blank string | | productOrderItem.product.relatedParty.id | Sys_id of the line item contact associated with the order line item. Located in the Order Line Item Contact \[sn_ind_tmt_orm_order_line_item_contact\] table. Data type: String{#tmf_prod_order-PATCH-productorder-id__prod_relParty_id_data_type-p-tmf622} Table/field updated: sn_ind_tmt_orm_order_line_item_contact/sys_id Default: Blank string | | productOrderItem.product.relatedParty.lastName | Last name of the contact. Data type: String{#tmf_prod_order-PATCH-productorder-id__prod_relParty_lastName_data_type-p-tmf622} Table/field updated: sn_ind_tmt_orm_order_line_item_contact/lastName Default: Blank string | | productOrderItem.product.relatedParty.phone | Business phone number of the contact. Data type: String{#tmf_prod_order-PATCH-productorder-id__prod_relParty_phone_data_type-p-tmf622} Table/field updated: sn_ind_tmt_orm_order_line_item_contact/business_phone Default: Blank string | | productOrderItem.product.relatedParty.@referredType | Type of customer. Possible value: OrderLineItemContact{#tmf_prod_order-PATCH-productorder-id__prod_relParty_refType-p-tmf622} Data type: String | | productOrderItem.product.relatedParty.@type | 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 | | productOrderItem.product.@type | Part of TMF Open API standard. Annotation for the product. This value is always Product. This information is not stored. Data type: String | | productOrderItem.productOffering | Description of the product offering associated with the product. Data type: Object{#tmf_prod_order-PATCH-productorder-id__prodOffer_data_type-p-tmf622} "productOffering": { "id": "String", "internalVersion": "String", "name": "String", "version": "String" } {#tmf_prod_order-PATCH-productorder-id__prodOffer-codeblock-tmf622} Table updated: sn_ind_tmt_orm_order_line_item | | productOrderItem.productOffering.id | Required if the productOrderItem.productOffering parameter is used. Initial_version or external_id of the product offering. The initial_version is the sys_id of the first version of the offering. Located in the sys_id or external_id field of the Product Offering \[sn_prd_pm_product_offering\] table. Data type: String | | productOrderItem.productOffering.internalVersion | Version of the product offering. Located in the Product Offering \[sn_prd_pm_product_offering\] table. Data type: String | | productOrderItem.productOffering.name | Name of the product offering. Located in the Product Offering \[sn_prd_pm_product_offering\] table. Data type: String | | productOrderItem.productOffering.version | External_version of the product offering. Located in the Product Offering \[sn_prd_pm_product_offering\] table. Data type: String | | productOrderItem.productOrderItem.quantity | Number of the associated items to order. Data type: Number{#tmf_prod_order-PATCH-productorder-id__prodOrdItem_quantity_data_type-p-tmf622} Table/field updated: sn_ind_tmt_orm_order/quantity Default: null | | productOrderItem.productOrderItemRelationship | Array of objects that describe the relationships between order line items. Data type: Array{#tmf_prod_order-PATCH-productorder-id__prodOrderItemRel_data_type-p-tmf622} "productOrderItemRelationship": [ { "id": "String", "relationshipType": "String" } ] {#tmf_prod_order-PATCH-productorder-id__prodOrderItemRel-codeblock-tmf622} Table/field updated: sn_ind_tmt_orm_order_line_item | | productOrderItem.productOrderItemRelationship.id | Required if the productOrderItem.productOrderItemRelationship parameter is used. 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{#tmf_prod_order-PATCH-productorder-id__prodOrderItemRel_id_data_type-p-tmf622} Table/field updated: sn_ind_tmt_orm_order_line_item/parent_line_item Default: Blank string | | productOrderItem.productOrderItemRelationship.relationshipType | Type of relationship between the two line items. This information is used to identify the relationship hierarchy. Possible values: * HasChild * HasParent * Requires {#tmf_prod_order-PATCH-productorder-id__ul_yqf_2ty_54b} `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 | | productOrderItem.quantity | Number of items ordered. Data type: Number Table/field updated: sn_ind_tmt_orm_order/quantity Default: Blank string | | productOrderItem.revisionOperation | Type of update to perform on the line item. If this value is empty, the existing line item is updated, or a new line item is added if it does not already exist. If this value is cancel, the line item is canceled. Data type: String Default: Blank string | | productOrderItem.@type | Part of TMF Open API standard. Annotation for the product. This value is always ProductOrderItem. This information is not stored. Data type: String | | relatedParty | List of contacts for the order. Each contact is an object in the array. Must list at least one item which contains customer account or consumer account information. Data type: Array{#tmf_prod_order-PATCH-productorder-id__relatedParty_data_type-p-tmf622} "relatedParty": [ { "id": "String", "name": "String", "@referredType": "String", "@type": "String" } ] {#tmf_prod_order-PATCH-productorder-id__relatedParty-codeblock-tmf622} | | relatedParty.id | Sys_id or external_id of the account, customer contact, or consumer associated with the order. Located in the Account \[customer_account\], Contact \[customer_contact\] table, or Consumer \[csm_consumer\] table. Data type: String | | relatedParty.name | Name of the account, customer, or consumer. Data type: String | | relatedParty.@referredType | Type of customer. Possible values: * Consumer * Customer * CustomerContact {#tmf_prod_order-PATCH-productorder-id__ul_lcq_jwm_t4b} Data type: String | | relatedParty.@type | Part of TMF Open API standard. Annotation for the product. This value is always RelatedParty. This information is not stored. Data type: String | | requestedCompletionDate | Delivery date requested by the customer. Data type: String{#tmf_prod_order-PATCH-productorder-id__reqCompDate_data_type-p-tmf622} Table/field updated: sn_ind_tmt_orm_order/expected_end_date Default: Blank string | | requestedStartDate | Order start date requested by the customer. Data type: String{#tmf_prod_order-PATCH-productorder-id__reqStartDate_data_type-p-tmf622} Table/field updated: sn_ind_tmt_orm_order/expected_start_date Default: Blank string | | @type | Part of TMF Open API standard. Annotation for the product. This value is always ProductOrder. This information is not stored. Data type: String | [Table 33. Request body parameters (JSON)] {#tmf_prod_order-PATCH-productorder-id__id_vk2_p5n_t4b} ### 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](https://servicenow-prod.fluidtopics.net/2vuQj3~2s_niNXyXhrbRZA "REST (REpresentational State Transfer) is a simple stateless architecture that provides standards between computer systems on the web, making it easier for them to communicate with each other."). {#tmf_prod_order-PATCH-productorder-id__table_omb_dvk_5rb__entry__2}{#tmf_prod_order-PATCH-productorder-id__accept-JSON-only-entry-RESTAPI}{#tmf_prod_order-PATCH-productorder-id__content_type-JSON-only-entry-RESTAPI} | 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. | [Table 34. Request headers] {#tmf_prod_order-PATCH-productorder-id__table_omb_dvk_5rb} {#tmf_prod_order-PATCH-productorder-id__table_tzy_thy_ksb__entry__2} | Header | Description | |-|-| | Content-Type | Data format of the response body. Only supports application/json. | [Table 35. Response headers] {#tmf_prod_order-PATCH-productorder-id__table_tzy_thy_ksb} ### 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](https://servicenow-prod.fluidtopics.net/2vuQj3~2s_niNXyXhrbRZA "REST (REpresentational State Transfer) is a simple stateless architecture that provides standards between computer systems on the web, making it easier for them to communicate with each other."). {#tmf_prod_order-PATCH-productorder-id__table_xfv_2vk_5rb__entry__2} | Status code | Description | |-|-| | 201 | 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: * The following Order Item characteristics does not exist: Review specification \ and correct the characteristic and characteristic option in the order line item prior to approving the order. * Order Item characteristic: \ with characteristic value: \is invalid. Correct the characteristic values before approving the order. {#tmf_prod_order-PATCH-productorder-id__ul_xtx_xym_t4b} | | 400 | Bad Request. Could be any of the following reasons: * Invalid payload: Request body missing - Payload was not passed in the request body. * Invalid payload: productOrderItem is missing - Product order line item object or JSON is missing. * Invalid payload: productOrderItem id is missing - The id parameter is missing in the product order line item of the payload. * Invalid payload: productOrderItem action is missing - The action parameter is missing in the product order line item of the payload. * Invalid payload: productOrderItem productOffering is missing - The product offering object or JSON is missing from the product order line item in the payload. * Invalid payload: productOffering id is missing - The id parameter is missing in the product order line item of the product offering object in the payload. * Invalid payload: Product offering does not exist - The product offering in the product order line item is not valid. * Invalid payload: productOrderItem product is missing - The product object or JSON in the product order line item is missing from the payload. * Invalid payload: product productSpecification is missing - The product specification object or JSON in the product order line item is missing from the payload. * Invalid payload: productSpecification id is missing - The id parameter in the product order line item of the product specification object is missing from the payload. * Invalid payload: Product specification does not exist - The product specification in the product order line item is not valid. * Invalid payload: Product Inventory does not exist - In a change order (action = change), the quantity of an item is greater than what is in stock. * Invalid payload: Product inventory ID is missing - In a change order, the product.id is missing in the payload. * Invalid payload: Sold Product is inactive - In a change order, a product specified in the payload is inactive. * Invalid payload: relatedParty is missing - The related party object is missing from the payload. * Invalid payload: Customer Account or Consumer is missing - The related party customer or consumer object is missing from the payload. * Invalid payload: Consumer does not exist - The specified related party consumer does not exist in the ServiceNow instance. * Invalid payload: Customer Account does not exist - The specified related party customer does not exist in the ServiceNow instance. * Invalid payload: Order creation failed - Not able to create the requested order. * Invalid payload: This order is yet to be created in customer order table. Please check in inbound queue for more details. - The patch request was made for an order that is not in the customer order table yet. The order is in the Inbound Queue \[sn_tmt_core_inbound_queue\] table waiting for the scheduler to pick the record to be processed. * Invalid payload: Patch request cannot be made as the order's fulfillment type is not 'deliver'. - The patch request was made for an order which has a fulfillment type other than deliver. {#tmf_prod_order-PATCH-productorder-id__ul_g2v_rzm_t4b} | [Table 36. Status codes] {#tmf_prod_order-PATCH-productorder-id__table_xfv_2vk_5rb} ### Response body parameters (JSON) {#tmf_prod_order-PATCH-productorder-id__section_b1v_xpk_5rb} {#tmf_prod_order-PATCH-productorder-id__table_c1v_xpk_5rb__entry__2} | Name | Description | |-|-| | channel | Array of objects that describe the channels to use for selling the products. Data type: Array "channel": [ { "id": "String", "name": "String" } ] | | channel.id | Unique identifier of the channel to use to sell the associated products. Channel ID values are located in the external_id field of the Distribution Channel \[sn_prd_pm_distribution_channel\] table. Data type: String | | channel.name | Name of the channel to use to sell the associated products. Data type: String | | id | Sys_id of the customer order updated for this request. Data type: String | | externalId | External identifier for the customer order, such as a purchase order number. Data type: String | | note | Array of objects that describe additional notes made by the customer when ordering. Data type: Array "note": [ { "text": "String" } ] | | note.text | Additional notes/comments made by the customer while ordering. Data type: String | | productOrderItem | List that describes items associated with the product order and their associated action. Data type: Array "productOrderItem:" [ { "action": "String", "actionReason": "String", "id": "String", "itemPrice": [Array], "product": {Object}, "productOffering": {Object}, "productOrderItemReleationship": [Array], "quantity": Number, "state": "String", "@type": "String" } ] | | productOrderItem.action | Action to carry out on the product. Possible actions are defined on the Choice List tab in the Action Dictionary Entry of the sn_ind_tmt_orm_order_line_item table. Data type: String | | productOrderItem.actionReason | The reason for adding the order line item. Data type: String Table/field updated: sn_ind_tmt_orm_order_line_item/action_reason | | productOrderItem.id | 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 | | productOrderItem.itemPrice | Array of objects that describe the price associated with the product. Data type: Array "itemPrice": [ { "price": {Object}, "priceType": "String", "recurringChargePeriod": "String" } ] | | productOrderItem.itemPrice.price | Description of the price of the associated product. Data type: Object "price": { "taxIncludedAmount": {Object} } | | productOrderItem.itemPrice.price.taxIncludeAmount | Description of the price of the associated product, including the tax. Data type: Object "taxIncludedAmount": { "unit": "String", "value": Number } | | productOrderItem.itemPrice.price.taxIncludeAmount.unit | Currency code in which the price is depicted. Data type: String | | productOrderItem.itemPrice.price.taxIncludeAmount.value | Price of product, including any tax. Data type: Number | | productOrderItem.itemPrice.priceType | Type of item price, recurring or non-recurring. Data type: String | | productOrderItem.itemPrice.recurringChargePeriod | If the price is recurring, the recurring period, such as month. Data type: String | | productOrderItem.product | Description of the instance details of the product purchased by the customer. Data type: Object "product": { "id": "String", "place": {Object}, "productCharacteristic": [Array], "productSpecification": {Object}, "relatedParty": {Object}, "@type": "String" } | | productOrderItem.product.id | Unique identifier of the product sold. Located in the sys_id or sn_ind_tmt_orm_external_id field of the Product Inventory \[sn_ind_tmt_orm_product_inventory\] table. Data type: String | | productOrderItem.product.place | Maps of the locations on which to install the product. Data type: Object "place": { "id": "String", "@type": "String" } | | productOrderItem.product.place.id | Sys_id of the associated location record in the Location \[cmn_location\] table. Data type: String | | productOrderItem.product.productCharacteristic | Array of objects that describe the characteristics of the associated product. Data type: Array "productCharacteristic": [ { "name": "String", "previousValue": "String", "value": "String" } ] | | productOrderItem.product.productCharacteristic.name | Name of the characteristic record to associate with the product. Located in the Characteristic \[sn_prd_pm_characteristic\] table. Data type: String | | productOrderItem.product.productCharacteristic.previousValue | Previous characteristic option values if the update is for a change order. The request is a change order if the productOrderItem.action parameter is other than add. For additional information on characteristic option values, see [Create product characteristics and characteristic options](https://www.servicenow.com/docs/access?context=som-product-config-add-characteristics&version=xanadu&pubname=xanadu-order-management&ft:locale=en-US). Data type: String | | productOrderItem.product.productCharacteristic.value | Characteristic option values associated with the product. For additional information on characteristic option values, see [Create product characteristics and characteristic options](https://www.servicenow.com/docs/access?context=som-product-config-add-characteristics&version=xanadu&pubname=xanadu-order-management&ft:locale=en-US). Data type: String | | productOrderItem.product.productSpecification | Description of the product specification associated with the product. Data type: Object "productSpecification": { "id": "String", "internalVersion": "String", "name": "String", "version": "String", "@type": "String" } | | productOrderItem.product.productSpecification.id | Initial_version or external_id of the product 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 Product Specification \[sn_prd_pm_product_specification\] table. Data type: String | | productOrderItem.product.productSpecification.name | Name of the product specification. Located in the Product Specification \[sn_prd_pm_product_specification\] table. Data type: String | | productOrderItem.product.productSpecification.@type | Part of the TMF Open API standard. This value is always ProductSpecificationRef. This information is not stored. Data type: String | | productOrderItem.product.relatedParty | List of contacts for line items. Data type: Array "relatedParty": [ { "email": "String", "firstName": "String", "id": "String", "lastName": "String", "phone": "String", "@referredType": "String", "@type": "String" } ] | | productOrderItem.product.relatedParty.email | Email address of the contact. Data type: String | | productOrderItem.product.relatedParty.firstName | First name of the contact. Data type: String | | productOrderItem.product.relatedParty.id | Sys_id of the line item contact associated with the order line item. Located in the Order Line Item Contact \[sn_ind_tmt_orm_order_line_item_contact\] table. Data type: String | | productOrderItem.product.relatedParty.lastName | Last name of the contact. Data type: String Data type: String | | productOrderItem.product.relatedParty.phone | Business phone number of the contact. Data type: String | | productOrderItem.product.relatedParty.@referredType | Type of customer. Possible value: OrderLineItemContact Data type: String | | productOrderItem.product.relatedParty.@type | 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 | | productOrderItem.product.@type | Part of TMF Open API standard. Annotation for the product. This value is always Product. This information is not stored. Data type: String | | productOrderItem.productOffering | Description of the product offering associated with the product. Data type: Object "productOffering": { "id": "String", "internalVersion": "String", "name": "String", "version": "String" } | | productOrderItem.productOffering.id | Initial_version or external_id of the product offering. The initial_version is the sys_id of the first version of the offering. Located in the sys_id or external_id field of the Product Offering \[sn_prd_pm_product_offering\] table. Data type: String | | productOrderItem.productOffering.name | Name of the product offering. Located in the Product Offering \[sn_prd_pm_product_offering\] table. Data type: String | | productOrderItem.productOrderItemRelationship | Array of objects that describe the relationships between order line items. Data type: Array "productOrderItemRelationship": [ { "id": "String", "relationshipType": "String" } ] | | productOrderItem.productOrderItemRelationship.id | 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 | | productOrderItem.productOrderItemRelationship.relationshipType | Type of relationship between the two line items. This information is used to identify the relationship hierarchy. Data type: String | | productOrderItem.quantity | Number of the associated items to order. Data type: Number | | productOrderItem.state | Current state of the product order item. Data type: String | | productOrderItem.@type | Part of TMF Open API standard. Annotation for the product. This value is always ProductOrderItem. This information is not stored. Data type: String | | relatedParty | List of contacts for the order. Each contact is an object in the array. Must list at least one item which contains customer account or consumer account information. Data type: Array "relatedParty": [ { "id": "String", "name": "String", "@referredType": "String", "@type": "String" } ] | | relatedParty.id | Sys_id or external_id of the account, customer contact, or consumer associated with the order. Located in the Account \[customer_account\], Contact \[customer_contact\] table, or Consumer \[csm_consumer\] table. Data type: String | | relatedParty.name | Name of the account, customer, or consumer. Data type: String | | relatedParty.type | Type of customer. Possible values: * Consumer * Customer * CustomerContact {#tmf_prod_order-PATCH-productorder-id__d3046e2459} Data type: String | | requestedCompletionDate | Delivery date requested by the customer. Data type: String | | requestedStartDate | Order start date requested by the customer. Data type: String | | state | Current state of the order. Data type: String | | @type | Part of TMF Open API standard. Annotation for the product. This value is always ProductOrder. This information is not stored. Data type: String | [ ] {#tmf_prod_order-PATCH-productorder-id__table_c1v_xpk_5rb} ### cURL request {#tmf_prod_order-PATCH-productorder-id__example_jsc_1dc_vrb} The following code example updates the channel for a customer order. curl -X PATCH "https://instance.servicenow.com/api/sn_ind_tmt_orm/productorder/6be0a925c3a220103e2e73ce3640ddfe" \ -H "Accept: application/json" \ -H "Content-Type: application/json" \ -u "username":"password" \ -d { "channel": [ { "id": "1", "name": "Agent Assist" } ] } Response body. { "requestedCompletionDate": "2021-05-02T08:13:59.506Z", "requestedStartDate": "2020-05-03T08:13:59.506Z", "externalId": "PO-456", "channel": [ { "id": "1", "name": "Agent Assist" } ], "note": [ { "text": "This is a TMF product order illustration" }, { "text": "This is a TMF product order illustration no 2" } ], "productOrderItem": [ { "id": "POI100", "quantity": 1, "action": "change", "actionReason":"adding service package OLI", "product": { "id": "fa6d13f45b5620102dff5e92dc81c77f", "@type": "Product", "productSpecification": { "id": "cfe5ef6a53702010cd6dddeeff7b12f6", "name": "SD-WAN Service Package", "@type": "ProductSpecificationRef" }, "place": { "id": "25ab9c4d0a0a0bb300f7dabdc0ca7c1c", "@type": "Place" } }, "productOffering": { "id": "69017a0f536520103b6bddeeff7b127d", "name": "Premium SD-WAN Offering" }, "productOrderItemRelationship": [ { "id": "POI120", "relationshipType": "HasChild" }, { "id": "POI130", "relationshipType": "HasChild" } ], "@type": "ProductOrderItem", "state": "new" }, { "id": "POI120", "quantity": 1, "action": "change", "actionReason":"adding service package OLI", "itemPrice": [ { "priceType": "recurring", "recurringChargePeriod": "month", "price": { "taxIncludedAmount": { "unit": "USD", "value": 20 } } } ], "product": { "id": "766d13f45b5620102dff5e92dc81c78a", "@type": "Product", "productCharacteristic": [ { "name": "WAN Optimization", "value": "Base", "previousValue": "Advance" } ], "productSpecification": { "id": "39b627aa53702010cd6dddeeff7b1202", "name": "SD-WAN Edge Device", "@type": "ProductSpecificationRef" }, "relatedParty": [ { "id": "51670151c35420105252716b7d40ddfe", "firstName": "Joe", "lastName": "Doe", "email": "abc@example.com", "phone": "1234567890", "@type": "RelatedParty", "@referredType": "OrderLineItemContact" } ], "place": { "id": "25ab9c4d0a0a0bb300f7dabdc0ca7c1c", "@type": "Place" } }, "productOffering": { "id": "69017a0f536520103b6bddeeff7b127d", "name": "Premium SD-WAN Offering" }, "productOrderItemRelationship": [ { "id": "POI100", "relationshipType": "HasParent" } ], "@type": "ProductOrderItem", "state": "new" }, { "id": "POI130", "quantity": 1, "action": "add", "actionReason":"adding service package OLI", "itemPrice": [ { "priceType": "recurring", "recurringChargePeriod": "month", "price": { "taxIncludedAmount": { "unit": "USD", "value": 20 } } } ], "product": { "@type": "Product", "productCharacteristic": [ { "name": "Security Type", "value": "Base", "previousValue": "Advance" } ], "productSpecification": { "id": "a6514bd3534560102f18ddeeff7b1247", "name": "SD-WAN Security", "@type": "ProductSpecificationRef" }, "relatedParty": [ { "id": "51670151c35420105252716b7d40ddfe", "firstName": "Joe", "lastName": "Doe", "email": "abc@example.com", "phone": "1234567890", "@type": "RelatedParty", "@referredType": "OrderLineItemContact" } ], "place": { "id": "25ab9c4d0a0a0bb300f7dabdc0ca7c1c", "@type": "Place" } }, "productOffering": { "id": "69017a0f536520103b6bddeeff7b127d", "name": "Premium SD-WAN Offering" }, "productOrderItemRelationship": [ { "id": "POI100", "relationshipType": "HasParent" } ], "@type": "ProductOrderItem", "state": "new" } ], "relatedParty": [ { "id": "eaf68911c35420105252716b7d40ddde", "name": "Sally Thomas", "@type": "RelatedParty", "@referredType": "CustomerContact" }, { "id": "ffc68911c35420105252716b7d40dd55", "name": "Funco Intl", "@type": "RelatedParty", "@referredType": "Customer" }, { "id": "59f16de1c3b67110ff00ed23a140dd9e", "name": "Funco External", "@type": "RelatedParty", "@referredType": "Consumer" } ], "@type": "ProductOrder", "id": "6be0a925c3a220103e2e73ce3640ddfe", "state": "in_progress" } ## Product Order Open API - POST /sn_ind_tmt_orm/cancelproductorder {#ariaid-title8} Cancels the specified customer order. ### URL format Default URL: /api/sn_ind_tmt_orm/cancelproductorder ### Supported request parameters {#tmf_prod_order-POST-cancelproductorder__entry__2} | Name | Description | |-|-| | None | | [Table 37. Path parameters] {#tmf_prod_order-POST-cancelproductorder__entry__6} | Name | Description | |-|-| | None | | [Table 38. Query parameters] {#tmf_prod_order-POST-cancelproductorder__entry__10} | Name | Description | |-|-| | cancellationReason | Reason for cancellation. Data type: String Default: Blank string | | productOrder | Contains data about the product order. Data type: Object "productOrder": { "id": "String", "href": "String", "@referredType": "String" } | | productOrder.id | Required. Sys_id of the customer order to cancel. Located in the Customer Order \[sn_ind_tmt_orm_order\] table. Data type: String | | productOrder.href | URL of the customer order to cancel. Data type: String Default: Blank string | | productOrder.@referredType | The value for this parameter should be `ProductOrder`. Data type: String Default: Blank string | | requestedCancellationDate | Date to cancel the order. Data type: String Default: Blank string | | @type | The value for this parameter should be `CancelProductOrder`. Data type: String Default: Blank string | [Table 39. Request body parameters (JSON)] ### 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](https://servicenow-prod.fluidtopics.net/2vuQj3~2s_niNXyXhrbRZA "REST (REpresentational State Transfer) is a simple stateless architecture that provides standards between computer systems on the web, making it easier for them to communicate with each other."). {#tmf_prod_order-POST-cancelproductorder__table_omb_dvk_5rb__entry__2}{#tmf_prod_order-POST-cancelproductorder__accept-JSON-only-entry-RESTAPI}{#tmf_prod_order-POST-cancelproductorder__content_type-JSON-only-entry-RESTAPI} | 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. | [Table 40. Request headers] {#tmf_prod_order-POST-cancelproductorder__table_omb_dvk_5rb} {#tmf_prod_order-POST-cancelproductorder__table_tzy_thy_ksb__entry__2} | Header | Description | |-|-| | Content-Type | Data format of the response body. Only supports application/json. | [Table 41. Response headers] {#tmf_prod_order-POST-cancelproductorder__table_tzy_thy_ksb} ### 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](https://servicenow-prod.fluidtopics.net/2vuQj3~2s_niNXyXhrbRZA "REST (REpresentational State Transfer) is a simple stateless architecture that provides standards between computer systems on the web, making it easier for them to communicate with each other."). {#tmf_prod_order-POST-cancelproductorder__entry__36} | Status code | Description | |-|-| | 200 | Successful. The request was successfully processed. | | 400 | Bad Request. Could be any of the following reasons: * Empty payload. * Invalid payload. Mandatory field missing: \. * Invalid order ID. * Invalid order ID: This order is yet to be created in customer order table. The cancel request was made for an order that has not been created yet. The order is in the Inbound Queue \[sn_tmt_core_inbound_queue\] table waiting for the scheduler to pick up the record. {#tmf_prod_order-POST-cancelproductorder__ul_lg1_5vt_5rb} | [Table 42. Status codes] ### Response body parameters (JSON) {#tmf_prod_order-POST-cancelproductorder__entry__42} | Name | Description | |-|-| | cancellationReason | Reason for cancellation. Data type: String | | href | URL of the cancelled order. Data type: String | | id | Sys_id of the cancelled order. Data type: String | | productOrder | Contains data about the product order. Data type: Object "productOrder": { "id": "String", "href": "String", "@referredType": "String" } | | productOrder.id | Sys_id of the cancelled order. Data type: String | | productOrder.href | URL of the cancelled order. Data type: String | | productOrder.@referredType | The value for this parameter is `ProductOrder`. Data type: String | | requestedCancellationDate | Date to cancel the order. Data type: String | | state | State of the cancellation. If the cancellation request was successfully processed (201 status code), the value for this parameter is `done`. Data type: String | | @type | The value for this parameter is `CancelProductOrder`. Data type: String | [ ] ### cURL request The following code example cancels a customer order. curl -X POST "https://instance.servicenow.com/api/sn_ind_tmt_orm/cancelproductorder" \ -H "Accept: application/json" \ -H "Content-Type: application/json" \ -u "username":"password" \ -d { "cancellationReason": "Duplicate order", "requestedCancellationDate": "2019-04-30T12:56:21.931Z", "productOrder": { "id": "163ee2805358811032a4ddeeff7b122d", "href": "https://instance.servicenow.com/productOrderingManagement/v4/productOrder/64a9607feb45301032a442871352285b", "@referredType": "ProductOrder" }, "@type": "CancelProductorder" } { "id": "163ee2805358811032a4ddeeff7b122d", "href": "https://instance.servicenow.com/productOrderingManagement/v4/productOrder/64a9607feb45301032a442871352285b", "cancellationReason": "Duplicate order", "requestedCancellationDate": "2019-04-30T12:56:21.931Z", "@type": "CancelProductorder", "productOrder": { "id": "163ee2805358811032a4ddeeff7b122d", "href": "https://instance.servicenow.com/productOrderingManagement/v4/productOrder/64a9607feb45301032a442871352285b", "@referredType": "ProductOrder" }, "state": "done" } ## Product Order Open API - POST /sn_ind_tmt_orm/order/productOrder {#ariaid-title9} Creates the specified customer order and customer order line items. Once processed, records are created in the following tables: * Customer Order \[sn_ind_tmt_orm_order\] * Order Characteristic \[sn_ind_tmt_orm_order_characteristic_value\] * Order Line Item \[sn_ind_tmt_orm_order_line_item\] * Order Line Item Contact \[sn_ind_tmt_orm_order_line_item_contact\] * Order Line Related Items \[sn_ind_tmt_orm_order_line_related_items\] {#tmf_prod_order-POST-ord-productOrder__ul_hxq_vdb_hqb} ### URL format Default URL: /api/sn_ind_tmt_orm/order/productOrder ### Supported request parameters {#tmf_prod_order-POST-ord-productOrder__entry__2} | Name | Description | |-|-| | None | | [Table 43. Path parameters] {#tmf_prod_order-POST-ord-productOrder__entry__6} | Name | Description | |-|-| | mode | Enables asynchronous order processing.​ That is, the order is added to the Inbound Queue \[sn_tmt_core_inbound_queue\] table to be created. If not included, the order is processed synchronously. Possible value: async Data type: String | [Table 44. Query parameters] {#tmf_prod_order-POST-ord-productOrder__id_vk2_p5n_t4b__entry__2}{#tmf_prod_order-POST-ord-productOrder__due-date-entry}{#tmf_prod_order-POST-ord-productOrder__productOrder-href-request}{#tmf_prod_order-POST-ord-productOrder__productOrder-addReason-request}{#tmf_prod_order-POST-ord-productOrder__due-date-item-entry}{#tmf_prod_order-POST-ord-productOrder__externalProductInventory-GET-desc-request}{#tmf_prod_order-POST-ord-productOrder__externalProductInventoryId-desc} | Name | Description | |-|-| | channel | Array of objects that describe the channels to use for selling the products. Data type: Array "channel": [ { "id": "String", "name": "String" } ] Table/field updated: sn_ind_tmt_orm_order | | channel.id | Required. Unique identifier of the channel to use to sell the associated products. Channel ID values are located in the external_id field of the Distribution Channel \[sn_prd_pm_distribution_channel\] table. Data type: String Table/field updated: sn_ind_tmt_orm_order/channel Default: Blank string | | channel.name | Name of the channel to use to sell the associated products. Possible channel names are defined on the Choice List tab in the Channel Dictionary Entry of the sn_ind_tmt_orm_order table. Data type: String Default: Blank string | | committedDueDate | Date and time when the action must be performed on the order. This value must be the same as or later than the committedDueDate values for each order line item. Data type: String Table/field updated: sn_ind_tmt_orm_order/committed_due_date | | externalId | Unique identifier for the customer order. This value is determined by an external system. Data type: String Table/field updated: sn_ind_tmt_orm_order/external_id Default: Blank string | | href | A relative link to the resource record. Data type: String Default: Blank string | | note | Array of objects that contain additional notes made by the customer when ordering. Data type: Array "note": [ { "text": "String" } ] Table/field updated: sn_ind_tmt_orm_order | | note.text | Required. Additional notes/comments made by the customer while ordering. Data type: String Table/field updated: sn_ind_tmt_orm_order/comments Default: Blank string | | orderCurrency | Required. Currency code for the order and order line items. The currency must be the same for all elements of the order and order line items, otherwise an error is returned and the order isn't created. Once an order is created, its currency code can't be changed. Data type: String | | productOrderItem | Required. Array of objects that describe items associated with the product order and their associated action. Data type: Array "productOrderItem": [ { "action": "String", "actionReason": "String", "committedDueDate": "String", "externalProductInventory": [Array], "id": "String", "itemPrice": [Array], "product": {Object}, "productOffering": {Object}, "productOrderItemRelationship": [Array], "quantity": Number, "@type": "String" } ] Table/field updated: sn_ind_tmt_orm_order_line_item | | productOrderItem.action | Required. Action to carry out on the product. Possible actions are defined on the Choice List tab in the Action Dictionary Entry of the sn_ind_tmt_orm_order_line_item table. Possible values: * add * change * delete * no-change * resume * suspend {#tmf_prod_order-POST-ord-productOrder__ul_qbd_dyp_ysb} Data type: String Table/field updated: sn_ind_tmt_orm_order_line_item/action | | productOrderItem.actionReason | Optional. Description of the reason for the order line item. Data type: String Table/field updated: sn_ind_tmt_orm_order_line_item/action_reason | | productOrderItem.committedDueDate | Date and time when the action must be performed on the order line item. Data type: String Table/field updated: sn_ind_tmt_orm_order_line_item/committed_due_date | | productOrderItem.externalProductInventory | Array of objects containing external ids to map to the product inventories created for the order. Data type: Array of objects "externalProductInventory": [ { "externalProductInventoryId": "String" } ] | | productOrderItem.externalProductInventory.externalProductInventoryId | External id to map to the product inventory. Data type: String Table/field updated: sn_ind_tmt_orm_order_line_item/external_inventory_id and sn_prd_invt_product_inventory/sn_prd_invt_external_id | | productOrderItem.id | Required. Unique identifier of the line item. Data type: String Table/field updated: sn_ind_tmt_orm_order_line_item/external_id Maximum length: 40 Default: Blank string | | productOrderItem.itemPrice | Array of objects that describe the price associated with the product. Data type: Array "itemPrice": [ { "price": {Object}, "priceType": "String", "recurringChargePeriod": "String" } ] Table updated: sn_ind_tmt_orm_order Default: Blank string | | productOrderItem.itemPrice.price | Description of the price of the associated product. Data type: Object "price": { "taxIncludedAmount": {Object} } Table updated: sn_ind_tmt_orm_order_line_item Default: Blank string | | productOrderItem.itemPrice.price.taxIncludedAmount | Description of the price of the associated product, including the tax. Data type: Object "taxIncludedAmount": { "unit": "String", "value": Number } Table updated: sn_ind_tmt_orm_order_line_item | | productOrderItem.itemPrice.price.taxIncludedAmount.unit | Currency code in which the price is depicted. Data type: String Table/field updated: sn_ind_tmt_orm_order_line_item/mrc or nrc | | productOrderItem.itemPrice.price.taxIncludedAmount.value | Price of product, including any tax. Data type: Number Table/field updated: sn_ind_tmt_orm_order_line_item/mrc or nrc | | productOrderItem.itemPrice.priceType | Specifies whether the price of the item is recurring or non-recurring. Data type: String | | productOrderItem.itemPrice.recurringChargePeriod | If the price is recurring, specifies the recurring period, such as month. Data type: String | | productOrderItem.product | Required if productOrderItem.action is change or delete. Description of the instance details of the product purchased by the customer. Data type: Object "product": { "id": "String", "place": {Object}, "productCharacteristic": [Array], "productSpecification": {Object}, "relatedParty": {Object}, "@type": "String" } Table/field updated: sn_ind_tmt_orm_order_line_item | | productOrderItem.product.id | Required if productOrderItem.action is change or delete. Unique identifier of the product sold. Located in the sys_id or sn_ind_tmt_orm_external_id field of the Product Inventory \[sn_ind_tmt_orm_product_inventory\] table. Data type: String Default: Blank string | | productOrderItem.product.place | Maps of the locations on which to install the product. Data type: Object "place": { "id": "String", "@type": "String" } Table/field updated: sn_ind_tmt_orm_order_line_item | | productOrderItem.product.place.id | Required. Sys_id of the associated location record in the Location \[cmn_location\] table. Data type: String Table/field updated: sn_ind_tmt_orm_order_line_item/location | | productOrderItem.product.place.@type | 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 | | productOrderItem.product.productCharacteristic | Array of objects that describe the characteristics of the associated product. Data type: Array "productCharacteristic": [ { "name": "String", "previousValue": "String", "value": "String" } ] Table/field updated: sn_ind_tmt_orm_order_characteristic_value | | productOrderItem.product.productCharacteristic.name | Name of the characteristic record to associated with the product. Located in the Characteristic \[sn_prd_pm_characteristic\] table. Data type: String Table/field updated: sn_ind_tmt_orm_order_characteristic_value/characteristics Default: Blank string | | productOrderItem.product.productCharacteristic.previousValue | Previous characteristic option values if the update is for change order. The request is a change order if the productOrderItem.action parameter is other than add. For additional information on characteristic option values, see [Create product characteristics and characteristic options](https://www.servicenow.com/docs/access?context=som-product-config-add-characteristics&version=xanadu&pubname=xanadu-order-management&ft:locale=en-US). Data type: String Table/field updated: sn_ind_tmt_orm_order_characteristic_value/previous_characteristic_option_value Default: Blank string | | productOrderItem.product.productCharacteristic.value | Characteristic option values associated with the product. For additional information on characteristic option values, see [Create product characteristics and characteristic options](https://www.servicenow.com/docs/access?context=som-product-config-add-characteristics&version=xanadu&pubname=xanadu-order-management&ft:locale=en-US). Data type: String Table/field updated: sn_ind_tmt_orm_order_characteristic_value/characteristic_option_value Default: Blank string | | productOrderItem.product.productSpecification | Required. Description of the product specification associated with the product. Note: Change orders (productOrderItem.action is `change`) are processed differently based on the value of the sn_ind_tmt_orm.allowSpecVersionUpdateInChangeOrder system property. The value of this system property determines how the order is processed if the product inventory is a different version than indicated in the order. * When this system property is set to true (default), the product inventory is automatically upgraded to the version in the order by changing the referenced product specification. This allows the order to be successfully processed. * When this system property is set to false, if the product inventory is a different version than indicated in the order, the order fails due to the version mismatch. {#tmf_prod_order-POST-ord-productOrder__ul_zbw_sdz_dbc} Data type: Object "productSpecification": { "id": "String", "internalVersion": "String", "name": "String", "version": "String", "@type": "String" } Table/field updated: sn_ind_tmt_orm_order_line_item | | productOrderItem.product.productSpecification.id | Required. Initial_version or external_id of the product 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 Product Specification \[sn_prd_pm_product_specification\] table. Data type: String | | productOrderItem.product.productSpecification.internalVersion | Version of the product specification. Located in the Product Specification \[sn_prd_pm_product_specification\] table. Data type: String | | productOrderItem.product.productSpecification.name | Name of the product specification. Located in the Product Specification \[sn_prd_pm_product_specification\] table. Data type: String | | productOrderItem.product.productSpecification.version | External_version of the product specification. Located in the Product Specification \[sn_prd_pm_product_specification\] table. Data type: String | | productOrderItem.product.productSpecification.@type | Part of the TMF Open API standard. This value is always ProductSpecificationRef. This information is not stored. Data type: String | | productOrderItem.product.relatedParty | Array of objects that describe the party role linked to an OrderLineItemContact. Data type: Array "relatedParty": [ { "email": "String", "firstName": "String", "lastName": "String", "phone": "String", "@referredType": "String", "@type": "String" } ] Table/field updated: sn_ind_tmt_orm_order_line_item_contact | | productOrderItem.product.relatedParty.email | Email address of the contact. Data type: String Table/field updated: sn_ind_tmt_orm_order_line_item_contact/email Default: Blank string | | productOrderItem.product.relatedParty.firstName | First name of the contact. Data type: String Table/field updated: sn_ind_tmt_orm_order_line_item_contact/first_name Default: Blank string | | productOrderItem.product.relatedParty.lastName | Last name of the contact. Data type: String Table/field updated: sn_ind_tmt_orm_order_line_item_contact/lastName Default: Blank string | | productOrderItem.product.relatedParty.phone | Business phone number of the contact. Data type: String Table/field updated: sn_ind_tmt_orm_order_line_item_contact/business_phone Default: Blank string | | productOrderItem.product.relatedParty.@referredType | Required. Type of customer. Possible value -- OrderLineItemContact Data type: String | | productOrderItem.product.relatedParty.@type | 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 | | productOrderItem.product.@type | Part of TMF Open API standard. Annotation for the product. This value is always Product. This information is not stored. Data type: String | | productOrderItem.productOffering | Required. Description of the product offering associated with the product. Data type: Object "productOffering": { "id": "String", "internalVersion": "String", "name": "String", "version": "String" } Table updated: sn_ind_tmt_orm_order_line_item | | productOrderItem.productOffering.id | Required. Initial_version or external_id of the product offering. The initial_version is the sys_id of the first version of the offering. Located in the sys_id or external_id field of the Product Offering \[sn_prd_pm_product_offering\] table. Data type: String | | productOrderItem.productOffering.internalVersion | Version of the product offering. Located in the Product Offering \[sn_prd_pm_product_offering\] table. Data type: String | | productOrderItem.productOffering.name | Name of the product offering. Located in the Product Offering \[sn_prd_pm_product_offering\] table. Data type: String | | productOrderItem.productOffering.version | External_version of the product offering. Located in the Product Offering \[sn_prd_pm_product_offering\] table. Data type: String | | productOrderItem.productOrderItem.quantity | Number of the associated items to order. Data type: Number Table/field updated: sn_ind_tmt_orm_order/quantity Default: null | | productOrderItem.productOrderItemRelationship | Required. Array of objects that describe the parent/child relationship between order items. Data type: Array "productOrderItemRelationship": [ { "id": "String", "relationshipType": "String" } ] Table/field updated: sn_ind_tmt_orm_order_line_item | | productOrderItem.productOrderItemRelationship.id | Required. Same as the productOrderItem.id value. Used for parent/child relationship Data type: String Table/field updated: sn_ind_tmt_orm_order_line_item/parent_line_item Default: Blank string | | productOrderItem.productOrderItemRelationship.relationshipType | Required. Type of relationship between the two line items. This information is used to identify relationship hierarchy. Possible values: * HasChild * HasParent {#tmf_prod_order-POST-ord-productOrder__ul_rmq_vrk_5rb} Data type: String | | productOrderItem.quantity | Number of items ordered. Data type: Number Table/field updated: sn_ind_tmt_orm_order/quantity Default: Blank string | | productOrderItem.@type | Part of TMF Open API standard. Annotation for the product. This value is always ProductOrderItem. This information is not stored. Data type: String | | relatedParty | List of contacts for the order. Each contact is an object in the array. Must list at least one item which contains customer account or consumer account information. Data type: Array "relatedParty": [ { "id": "String", "name": "String", "@referredType": "String", "@type": "String" } ] | | relatedParty.id | Sys_id or external_id of the account or customer contact associated with the order. Located in either the account \[customer_account\], Contact \[customer_contact\] table, or Consumer \[csm_consumer\] table. Data type: String | | relatedParty.name | Name of the account, customer, or consumer. Data type: String | | relatedParty.@referredType | Required. Type of customer. Possible values: * Consumer * Customer * CustomerContact {#tmf_prod_order-POST-ord-productOrder__ul_smq_vrk_5rb} Data type: String | | relatedParty.@type | Part of TMF Open API standard. Annotation for the product. This value is always RelatedParty. This information is not stored. Data type: String | | requestedCompletionDate | Delivery date requested by the customer. Data type: String Table/field updated: sn_ind_tmt_orm_order/expected_end_date Default: Blank string | | requestedStartDate | Order start date requested by the customer. Data type: String Table/field updated: sn_ind_tmt_orm_order/expected_start_date Default: Blank string | | @type | Part of TMF Open API standard. Annotation for the product. This value is always ProductOrder. This information is not stored. Data type: String | [Table 45. Request body parameters (JSON)] {#tmf_prod_order-POST-ord-productOrder__id_vk2_p5n_t4b} ### 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](https://servicenow-prod.fluidtopics.net/2vuQj3~2s_niNXyXhrbRZA "REST (REpresentational State Transfer) is a simple stateless architecture that provides standards between computer systems on the web, making it easier for them to communicate with each other."). {#tmf_prod_order-POST-ord-productOrder__table_omb_dvk_5rb__entry__2}{#tmf_prod_order-POST-ord-productOrder__accept-JSON-only-entry-RESTAPI}{#tmf_prod_order-POST-ord-productOrder__content_type-JSON-only-entry-RESTAPI} | 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. | [Table 46. Request headers] {#tmf_prod_order-POST-ord-productOrder__table_omb_dvk_5rb} {#tmf_prod_order-POST-ord-productOrder__table_tzy_thy_ksb__entry__2} | Header | Description | |-|-| | Content-Type | Data format of the response body. Only supports application/json. | [Table 47. Response headers] {#tmf_prod_order-POST-ord-productOrder__table_tzy_thy_ksb} ### 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](https://servicenow-prod.fluidtopics.net/2vuQj3~2s_niNXyXhrbRZA "REST (REpresentational State Transfer) is a simple stateless architecture that provides standards between computer systems on the web, making it easier for them to communicate with each other."). {#tmf_prod_order-POST-ord-productOrder__entry__152} | Status code | Description | |-|-| | 201 | 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: * The following Order Item characteristics does not exist: Review specification \ and correct the characteristic and characteristic option in the order line item prior to approving the order. * Order Item characteristic: \ with characteristic value: \is invalid. Correct the characteristic values before approving the order. {#tmf_prod_order-POST-ord-productOrder__ul_xtx_xym_t4b} | | 202 | Accepted. Successful request for an order in asynchronous mode. That is, the request was made with the mode parameter set to `async` and the record is scheduled to be processed in the Inbound Queue \[sn_tmt_core_inbound_queue\] table. | | 400 | Bad Request. Could be any of the following reasons: * Invalid payload: Request body missing - Payload was not passed in the request body. * Invalid payload: productOrderItem is missing - Product order line item object or JSON is missing. * Invalid payload: productOrderItem id is missing - The id parameter is missing in the product order line item of the payload. * Invalid payload: productOrderItem action is missing - The action parameter is missing in the product order line item of the payload. * Invalid payload: productOrderItem productOffering is missing - The product offering object or JSON is missing from the product order line item in the payload. * Invalid payload: productOffering id is missing - The id parameter is missing in the product order line item of the product offering object in the payload. * Invalid payload: Product offering does not exist - The product offering in the product order line item is not valid. * Invalid payload: productOrderItem product is missing - The product object or JSON in the product order line item is missing from the payload. * Invalid payload: product productSpecification is missing - The product specification object or JSON in the product order line item is missing from the payload. * Invalid payload: productSpecification id is missing - The id parameter in the product order line item of the product specification object is missing from the payload. * Invalid payload: Product specification does not exist - The product specification in the product order line item is not valid. * Invalid payload: Product Inventory does not exist - In a change order (action = change), the quantity of an item is greater than what is in stock. * Invalid payload: Product inventory ID is missing - In change order, the product.id is missing in the payload. * Invalid payload: Sold Product is inactive - In a change order, a product specified in the payload is inactive. * Invalid payload: relatedParty is missing - The related party object is missing from the payload. * Invalid payload: Customer Account or Consumer is missing - The related party customer or consumer object is missing from the payload. * Invalid payload: Consumer does not exist - The specified related party consumer does not exist in the ServiceNow instance. * Invalid payload: Customer Account does not exist - The specified related party customer does not exist in the ServiceNow instance. * Invalid payload: Order creation failed - Not able to create the requested order. * Invalid payload: orderCurrency is required - The orderCurrency parameter is missing from the payload. * Inactive Currency Code: \ - The provided currency is inactive in the ServiceNow instance. * One or more line items has a different currency code than the order currency - All line items do not have the same currency code as the order currency. * In-flight revision to order currency not supported - The orderCurrency parameter can't be updated after the order is created. {#tmf_prod_order-POST-ord-productOrder__ul_g2v_rzm_t4b} | [Table 48. Status codes] ### Response body parameters (JSON) {#tmf_prod_order-POST-ord-productOrder__entry__160}{#tmf_prod_order-POST-ord-productOrder__externalProdInv-resp-descr}{#tmf_prod_order-POST-ord-productOrder__externalProdInvId-resp-descr} | Name | Description | |-|-| | channel | Array of objects that describe the channels to use for selling the products. Data type: Array "channel": [ { "id": "String", "name": "String" } ] | | channel.id | Unique identifier of the channel to use to sell the associated products. Channel ID values are located in the external_id field of the Distribution Channel \[sn_prd_pm_distribution_channel\] table. Data type: String | | channel.name | Name of the channel to use to sell the associated products. Data type: String | | committedDueDate | Date and time when the action must be performed on the order. This value must be the same as or later than the committedDueDate values for each order line item. Data type: String | | externalId | External identifier for the customer order, such as a purchase order number. Data type: String | | href | Relative link to the product order record. Data type: String | | id | Sys_id of the customer order created for this request. Data type: String | | note | Array of objects that describe additional notes made by the customer when ordering. Data type: Array "note": [ { "text": "String" } ] | | note.text | Additional notes/comments made by the customer while ordering. Data type: String | | orderCurrency | Currency code for the order and order line items. Data type: String | | orderId | 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. Note: This value is the only result if the order is created asynchronously using the mode query parameter. { "orderId": "b0fc877ac3ab5110856d73ce3640dde0" } Data type: String | | productOrderItem | List that describes items associated with the product order and their associated action. Data type: Array "productOrderItem:" [ { "action": "String", "committedDueDate": "String", "externalProductInventory": [Array], "id": "String", "itemPrice": [Array], "product": {Object}, "productOffering": {Object}, "productOrderItemReleationship": [Array], "quantity": Number, "state": "String", "@type": "String" } ] | | productOrderItem.action | Action to carry out on the product. Possible actions are defined on the Choice List tab in the Action Dictionary Entry of the sn_ind_tmt_orm_order_line_item table. Data type: String | | productOrderItem.actionReason | The reason for adding the order line item. Data type: String Table/field updated: sn_ind_tmt_orm_order_line_item/action_reason | | productOrderItem.committedDueDate | Date and time when the action must be performed on the order line item. Data type: String | | productOrderItem.externalProductInventory | Array of objects containing external ids mapped to the product inventories created for the order. Data type: Array "externalProductInventory": [ { "externalProductInventoryId": "String" } ] | | productOrderItem.externalProductInventory.externalProductInventoryId | External id mapped to the product inventory. Data type: String | | productOrderItem.id | 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 | | productOrderItem.itemPrice | Array of objects that describe the price associated with the product. Data type: Array "itemPrice": [ { "price": {Object}, "priceType": "String", "recurringChargePeriod": "String" } ] | | productOrderItem.itemPrice.price | Description of the price of the associated product. Data type: Object "price": { "taxIncludedAmount": {Object} } | | productOrderItem.itemPrice.price.taxIncludeAmount | Description of the price of the associated product, including the tax. Data type: Object "taxIncludedAmount": { "unit": "String", "value": Number } | | productOrderItem.itemPrice.price.taxIncludeAmount.unit | Currency code in which the price is depicted. Data type: String | | productOrderItem.itemPrice.price.taxIncludeAmount.value | Price of product, including any tax. Data type: Number | | productOrderItem.itemPrice.priceType | Type of item price, recurring or non-recurring. Data type: String | | productOrderItem.itemPrice.recurringChargePeriod | If the price is recurring, the recurring period, such as month. Data type: String | | productOrderItem.product | Description of the instance details of the product purchased by the customer. Data type: Object "product": { "id": "String", "place": {Object}, "productCharacteristic": [Array], "productSpecification": {Object}, "relatedParty": {Object}, "@type": "String" } | | productOrderItem.product.id | Unique identifier of the product sold. Located in the sys_id or sn_ind_tmt_orm_external_id field of the Product Inventory \[sn_ind_tmt_orm_product_inventory\] table. This parameter is only returned if productOrderItem.action is change or delete. If both sys_id and external_id are present, the external_id is returned. Data type: String | | productOrderItem.product.place | Maps of the locations on which to install the product. Data type: Object "place": { "id": "String", "@type": "String" } | | productOrderItem.product.place.id | Sys_id of the associated location record in the Location \[cmn_location\] table. Data type: String | | productOrderItem.product.productCharacteristic | Array of objects that describe the characteristics of the associated product. Data type: Array "productCharacteristic": [ { "name": "String", "previousValue": "String", "value": "String" } ] | | productOrderItem.product.productCharacteristic.name | Name of the characteristic record to associate with the product. Located in the Characteristic \[sn_prd_pm_characteristic\] table. Data type: String | | productOrderItem.product.productCharacteristic.previousValue | Previous characteristic option values if the update is for a change order. The request is a change order if the productOrderItem.action parameter is other than add. For additional information on characteristic option values, see [Create product characteristics and characteristic options](https://www.servicenow.com/docs/access?context=som-product-config-add-characteristics&version=xanadu&pubname=xanadu-order-management&ft:locale=en-US). Data type: String | | productOrderItem.product.productCharacteristic.value | Characteristic option values associated with the product. For additional information on characteristic option values, see [Create product characteristics and characteristic options](https://www.servicenow.com/docs/access?context=som-product-config-add-characteristics&version=xanadu&pubname=xanadu-order-management&ft:locale=en-US). Data type: String | | productOrderItem.product.productRelationship | List of product relationship details for an order line item. Data type: Array "productRelationship": [ { "id": "String", "relationshipType": "String" } ] | | productOrderItem.product.productRelationship.id | Sys_id or sn_prd_invt_external_id of the product inventory. Located in the sys_id or sn_prd_invt_external_id field of the Product Inventory \[sn_prd_invt_product_inventory\] table. Data type: String | | productOrderItem.product.productRelationship.relationshipType | Type of relationship between the order line item and the product inventory. Possible value: Requires Data type: String | | productOrderItem.product.productSpecification | Description of the product specification associated with the product. Data type: Object "productSpecification:" { "id": "String", "internalId": "String", "internalVersion": "String", "name": "String", "version": "String", "@type": "String" } | | productOrderItem.product.productSpecification.id | Initial_version or external_id of the product 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 Product Specification \[sn_prd_pm_product_specification\] table. If both sys_id and external_id are present, the external_id is returned. Data type: String | | productOrderItem.product.productSpecification.internalId | Initial_version of the product specification. The initial_version is the sys_id of the first version of the specification. Located in the Product Specification \[sn_prd_pm_product_specification\] table. Data type: String | | productOrderItem.product.productSpecification.internalVersion | Version of the product specification. Located in the Product Specification \[sn_prd_pm_product_specification\] table. Data type: String | | productOrderItem.product.productSpecification.name | Name of the product specification. Located in the Product Specification \[sn_prd_pm_product_specification\] table. Data type: String | | productOrderItem.product.productSpecification.version | External_version of the product specification. Located in the Product Specification \[sn_prd_pm_product_specification\] table. Data type: String | | productOrderItem.product.productSpecification.@type | Part of the TMF Open API standard. This value is always ProductSpecificationRef. This information is not stored. Data type: String | | productOrderItem.product.relatedParty | List of contacts for line items. Data type: Array "relatedParty:" [ { "email": "String", "firstName": "String", "lastName": "String", "phone": "String", "@referredType": "String", "@type": "String" } ] | | productOrderItem.product.relatedParty.email | Email address of the contact. Data type: String | | productOrderItem.product.relatedParty.firstName | First name of the contact. Data type: String | | productOrderItem.product.relatedParty.lastName | Last name of the contact. Data type: String Data type: String | | productOrderItem.product.relatedParty.phone | Business phone number of the contact. Data type: String | | productOrderItem.product.relatedParty.@referredType | Type of customer. Possible value: OrderLineItemContact Data type: String | | productOrderItem.product.relatedParty.@type | 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 | | productOrderItem.product.@type | Part of TMF Open API standard. Annotation for the product. This value is always Product. This information is not stored. Data type: String | | productOrderItem.productOffering | Description of the product offering associated with the product. Data type: Object "productOffering:" { "id": "String", "internalId": "String", "internalVersion": "String", "name": "String", "version": "String" } | | productOrderItem.productOffering.id | Initial_version or external_id of the product offering. The initial_version is the sys_id of the first version of the offering. Located in the sys_id or external_id field of the Product Offering \[sn_prd_pm_product_offering\] table. If both sys_id and external_id are present, the external_id is returned. Data type: String | | productOrderItem.productOffering.internalId | Initial_version of the product offering. The initial_version is the sys_id of the first version of the offering. Located in the Product Offering \[sn_prd_pm_product_offering\] table. Data type: String | | productOrderItem.productOffering.internalVersion | Version of the product offering. Located in the Product Offering \[sn_prd_pm_product_offering\] table. Data type: String | | productOrderItem.productOffering.name | Name of the product offering. Located in the Product Offering \[sn_prd_pm_product_offering\] table. Data type: String | | productOrderItem.productOffering.version | External_version of the product offering. Located in the Product Offering \[sn_prd_pm_product_offering\] table. Data type: String | | productOrderItem.productOrderItemRelationship | Array of objects that describe the relationships between order line items. Data type: Array "productOrderItemRelationship": [ { "id": "String", "relationshipType": "String" } ] | | productOrderItem.productOrderItemRelationship.id | 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 | | productOrderItem.productOrderItemRelationship.relationshipType | Type of relationship between the two line items. This information is used to identify the relationship hierarchy. Possible values: * HasChild * HasParent * Requires {#tmf_prod_order-POST-ord-productOrder__ul_yqf_2ty_54b} `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 | | productOrderItem.quantity | Number of the associated items to order. Data type: Number | | productOrderItem.state | Current state of the product order item. This value is always new. Data type: String | | productOrderItem.@type | Part of TMF Open API standard. Annotation for the product. This value is always ProductOrderItem. This information is not stored. Data type: String | | relatedParty | List of contacts for the order. Each contact is an object in the array. Must list at least one item which contains customer account or consumer account information. Data type: Array "relatedParty": [ { "id": "String", "name": "String", "@referredType": "String", "@type": "String" } ] | | relatedParty.id | Sys_id or external_id of the account, customer contact, or consumer associated with the order. Located in the Account \[customer_account\], Contact \[customer_contact\] table, or Consumer \[csm_consumer\] table. Data type: String | | relatedParty.name | Name of the account, customer, or consumer. Data type: String | | relatedParty.type | Type of customer. Possible values: * Consumer * Customer * CustomerContact {#tmf_prod_order-POST-ord-productOrder__ul_lcq_jwm_t4b} Data type: String | | requestedCompletionDate | Delivery date requested by the customer. Data type: String | | requestedStartDate | Order start date requested by the customer. Data type: String | | state | Current state of the order. For this endpoint, this value is always new. Data type: String | | @type | Part of TMF Open API standard. Annotation for the product. This value is always ProductOrder. This information is not stored. Data type: String | [ ] ### Processing asynchronously {#tmf_prod_order-POST-ord-productOrder__example_ynv_vhx_fwb} 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. curl -X POST 'https://instance.service-now.com/api/sn_ind_tmt_orm/order/productOrder?mode=async' \ -H "Accept: application/json" \ -H "Content-Type: application/json" \ -u "username":"password" \ -d '{ "requestedCompletionDate": "2021-05-02T08:13:59.506Z", "requestedStartDate": "2020-05-03T08:13:59.506Z", "orderDate": "2020-05-03T08:13:59.506Z", "externalId": "PO-4ddd56", "orderCurrency": "USD", "note": [ { "id": "1", "author": "Jean Pontus", "date": "2019-04-30T08:13:59.509Z", "text": "This is a TMF product order illustration" }, { "id": "2", "author": "Jean Pontus1", "date": "2019-04-30T08:13:59.509Z", "text": "This is a TMF product order illustration no 2" } ], "productOrderItem": [ { "id": "100", "quantity": 1, "action": "add", "actionReason":"adding service package OLI", "product": { "isBundle": false, "@type": "Product", "productSpecification": { "id": "cfe5ef6a53702010cd6dddeeff7b12f6", "name": "SD-WAN Service Package", "@type": "ProductSpecificationRef" }, "relatedParty": [ { "firstName": "John", "lastName": "Smith", "email": "abc2@example.com", "phone": "32456768", "@type": "RelatedParty", "@referredType": "OrderLineItemContact" } ], "productRelationship": [ { "id": "be6d13f45b5620102dff5e92dc81c781", "relationshipType": "Requires" } ] }, "productOffering": { "id": "69017a0f536520103b6bddeeff7b127d", "name": "Premium SD-WAN Offering" }, "productOrderItemRelationship": [ { "id": "110", "relationshipType": "HasChild" }, { "id": "120", "relationshipType": "HasChild" }, { "id": "130", "relationshipType": "HasChild" } ], "@type": "ProductOrderItem" }, { "id": "110", "quantity": 1, "action": "add", "itemPrice": [ { "description": "Access Fee", "name": "Access Fee", "priceType": "nonRecurring", "price": { "taxRate": 0, "dutyFreeAmount": { "unit": "USD", "value": 100 }, "taxIncludedAmount": { "unit": "USD", "value": 220 } } } ], "product": { "isBundle": false, "@type": "Product", "productCharacteristic": [ { "name": "Tenancy", "valueType": "string", "value": "Premium (>50 sites)" } ], "productSpecification": { "id": "216663aa53702010cd6dddeeff7b12b5", "name": "SD-WAN Controller", "@type": "ProductSpecificationRef" }, "place": { "@type": "Place", "id": "5671dd2ec3a53010188473ce3640dd81" }, "relatedParty": [ { "firstName": "John", "lastName": "Smith", "email": "abc2@example.com", "phone": "32456768", "@type": "RelatedParty", "@referredType": "OrderLineItemContact" } ], "productRelationship": [ { "id": "be6d13f45b5620102dff5e92dc81c781", "relationshipType": "Requires" } ] }, "productOffering": { "id": "69017a0f536520103b6bddeeff7b127d", "name": "Premium SD-WAN Offering" }, "productOrderItemRelationship": [ { "id": "100", "relationshipType": "HasParent" } ], "@type": "ProductOrderItem" }, { "id": "120", "action": "add", "actionReason":"adding service package OLI", "quantity": 1, "itemPrice": [ { "description": "Tariff plan monthly fee", "name": "MonthlyFee", "priceType": "recurring", "recurringChargePeriod": "month", "price": { "taxRate": 0, "dutyFreeAmount": { "unit": "USD", "value": 300 }, "taxIncludedAmount": { "unit": "USD", "value": 349 } } } ], "product": { "isBundle": false, "@type": "Product", "productCharacteristic": [ { "name": "CPE Model", "valueType": "string", "value": "ASR" }, { "name": "WAN Optimization", "valueType": "string", "value": "Advance" }, { "name": "CPE Type", "valueType": "string", "value": "Physical" }, { "name": "Routing", "valueType": "string", "value": "Premium" } ], "productSpecification": { "id": "39b627aa53702010cd6dddeeff7b1202", "name": "SD-WAN Edge Device", "@type": "ProductSpecificationRef" }, "place": { "@type": "Place", "id": "5671dd2ec3a53010188473ce3640dd81" }, "relatedParty": [ { "firstName": "John", "lastName": "Smith", "email": "abc2@example.com", "phone": "32456768", "@type": "RelatedParty", "@referredType": "OrderLineItemContact" } ], "productRelationship": [ { "id": "be6d13f45b5620102dff5e92dc81c781", "relationshipType": "Requires" } ] }, "productOffering": { "id": "69017a0f536520103b6bddeeff7b127d", "name": "Premium SD-WAN Offering" }, "productOrderItemRelationship": [ { "id": "100", "relationshipType": "HasParent" } ], "@type": "ProductOrderItem" }, { "id": "130", "quantity": 1, "action": "add", "actionReason":"adding service package OLI", "itemPrice": [ { "description": "Tariff plan monthly security", "name": "MonthlySecurity", "priceType": "nonRecurring", "price": { "taxRate": 0, "dutyFreeAmount": { "unit": "USD", "value": 30 }, "taxIncludedAmount": { "unit": "USD", "value": 30 } } } ], "product": { "isBundle": false, "@type": "Product", "productCharacteristic": [ { "name": "Security Type", "valueType": "string", "value": "Premium" } ], "productSpecification": { "id": "a6514bd3534560102f18ddeeff7b1247", "name": "SD-WAN Security", "@type": "ProductSpecificationRef" }, "place": { "@type": "Place", "id": "5671dd2ec3a53010188473ce3640dd81" }, "relatedParty": [ { "firstName": "John", "lastName": "Smith", "email": "abc2@example.com", "phone": "32456768", "@type": "RelatedParty", "@referredType": "OrderLineItemContact" } ], "productRelationship": [ { "id": "be6d13f45b5620102dff5e92dc81c781", "relationshipType": "Requires" } ] }, "productOffering": { "id": "69017a0f536520103b6bddeeff7b127d", "name": "Premium SD-WAN Offering" }, "productOrderItemRelationship": [ { "id": "100", "relationshipType": "HasParent" } ], "@type": "ProductOrderItem" } ], "relatedParty": [ { "id": "eaf68911c35420105252716b7d40ddde", "name": "Sally Thomas", "@type": "RelatedParty", "@referredType": "CustomerContact" }, { "id": "ffc68911c35420105252716b7d40dd55", "name": "Funco Intl", "@type": "RelatedParty", "@referredType": "Customer" }, { "id": "59f16de1c3b67110ff00ed23a140dd9e", "name": "Funco External", "@type": "RelatedParty", "@referredType": "Consumer" } ], "@type": "ProductOrder" }' Response body. { "orderId": "304e877ac3ab5110856d73ce3640dde5" } ### Processing synchronously (default) The following example shows how to create a product order. curl -X POST "https://instance.service-now.com/api/sn_ind_tmt_orm/order/productOrder" \ -H "Accept: application/json" \ -H "Content-Type: application/json" \ -u "username":"password" \ -d { "requestedCompletionDate": "2021-05-02T08:13:59.506Z", "requestedStartDate": "2020-05-03T08:13:59.506Z", "externalId": "PO-456", "currencyCode": "USD", "channel": [ { "id": "2", "name": "Online channel" } ], "note": [ { "text": "This is a TMF product order illustration" }, { "text": "This is a TMF product order illustration no 2" } ], "productOrderItem": [ { "id": "POI100", "quantity": 1, "action": "change", "product": { "id": "fa6d13f45b5620102dff5e92dc81c77f", "@type": "Product", "productSpecification": { "id": "cfe5ef6a53702010cd6dddeeff7b12f6", "name": "SD-WAN Service Package", "@type": "ProductSpecificationRef" }, "place": { "id": "25ab9c4d0a0a0bb300f7dabdc0ca7c1c", "@type": "Place" } }, "productOffering": { "id": "69017a0f536520103b6bddeeff7b127d", "name": "Premium SD-WAN Offering" }, "productOrderItemRelationship": [ { "id": "POI120", "relationshipType": "HasChild" }, { "id": "POI130", "relationshipType": "HasChild" } ], "@type": "ProductOrderItem" }, { "id": "POI120", "quantity": 1, "action": "change", "actionReason":"adding service package OLI", "itemPrice": [ { "priceType": "recurring", "recurringChargePeriod": "month", "price": { "taxIncludedAmount": { "unit": "USD", "value": 20 } } } ], "product": { "id": "766d13f45b5620102dff5e92dc81c78a", "@type": "Product", "productCharacteristic": [ { "name": "WAN Optimization", "value": "Base", "previousValue": "Advance" } ], "productSpecification": { "id": "39b627aa53702010cd6dddeeff7b1202", "name": "SD-WAN Edge Device", "@type": "ProductSpecificationRef" }, "productRelationship": [ { "id": "326d13f45b5620102dff5e92dc81c785", "relationshipType": "Requires" } ], "relatedParty": [ { "id": "51670151c35420105252716b7d40ddfe", "firstName": "Joe", "lastName": "Doe", "email": "abc@example.com", "phone": "1234567890", "@type": "RelatedParty", "@referredType": "OrderLineItemContact" } ], "place": { "id": "25ab9c4d0a0a0bb300f7dabdc0ca7c1c", "@type": "Place" } }, "productOffering": { "id": "69017a0f536520103b6bddeeff7b127d", "name": "Premium SD-WAN Offering" }, "productOrderItemRelationship": [ { "id": "POI100", "relationshipType": "HasParent" }, { "id": "POI130", "relationshipType": "Requires" } ], "@type": "ProductOrderItem" }, { "id": "POI130", "quantity": 1, "action": "add", "actionReason":"adding service package OLI", "itemPrice": [ { "priceType": "recurring", "recurringChargePeriod": "month", "price": { "taxIncludedAmount": { "unit": "USD", "value": 20 } } } ], "product": { "@type": "Product", "productCharacteristic": [ { "name": "Security Type", "value": "Base", "previousValue": "Advance" } ], "productSpecification": { "id": "a6514bd3534560102f18ddeeff7b1247", "name": "SD-WAN Security", "@type": "ProductSpecificationRef" }, "relatedParty": [ { "id": "51670151c35420105252716b7d40ddfe", "firstName": "Joe", "lastName": "Doe", "email": "abc@example.com", "phone": "1234567890", "@type": "RelatedParty", "@referredType": "OrderLineItemContact" } ], "place": { "id": "25ab9c4d0a0a0bb300f7dabdc0ca7c1c", "@type": "Place" } }, "productOffering": { "id": "69017a0f536520103b6bddeeff7b127d", "name": "Premium SD-WAN Offering" }, "productOrderItemRelationship": [ { "id": "POI100", "relationshipType": "HasParent" } ], "@type": "ProductOrderItem" } ], "relatedParty": [ { "id": "eaf68911c35420105252716b7d40ddde", "name": "Sally Thomas", "@type": "RelatedParty", "@referredType": "CustomerContact" }, { "id": "ffc68911c35420105252716b7d40dd55", "name": "Funco Intl", "@type": "RelatedParty", "@referredType": "Customer" }, { "id": "59f16de1c3b67110ff00ed23a140dd9e", "name": "Funco External", "@type": "RelatedParty", "@referredType": "Consumer" } ], "@type": "ProductOrder" } Response body. { "requestedCompletionDate": "2021-05-02T08:13:59.506Z", "requestedStartDate": "2020-05-03T08:13:59.506Z", "externalId": "PO-456", "currencyCode": "USD", "channel": [ { "id": "2", "name": "Online chanel" } ], "note": [ { "text": "This is a TMF product order illustration" }, { "text": "This is a TMF product order illustration no 2" } ], "productOrderItem": [ { "id": "POI100", "quantity": 1, "action": "change", "actionReason":"adding service package OLI", "product": { "id": "fa6d13f45b5620102dff5e92dc81c77f", "@type": "Product", "productSpecification": { "id": "cfe5ef6a53702010cd6dddeeff7b12f6", "name": "SD-WAN Service Package", "internalVersion": "1", "version": "v1", "internalId": "cfe5ef6a53702010cd6dddeeff7b12f6", "@type": "ProductSpecificationRef" }, "place": { "id": "25ab9c4d0a0a0bb300f7dabdc0ca7c1c", "@type": "Place" } }, "productOffering": { "id": "69017a0f536520103b6bddeeff7b127d", "name": "Premium SD-WAN Offering", "internalVersion": "1", "version": "v1", "internalId": "69017a0f536520103b6bddeeff7b127d" }, "productOrderItemRelationship": [ { "id": "POI120", "relationshipType": "HasChild" }, { "id": "POI130", "relationshipType": "HasChild" } ], "@type": "ProductOrderItem", "state": "new" }, { "id": "POI120", "quantity": 1, "action": "change", "actionReason":"adding service package OLI", "itemPrice": [ { "priceType": "recurring", "recurringChargePeriod": "month", "price": { "taxIncludedAmount": { "unit": "USD", "value": 20 } } } ], "product": { "id": "766d13f45b5620102dff5e92dc81c78a", "@type": "Product", "productCharacteristic": [ { "name": "WAN Optimization", "value": "Base", "previousValue": "Advance" } ], "productSpecification": { "id": "39b627aa53702010cd6dddeeff7b1202", "name": "SD-WAN Edge Device", "internalVersion": "1", "version": "v1", "internalId": "39b627aa53702010cd6dddeeff7b1202", "@type": "ProductSpecificationRef" }, "productRelationship": [ { "id": "326d13f45b5620102dff5e92dc81c785", "relationshipType": "Requires" } ], "relatedParty": [ { "id": "51670151c35420105252716b7d40ddfe", "firstName": "Joe", "lastName": "Doe", "email": "abc@example.com", "phone": "1234567890", "@type": "RelatedParty", "@referredType": "OrderLineItemContact" } ], "place": { "id": "25ab9c4d0a0a0bb300f7dabdc0ca7c1c", "@type": "Place" } }, "productOffering": { "id": "69017a0f536520103b6bddeeff7b127d", "name": "Premium SD-WAN Offering", "internalVersion": "1", "version": "v1", "internalId": "69017a0f536520103b6bddeeff7b127d" }, "productOrderItemRelationship": [ { "id": "POI100", "relationshipType": "HasParent" }, { "id": "POI130", "relationshipType": "Requires" } ], "@type": "ProductOrderItem", "state": "new" }, { "id": "POI130", "quantity": 1, "action": "add", "actionReason":"adding service package OLI", "itemPrice": [ { "priceType": "recurring", "recurringChargePeriod": "month", "price": { "taxIncludedAmount": { "unit": "USD", "value": 20 } } } ], "product": { "@type": "Product", "productCharacteristic": [ { "name": "Security Type", "value": "Base", "previousValue": "Advance" } ], "productSpecification": { "id": "a6514bd3534560102f18ddeeff7b1247", "name": "SD-WAN Security", "internalVersion": "1", "version": "v1", "internalId": "a6514bd3534560102f18ddeeff7b1247", "@type": "ProductSpecificationRef" }, "relatedParty": [ { "id": "51670151c35420105252716b7d40ddfe", "firstName": "Joe", "lastName": "Doe", "email": "abc@example.com", "phone": "1234567890", "@type": "RelatedParty", "@referredType": "OrderLineItemContact" } ], "place": { "id": "25ab9c4d0a0a0bb300f7dabdc0ca7c1c", "@type": "Place" } }, "productOffering": { "id": "69017a0f536520103b6bddeeff7b127d", "name": "Premium SD-WAN Offering", "internalVersion": "1", "version": "v1", "internalId": "69017a0f536520103b6bddeeff7b127d" }, "productOrderItemRelationship": [ { "id": "POI100", "relationshipType": "HasParent" } ], "@type": "ProductOrderItem", "state": "new" } ], "relatedParty": [ { "id": "eaf68911c35420105252716b7d40ddde", "name": "Sally Thomas", "@type": "RelatedParty", "@referredType": "CustomerContact" }, { "id": "ffc68911c35420105252716b7d40dd55", "name": "Funco Intl", "@type": "RelatedParty", "@referredType": "Customer" }, { "id": "59f16de1c3b67110ff00ed23a140dd9e", "name": "Funco External", "@type": "RelatedParty", "@referredType": "Consumer" } ], "@type": "ProductOrder", "id": "8d75939453126010a795ddeeff7b126a", "href": "/api/sn_ind_tmt_orm/order/productOrder/8d75939453126010a795ddeeff7b126a", "state": "new" } ## Product Order Open API - POST /sn_ind_tmt_orm/productorder {#ariaid-title10} Creates the specified customer order and customer order line items. Important: Starting with the Tokyo release, this endpoint is deprecated. The new version of this endpoint is [Product Order Open API - POST /sn_ind_tmt_orm/order/productOrder](https://servicenow-prod.fluidtopics.net/lU3_sIIHvtqhkTfEEUFOCw#tmf_prod_order-POST-ord-productOrder "Creates the specified customer order and customer order line items."). Once processed, new records are created in the following tables: * Customer Order \[sn_ind_tmt_orm_order\] * Order Characteristic \[sn_ind_tmt_orm_order_characteristic_value\] * Order Line Item \[sn_ind_tmt_orm_order_line_item\] * Order Line Item Contact \[sn_ind_tmt_orm_order_line_item_contact\] {#tmf_prod_order-POST-productOrder__ul_hxq_vdb_hqb} ### URL format Default URL: /api/sn_ind_tmt_orm/productorder ### Supported request parameters {#tmf_prod_order-POST-productOrder__entry__2} | Name | Description | |-|-| | None | | [Table 49. Path parameters] {#tmf_prod_order-POST-productOrder__entry__6} | Name | Description | |-|-| | None | | [Table 50. Query parameters] {#tmf_prod_order-POST-productOrder__id_vk2_p5n_t4b__entry__2}{#tmf_prod_order-POST-productOrder__due-date-entry}{#tmf_prod_order-POST-productOrder__productOrder-href-request}{#tmf_prod_order-POST-productOrder__productOrder-addReason-request}{#tmf_prod_order-POST-productOrder__due-date-item-entry}{#tmf_prod_order-POST-productOrder__externalProductInventory-GET-desc-request}{#tmf_prod_order-POST-productOrder__externalProductInventoryId-desc} | Name | Description | |-|-| | channel | Array of objects that describe the channels to use for selling the products. Data type: Array "channel": [ { "id": "String", "name": "String" } ] Table/field updated: sn_ind_tmt_orm_order | | channel.id | Required. Unique identifier of the channel to use to sell the associated products. Channel ID values are located in the external_id field of the Distribution Channel \[sn_prd_pm_distribution_channel\] table. Data type: String Table/field updated: sn_ind_tmt_orm_order/channel Default: Blank string | | channel.name | Name of the channel to use to sell the associated products. Possible channel names are defined on the Choice List tab in the Channel Dictionary Entry of the sn_ind_tmt_orm_order table. Data type: String Default: Blank string | | committedDueDate | Date and time when the action must be performed on the order. This value must be the same as or later than the committedDueDate values for each order line item. Data type: String Table/field updated: sn_ind_tmt_orm_order/committed_due_date | | externalId | Unique identifier for the customer order. This value is determined by an external system. Data type: String Table/field updated: sn_ind_tmt_orm_order/external_id Default: Blank string | | href | A relative link to the resource record. Data type: String Default: Blank string | | note | Array of objects that contain additional notes made by the customer when ordering. Data type: Array "note": [ { "text": "String" } ] Table/field updated: sn_ind_tmt_orm_order | | note.text | Required. Additional notes/comments made by the customer while ordering. Data type: String Table/field updated: sn_ind_tmt_orm_order/comments Default: Blank string | | orderCurrency | Required. Currency code for the order and order line items. The currency must be the same for all elements of the order and order line items, otherwise an error is returned and the order isn't created. Once an order is created, its currency code can't be changed. Data type: String | | productOrderItem | Required. Array of objects that describe items associated with the product order and their associated action. Data type: Array "productOrderItem": [ { "action": "String", "actionReason": "String", "committedDueDate": "String", "externalProductInventory": [Array], "id": "String", "itemPrice": [Array], "product": {Object}, "productOffering": {Object}, "productOrderItemRelationship": [Array], "quantity": Number, "@type": "String" } ] Table/field updated: sn_ind_tmt_orm_order_line_item | | productOrderItem.action | Required. Action to carry out on the product. Possible actions are defined on the Choice List tab in the Action Dictionary Entry of the sn_ind_tmt_orm_order_line_item table. Possible values: * add * change * delete * no-change * resume * suspend {#tmf_prod_order-POST-productOrder__ul_qbd_dyp_ysb} Data type: String Table/field updated: sn_ind_tmt_orm_order_line_item/action | | productOrderItem.actionReason | Optional. Description of the reason for the order line item. Data type: String Table/field updated: sn_ind_tmt_orm_order_line_item/action_reason | | productOrderItem.committedDueDate | Date and time when the action must be performed on the order line item. Data type: String Table/field updated: sn_ind_tmt_orm_order_line_item/committed_due_date | | productOrderItem.externalProductInventory | Array of objects containing external ids to map to the product inventories created for the order. Data type: Array of objects "externalProductInventory": [ { "externalProductInventoryId": "String" } ] | | productOrderItem.externalProductInventory.externalProductInventoryId | External id to map to the product inventory. Data type: String Table/field updated: sn_ind_tmt_orm_order_line_item/external_inventory_id and sn_prd_invt_product_inventory/sn_prd_invt_external_id | | productOrderItem.id | Required. Unique identifier of the line item. Data type: String Table/field updated: sn_ind_tmt_orm_order_line_item/external_id Maximum length: 40 Default: Blank string | | productOrderItem.itemPrice | Array of objects that describe the price associated with the product. Data type: Array "itemPrice": [ { "price": {Object}, "priceType": "String", "recurringChargePeriod": "String" } ] Table updated: sn_ind_tmt_orm_order Default: Blank string | | productOrderItem.itemPrice.price | Description of the price of the associated product. Data type: Object "price": { "taxIncludedAmount": {Object} } Table updated: sn_ind_tmt_orm_order_line_item Default: Blank string | | productOrderItem.itemPrice.price.taxIncludedAmount | Description of the price of the associated product, including the tax. Data type: Object "taxIncludedAmount": { "unit": "String", "value": Number } Table updated: sn_ind_tmt_orm_order_line_item | | productOrderItem.itemPrice.price.taxIncludedAmount.unit | Currency code in which the price is depicted. Data type: String Table/field updated: sn_ind_tmt_orm_order_line_item/mrc or nrc | | productOrderItem.itemPrice.price.taxIncludedAmount.value | Price of product, including any tax. Data type: Number Table/field updated: sn_ind_tmt_orm_order_line_item/mrc or nrc | | productOrderItem.itemPrice.priceType | Specifies whether the price of the item is recurring or non-recurring. Data type: String | | productOrderItem.itemPrice.recurringChargePeriod | If the price is recurring, specifies the recurring period, such as month. Data type: String | | productOrderItem.product | Required if productOrderItem.action is change or delete. Description of the instance details of the product purchased by the customer. Data type: Object "product": { "id": "String", "place": {Object}, "productCharacteristic": [Array], "productSpecification": {Object}, "relatedParty": {Object}, "@type": "String" } Table/field updated: sn_ind_tmt_orm_order_line_item | | productOrderItem.product.id | Required if productOrderItem.action is change or delete. Unique identifier of the product sold. Located in the sys_id or sn_ind_tmt_orm_external_id field of the Product Inventory \[sn_ind_tmt_orm_product_inventory\] table. Data type: String Default: Blank string | | productOrderItem.product.place | Maps of the locations on which to install the product. Data type: Object "place": { "id": "String", "@type": "String" } Table/field updated: sn_ind_tmt_orm_order_line_item | | productOrderItem.product.place.id | Required. Sys_id of the associated location record in the Location \[cmn_location\] table. Data type: String Table/field updated: sn_ind_tmt_orm_order_line_item/location | | productOrderItem.product.place.@type | 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 | | productOrderItem.product.productCharacteristic | Array of objects that describe the characteristics of the associated product. Data type: Array "productCharacteristic": [ { "name": "String", "previousValue": "String", "value": "String" } ] Table/field updated: sn_ind_tmt_orm_order_characteristic_value | | productOrderItem.product.productCharacteristic.name | Name of the characteristic record to associated with the product. Located in the Characteristic \[sn_prd_pm_characteristic\] table. Data type: String Table/field updated: sn_ind_tmt_orm_order_characteristic_value/characteristics Default: Blank string | | productOrderItem.product.productCharacteristic.previousValue | Previous characteristic option values if the update is for change order. The request is a change order if the productOrderItem.action parameter is other than add. For additional information on characteristic option values, see [Create product characteristics and characteristic options](https://www.servicenow.com/docs/access?context=som-product-config-add-characteristics&version=xanadu&pubname=xanadu-order-management&ft:locale=en-US). Data type: String Table/field updated: sn_ind_tmt_orm_order_characteristic_value/previous_characteristic_option_value Default: Blank string | | productOrderItem.product.productCharacteristic.value | Characteristic option values associated with the product. For additional information on characteristic option values, see [Create product characteristics and characteristic options](https://www.servicenow.com/docs/access?context=som-product-config-add-characteristics&version=xanadu&pubname=xanadu-order-management&ft:locale=en-US). Data type: String Table/field updated: sn_ind_tmt_orm_order_characteristic_value/characteristic_option_value Default: Blank string | | productOrderItem.product.productSpecification | Required. Description of the product specification associated with the product. Note: Change orders (productOrderItem.action is `change`) are processed differently based on the value of the sn_ind_tmt_orm.allowSpecVersionUpdateInChangeOrder system property. The value of this system property determines how the order is processed if the product inventory is a different version than indicated in the order. * When this system property is set to true (default), the product inventory is automatically upgraded to the version in the order by changing the referenced product specification. This allows the order to be successfully processed. * When this system property is set to false, if the product inventory is a different version than indicated in the order, the order fails due to the version mismatch. {#tmf_prod_order-POST-productOrder__ul_zbw_sdz_dbc} Data type: Object "productSpecification": { "id": "String", "internalVersion": "String", "name": "String", "version": "String", "@type": "String" } Table/field updated: sn_ind_tmt_orm_order_line_item | | productOrderItem.product.productSpecification.id | Required. Initial_version or external_id of the product 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 Product Specification \[sn_prd_pm_product_specification\] table. Data type: String | | productOrderItem.product.productSpecification.internalVersion | Version of the product specification. Located in the Product Specification \[sn_prd_pm_product_specification\] table. Data type: String | | productOrderItem.product.productSpecification.name | Name of the product specification. Located in the Product Specification \[sn_prd_pm_product_specification\] table. Data type: String | | productOrderItem.product.productSpecification.version | External_version of the product specification. Located in the Product Specification \[sn_prd_pm_product_specification\] table. Data type: String | | productOrderItem.product.productSpecification.@type | Part of the TMF Open API standard. This value is always ProductSpecificationRef. This information is not stored. Data type: String | | productOrderItem.product.relatedParty | Array of objects that describe the party role linked to an OrderLineItemContact. Data type: Array "relatedParty": [ { "email": "String", "firstName": "String", "lastName": "String", "phone": "String", "@referredType": "String", "@type": "String" } ] Table/field updated: sn_ind_tmt_orm_order_line_item_contact | | productOrderItem.product.relatedParty.email | Email address of the contact. Data type: String Table/field updated: sn_ind_tmt_orm_order_line_item_contact/email Default: Blank string | | productOrderItem.product.relatedParty.firstName | First name of the contact. Data type: String Table/field updated: sn_ind_tmt_orm_order_line_item_contact/first_name Default: Blank string | | productOrderItem.product.relatedParty.lastName | Last name of the contact. Data type: String Table/field updated: sn_ind_tmt_orm_order_line_item_contact/lastName Default: Blank string | | productOrderItem.product.relatedParty.phone | Business phone number of the contact. Data type: String Table/field updated: sn_ind_tmt_orm_order_line_item_contact/business_phone Default: Blank string | | productOrderItem.product.relatedParty.@referredType | Required. Type of customer. Possible value -- OrderLineItemContact Data type: String | | productOrderItem.product.relatedParty.@type | 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 | | productOrderItem.product.@type | Part of TMF Open API standard. Annotation for the product. This value is always Product. This information is not stored. Data type: String | | productOrderItem.productOffering | Required. Description of the product offering associated with the product. Data type: Object "productOffering": { "id": "String", "internalVersion": "String", "name": "String", "version": "String" } Table updated: sn_ind_tmt_orm_order_line_item | | productOrderItem.productOffering.id | Required. Initial_version or external_id of the product offering. The initial_version is the sys_id of the first version of the offering. Located in the sys_id or external_id field of the Product Offering \[sn_prd_pm_product_offering\] table. Data type: String | | productOrderItem.productOffering.internalVersion | Version of the product offering. Located in the Product Offering \[sn_prd_pm_product_offering\] table. Data type: String | | productOrderItem.productOffering.name | Name of the product offering. Located in the Product Offering \[sn_prd_pm_product_offering\] table. Data type: String | | productOrderItem.productOffering.version | External_version of the product offering. Located in the Product Offering \[sn_prd_pm_product_offering\] table. Data type: String | | productOrderItem.productOrderItem.quantity | Number of the associated items to order. Data type: Number Table/field updated: sn_ind_tmt_orm_order/quantity Default: null | | productOrderItem.productOrderItemRelationship | Required. Array of objects that describe the parent/child relationship between order items. Data type: Array "productOrderItemRelationship": [ { "id": "String", "relationshipType": "String" } ] Table/field updated: sn_ind_tmt_orm_order_line_item | | productOrderItem.productOrderItemRelationship.id | Required. Same as the productOrderItem.id value. Used for parent/child relationship Data type: String Table/field updated: sn_ind_tmt_orm_order_line_item/parent_line_item Default: Blank string | | productOrderItem.productOrderItemRelationship.relationshipType | Required. Type of relationship between the two line items. This information is used to identify relationship hierarchy. Possible values: * HasChild * HasParent {#tmf_prod_order-POST-productOrder__ul_rmq_vrk_5rb} Data type: String | | productOrderItem.quantity | Number of items ordered. Data type: Number Table/field updated: sn_ind_tmt_orm_order/quantity Default: Blank string | | productOrderItem.@type | Part of TMF Open API standard. Annotation for the product. This value is always ProductOrderItem. This information is not stored. Data type: String | | relatedParty | List of contacts for the order. Each contact is an object in the array. Must list at least one item which contains customer account or consumer account information. Data type: Array "relatedParty": [ { "id": "String", "name": "String", "@referredType": "String", "@type": "String" } ] | | relatedParty.id | Sys_id or external_id of the account or customer contact associated with the order. Located in either the account \[customer_account\], Contact \[customer_contact\] table, or Consumer \[csm_consumer\] table. Data type: String | | relatedParty.name | Name of the account, customer, or consumer. Data type: String | | relatedParty.@referredType | Required. Type of customer. Possible values: * Consumer * Customer * CustomerContact {#tmf_prod_order-POST-productOrder__ul_smq_vrk_5rb} Data type: String | | relatedParty.@type | Part of TMF Open API standard. Annotation for the product. This value is always RelatedParty. This information is not stored. Data type: String | | requestedCompletionDate | Delivery date requested by the customer. Data type: String Table/field updated: sn_ind_tmt_orm_order/expected_end_date Default: Blank string | | requestedStartDate | Order start date requested by the customer. Data type: String Table/field updated: sn_ind_tmt_orm_order/expected_start_date Default: Blank string | | @type | Part of TMF Open API standard. Annotation for the product. This value is always ProductOrder. This information is not stored. Data type: String | [Table 51. Request body parameters (JSON)] {#tmf_prod_order-POST-productOrder__id_vk2_p5n_t4b} ### 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](https://servicenow-prod.fluidtopics.net/2vuQj3~2s_niNXyXhrbRZA "REST (REpresentational State Transfer) is a simple stateless architecture that provides standards between computer systems on the web, making it easier for them to communicate with each other."). {#tmf_prod_order-POST-productOrder__table_omb_dvk_5rb__entry__2}{#tmf_prod_order-POST-productOrder__accept-JSON-only-entry-RESTAPI}{#tmf_prod_order-POST-productOrder__content_type-JSON-only-entry-RESTAPI} | 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. | [Table 52. Request headers] {#tmf_prod_order-POST-productOrder__table_omb_dvk_5rb} {#tmf_prod_order-POST-productOrder__table_tzy_thy_ksb__entry__2} | Header | Description | |-|-| | Content-Type | Data format of the response body. Only supports application/json. | [Table 53. Response headers] {#tmf_prod_order-POST-productOrder__table_tzy_thy_ksb} ### 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](https://servicenow-prod.fluidtopics.net/2vuQj3~2s_niNXyXhrbRZA "REST (REpresentational State Transfer) is a simple stateless architecture that provides standards between computer systems on the web, making it easier for them to communicate with each other."). {#tmf_prod_order-POST-productOrder__entry__152} | Status code | Description | |-|-| | 201 | 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: * The following Order Item characteristics does not exist: Review specification \ and correct the characteristic and characteristic option in the order line item prior to approving the order. * Order Item characteristic: \ with characteristic value: \is invalid. Correct the characteristic values before approving the order. {#tmf_prod_order-POST-productOrder__ul_xtx_xym_t4b} | | 400 | Bad Request. Could be any of the following reasons: * Invalid payload: Request body missing - Payload was not passed in the request body. * Invalid payload: productOrderItem is missing - Product order line item object or JSON is missing. * Invalid payload: productOrderItem id is missing - The id parameter is missing in the product order line item of the payload. * Invalid payload: productOrderItem action is missing - The action parameter is missing in the product order line item of the payload. * Invalid payload: productOrderItem productOffering is missing - The product offering object or JSON is missing from the product order line item in the payload. * Invalid payload: productOffering id is missing - The id parameter is missing in the product order line item of the product offering object in the payload. * Invalid payload: Product offering does not exist - The product offering in the product order line item is not valid. * Invalid payload: productOrderItem product is missing - The product object or JSON in the product order line item is missing from the payload. * Invalid payload: product productSpecification is missing - The product specification object or JSON in the product order line item is missing from the payload. * Invalid payload: productSpecification id is missing - The id parameter in the product order line item of the product specification object is missing from the payload. * Invalid payload: Product specification does not exist - The product specification in the product order line item is not valid. * Invalid payload: Product Inventory does not exist - In a change order (action = change), the quantity of an item is greater than what is in stock. * Invalid payload: Product inventory ID is missing - In change order, the product.id is missing in the payload. * Invalid payload: Sold Product is inactive - In a change order, a product specified in the payload is inactive. * Invalid payload: relatedParty is missing - The related party object is missing from the payload. * Invalid payload: Customer Account or Consumer is missing - The related party customer or consumer object is missing from the payload. * Invalid payload: Consumer does not exist - The specified related party consumer does not exist in the ServiceNow instance. * Invalid payload: Customer Account does not exist - The specified related party customer does not exist in the ServiceNow instance. * Invalid payload: Order creation failed - Not able to create the requested order. {#tmf_prod_order-POST-productOrder__ul_g2v_rzm_t4b} | [Table 54. Status codes] ### Response body parameters (JSON) {#tmf_prod_order-POST-productOrder__entry__158} | Name | Description | |-|-| | channel | Array of objects that describe the channels to use for selling the products. Data type: Array "channel": [ { "id": "String", "name": "String" } ] | | channel.id | Unique identifier of the channel to use to sell the associated products. Channel ID values are located in the external_id field of the Distribution Channel \[sn_prd_pm_distribution_channel\] table. Data type: String | | channel.name | Name of the channel to use to sell the associated products. Data type: String | | id | Sys_id of the customer order created for this request. Data type: String | | externalId | External identifier for the customer order, such as a purchase order number. Data type: String | | note | Array of objects that describe additional notes made by the customer when ordering. Data type: Array "note": [ { "text": "String" } ] | | note.text | Additional notes/comments made by the customer while ordering. Data type: String | | productOrderItem | List that describes items associated with the product order and their associated action. Data type: Array "productOrderItem:" [ { "action": "String", "id": "String", "itemPrice": [Array], "product": {Object}, "productOffering": {Object}, "productOrderItemReleationship": [Array], "quantity": Number, "state": "String", "@type": "String" } ] | | productOrderItem.action | Action to carry out on the product. Possible actions are defined on the Choice List tab in the Action Dictionary Entry of the sn_ind_tmt_orm_order_line_item table. Data type: String | | productOderItem.actionReason | The reason for adding the order line item. Data type: String Table/field updated: sn_ind_tmt_orm_order_line_item/action_reason | | productOrderItem.id | 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 | | productOrderItem.itemPrice | Array of objects that describe the price associated with the product. Data type: Array "itemPrice": [ { "price": {Object}, "priceType": "String", "recurringChargePeriod": "String" } ] | | productOrderItem.itemPrice.price | Description of the price of the associated product. Data type: Object "price": { "taxIncludedAmount": {Object} } | | productOrderItem.itemPrice.price.taxIncludeAmount | Description of the price of the associated product, including the tax. Data type: Object "taxIncludedAmount": { "unit": "String", "value": Number } | | productOrderItem.itemPrice.price.taxIncludeAmount.unit | Currency code in which the price is depicted. Data type: String | | productOrderItem.itemPrice.price.taxIncludeAmount.value | Price of product, including any tax. Data type: Number | | productOrderItem.itemPrice.priceType | Type of item price, recurring or non-recurring. Data type: String | | productOrderItem.itemPrice.recurringChargePeriod | If the price is recurring, the recurring period, such as month. Data type: String | | productOrderItem.product | Description of the instance details of the product purchased by the customer. Data type: Object "product": { "id": "String", "place": {Object}, "productCharacteristic": [Array], "productSpecification": {Object}, "relatedParty": {Object}, "@type": "String" } | | productOrderItem.product.id | Unique identifier of the product sold. Located in the sys_id or sn_ind_tmt_orm_external_id field of the Product Inventory \[sn_ind_tmt_orm_product_inventory\] table. This parameter is only returned if productOrderItem.action is change or delete. If both sys_id and external_id are present, the external_id is returned. Data type: String | | productOrderItem.product.place | Maps of the locations on which to install the product. Data type: Object "place": { "id": "String", "@type": "String" } | | productOrderItem.product.place.id | Sys_id of the associated location record in the Location \[cmn_location\] table. Data type: String | | productOrderItem.product.productCharacteristic | Array of objects that describe the characteristics of the associated product. Data type: Array "productCharacteristic": [ { "name": "String", "previousValue": "String", "value": "String" } ] | | productOrderItem.product.productCharacteristic.name | Name of the characteristic record to associate with the product. Located in the Characteristic \[sn_prd_pm_characteristic\] table. Data type: String | | productOrderItem.product.productCharacteristic.previousValue | Previous characteristic option values if the update is for a change order. The request is a change order if the productOrderItem.action parameter is other than add. For additional information on characteristic option values, see [Create product characteristics and characteristic options](https://www.servicenow.com/docs/access?context=som-product-config-add-characteristics&version=xanadu&pubname=xanadu-order-management&ft:locale=en-US). Data type: String | | productOrderItem.product.productCharacteristic.value | Characteristic option values associated with the product. For additional information on characteristic option values, see [Create product characteristics and characteristic options](https://www.servicenow.com/docs/access?context=som-product-config-add-characteristics&version=xanadu&pubname=xanadu-order-management&ft:locale=en-US). Data type: String | | productOrderItem.product.productSpecification | Description of the product specification associated with the product. Data type: Object "productSpecification": { "id": "String", "internalVersion": "String", "name": "String", "version": "String", "@type": "String" } | | productOrderItem.product.productSpecification.id | Initial_version or external_id of the product 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 Product Specification \[sn_prd_pm_product_specification\] table. If both sys_id and external_id are present, the external_id is returned. Data type: String | | productOrderItem.product.productSpecification.name | Name of the product specification. Located in the Product Specification \[sn_prd_pm_product_specification\] table. Data type: String | | productOrderItem.product.productSpecification.@type | Part of the TMF Open API standard. This value is always ProductSpecificationRef. This information is not stored. Data type: String | | productOrderItem.product.relatedParty | List of contacts for line items. Data type: Array "relatedParty:" [ { "email": "String", "firstName": "String", "lastName": "String", "phone": "String", "@referredType": "String", "@type": "String" } ] | | productOrderItem.product.relatedParty.email | Email address of the contact. Data type: String | | productOrderItem.product.relatedParty.firstName | First name of the contact. Data type: String | | productOrderItem.product.relatedParty.lastName | Last name of the contact. Data type: String Data type: String | | productOrderItem.product.relatedParty.phone | Business phone number of the contact. Data type: String | | productOrderItem.product.relatedParty.@referredType | Type of customer. Possible value: OrderLineItemContact Data type: String | | productOrderItem.product.relatedParty.@type | 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 | | productOrderItem.product.@type | Part of TMF Open API standard. Annotation for the product. This value is always Product. This information is not stored. Data type: String | | productOrderItem.productOffering | Description of the product offering associated with the product. Data type: Object "productOffering": { "id": "String", "internalVersion": "String", "name": "String", "version": "String" } | | productOrderItem.productOffering.id | Initial_version or external_id of the product offering. The initial_version is the sys_id of the first version of the offering. Located in the sys_id or external_id field of the Product Offering \[sn_prd_pm_product_offering\] table. If both sys_id and external_id are present, the external_id is returned. Data type: String | | productOrderItem.productOffering.name | Name of the product offering. Located in the Product Offering \[sn_prd_pm_product_offering\] table. Data type: String | | productOrderItem.productOrderItemRelationship | Array of objects that describe the relationships between order line items. Data type: Array "productOrderItemRelationship": [ { "id": "String", "relationshipType": "String" } ] | | productOrderItem.productOrderItemRelationship.id | 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 | | productOrderItem.productOrderItemRelationship.relationshipType | Type of relationship between the two line items. This information is used to identify the relationship hierarchy. Data type: String | | productOrderItem.quantity | Number of the associated items to order. Data type: Number | | productOrderItem.state | Current state of the product order item. This value is always new. Data type: String | | productOrderItem.@type | Part of TMF Open API standard. Annotation for the product. This value is always ProductOrderItem. This information is not stored. Data type: String | | relatedParty | List of contacts for the order. Each contact is an object in the array. Must list at least one item which contains customer account or consumer account information. Data type: Array "relatedParty": [ { "id": "String", "name": "String", "@referredType": "String", "@type": "String" } ] | | relatedParty.id | Sys_id or external_id of the account, customer contact, or consumer associated with the order. Located in the Account \[customer_account\], Contact \[customer_contact\] table, or Consumer \[csm_consumer\] table. Data type: String | | relatedParty.name | Name of the account, customer, or consumer. Data type: String | | relatedParty.type | Type of customer. Possible values: * Consumer * Customer * CustomerContact {#tmf_prod_order-POST-productOrder__ul_lcq_jwm_t4b} Data type: String | | requestedCompletionDate | Delivery date requested by the customer. Data type: String | | requestedStartDate | Order start date requested by the customer. Data type: String | | state | Current state of the order. For this endpoint, this value is always new. Data type: String | | @type | Part of TMF Open API standard. Annotation for the product. This value is always ProductOrder. This information is not stored. Data type: String | [ ] ### cURL request The following code example creates a customer order. curl -X POST "https://servicenow-instance/api/sn_ind_tmt_orm/productorder" \ -H "Accept: application/json" \ -H "Content-Type: application/json" \ -u "username":"password" \ -d { "requestedCompletionDate": "2021-05-02T08:13:59.506Z", "requestedStartDate": "2020-05-03T08:13:59.506Z", "externalId": "PO-456", "channel": [ { "id": "2", "name": "Online channel" } ], "note": [ { "text": "This is a TMF product order illustration" }, { "text": "This is a TMF product order illustration no 2" } ], "productOrderItem": [ { "id": "POI100", "quantity": 1, "action": "change", "product": { "id": "fa6d13f45b5620102dff5e92dc81c77f", "@type": "Product", "productSpecification": { "id": "cfe5ef6a53702010cd6dddeeff7b12f6", "name": "SD-WAN Service Package", "@type": "ProductSpecificationRef" }, "place": { "id": "25ab9c4d0a0a0bb300f7dabdc0ca7c1c", "@type": "Place" } }, "productOffering": { "id": "69017a0f536520103b6bddeeff7b127d", "name": "Premium SD-WAN Offering" }, "productOrderItemRelationship": [ { "id": "POI120", "relationshipType": "HasChild" }, { "id": "POI130", "relationshipType": "HasChild" } ], "@type": "ProductOrderItem" }, { "id": "POI120", "quantity": 1, "action": "change", "itemPrice": [ { "priceType": "recurring", "recurringChargePeriod": "month", "price": { "taxIncludedAmount": { "unit": "USD", "value": 20 } } } ], "product": { "id": "766d13f45b5620102dff5e92dc81c78a", "@type": "Product", "productCharacteristic": [ { "name": "WAN Optimization", "value": "Base", "previousValue": "Advance" } ], "productSpecification": { "id": "39b627aa53702010cd6dddeeff7b1202", "name": "SD-WAN Edge Device", "@type": "ProductSpecificationRef" }, "relatedParty": [ { "id": "51670151c35420105252716b7d40ddfe", "firstName": "Joe", "lastName": "Doe", "email": "abc@example.com", "phone": "1234567890", "@type": "RelatedParty", "@referredType": "OrderLineItemContact" } ], "place": { "id": "25ab9c4d0a0a0bb300f7dabdc0ca7c1c", "@type": "Place" } }, "productOffering": { "id": "69017a0f536520103b6bddeeff7b127d", "name": "Premium SD-WAN Offering" }, "productOrderItemRelationship": [ { "id": "POI100", "relationshipType": "HasParent" } ], "@type": "ProductOrderItem" }, { "id": "POI130", "quantity": 1, "action": "add", "itemPrice": [ { "priceType": "recurring", "recurringChargePeriod": "month", "price": { "taxIncludedAmount": { "unit": "USD", "value": 20 } } } ], "product": { "@type": "Product", "productCharacteristic": [ { "name": "Security Type", "value": "Base", "previousValue": "Advance" } ], "productSpecification": { "id": "a6514bd3534560102f18ddeeff7b1247", "name": "SD-WAN Security", "@type": "ProductSpecificationRef" }, "relatedParty": [ { "id": "51670151c35420105252716b7d40ddfe", "firstName": "Joe", "lastName": "Doe", "email": "abc@example.com", "phone": "1234567890", "@type": "RelatedParty", "@referredType": "OrderLineItemContact" } ], "place": { "id": "25ab9c4d0a0a0bb300f7dabdc0ca7c1c", "@type": "Place" } }, "productOffering": { "id": "69017a0f536520103b6bddeeff7b127d", "name": "Premium SD-WAN Offering" }, "productOrderItemRelationship": [ { "id": "POI100", "relationshipType": "HasParent" } ], "@type": "ProductOrderItem" } ], "relatedParty": [ { "id": "eaf68911c35420105252716b7d40ddde", "name": "Sally Thomas", "@type": "RelatedParty", "@referredType": "CustomerContact" }, { "id": "ffc68911c35420105252716b7d40dd55", "name": "Funco Intl", "@type": "RelatedParty", "@referredType": "Customer" }, { "id": "59f16de1c3b67110ff00ed23a140dd9e", "name": "Funco External", "@type": "RelatedParty", "@referredType": "Consumer" } ], "@type": "ProductOrder" } Response body. { "requestedCompletionDate": "2021-05-02T08:13:59.506Z", "requestedStartDate": "2020-05-03T08:13:59.506Z", "externalId": "PO-456", "channel": [ { "id": "2", "name": "Online chanel" } ], "note": [ { "text": "This is a TMF product order illustration" }, { "text": "This is a TMF product order illustration no 2" } ], "productOrderItem": [ { "id": "POI100", "quantity": 1, "action": "change", "product": { "id": "fa6d13f45b5620102dff5e92dc81c77f", "@type": "Product", "productSpecification": { "id": "cfe5ef6a53702010cd6dddeeff7b12f6", "name": "SD-WAN Service Package", "@type": "ProductSpecificationRef" }, "place": { "id": "25ab9c4d0a0a0bb300f7dabdc0ca7c1c", "@type": "Place" } }, "productOffering": { "id": "69017a0f536520103b6bddeeff7b127d", "name": "Premium SD-WAN Offering" }, "productOrderItemRelationship": [ { "id": "POI120", "relationshipType": "HasChild" }, { "id": "POI130", "relationshipType": "HasChild" } ], "@type": "ProductOrderItem", "state": "new" }, { "id": "POI120", "quantity": 1, "action": "change", "itemPrice": [ { "priceType": "recurring", "recurringChargePeriod": "month", "price": { "taxIncludedAmount": { "unit": "USD", "value": 20 } } } ], "product": { "id": "766d13f45b5620102dff5e92dc81c78a", "@type": "Product", "productCharacteristic": [ { "name": "WAN Optimization", "value": "Base", "previousValue": "Advance" } ], "productSpecification": { "id": "39b627aa53702010cd6dddeeff7b1202", "name": "SD-WAN Edge Device", "@type": "ProductSpecificationRef" }, "relatedParty": [ { "id": "51670151c35420105252716b7d40ddfe", "firstName": "Joe", "lastName": "Doe", "email": "abc@example.com", "phone": "1234567890", "@type": "RelatedParty", "@referredType": "OrderLineItemContact" } ], "place": { "id": "25ab9c4d0a0a0bb300f7dabdc0ca7c1c", "@type": "Place" } }, "productOffering": { "id": "69017a0f536520103b6bddeeff7b127d", "name": "Premium SD-WAN Offering" }, "productOrderItemRelationship": [ { "id": "POI100", "relationshipType": "HasParent" } ], "@type": "ProductOrderItem", "state": "new" }, { "id": "POI130", "quantity": 1, "action": "add", "itemPrice": [ { "priceType": "recurring", "recurringChargePeriod": "month", "price": { "taxIncludedAmount": { "unit": "USD", "value": 20 } } } ], "product": { "@type": "Product", "productCharacteristic": [ { "name": "Security Type", "value": "Base", "previousValue": "Advance" } ], "productSpecification": { "id": "a6514bd3534560102f18ddeeff7b1247", "name": "SD-WAN Security", "@type": "ProductSpecificationRef" }, "relatedParty": [ { "id": "51670151c35420105252716b7d40ddfe", "firstName": "Joe", "lastName": "Doe", "email": "abc@example.com", "phone": "1234567890", "@type": "RelatedParty", "@referredType": "OrderLineItemContact" } ], "place": { "id": "25ab9c4d0a0a0bb300f7dabdc0ca7c1c", "@type": "Place" } }, "productOffering": { "id": "69017a0f536520103b6bddeeff7b127d", "name": "Premium SD-WAN Offering" }, "productOrderItemRelationship": [ { "id": "POI100", "relationshipType": "HasParent" } ], "@type": "ProductOrderItem", "state": "new" } ], "relatedParty": [ { "id": "eaf68911c35420105252716b7d40ddde", "name": "Sally Thomas", "@type": "RelatedParty", "@referredType": "CustomerContact" }, { "id": "ffc68911c35420105252716b7d40dd55", "name": "Funco Intl", "@type": "RelatedParty", "@referredType": "Customer" }, { "id": "59f16de1c3b67110ff00ed23a140dd9e", "name": "Funco External", "@type": "RelatedParty", "@referredType": "Consumer" } ], "@type": "ProductOrder", "id": "6be0a925c3a220103e2e73ce3640ddfe", "state": "new" }