製品注文オープン API

リリースバージョン: Australia

更新日 2026年03月12日

所要時間：372分

Product Order Open API は、製品を注文するための標準化されたメカニズムを有効にするエンドポイントを提供します。

製品注文は、製品カタログで定義および公開されている製品オファリングに基づいて作成されます。製品オファリングは、顧客が利用可能な製品または製品セットを識別し、製品の一意のオプションをキャプチャする関連する製品特性と、価格、契約条件、可用性などのその他の関連属性を含みます。

この API にアクセスするには、通信事業向け注文管理 (sn_ind_tmt_orm) プラグインを有効にする必要があります。詳細については、「Install Order Management 」を参照してください。注文管理テーブルとロールの詳細については、「Components installed with Order Management」を参照してください。

この API は、 sn_ind_tmt_orm 名前空間内で提供されます。

呼び出し元ユーザーには sn_ind_tmt_orm.order_integrator ロールが必要です。

この API を拡張して、必須パラメーター、要求本文の検証、追加の REST 操作、およびフィールドマッピングをカスタマイズできます。詳細については、「製品注文オープン API 開発者ガイド。

製品注文オープン API は、TM フォーラムの製品注文管理 API 仕様のServiceNow®実装です。この実装は、 TMF622 製品注文管理 API ユーザーガイド v5.0.0 (2024 年 9 月) に基づいています。Product Order Open API は、TM フォーラムによって適合性認定を受けています。

TMF 準拠ロゴ

Product Order Open API - GET /sn_ind_tmt_orm/order/productOrder

すべての製品注文を取得します。

このエンドポイントは、次のテーブルから注文情報を取得します。

顧客注文 [sn_ind_tmt_orm_order]
注文明細品目 [sn_ind_tmt_orm_order_line_item]
発注特性 [sn_ind_tmt_orm_order_characteristic_value]
注文明細品目連絡先 [sn_ind_tmt_orm_order_line_item_contact]
注文明細関連品目 [sn_ind_tmt_orm_order_line_related_items]

URL 形式

デフォルト URL: /api/sn_ind_tmt_orm/order/productOrder

サポートされている要求パラメーター

表 : 1. パスパラメーター
名前	説明
なし

表 : 2. クエリパラメーター
名前	説明
フィールド	応答で返すフィールドのリスト。無効なフィールドは無視されます。データタイプ：文字列デフォルト:すべてのフィールドが返されます。
limit	返されるレコードの最大数。このレコード数を超える要求の場合は、 offset パラメーターを使用してレコード取得をページネーションします。データタイプ：数値デフォルト値：20 最大:100
オフセット	レコードの取得を開始する開始インデックス。この値を使用して、レコード取得をページネーションします。この機能を使用すると、レコードの数に関係なく、すべてのレコードを小さな管理可能なチャンクで取得できます。データタイプ：数値デフォルト：0
状況	注文をステータスでフィルタリングします。このパラメーターの値と一致するステータスの注文のみが応答に返されます。データタイプ：文字列デフォルト:ステータス順に並べ替えません。

表 : 3. 要求本文パラメーター (JSON)
名前	説明
なし

ヘッダー

次の要求ヘッダーと応答ヘッダーは、この HTTP アクションにのみ適用されるか、別の方法でこのアクションに適用されます。REST API で使用される一般的なヘッダーのリストについては、「サポートされている REST API ヘッダー」を参照してください。

表 : 4. 要求ヘッダー
ヘッダー	説明
なし

表 : 5. 応答ヘッダー
ヘッダー	説明
Content-Range	ページネーションされた呼び出しで返されるコンテンツの範囲。たとえば、 `offset=2` で `limit=3` の場合、 Content-Range ヘッダーの値は `アイテム 3 から 5` です。
Content-Type	応答本文のデータフォーマット。application/json のみをサポートします。
「リンク」	クエリ結果間を移動するための次のリンクが含まれています。第 1 最終次へ前へ
X-合計-数	ページネーションされたクエリの場合、このヘッダーはサーバーで使用可能なレコードの合計数を指定します。

ステータスコード

この HTTP アクションには、次のステータスコードが適用されます。REST API で使用される可能性のあるステータスコードのリストについては、「 REST API HTTP 応答コード」を参照してください。

表 : 6. ステータスコード
ステータスコード	説明
200	要求が正常に処理されました。応答で返された完全なリソース (ページネーションなし)。
206	応答で返された部分的なリソース (ページネーションあり)。
400	要求が正しくありません。考えられる理由: 無効なパスパラメーター無効な URI
404	レコードが見つかりません。クエリパラメーターに一致するレコードがテーブルに見つかりません。

応答本文のパラメーター (JSON)


名前	説明
チャネル	製品の販売に使用するチャネルのリスト。データタイプ：オブジェクトのアレイ `"channel": [ { "id": "String", "name": "String" } ]`
channel.id	関連製品の販売に使用するチャネルの一意の識別子。データタイプ：文字列
channel.name	関連製品の販売に使用するチャネルの名前。データタイプ：文字列
committedDueDate	注文に対してアクションを実行する必要がある日時。この値は、各注文品目の committedDueDate 値と同じかそれ以降にする必要があります。データタイプ：文字列
完了予定日	注文が完了する日付。データタイプ：文字列
href	製品注文レコードへの相対リンク。データタイプ：文字列
ID	製品注文の sys_id。データタイプ：文字列
注意	注文時に顧客が行った追加のメモのリスト。データタイプ：オブジェクトのアレイ `"note": [ { "author": "String", "date": "String", "text": "String" } ]`
note.author	関連するメモの作成者のユーザー名。データタイプ：文字列
note.date	メモが作成された日付。データタイプ：文字列
note.text	注文時に顧客が行った追加のメモ/コメント。データタイプ：文字列
orderCurrency	注文と注文明細品目の通貨コード。データタイプ：文字列
PONR	注文のリターンノーポイントに達したかどうかを示すフラグ。可能な値： true:注文は戻れないポイントに達しました。 false:注文の戻り不能ポイントに達していません。データタイプ：ブーリアン
製品注文アイテム	製品注文とそれに関連するアクションに関連付けられたアイテムを説明するリスト。データタイプ：オブジェクトのアレイ `"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	製品に対して実行するアクション。可能なアクションは、sn_ind_tmt_orm_order_line_itemテーブルのアクション辞書エントリの [選択リスト] タブで定義されます。データタイプ：文字列
productOrderItem.actionReason	注文明細品目を追加する理由。データタイプ：文字列格納場所:sn_ind_tmt_orm_order_line_itemテーブルのaction_reasonフィールド。
productOrderItem.committedDueDate	注文品目に対してアクションを実行する必要がある日時。データタイプ：文字列
productOrderItem.externalProductInventory	注文に対して作成された製品インベントリにマッピングされた外部 ID のリスト。データタイプ：オブジェクトのアレイ `"externalProductInventory": [ { "externalProductInventoryId": "String" } ]`
productOrderItem.externalProductInventory.externalProductInventoryId	製品インベントリにマッピングされた外部 ID。データタイプ：文字列
productOrderItem.id	品目の一意の識別子。注文明細品目 [sn_ind_tmt_orm_order_line_item] テーブルの sn_ind_tmt_orm_external_id フィールドにあります。データタイプ：文字列
productOrderItem.itemPrice	製品に関連付けられた価格を説明するリスト。データタイプ：オブジェクトのアレイ `"itemPrice": [ { "price": {Object}, "priceType": "String", "recurringChargePeriod": "String" } ]`
productOrderItem.itemPrice.price	関連製品の価格の説明。データタイプ: オブジェクト `"price": { "taxIncludedAmount": {Object} }`
productOrderItem.itemPrice.price.taxIncludedAmount	税を含む関連製品の価格の説明。データタイプ: オブジェクト `"taxIncludedAmount": { "unit": "String", "value": Number }`
productOrderItem.itemPrice.price.taxIncludedAmount.unit	価格を表す通貨コード。データタイプ：文字列
productOrderItem.itemPrice.price.taxIncludedAmount.value	製品の価格 (税込み)。データタイプ：数値
productOrderItem.itemPrice.priceType	アイテム価格のタイプ (繰り返しまたは非繰り返し)。データタイプ：文字列
productOrderItem.itemPrice.recurringChargePeriod	価格が繰り返し発生する場合は、 `月`などの繰り返し期間。データタイプ：文字列
productOrderItem.ponr	注文のリターンノーポイントに達したかどうかを示すフラグ。可能な値： true:注文は戻れないポイントに達しました。 false:注文の戻り不能ポイントに達していません。データタイプ：ブーリアン
productOrderItem.product	顧客が購入した製品のインスタンス詳細の説明。データタイプ: オブジェクト `"product:" { "place": {Object}, "productCharacteristic": [Array], "productRelationship": [Array], "productSpecification": {Object}, "relatedParty": {Object}, "@type": "String" }`
productOrderItem.product.place	製品を設置する場所のマップ。データタイプ: オブジェクト `"place": { "id": "String", "@type": "String" }`
productOrderItem.product.place.id	場所 [cmn_location] テーブル内の関連する場所レコードのSys_id。製品注文アイテムに対して ( productOrderItem.action パラメーターを使用して) 変更アクションを使用する場合、要求を新しい場所sys_id更新すると、注文は変更されず、新しい場所で履行される移動オーダーが作成されます。データタイプ：文字列
productOrderItem.product.place.@type	TMF Open API 標準の一部です。注文明細品目の連絡先の注釈。この値は常に `Place` です。この情報は保存されません。データタイプ：文字列
productOrderItem.product.productCharacteristic	関連製品の特性のリスト。 valueがpreviousValueと異なる製品特性のみが返されます。データタイプ：オブジェクトのアレイ `"productCharacteristic": [ { "name": "String", "previousValue": "String", "value": "String", "valueType": "String" } ]`
productOrderItem.product.productCharacteristic.name	製品に関連付ける特性レコードの名前。特性 [sn_prd_pm_characteristic] テーブルにあります。データタイプ：文字列
productOrderItem.product.productCharacteristic.previousValue	更新が変更指示用である場合の以前の特性オプションの値。productOrderItem.actionパラメーターが `add` 以外の場合、要求は変更指示です。特性オプション値の詳細については、「 Create product characteristics and characteristic options」を参照してください。データタイプ：文字列
productOrderItem.product.productCharacteristic.value	製品に関連付けられた特性オプション値。特性オプション値の詳細については、「 Create product characteristics and characteristic options」を参照してください。データタイプ：文字列
productOrderItem.product.productCharacteristic.valueType	特性値のタイプ。可能な値： Array.Date Array.Datetime Array.Decimal Array.Integer Array.Object Array.Single Line Test チェックボックス選択肢日付、住所メール整数、日付/時刻オブジェクト 1 行テキストはい/いいえデータタイプ：文字列
productOrderItem.product.productRelationship	注文品目の製品リレーションシップの詳細のリスト。データタイプ：オブジェクトのアレイ `"productRelationship": [ { "id": "String", "relationshipType": "String" } ]`
productOrderItem.product.productRelationship.id	製品インベントリのSys_idまたはsn_prd_invt_external_id。データタイプ：文字列テーブル:製品インベントリ [sn_prd_invt_product_inventory] テーブルのsys_idまたはsn_prd_invt_external_idフィールド内。
productOrderItem.product.productRelationship.relationshipType	注文品目と製品インベントリの間の関係のタイプ。可能な値:必要データタイプ：文字列
productOrderItem.product.productSpecification	製品に関連付けられた製品仕様の説明。データタイプ: オブジェクト `"productSpecification:" { "id": "String", "internalId": "String", "internalVersion": "String", "name": "String", "version": "String", "@type": "String" }`
productOrderItem.product.productSpecification.id	製品仕様のInitial_versionまたはexternal_id。initial_versionは仕様の最初のバージョンのsys_idです。製品仕様 [sn_prd_pm_product_specification] テーブルの [sys_id] または [external_id] フィールドにあります。データタイプ：文字列
productOrderItem.product.productSpecification.internalId	製品仕様の初期バージョン。初期バージョンは、仕様の最初のバージョンのsys_idです。データタイプ：文字列表:製品仕様 [sn_prd_pm_product_specification]
productOrderItem.product.productSpecification.internalVersion	製品仕様のバージョン。データタイプ：文字列テーブル:製品仕様 [sn_prd_pm_product_specification] テーブルのバージョンフィールド。
productOrderItem.product.productSpecification.name	製品仕様の名前。製品仕様 [sn_prd_pm_product_specification] テーブルにあります。データタイプ：文字列
productOrderItem.product.productSpecification.version	製品仕様の外部バージョン。データタイプ：文字列テーブル:製品仕様 [sn_prd_pm_product_specification] テーブルの external_version フィールド。
productOrderItem.product.productSpecification.@type	TMF Open API 標準の一部です。この値は常に `ProductSpecificationRef` です。この情報は保存されません。データタイプ：文字列
productOrderItem.product.relatedParty	品目の連絡先のリスト。データタイプ：オブジェクトのアレイ `"relatedParty:" [ { "email": "String", "firstName": "String", "id": "String", "lastName": "String", "phone": "String", "@referredType": "String", "@type": "String" } ]`
productOrderItem.product.relatedParty.email	連絡先のメールアドレス。データタイプ：文字列
productOrderItem.product.relatedParty.firstName	連絡先の名。データタイプ：文字列
productOrderItem.product.relatedParty.id	注文品目に関連付けられた品目連絡先のSys_id。注文明細品目連絡先 [sn_ind_tmt_orm_order_line_item_contact] テーブルにあります。データタイプ：文字列
productOrderItem.product.relatedParty.lastName	連絡先の名前 (姓)。データタイプ：文字列データタイプ：文字列
productOrderItem.product.relatedParty.phone	連絡先の勤務先電話番号。データタイプ：文字列
productOrderItem.product.relatedParty.@referredType	顧客のタイプ。可能な値:OrderLineItemContact データタイプ：文字列
productOrderItem.product.relatedParty.@type	TMF Open API 標準の一部です。注文明細品目の連絡先の注釈。この値は常に `RelatedParty` です。この情報は保存されません。データタイプ：文字列
productOrderItem.productOffering	製品に関連付けられた製品オファリングの説明。データタイプ: オブジェクト `"productOffering:" { "id": "String", "internalId": "String", "internalVersion": "String", "name": "String", "version": "String" }`
productOrderItem.productOffering.id	製品オファリングのInitial_versionまたはexternal_id。initial_versionは、オファリングの最初のバージョンのsys_idです。製品オファリング [sn_prd_pm_product_offering] テーブルの sys_id または external_id フィールドにあります。データタイプ：文字列
productOrderItem.productOffering.internalId	製品オファリングの初期バージョン。初期バージョンは、オファリングの最初のバージョンのsys_idです。データタイプ：文字列テーブル:製品オファリング [sn_prd_pm_product_offering]
productOrderItem.productOffering.internalVersion	製品オファリングのバージョン。データタイプ：文字列テーブル:製品オファリング [sn_prd_pm_product_offering] テーブル、フィールドバージョン。
productOrderItem.productOffering.name	製品オファリングの名前。製品オファリング [sn_prd_pm_product_offering] テーブルにあります。データタイプ：文字列
productOrderItem.productOffering.version	製品オファリングの外部バージョン。データタイプ：文字列テーブル:製品オファリング [sn_prd_pm_product_offering] テーブルの [external_version] フィールド。
productOrderItem.quantity	購入した製品アイテムの数。データタイプ：数値
productOrderItem.productOrderItemRelationship	注文品目間の関係のリスト。データタイプ：オブジェクトのアレイ `"productOrderItemRelationship": [ { "id": "String", "relationshipType": "String" } ]`
productOrderItem.productOrderItemRelationship.id	関連品目の一意の識別子。注文明細品目 [sn_ind_tmt_orm_order_line_item] テーブルの sn_ind_tmt_orm_external_id フィールドにあります。データタイプ：文字列
productOrderItem.productOrderItemRelationship.relationshipType	2 つの品目間の関係のタイプ。この情報は、関係階層を識別するために使用されます。可能な値： HasChild 親がある必要 `HasChild` と `HasParent` は、親子関係に使用されます。[`必須]` は水平関係に使用されます (品目には別の品目が必要です)。データタイプ：文字列
productOrderItem.state	関連製品アイテムの注文状況。データタイプ：文字列
productOrderItem.version	注文バージョン。データタイプ：文字列
productOrderItem.@type	TMF Open API 標準の一部です。製品の注釈。この値は常に `ProductOrderItem` です。この情報は保存されません。データタイプ：文字列
関連パーティー	注文の連絡先のリスト。各連絡先はアレイ内のオブジェクトです。顧客アカウントまたはコンシューマーアカウント情報を含むアイテムを少なくとも 1 つリストする必要があります。データタイプ：オブジェクトのアレイ `"relatedParty:" [ { "id": "String", "name": "String", "@referredType": "String", "@type": "String" } ]`
relatedParty.id	注文に関連付けられたアカウント、顧客連絡先、またはコンシューマーのSys_idまたはexternal_id。アカウント [customer_account]、連絡先 [customer_contact] テーブル、またはコンシューマー [csm_consumer] テーブルにあります。データタイプ：文字列
relatedParty.name	アカウント、顧客、またはコンシューマーの名前。データタイプ：文字列
relatedParty.@referredType	顧客のタイプ。可能な値：コンシューマー顧客顧客連絡先データタイプ：文字列
relatedParty.@type	TMF Open API 標準の一部です。製品の注釈。この値は常に `RelatedParty` です。この情報は保存されません。データタイプ：文字列
requestedCompletionDate	顧客が要求した配送日。データタイプ：文字列
requestedStartDate	顧客が要求した注文開始日。データタイプ：文字列
状況	注文の現在のステータス。データタイプ：文字列
version	注文バージョン。データタイプ：文字列
@type	TMF Open API 標準の一部です。製品の注釈。この値は常に `ProductOrder` です。この情報は保存されません。データタイプ：文字列

cURL 要求

この例では、すべての製品注文を取得します。

curl --location --request GET 'https://instance.service-now.com/api/sn_ind_tmt_orm/order/productOrder' \
--user 'username':'password'

応答本文。

[
   {
      "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/productorder

すべての製品注文を取得します。

重要:

Tokyoリリース以降、このエンドポイントは廃止されました。このエンドポイントの新しいバージョンは Product Order Open API - GET /sn_ind_tmt_orm/order/productOrder です。

このエンドポイントは、次のテーブルから注文情報を取得します。

顧客注文 [sn_ind_tmt_orm_order]
発注特性 [sn_ind_tmt_orm_order_characteristic_value]
注文明細品目 [sn_ind_tmt_orm_order_line_item]
注文明細品目連絡先 [sn_ind_tmt_orm_order_line_item_contact]

URL 形式

デフォルト URL: /api/sn_ind_tmt_orm/productorder

サポートされている要求パラメーター

表 : 7. パスパラメーター
名前	説明
なし

表 : 8. クエリパラメーター
名前	説明
フィールド	応答で返すフィールドのリスト。無効なフィールドは無視されます。データタイプ：文字列デフォルト:すべてのフィールドが返されます。
limit	返されるレコードの最大数。このレコード数を超える要求の場合は、 offset パラメーターを使用してレコード取得をページネーションします。データタイプ：数値デフォルト値：20 最大:100
オフセット	レコードの取得を開始する開始インデックス。この値を使用して、レコード取得をページネーションします。この機能を使用すると、レコードの数に関係なく、すべてのレコードを小さな管理可能なチャンクで取得できます。データタイプ：数値デフォルト：0
状況	注文をステータスでフィルタリングします。このパラメーターの値と一致するステータスの注文のみが応答に返されます。データタイプ：文字列デフォルト:すべてのステータスが返されます。

表 : 9. 要求本文パラメーター (JSON)
名前	説明
なし

ヘッダー

表 : 10. 要求ヘッダー
ヘッダー	説明
なし

表 : 11. 応答ヘッダー
ヘッダー	説明
Content-Range	ページネーションされた呼び出しで返されるコンテンツの範囲。たとえば、 `offset=2` で `limit=3` の場合、 Content-Range ヘッダーの値は `アイテム 3 から 5` です。
Content-Type	応答本文のデータフォーマット。application/json のみをサポートします。
「リンク」	クエリ結果間を移動するための次のリンクが含まれています。第 1 最終次へ前へ
X-合計-数	ページネーションされたクエリの場合、このヘッダーはサーバーで使用可能なレコードの合計数を指定します。

ステータスコード

表 : 12. ステータスコード
ステータスコード	説明
200	要求が正常に処理されました。応答で返された完全なリソース (ページネーションなし)。
206	応答で返された部分的なリソース (ページネーションあり)。
400	要求が正しくありません。考えられる理由: 無効なパスパラメーター無効な URI
404	レコードが見つかりません。クエリパラメーターに一致するレコードがテーブルに見つかりません。

応答本文のパラメーター (JSON)


名前	説明
チャネル	製品の販売に使用するチャネルのリスト。データタイプ：オブジェクトのアレイ `"channel": [ { "id": "String", "name": "String" } ]`
channel.id	関連製品の販売に使用するチャネルの一意の識別子。データタイプ：文字列
channel.name	関連製品の販売に使用するチャネルの名前。データタイプ：文字列
完了予定日	注文が完了する日付。データタイプ：文字列
注意	注文時に顧客が行った追加のメモのリスト。データタイプ：オブジェクトのアレイ `"note": { "author": "String", "date": "String", "text": "String" }`
note.author	関連するメモの作成者のユーザー名。データタイプ：文字列
note.date	メモが作成された日付。データタイプ：文字列
note.text	注文時に顧客が行った追加のメモ/コメント。データタイプ：文字列
PONR	注文のリターンノーポイントに達したかどうかを示すフラグ。可能な値： true:注文は戻れないポイントに達しました。 false:注文の戻り不能ポイントに達していません。データタイプ：ブーリアン
製品注文アイテム	製品注文とそれに関連するアクションに関連付けられたアイテムを説明するリスト。データタイプ：オブジェクトのアレイ `"productOrderItem:" [ { "action": "String", "actionReason": "String", "id": "String", "itemPrice": [Array], "product": {Object}, "productOffering": {Object}, "productOrderItemReleationship": [Array], "quantity": Number, "state": "String", "@type": "String" } ]`
productOrderItem.action	製品に対して実行するアクション。可能なアクションは、sn_ind_tmt_orm_order_line_itemテーブルのアクション辞書エントリの [選択リスト] タブで定義されます。データタイプ：文字列
productOrderItem.actionReason	注文明細品目を追加する理由。データタイプ：文字列格納場所:sn_ind_tmt_orm_order_line_itemテーブルのaction_reasonフィールド。
productOrderItem.id	品目の一意の識別子。注文明細品目 [sn_ind_tmt_orm_order_line_item] テーブルの sn_ind_tmt_orm_external_id フィールドにあります。データタイプ：文字列
productOrderItem.itemPrice	製品に関連付けられた価格を説明するリスト。データタイプ：オブジェクトのアレイ `"itemPrice": [ { "price": {Object}, "priceType": "String", "recurringChargePeriod": "String" } ]`
productOrderItem.itemPrice.price	関連製品の価格の説明。データタイプ: オブジェクト `"price": { "taxIncludedAmount": {Object} }`
productOrderItem.itemPrice.price.taxIncludedAmount	税を含む関連製品の価格の説明。データタイプ: オブジェクト `"taxIncludedAmount": { "unit": "String", "value": Number }`
productOrderItem.itemPrice.price.taxIncludedAmount.unit	価格を表す通貨コード。データタイプ：文字列
productOrderItem.itemPrice.price.taxIncludedAmount.value	製品の価格 (税込み)。データタイプ：数値
productOrderItem.itemPrice.priceType	アイテム価格のタイプ (繰り返しまたは非繰り返し)。データタイプ：文字列
productOrderItem.itemPrice.recurringChargePeriod	価格が繰り返し発生する場合は、 `月`などの繰り返し期間。データタイプ：文字列
productOrderItem.ponr	注文のリターンノーポイントに達したかどうかを示すフラグ。可能な値： true:注文は戻れないポイントに達しました。 false:注文の戻り不能ポイントに達していません。データタイプ：ブーリアン
productOrderItem.product	顧客が購入した製品のインスタンス詳細の説明。データタイプ: オブジェクト `"product:" { "place": {Object}, "productCharacteristic": [Array], "productSpecification": {Object}, "relatedParty": {Object}, "@type": "String" }`
productOrderItem.product.place	製品を設置する場所のマップ。データタイプ: オブジェクト `"place": { "id": "String", "@type": "String" }`
productOrderItem.product.place.id	場所 [cmn_location] テーブル内の関連する場所レコードのSys_id。製品注文アイテムに対して ( productOrderItem.action パラメーターを使用して) 変更アクションを使用する場合、要求を新しい場所sys_id更新すると、注文は変更されず、新しい場所で履行される移動オーダーが作成されます。データタイプ：文字列
productOrderItem.product.place.@type	TMF Open API 標準の一部です。注文明細品目の連絡先の注釈。この値は常に `Place` です。この情報は保存されません。データタイプ：文字列
productOrderItem.product.productCharacteristic	関連製品の特性のリスト。 valueがpreviousValueと異なる製品特性のみが返されます。データタイプ：オブジェクトのアレイ `"productCharacteristic": [ { "name": "String", "previousValue": "String", "value": "String", "valueType": "String" } ]`
productOrderItem.product.productCharacteristic.name	製品に関連付ける特性レコードの名前。特性 [sn_prd_pm_characteristic] テーブルにあります。データタイプ：文字列
productOrderItem.product.productCharacteristic.previousValue	更新が変更指示用である場合の以前の特性オプションの値。productOrderItem.actionパラメーターが `add` 以外の場合、要求は変更指示です。特性オプション値の詳細については、「 Create product characteristics and characteristic options」を参照してください。データタイプ：文字列
productOrderItem.product.productCharacteristic.value	製品に関連付けられた特性オプション値。特性オプション値の詳細については、「 Create product characteristics and characteristic options」を参照してください。データタイプ：文字列
productOrderItem.product.productCharacteristic.valueType	特性値のタイプ。可能な値： Array.Date Array.Datetime Array.Decimal Array.Integer Array.Object Array.Single Line Test チェックボックス選択肢日付、住所メール整数、日付/時刻オブジェクト 1 行テキストはい/いいえデータタイプ：文字列
productOrderItem.product.productSpecification	製品に関連付けられた製品仕様の説明。データタイプ: オブジェクト `"productSpecification:" { "id": "String", "name": "String", "@type": "String" }`
productOrderItem.product.productSpecification.id	製品仕様のInitial_versionまたはexternal_id。initial_versionは仕様の最初のバージョンのsys_idです。製品仕様 [sn_prd_pm_product_specification] テーブルの [sys_id] または [external_id] フィールドにあります。データタイプ：文字列
productOrderItem.product.productSpecification.name	製品仕様の名前。製品仕様 [sn_prd_pm_product_specification] テーブルにあります。データタイプ：文字列
productOrderItem.product.productSpecification.@type	TMF Open API 標準の一部です。この値は常に `ProductSpecificationRef` です。この情報は保存されません。データタイプ：文字列
productOrderItem.product.relatedParty	品目の連絡先のリスト。データタイプ：オブジェクトのアレイ `"relatedParty:" { "email": "String", "firstName": "String", "id": "String", "lastName": "String", "phone": "String", "@referredType": "String", "@type": "String" }`
productOrderItem.product.relatedParty.email	連絡先のメールアドレス。データタイプ：文字列
productOrderItem.product.relatedParty.firstName	連絡先の名。データタイプ：文字列
productOrderItem.product.relatedParty.id	注文品目に関連付けられた品目連絡先のSys_id。注文明細品目連絡先 [sn_ind_tmt_orm_order_line_item_contact] テーブルにあります。データタイプ：文字列
productOrderItem.product.relatedParty.lastName	連絡先の名前 (姓)。データタイプ：文字列データタイプ：文字列
productOrderItem.product.relatedParty.phone	連絡先の勤務先電話番号。データタイプ：文字列
productOrderItem.product.relatedParty.@referredType	顧客のタイプ。可能な値:OrderLineItemContact データタイプ：文字列
productOrderItem.product.relatedParty.@type	TMF Open API 標準の一部です。注文明細品目の連絡先の注釈。この値は常に `RelatedParty` です。この情報は保存されません。データタイプ：文字列
productOrderItem.productOffering	製品に関連付けられた製品オファリングの説明。データタイプ: オブジェクト `"productOffering": { "id": "String", "internalVersion": "String", "name": "String", "version": "String" }`
productOrderItem.productOffering.id	製品オファリングのInitial_versionまたはexternal_id。initial_versionは、オファリングの最初のバージョンのsys_idです。製品オファリング [sn_prd_pm_product_offering] テーブルの sys_id または external_id フィールドにあります。データタイプ：文字列
productOrderItem.productOffering.name	製品オファリングの名前。製品オファリング [sn_prd_pm_product_offering] テーブルにあります。データタイプ：文字列
productOrderItem.quantity	購入した製品アイテムの数。データタイプ：数値
productOrderItem.productOrderItemRelationship	注文品目間の関係のリスト。データタイプ：オブジェクトのアレイ `"productOrderItemRelationship": [ { "id": "String", "relationshipType": "String" } ]`
productOrderItem.productOrderItemRelationship.id	関連品目の一意の識別子。注文明細品目 [sn_ind_tmt_orm_order_line_item] テーブルの sn_ind_tmt_orm_external_id フィールドにあります。データタイプ：文字列
productOrderItem.productOrderItemRelationship.relationshipType	2 つの品目間の関係のタイプ。この情報は、関係階層を識別するために使用されます。可能な値： HasChild 親がある必要 `HasChild` と `HasParent` は、親子関係に使用されます。[`必須]` は水平関係に使用されます (品目には別の品目が必要です)。データタイプ：文字列
productOrderItem.state	関連製品アイテムの注文状況。データタイプ：文字列
productOrderItem.version	注文バージョン。データタイプ：文字列
productOrderItem.@type	TMF Open API 標準の一部です。製品の注釈。この値は常に `ProductOrderItem` です。この情報は保存されません。データタイプ：文字列
関連パーティー	注文の連絡先のリスト。各連絡先はアレイ内のオブジェクトです。顧客アカウントまたはコンシューマーアカウント情報を含むアイテムを少なくとも 1 つリストする必要があります。データタイプ：オブジェクトのアレイ `"relatedParty:" [ { "id": "String", "name": "String", "@referredType": "String", "@type": "String" } ]`
relatedParty.id	注文に関連付けられたアカウント、顧客連絡先、またはコンシューマーのSys_idまたはexternal_id。アカウント [customer_account]、連絡先 [customer_contact] テーブル、またはコンシューマー [csm_consumer] テーブルにあります。データタイプ：文字列
relatedParty.name	アカウント、顧客、またはコンシューマーの名前。データタイプ：文字列
relatedParty.@referredType	顧客のタイプ。可能な値：コンシューマー顧客顧客連絡先データタイプ：文字列
relatedParty.@type	TMF Open API 標準の一部です。製品の注釈。この値は常に `RelatedParty` です。この情報は保存されません。データタイプ：文字列
requestedCompletionDate	顧客が要求した配送日。データタイプ：文字列
requestedStartDate	顧客が要求した注文開始日。データタイプ：文字列
状況	注文の現在のステータス。データタイプ：文字列
version	注文バージョン。データタイプ：文字列
@type	TMF Open API 標準の一部です。製品の注釈。この値は常に `ProductOrder` です。この情報は保存されません。データタイプ：文字列

cURL 要求

この例では、すべての製品注文を取得します。

curl --location --request GET 'https://instance.servicenow.com/api/sn_ind_tmt_orm/productorder' \
--user 'username':'password'

応答本文。

[
   {
      "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}

指定された製品注文を取得します。

重要:

Tokyoリリース以降、このエンドポイントは廃止されました。このエンドポイントの新しいバージョンは Product Order Open API - GET /sn_ind_tmt_orm/productorder/{id} です。

このエンドポイントは、次のテーブルから注文情報を取得します。

顧客注文 [sn_ind_tmt_orm_order]
発注特性 [sn_ind_tmt_orm_order_characteristic_value]
注文明細品目 [sn_ind_tmt_orm_order_line_item]
注文明細品目連絡先 [sn_ind_tmt_orm_order_line_item_contact]

URL 形式

デフォルト URL: /api/sn_ind_tmt_orm/productorder/{id}

サポートされている要求パラメーター

表 : 13. パスパラメーター
名前	説明
ID	取得する顧客注文のSys_idまたはexternal_id。データタイプ：文字列テーブル:顧客注文 [sn_ind_tmt_orm_order]

表 : 14. クエリパラメーター
名前	説明
なし

表 : 15. 要求本文パラメーター (JSON)
名前	説明
なし

ヘッダー

表 : 16. 要求ヘッダー
ヘッダー	説明
なし

表 : 17. 応答ヘッダー
ヘッダー	説明
Content-Type	応答本文のデータフォーマット。application/json のみをサポートします。

ステータスコード

表 : 18. ステータスコード
ステータスコード	説明
201	成功。要求が正常に処理されました。
400	要求が正しくありません。次のいずれかの理由が考えられます。クエリパラメーターがありません無効な URI
404	見つかりません。要求されたアイテムが見つかりませんでした。

応答本文のパラメーター (JSON)


名前	説明
チャネル	製品の販売に使用するチャネルのリスト。データタイプ：オブジェクトのアレイ `"channel": [ { "id": "String", "name": "String" } ]`
channel.id	関連製品の販売に使用するチャネルの一意の識別子。データタイプ：文字列
channel.name	関連製品の販売に使用するチャネルの名前。データタイプ：文字列
完了予定日	注文が完了する日付。データタイプ：文字列
注意	注文時に顧客が行った追加のメモのリスト。データタイプ: オブジェクト `"note": { "author": "String", "date": "String", "text": "String" }`
note.author	関連するメモの作成者のユーザー名。データタイプ：文字列
note.date	メモが作成された日付。データタイプ：文字列
note.text	注文時に顧客が行った追加のメモ/コメント。データタイプ：文字列
PONR	注文のリターンノーポイントに達したかどうかを示すフラグ。可能な値： true:注文は戻れないポイントに達しました。 false:注文の戻り不能ポイントに達していません。データタイプ：ブーリアン
製品注文アイテム	製品注文とそれに関連するアクションに関連付けられたアイテムを説明するリスト。データタイプ：オブジェクトのアレイ `"productOrderItem:" [ { "action": "String", "actionReason": "String", "id": "String", "itemPrice": [Array], "product": {Object}, "productOffering": {Object}, "productOrderItemReleationship": [Array], "quantity": Number, "state": "String", "@type": "String" } ]`
productOrderItem.action	製品に対して実行するアクション。可能なアクションは、sn_ind_tmt_orm_order_line_itemテーブルのアクション辞書エントリの [選択リスト] タブで定義されます。データタイプ：文字列
productOrderItem.actionReason	注文明細品目を追加する理由。データタイプ：文字列格納場所:sn_ind_tmt_orm_order_line_itemテーブルのaction_reasonフィールド。
productOrderItem.id	品目の一意の識別子。注文明細品目 [sn_ind_tmt_orm_order_line_item] テーブルの sn_ind_tmt_orm_external_id フィールドにあります。データタイプ：文字列
productOrderItem.itemPrice	製品に関連付けられた価格を説明するリスト。データタイプ：オブジェクトのアレイ `"itemPrice": [ { "price": {Object}, "priceType": "String", "recurringChargePeriod": "String" } ]`
productOrderItem.itemPrice.price	関連製品の価格の説明。データタイプ: オブジェクト `"price": { "taxIncludedAmount": {Object} }`
productOrderItem.itemPrice.price.taxIncludedAmount	税を含む関連製品の価格の説明。データタイプ: オブジェクト `"taxIncludedAmount": { "unit": "String", "value": Number }`
productOrderItem.itemPrice.price.taxIncludedAmount.unit	価格を表す通貨コード。データタイプ：文字列
productOrderItem.itemPrice.price.taxIncludedAmount.value	製品の価格 (税込み)。データタイプ：数値
productOrderItem.itemPrice.priceType	アイテム価格のタイプ (繰り返しまたは非繰り返し)。データタイプ：文字列
productOrderItem.itemPrice.recurringChargePeriod	価格が繰り返し発生する場合は、 `月`などの繰り返し期間。データタイプ：文字列
productOrderItem.ponr	注文のリターンノーポイントに達したかどうかを示すフラグ。可能な値： true:注文は戻れないポイントに達しました。 false:注文の戻り不能ポイントに達していません。データタイプ：ブーリアン
productOrderItem.product	顧客が購入した製品のインスタンス詳細の説明。データタイプ: オブジェクト `"product:" { "place": {Object}, "productCharacteristic": [Array], "productSpecification": {Object}, "relatedParty": {Object}, "@type": "String" }`
productOrderItem.product.place	製品を設置する場所のマップ。データタイプ: オブジェクト `"place": { "id": "String", "@type": "String" }`
productOrderItem.product.place.id	場所 [cmn_location] テーブル内の関連する場所レコードのSys_id。製品注文アイテムに対して ( productOrderItem.action パラメーターを使用して) 変更アクションを使用する場合、要求を新しい場所sys_id更新すると、注文は変更されず、新しい場所で履行される移動オーダーが作成されます。データタイプ：文字列
productOrderItem.product.place.@type	TMF Open API 標準の一部です。注文明細品目の連絡先の注釈。この値は常に `Place` です。この情報は保存されません。データタイプ：文字列
productOrderItem.product.productCharacteristic	関連製品の特性のリスト。 valueがpreviousValueと異なる製品特性のみが返されます。データタイプ：オブジェクトのアレイ `"productCharacteristic": [ { "name": "String", "previousValue": "String", "value": "String", "valueType": "String" } ]`
productOrderItem.product.productCharacteristic.name	製品に関連付ける特性レコードの名前。特性 [sn_prd_pm_characteristic] テーブルにあります。データタイプ：文字列
productOrderItem.product.productCharacteristic.previousValue	更新が変更指示用である場合の以前の特性オプションの値。productOrderItem.actionパラメーターが `add` 以外の場合、要求は変更指示です。特性オプション値の詳細については、「 Create product characteristics and characteristic options」を参照してください。データタイプ：文字列
productOrderItem.product.productCharacteristic.value	製品に関連付けられた特性オプション値。特性オプション値の詳細については、「 Create product characteristics and characteristic options」を参照してください。データタイプ：文字列
productOrderItem.product.productCharacteristic.valueType	特性値のタイプ。可能な値： Array.Date Array.Datetime Array.Decimal Array.Integer Array.Object Array.Single Line Test チェックボックス選択肢日付、住所メール整数、日付/時刻オブジェクト 1 行テキストはい/いいえデータタイプ：文字列
productOrderItem.product.productSpecification	製品に関連付けられた製品仕様の説明。データタイプ: オブジェクト `"productSpecification:" { "id": "String", "name": "String", "@type": "String" }`
productOrderItem.product.productSpecification.id	製品仕様のInitial_versionまたはexternal_id。initial_versionは仕様の最初のバージョンのsys_idです。製品仕様 [sn_prd_pm_product_specification] テーブルの [sys_id] または [external_id] フィールドにあります。データタイプ：文字列
productOrderItem.product.productSpecification.name	製品仕様の名前。製品仕様 [sn_prd_pm_product_specification] テーブルにあります。データタイプ：文字列
productOrderItem.product.productSpecification.@type	TMF Open API 標準の一部です。この値は常に `ProductSpecificationRef` です。この情報は保存されません。データタイプ：文字列
productOrderItem.product.relatedParty	品目の連絡先のリスト。データタイプ: オブジェクト `"relatedParty:" { "email": "String", "firstName": "String", "id": "String", "lastName": "String", "phone": "String", "@referredType": "String", "@type": "String" }`
productOrderItem.product.relatedParty.email	連絡先のメールアドレス。データタイプ：文字列
productOrderItem.product.relatedParty.firstName	連絡先の名。データタイプ：文字列
productOrderItem.product.relatedParty.id	注文品目に関連付けられた品目連絡先のSys_id。注文明細品目連絡先 [sn_ind_tmt_orm_order_line_item_contact] テーブルにあります。データタイプ：文字列
productOrderItem.product.relatedParty.lastName	連絡先の名前 (姓)。データタイプ：文字列
productOrderItem.product.relatedParty.phone	連絡先の勤務先電話番号。データタイプ：文字列
productOrderItem.product.relatedParty.@referredType	顧客のタイプ。可能な値:OrderLineItemContact データタイプ：文字列
productOrderItem.product.relatedParty.@type	TMF Open API 標準の一部です。注文明細品目の連絡先の注釈。この値は常に `RelatedParty` です。この情報は保存されません。データタイプ：文字列
productOrderItem.productOffering	製品に関連付けられた製品オファリングの説明。データタイプ: オブジェクト `"productOffering": { "id": "String", "internalVersion": "String", "name": "String", "version": "String" }`
productOrderItem.productOffering.id	製品オファリングのInitial_versionまたはexternal_id。initial_versionは、オファリングの最初のバージョンのsys_idです。製品オファリング [sn_prd_pm_product_offering] テーブルの sys_id または external_id フィールドにあります。データタイプ：文字列
productOrderItem.productOffering.name	製品オファリングの名前。製品オファリング [sn_prd_pm_product_offering] テーブルにあります。データタイプ：文字列
productOrderItem.quantity	購入した製品アイテムの数。データタイプ：数値
productOrderItem.productOrderItemRelationship	注文品目間の関係のリスト。データタイプ：オブジェクトのアレイ `"productOrderItemRelationship": [ { "id": "String", "relationshipType": "String" } ]`
productOrderItem.productOrderItemRelationship.id	関連品目の一意の識別子。注文明細品目 [sn_ind_tmt_orm_order_line_item] テーブルの sn_ind_tmt_orm_external_id フィールドにあります。データタイプ：文字列
productOrderItem.productOrderItemRelationship.relationshipType	2 つの品目間の関係のタイプ。この情報は、関係階層を識別するために使用されます。可能な値： HasChild 親がある必要 `HasChild` と `HasParent` は、親子関係に使用されます。[`必須]` は水平関係に使用されます (品目には別の品目が必要です)。データタイプ：文字列
productOrderItem.state	関連製品アイテムの注文状況。データタイプ：文字列
productOrderItem.version	注文バージョン。データタイプ：文字列
productOrderItem.@type	TMF Open API 標準の一部です。製品の注釈。この値は常に `ProductOrderItem` です。この情報は保存されません。データタイプ：文字列
関連パーティー	注文の連絡先のリスト。各連絡先はアレイ内のオブジェクトです。顧客アカウントまたはコンシューマーアカウント情報を含むアイテムを少なくとも 1 つリストする必要があります。データタイプ：オブジェクトのアレイ `"relatedParty:" [ { "id": "String", "name": "String", "@referredType": "String", "@type": "String" } ]`
relatedParty.id	注文に関連付けられたアカウント、顧客連絡先、またはコンシューマーのSys_idまたはexternal_id。アカウント [customer_account]、連絡先 [customer_contact] テーブル、またはコンシューマー [csm_consumer] テーブルにあります。データタイプ：文字列
relatedParty.name	アカウント、顧客、またはコンシューマーの名前。データタイプ：文字列
relatedParty.@referredType	顧客のタイプ。可能な値：コンシューマー顧客顧客連絡先データタイプ：文字列
relatedParty.@type	TMF Open API 標準の一部です。製品の注釈。この値は常に `RelatedParty` です。この情報は保存されません。データタイプ：文字列
requestedCompletionDate	顧客が要求した配送日。データタイプ：文字列
requestedStartDate	顧客が要求した注文開始日。データタイプ：文字列
状況	注文の現在のステータス。データタイプ：文字列
version	注文バージョン。データタイプ：文字列
@type	TMF Open API 標準の一部です。製品の注釈。この値は常に `ProductOrder` です。この情報は保存されません。データタイプ：文字列

cURL 要求

次のコード例は、既存の顧客の注文を要求します。

curl -X GET "https://servicenow-instance/api/sn_ind_tmt_orm/productorder/8d75939453126010a795ddeeff7b126a" \
-u "username":"password"

応答本文。

{
  "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 - GET /sn_ind_tmt_orm/order/productOrder/{id}

指定された顧客注文を更新します。

URL 形式

デフォルト URL: /api/sn_ind_tmt_orm/order/productOrder/{id}

サポートされている要求パラメーター

表 : 19. パスパラメーター
名前	説明
ID	更新する顧客注文のSys_id。データタイプ：文字列テーブル:顧客注文 [sn_ind_tmt_orm_order]

表 : 20. クエリパラメーター
名前	説明
なし

表 : 21. 要求本文パラメーター (JSON)
名前	説明
@type	TMF Open API 標準の一部です。製品の注釈。この値は常に `ProductOrder` です。この情報は保存されません。データタイプ：文字列
チャネル	製品の販売に使用するチャネルのリスト。データタイプ：オブジェクトのアレイ `"channel": [ { "id": "String", "name": "String" } ]` 保存場所:sn_ind_tmt_orm_order
channel.id	channelパラメーターを使用する場合は必須です。関連製品の販売に使用するチャネルの一意の識別子。データタイプ：文字列テーブル:流通チャネル [sn_prd_pm_distribution_channel] テーブルの external_id フィールド内。格納場所:sn_ind_tmt_orm_orderテーブルのチャネルフィールド。デフォルト：空白の文字列
channel.name	関連製品の販売に使用するチャネルの名前。可能なチャネル名は、sn_ind_tmt_orm_orderテーブルのチャネル辞書エントリの [選択リスト] タブで定義されます。データタイプ：文字列デフォルト：空白の文字列
committedDueDate	注文に対してアクションを実行する必要がある日時。この値は、各注文品目の committedDueDate 値と同じかそれ以降にする必要があります。注文品目のアクションが `一時停止` または `再開`の場合、このパラメーターは更新できません。データタイプ：文字列格納場所:sn_ind_tmt_orm_orderテーブルのcommitted_due_dateフィールド。
externalId	顧客注文の一意の識別子。この値は外部システムによって決定されます。データタイプ：文字列格納場所:sn_ind_tmt_orm_orderテーブルのexternal_idフィールド。デフォルト：空白の文字列
外部システム	`TMF622` が追加されたサービス注文の外部システム。たとえば、外部システムが ABC の場合、 externalSystem に `ABC-TMF622` と入力します。データタイプ:文字列
注意	注文時に顧客が行った追加のメモのリスト。データタイプ：オブジェクトのアレイ `"note": [ { "text": "String" } ]` 保存場所:sn_ind_tmt_orm_order
note.text	注文時に顧客が行った追加のメモ/コメント。データタイプ：文字列格納場所:sn_ind_tmt_orm_orderテーブルのコメントフィールド。デフォルト：空白の文字列
orderCurrency	注文と注文明細品目の通貨コード。既存の注文の通貨コードの更新はサポートされていません。注文に既に関連付けられている通貨コード以外の値を指定すると、更新が却下されます。データタイプ：文字列
製品注文アイテム	製品注文とそれに関連するアクションに関連付けられたアイテムを説明するリスト。データタイプ：オブジェクトのアレイ `"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" } ]` 格納場所:sn_ind_tmt_orm_order_line_item
productOrderItem.@type	TMF Open API 標準の一部です。製品の注釈。この値は常に `ProductOrderItem` です。この情報は保存されません。データタイプ：文字列
productOrderItem.action	productOrderItemパラメーターを使用する場合は必須です。製品に対して実行するアクション。可能なアクションは、sn_ind_tmt_orm_order_line_itemテーブルのアクション辞書エントリの [選択リスト] タブで定義されます。可能な値：追加変更注: productOrderItem.product.place.idを介して新しいサービスの場所を含む変更ペイロードを送信すると、移動オーダーとして処理されます。 delete 変更なし再開停止するデータタイプ：文字列格納場所:sn_ind_tmt_orm_order_line_itemテーブルのアクションフィールド。デフォルト:追加
productOrderItem.actionReason	注文明細品目を追加する理由。データタイプ：文字列格納場所:sn_ind_tmt_orm_order_line_itemテーブルのaction_reasonフィールド。
productOrderItem.committedDueDate	注文品目に対してアクションを実行する必要がある日時。アイテムのアクションが `一時停止` または `再開`の場合、このパラメーターは更新できません。データタイプ：文字列格納場所:sn_ind_tmt_orm_order_line_itemテーブルのcommitted_due_dateフィールド。
productOrderItem.externalProductInventory.externalProductInventoryId	製品インベントリにマッピングする外部 ID。データタイプ：文字列格納場所:sn_ind_tmt_orm_order_line_itemテーブルのexternal_inventory_idフィールドとsn_prd_invt_product_inventoryテーブルのsn_prd_invt_external_idフィールド。
productOrderItem.externalProductInventory	注文に対して作成された製品在庫にマッピングする外部 ID のリスト。データタイプ：オブジェクトのアレイ `"externalProductInventory": [ { "externalProductInventoryId": "String" } ]` 注: 以前は、既に存在する外部製品インベントリ ID を使用して PATCH 注文を作成すると、操作が中断され、エラーが返されていました。Xanaduリリースでは、既存の外部プロダクトインベントリ ID が指定されていて、エラーがスローされない場合、このパラメーターは単純に無視されます。
productOrderItem.id	productOrderItemパラメーターを使用する場合は必須です。品目の一意の識別子。注文明細品目 [sn_ind_tmt_orm_order_line_item] テーブルの sn_ind_tmt_orm_external_id フィールドにあります。データタイプ：文字列格納場所:sn_ind_tmt_orm_order_line_itemテーブルのexternal_idフィールド。最大長：40 デフォルト：空白の文字列
productOrderItem.itemPrice	製品に関連付けられた価格を説明するリスト。データタイプ：オブジェクトのアレイ `"itemPrice": [ { "price": {Object}, "priceType": "String", "recurringChargePeriod": "String" } ]` 保存場所:sn_ind_tmt_orm_order デフォルト：空白の文字列
productOrderItem.itemPrice.price	関連製品の価格の説明。データタイプ: オブジェクト `"price": { "taxIncludedAmount": {Object} }` 格納場所:sn_ind_tmt_orm_order_line_item デフォルト：空白の文字列
productOrderItem.itemPrice.price.taxIncludedAmount	税を含む関連製品の価格の説明。データタイプ: オブジェクト `"taxIncludedAmount": { "unit": "String", "value": Number }` 格納場所:sn_ind_tmt_orm_order_line_item
productOrderItem.itemPrice.price.taxIncludedAmount.unit	価格を表す通貨コード。データタイプ：文字列格納場所:sn_ind_tmt_orm_order_line_itemテーブルの mrc または nrc フィールド。
productOrderItem.itemPrice.price.taxIncludedAmount.value	製品の価格 (税込み)。データタイプ：数値格納場所:sn_ind_tmt_orm_order_line_itemテーブルの mrc または nrc フィールド。
productOrderItem.itemPrice.priceType	アイテム価格のタイプ (繰り返しまたは非繰り返し)。データタイプ：文字列
productOrderItem.itemPrice.recurringChargePeriod	価格が繰り返し発生する場合は、 `月`などの繰り返し期間。データタイプ：文字列
productOrderItem.product	productOrderItem.actionが変更または削除の場合は必須です。顧客が購入した製品のインスタンス詳細の説明。データタイプ: オブジェクト `"product": { "id": "String", "place": {Object}, "productCharacteristic": [Array], "productSpecification": {Object}, "relatedParty": {Object}, "@type": "String" }` 格納場所:sn_ind_tmt_orm_order_line_item
productOrderItem.product.@type	TMF Open API 標準の一部です。製品の注釈。この値は常に `Product` です。この情報は保存されません。データタイプ：文字列
productOrderItem.product.id	productOrderItem.actionが変更または削除の場合は必須です。販売された製品の一意の識別子。製品インベントリ [sn_ind_tmt_orm_product_inventory] テーブルのsys_idまたはsn_ind_tmt_orm_external_idフィールドにあります。データタイプ：文字列デフォルト：空白の文字列
productOrderItem.product.place	製品を設置する場所のマップ。データタイプ: オブジェクト `"place": { "id": "String", "@type": "String" }` 格納場所:sn_ind_tmt_orm_order_line_item
productOrderItem.product.place.@type	TMF Open API 標準の一部です。注文明細品目の連絡先の注釈。この値は常に `Place` です。この情報は保存されません。データタイプ：文字列
productOrderItem.product.place.id	productOrderItem.product.placeパラメーターを使用する場合は必須です。場所 [cmn_location] テーブル内の関連する場所レコードのSys_id。製品注文アイテムに対して ( productOrderItem.action パラメーターを使用して) 変更アクションを使用する場合、要求を新しい場所sys_id更新すると、注文は変更されず、新しい場所で履行される移動オーダーが作成されます。データタイプ：文字列格納場所:sn_ind_tmt_orm_order_line_itemテーブルの場所フィールド。デフォルト：空白の文字列
productOrderItem.product.productCharacteristic	関連製品の特性のリスト。データタイプ：オブジェクトのアレイ `"productCharacteristic": [ { "name": "String", "previousValue": "String", "value": "String", "valueType": "String" } ]` 格納場所:sn_ind_tmt_orm_order_characteristic_value
productOrderItem.product.productCharacteristic.name	製品に関連付ける特性レコードの名前。特性 [sn_prd_pm_characteristic] テーブルにあります。データタイプ：文字列格納場所:sn_ind_tmt_orm_order_characteristic_valueテーブルの特性フィールド。デフォルト：空白の文字列
productOrderItem.product.productCharacteristic.previousValue	更新が変更指示用である場合の以前の特性オプションの値。productOrderItem.actionパラメーターが `add` 以外の場合、要求は変更指示です。特性オプション値の詳細については、「 Create product characteristics and characteristic options」を参照してください。データタイプ：文字列格納場所:sn_ind_tmt_orm_order_characteristic_valueテーブルのprevious_characteristic_option_value。デフォルト：空白の文字列
productOrderItem.product.productCharacteristic.value	製品に関連付けられた特性オプション値。特性オプション値の詳細については、「 Create product characteristics and characteristic options」を参照してください。データタイプ：文字列格納場所:sn_ind_tmt_orm_order_characteristic_valueテーブルのcharacteristic_option_valueフィールド。デフォルト：空白の文字列
productOrderItem.product.productCharacteristic.valueType	特性値のタイプ。データタイプ：文字列可能な値： array.date array.datetime array.decimal array.integer array.object Array.Single Line テストチェックボックス選択日付、住所メール整数、日付/時刻オブジェクト 1 行テキストはい/いいえ
productOrderItem.product.productSpecification	製品に関連付けられた製品仕様の説明。注: 変更指示 (productOrderItem.action が `変更`) は、 sn_ind_tmt_orm.allowSpecVersionUpdateInChangeOrder システムプロパティの値に基づいて異なる方法で処理されます。このシステムプロパティの値は、製品インベントリが注文に示されているバージョンと異なる場合の注文の処理方法を決定します。このシステムプロパティが true (デフォルト) に設定されている場合、製品インベントリは、参照されている製品仕様を変更することによって注文のバージョンに自動的にアップグレードされます。これにより、注文を正常に処理できます。このシステムプロパティが false に設定されている場合、製品インベントリが注文に示されているバージョンと異なる場合、バージョンの不一致により注文は失敗します。データタイプ: オブジェクト `"productSpecification": { "id": "String", "internalVersion": "String", "name": "String", "version": "String", "@type": "String" }` 格納場所:sn_ind_tmt_orm_order_line_item
productOrderItem.product.productSpecification.@type	TMF Open API 標準の一部です。この値は常に `ProductSpecificationRef` です。この情報は保存されません。データタイプ：文字列
productOrderItem.product.productSpecification.id	productOrderItem.product.productSpecificationパラメーターを使用する場合は必須です。製品仕様のInitial_versionまたはexternal_id。initial_versionは仕様の最初のバージョンのsys_idです。製品仕様 [sn_prd_pm_product_specification] テーブルの [sys_id] または [external_id] フィールドにあります。データタイプ：文字列
productOrderItem.product.productSpecification.internalVersion	製品仕様の内部バージョン。version の値と一致する必要があります。一致しない場合、エラーがスローされます。データタイプ:文字列表:製品仕様 [sn_prd_pm_product_specification]
productOrderItem.product.productSpecification.name	製品仕様の名前。製品仕様 [sn_prd_pm_product_specification] テーブルにあります。データタイプ：文字列
productOrderItem.product.productSpecification.version	製品仕様の外部バージョン。internalVersion の値と一致する必要があります。一致しない場合、エラーがスローされます。データタイプ:文字列表:製品仕様 [sn_prd_pm_product_specification]
productOrderItem.product.relatedParty	品目の連絡先のリスト。データタイプ：オブジェクトのアレイ `"relatedParty": [ { "email": "String", "firstName": "String", "id": "String", "lastName": "String", "phone": "String", "@referredType": "String", "@type": "String" } ]` 格納場所:sn_ind_tmt_orm_order_line_item_contact
productOrderItem.product.relatedParty.@referredType	顧客のタイプ。可能な値:OrderLineItemContact データタイプ：文字列
productOrderItem.product.relatedParty.@type	TMF Open API 標準の一部です。注文明細品目の連絡先の注釈。この値は常に `RelatedParty` です。この情報は保存されません。データタイプ：文字列
productOrderItem.product.relatedParty.email	連絡先のメールアドレス。データタイプ：文字列格納場所:sn_ind_tmt_orm_order_line_item_contactテーブルのメールフィールド。デフォルト：空白の文字列
productOrderItem.product.relatedParty.firstName	連絡先の名。データタイプ：文字列格納場所:sn_ind_tmt_orm_order_line_item_contactテーブルのfirst_nameフィールド。デフォルト：空白の文字列
productOrderItem.product.relatedParty.id	注文品目に関連付けられた品目連絡先のSys_id。注文明細品目連絡先 [sn_ind_tmt_orm_order_line_item_contact] テーブルにあります。データタイプ：文字列格納場所:sn_ind_tmt_orm_order_line_item_contactテーブルのsys_idフィールド。デフォルト：空白の文字列
productOrderItem.product.relatedParty.lastName	連絡先の名前 (姓)。データタイプ：文字列格納場所:sn_ind_tmt_orm_order_line_item_contactテーブルの lastName フィールド。デフォルト：空白の文字列
productOrderItem.product.relatedParty.phone	連絡先の勤務先電話番号。データタイプ：文字列格納場所:sn_ind_tmt_orm_order_line_item_contactテーブルのbusiness_phoneフィールド。デフォルト：空白の文字列
productOrderItem.productOffering	製品に関連付けられた製品オファリングの説明。データタイプ: オブジェクト `"productOffering": { "id": "String", "internalVersion": "String", "name": "String", "version": "String" }` 格納場所:sn_ind_tmt_orm_order_line_item
productOrderItem.productOffering.id	productOrderItem.productOfferingパラメーターを使用する場合は必須です。製品オファリングのInitial_versionまたはexternal_id。initial_versionは、オファリングの最初のバージョンのsys_idです。製品オファリング [sn_prd_pm_product_offering] テーブルの sys_id または external_id フィールドにあります。データタイプ：文字列
productOrderItem.productOffering.internalVersion	製品オファリングのバージョン。データタイプ：文字列テーブル:製品オファリング [sn_prd_pm_product_offering]
productOrderItem.productOffering.name	製品オファリングの名前。製品オファリング [sn_prd_pm_product_offering] テーブルにあります。データタイプ：文字列
productOrderItem.productOffering.version	製品オファリングのExternal_version。データタイプ：文字列テーブル:製品オファリング [sn_prd_pm_product_offering]
productOrderItem.productOrderItem.quantity	注文する関連アイテムの数。データタイプ：数値格納場所:sn_ind_tmt_orm_orderの数量フィールド。デフォルト値:null
productOrderItem.productOrderItemRelationship	注文品目間の関係のリスト。データタイプ：オブジェクトのアレイ `"productOrderItemRelationship": [ { "id": "String", "relationshipType": "String" } ]` 格納場所:sn_ind_tmt_orm_order_line_item
productOrderItem.productOrderItemRelationship.id	productOrderItem.productOrderItemRelationshipパラメーターを使用する場合は必須です。関連品目の一意の識別子。注文明細品目 [sn_ind_tmt_orm_order_line_item] テーブルの sn_ind_tmt_orm_external_id フィールドにあります。データタイプ：文字列格納場所:テーブルのparent_line_itemフィールドthebsn_ind_tmt_orm_order_line_item。デフォルト：空白の文字列
productOrderItem.productOrderItemRelationship.relationshipType	2 つの品目間の関係のタイプ。この情報は、関係階層を識別するために使用されます。可能な値： HasChild 親がある必要 `HasChild` と `HasParent` は、親子関係に使用されます。[`必須]` は水平関係に使用されます (品目には別の品目が必要です)。データタイプ：文字列
productOrderItem.quantity	注文されたアイテムの数。データタイプ：数値格納場所:sn_ind_tmt_orm_orderテーブルの数量フィールド。デフォルト：空白の文字列
productOrderItem.revisionOperation	品目に対して実行する更新のタイプ。この値が空の場合、既存の品目が更新されるか、まだ存在しない場合は新しい品目が追加されます。この値が `cancel` の場合、品目はキャンセルされます。データタイプ：文字列デフォルト：空白の文字列
関連パーティー	注文の連絡先のリスト。各連絡先はアレイ内のオブジェクトです。顧客アカウントまたはコンシューマーアカウント情報を含むアイテムを少なくとも 1 つリストする必要があります。データタイプ：オブジェクトのアレイ `"relatedParty": [ { "id": "String", "name": "String", "@referredType": "String", "@type": "String" } ]`
relatedParty.@referredType	顧客のタイプ。可能な値：コンシューマー顧客顧客連絡先データタイプ：文字列
relatedParty.@type	TMF Open API 標準の一部です。製品の注釈。この値は常に `RelatedParty` です。この情報は保存されません。データタイプ：文字列
relatedParty.id	注文に関連付けられたアカウント、顧客連絡先、またはコンシューマーのSys_idまたはexternal_id。アカウント [customer_account]、連絡先 [customer_contact] テーブル、またはコンシューマー [csm_consumer] テーブルにあります。データタイプ：文字列
relatedParty.name	アカウント、顧客、またはコンシューマーの名前。データタイプ：文字列
requestedCompletionDate	顧客が要求した配送日。データタイプ：文字列格納場所:sn_ind_tmt_orm_orderテーブルのexpected_end_dateフィールド。デフォルト：空白の文字列
requestedStartDate	顧客が要求した注文開始日。データタイプ：文字列格納場所:sn_ind_tmt_orm_orderテーブルのexpected_start_dateフィールド。デフォルト：空白の文字列

ヘッダー

表 : 22. 要求ヘッダー
ヘッダー	説明
承認	応答本文のデータフォーマット。application/json のみをサポートします。
Content-Type	要求本文のデータ形式。application/json のみをサポートします。

表 : 23. 応答ヘッダー
ヘッダー	説明
Content-Type	応答本文のデータフォーマット。application/json のみをサポートします。

ステータスコード

表 : 24. ステータスコード
ステータスコード	説明
201	成功。特性または特性オプション情報に問題がある場合、エンドポイントは関連する顧客発注書明細レコードの作業メモフィールドに次のコメントを保存します。 `次の注文品目特性が存在しません。注文を承認する前に、仕様<characteristic.name>を確認し、注文明細品目の特性と特性オプションを修正してください。` `注文アイテム特性:特性値<characteristic.value>を持つ<characteristic.name>は無効です。注文を承認する前に特性値を修正してください。`
400	要求が正しくありません。以下のいずれかの理由が考えられます。 `無効なペイロード:要求本文がありません:ペ` イロードが要求本文で渡されませんでした。 `無効なペイロード:productOrderItem がありません` :製品の注文明細品目オブジェクトまたは JSON がありません。 `無効なペイロード:productOrderItem id がありません` :ペイロードの製品注文明細品目に id パラメーターがありません。 `無効なペイロード:productOrderItem アクションがありません:` ペイロードの製品注文明細品目に action パラメーターがありません。 `無効なペイロード:productOrderItem productOffering がありません` :ペイロードの製品注文明細品目に製品オファリングオブジェクトまたは JSON がありません。 `無効なペイロード:productOffering id がありません` :ペイロード内の製品オファリングオブジェクトの製品注文明細品目に id パラメーターがありません。 `無効なペイロード:製品オファリングが存在しません` :製品注文明細品目の製品オファリングが無効です。 `無効なペイロード:productOrderItem 製品がありません:` 製品注文明細品目の製品オブジェクトまたは JSON がペイロードにありません。 `無効なペイロード:製品 productSpecification がありません` :製品注文明細品目の製品仕様オブジェクトまたは JSON がペイロードにありません。 `無効なペイロード:productSpecification id がありません` :製品仕様オブジェクトの製品注文明細品目の id パラメーターがペイロードにありません。 `無効なペイロード:製品仕様が存在しません` :製品注文明細品目の製品仕様が無効です。 `無効なペイロード:プロダクトインベントリが存在しません` : 変更指示 (アクション = 変更) で、アイテムの数量が在庫数量を上回っています。 `無効なペイロード:製品インベントリ ID がありません:` 変更注文で、ペイロードに product.id がありません。 `無効なペイロード:販売済み製品は非アクティブです` :変更指示で、ペイロードに指定された製品が非アクティブです。 `無効なペイロード:relatedParty がありません` :関係者オブジェクトがペイロードにありません。 `顧客アカウントまたはコンシューマーがありません:` 関係者顧客またはコンシューマーオブジェクトがペイロードにありません。 `無効なペイロード:コンシューマーが存在しません` :指定された関係者コンシューマーが ServiceNow インスタンスに存在しません。 `無効なペイロード:顧客アカウントが存在しません` :指定された関係者顧客が ServiceNow インスタンスに存在しません。 `無効なペイロード:注文の作成に失敗しました。` 要求された注文を作成できません。 `注文通貨の実行中の改訂はサポートされていません` :注文の作成後に orderCurrency パラメーターを更新することはできません。 `この注文はまだ顧客注文テーブルで作成されていません。詳細については、受信キューでチェックインしてください。` – 指定された注文 ID が顧客注文テーブルにありません。 `注文のフルフィルメントタイプが「配送」ではないため、パッチ要求を作成できません。` – パッチ要求は、配送以外の履行タイプの注文に対して行われました。

応答本文のパラメーター (JSON)


名前	説明
チャネル	製品の販売に使用するチャネルのリスト。データタイプ：オブジェクトのアレイ `"channel": [ { "id": "String", "name": "String" } ]`
channel.id	関連製品の販売に使用するチャネルの一意の識別子。データタイプ：文字列
channel.name	関連製品の販売に使用するチャネルの名前。データタイプ：文字列
committedDueDate	注文に対してアクションを実行する必要がある日時。この値は、各注文品目の committedDueDate 値と同じかそれ以降にする必要があります。データタイプ：文字列
externalId	発注書番号などの顧客注文の外部識別子。データタイプ：文字列
href	製品注文レコードへの相対リンク。データタイプ：文字列
ID	この要求に対して更新された顧客注文のSys_id。データタイプ：文字列
注意	注文時に顧客が行った追加のメモのリスト。データタイプ：オブジェクトのアレイ `"note": [ { "text": "String" } ]`
note.text	注文時に顧客が行った追加のメモ/コメント。データタイプ：文字列
orderCurrency	注文と注文明細品目の通貨コード。データタイプ：文字列
製品注文アイテム	製品注文とそれに関連するアクションに関連付けられたアイテムを説明するリスト。データタイプ：オブジェクトのアレイ `"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	製品に対して実行するアクション。可能なアクションは、sn_ind_tmt_orm_order_line_itemテーブルのアクション辞書エントリの [選択リスト] タブで定義されます。データタイプ：文字列
productOrderItem.actionReason	注文明細品目を追加する理由。データタイプ：文字列格納場所:sn_ind_tmt_orm_order_line_itemテーブルのaction_reasonフィールド。
productOrderItem.committedDueDate	注文品目に対してアクションを実行する必要がある日時。データタイプ：文字列
productOrderItem.externalProductInventory	注文に対して作成された製品在庫にマッピングする外部 ID のリスト。データタイプ：オブジェクトのアレイ `"externalProductInventory": [ { "externalProductInventoryId": "String" } ]` 注: 以前は、既に存在する外部製品インベントリ ID を使用して PATCH 注文を作成すると、操作が中断され、エラーが返されていました。Xanaduリリースでは、既存の外部プロダクトインベントリ ID が指定されていて、エラーがスローされない場合、このパラメーターは単純に無視されます。
productOrderItem.externalProductInventory.externalProductInventoryId	製品インベントリにマッピングされた外部 ID。データタイプ：文字列
productOrderItem.id	品目の一意の識別子。注文明細品目 [sn_ind_tmt_orm_order_line_item] テーブルの sn_ind_tmt_orm_external_id フィールドにあります。データタイプ：文字列
productOrderItem.itemPrice	製品に関連付けられた価格を説明するリスト。データタイプ：オブジェクトのアレイ `"itemPrice": [ { "price": {Object}, "priceType": "String", "recurringChargePeriod": "String" } ]`
productOrderItem.itemPrice.price	関連製品の価格の説明。データタイプ: オブジェクト `"price": { "taxIncludedAmount": {Object} }`
productOrderItem.itemPrice.price.taxIncludeAmount	税を含む関連製品の価格の説明。データタイプ: オブジェクト `"taxIncludedAmount": { "unit": "String", "value": Number }`
productOrderItem.itemPrice.price.taxIncludeAmount.unit	価格を表す通貨コード。データタイプ：文字列
productOrderItem.itemPrice.price.taxIncludeAmount.value	製品の価格 (税込み)。データタイプ：数値
productOrderItem.itemPrice.priceType	アイテム価格のタイプ (繰り返しまたは非繰り返し)。データタイプ：文字列
productOrderItem.itemPrice.recurringChargePeriod	価格が繰り返し発生する場合は、 `月`などの繰り返し期間。データタイプ：文字列
productOrderItem.product	顧客が購入した製品のインスタンス詳細の説明。データタイプ: オブジェクト `"product": { "id": "String", "place": {Object}, "productCharacteristic": [Array], "productSpecification": {Object}, "relatedParty": {Object}, "@type": "String" }`
productOrderItem.product.id	販売された製品の一意の識別子。製品インベントリ [sn_ind_tmt_orm_product_inventory] テーブルのsys_idまたはsn_ind_tmt_orm_external_idフィールドにあります。データタイプ：文字列
productOrderItem.product.place	製品を設置する場所のマップ。データタイプ: オブジェクト `"place": { "id": "String", "@type": "String" }`
productOrderItem.product.place.id	場所 [cmn_location] テーブル内の関連する場所レコードのSys_id。製品注文アイテムに対して ( productOrderItem.action パラメーターを使用して) 変更アクションを使用する場合、要求を新しい場所sys_id更新すると、注文は変更されず、新しい場所で履行される移動オーダーが作成されます。データタイプ：文字列
productOrderItem.product.productCharacteristic	関連製品の特性のリスト。データタイプ：オブジェクトのアレイ `"productCharacteristic": [ { "name": "String", "previousValue": "String", "value": "String", "valueType": "String" } ]`
productOrderItem.product.productCharacteristic.name	製品に関連付ける特性レコードの名前。特性 [sn_prd_pm_characteristic] テーブルにあります。データタイプ：文字列
productOrderItem.product.productCharacteristic.previousValue	更新が変更指示用である場合の以前の特性オプションの値。productOrderItem.actionパラメーターが `add` 以外の場合、要求は変更指示です。特性オプション値の詳細については、「 Create product characteristics and characteristic options」を参照してください。データタイプ：文字列
productOrderItem.product.productCharacteristic.value	製品に関連付けられた特性オプション値。特性オプション値の詳細については、「 Create product characteristics and characteristic options」を参照してください。データタイプ：文字列
productOrderItem.product.productSpecification	製品に関連付けられた製品仕様の説明。データタイプ: オブジェクト `"productSpecification:" { "id": "String", "internalId": "String", "internalVersion": "String", "name": "String", "version": "String", "@type": "String" }`
productOrderItem.product.productSpecification.id	製品仕様のInitial_versionまたはexternal_id。initial_versionは仕様の最初のバージョンのsys_idです。製品仕様 [sn_prd_pm_product_specification] テーブルの [sys_id] または [external_id] フィールドにあります。データタイプ：文字列
productOrderItem.product.productSpecification.internalId	製品仕様の初期バージョン。初期バージョンは、仕様の最初のバージョンのsys_idです。データタイプ：文字列表:製品仕様 [sn_prd_pm_product_specification]
productOrderItem.product.productSpecification.internalVersion	製品仕様のバージョン。データタイプ：文字列テーブル:製品仕様 [sn_prd_pm_product_specification] テーブルのバージョンフィールド。
productOrderItem.product.productSpecification.name	製品仕様の名前。製品仕様 [sn_prd_pm_product_specification] テーブルにあります。データタイプ：文字列
productOrderItem.product.productSpecification.version	製品仕様の外部バージョン。データタイプ：文字列テーブル:製品仕様 [sn_prd_pm_product_specification] テーブルの external_version フィールド。
productOrderItem.product.productSpecification.@type	TMF Open API 標準の一部です。この値は常に `ProductSpecificationRef` です。この情報は保存されません。データタイプ：文字列
productOrderItem.product.relatedParty	品目の連絡先のリスト。データタイプ：オブジェクトのアレイ `"relatedParty": [ { "email": "String", "firstName": "String", "id": "String", "lastName": "String", "phone": "String", "@referredType": "String", "@type": "String" } ]`
productOrderItem.product.relatedParty.email	連絡先のメールアドレス。データタイプ：文字列
productOrderItem.product.relatedParty.firstName	連絡先の名。データタイプ：文字列
productOrderItem.product.relatedParty.id	注文品目に関連付けられた品目連絡先のSys_id。注文明細品目連絡先 [sn_ind_tmt_orm_order_line_item_contact] テーブルにあります。データタイプ：文字列
productOrderItem.product.relatedParty.lastName	連絡先の名前 (姓)。データタイプ：文字列
productOrderItem.product.relatedParty.phone	連絡先の勤務先電話番号。データタイプ：文字列
productOrderItem.product.relatedParty.@referredType	顧客のタイプ。可能な値:OrderLineItemContact データタイプ：文字列
productOrderItem.product.relatedParty.@type	TMF Open API 標準の一部です。注文明細品目の連絡先の注釈。この値は常に `RelatedParty` です。この情報は保存されません。データタイプ：文字列
productOrderItem.product.@type	TMF Open API 標準の一部です。製品の注釈。この値は常に `Product` です。この情報は保存されません。データタイプ：文字列
productOrderItem.productOffering	製品に関連付けられた製品オファリングの説明。データタイプ: オブジェクト `"productOffering:" { "id": "String", "internalId": "String", "internalVersion": "String", "name": "String", "version": "String" }`
productOrderItem.productOffering.id	製品オファリングのInitial_versionまたはexternal_id。initial_versionは、オファリングの最初のバージョンのsys_idです。製品オファリング [sn_prd_pm_product_offering] テーブルの sys_id または external_id フィールドにあります。データタイプ：文字列
productOrderItem.productOffering.internalId	製品オファリングの初期バージョン。初期バージョンは、オファリングの最初のバージョンのsys_idです。データタイプ：文字列テーブル:製品オファリング [sn_prd_pm_product_offering]
productOrderItem.productOffering.internalVersion	製品オファリングのバージョン。データタイプ：文字列テーブル:製品オファリング [sn_prd_pm_product_offering] テーブル、フィールドバージョン。
productOrderItem.productOffering.name	製品オファリングの名前。製品オファリング [sn_prd_pm_product_offering] テーブルにあります。データタイプ：文字列
productOrderItem.productOffering.version	製品オファリングの外部バージョン。データタイプ：文字列テーブル:製品オファリング [sn_prd_pm_product_offering] テーブルの [external_version] フィールド。
productOrderItem.productOrderItemRelationship	注文品目間の関係のリスト。データタイプ：オブジェクトのアレイ `"productOrderItemRelationship": [ { "id": "String", "relationshipType": "String" } ]`
productOrderItem.productOrderItemRelationship.id	関連品目の一意の識別子。注文明細品目 [sn_ind_tmt_orm_order_line_item] テーブルの sn_ind_tmt_orm_external_id フィールドにあります。データタイプ：文字列
productOrderItem.productOrderItemRelationship.relationshipType	2 つの品目間の関係のタイプ。この情報は、関係階層を識別するために使用されます。データタイプ：文字列
productOrderItem.quantity	注文する関連アイテムの数。データタイプ：数値
productOrderItem.state	製品注文アイテムの現在のステータス。データタイプ：文字列
productOrderItem.@type	TMF Open API 標準の一部です。製品の注釈。この値は常に `ProductOrderItem` です。この情報は保存されません。データタイプ：文字列
関連パーティー	注文の連絡先のリスト。各連絡先はアレイ内のオブジェクトです。顧客アカウントまたはコンシューマーアカウント情報を含むアイテムを少なくとも 1 つリストする必要があります。データタイプ：オブジェクトのアレイ `"relatedParty": [ { "id": "String", "name": "String", "@referredType": "String", "@type": "String" } ]`
relatedParty.id	注文に関連付けられたアカウント、顧客連絡先、またはコンシューマーのSys_idまたはexternal_id。アカウント [customer_account]、連絡先 [customer_contact] テーブル、またはコンシューマー [csm_consumer] テーブルにあります。データタイプ：文字列
relatedParty.name	アカウント、顧客、またはコンシューマーの名前。データタイプ：文字列
relatedParty.type	顧客のタイプ。可能な値：コンシューマー顧客顧客連絡先データタイプ：文字列
requestedCompletionDate	顧客が要求した配送日。データタイプ：文字列
requestedStartDate	顧客が要求した注文開始日。データタイプ：文字列
状況	注文の現在のステータス。データタイプ：文字列
@type	TMF Open API 標準の一部です。製品の注釈。この値は常に `ProductOrder` です。この情報は保存されません。データタイプ：文字列

cURL 要求

この例では、ID 8d75939453126010a795ddeeff7b126a に関連付けられた指定された製品注文を取得します。

curl -X GET "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"
    }
  ]
}

応答本文。

{
   "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"
}