製品注文オープン API

リリースバージョン: Zurich

更新日 2025年07月31日

所要時間：344分

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

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

この API にアクセスするには、Order Management for Telecommunications (sn_ind_tmt_orm) プラグインを有効にする必要があります。

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

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

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

製品注文オープン API は、TM Forum TMF622 Product Ordering Management API REST 仕様の ServiceNow® 実装であり、TM Forum によって適合性が認定されています。

TMF 適合ロゴ

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

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

ヘッダー

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

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

表 : 5. 応答ヘッダー
ヘッダー	説明
Content-Range	ページネーションされた呼び出しで返されるコンテンツの範囲。たとえば、`offset=2` および `limit=3` の場合、Content-Range ヘッダーの値は `items 3-5` です。
Content-Type	応答本文のデータフォーマット。application/json のみをサポートします。
Link	クエリー結果内を移動するための次のリンクが含まれています。 first last next previous
X-Total-Count	ページネーションされたクエリの場合、このヘッダーはサーバーで利用可能なレコードの合計数を指定します。

ステータスコード

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

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

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


名前	説明
channel	製品の販売に使用するチャネルのリスト。データタイプ：オブジェクトのアレイ `"channel": [ { "id": "String", "name": "String" } ]`
channel.id	関連製品の販売に使用するチャネルの一意の識別子。データタイプ：文字列
channel.name	関連する製品を販売するために使用するチャネルの名前。データタイプ：文字列
committedDueDate	注文に対してアクションを実行する必要がある日時。この値は、各注文明細品目の committedDueDate 値以降である必要があります。データタイプ：文字列
expectedCompletionDate	注文が完了する日付。データタイプ：文字列
href	製品注文レコードへの相対リンク。データタイプ：文字列
id	製品注文の sys_id。データタイプ：文字列
note	注文時に顧客が作成した追加のメモのリスト。データタイプ：オブジェクトのアレイ `"note": [ { "author": "String", "date": "String", "text": "String" } ]`
note.author	関連するメモを作成したユーザーの名前。データタイプ：文字列
note.date	メモが作成された日付。データタイプ：文字列
note.text	注文時に顧客が作成した追加のメモ/コメント。データタイプ：文字列
orderCurrency	注文および発注書明細の通貨コード。データタイプ：文字列
ponr	注文が返品不可期日に達したかどうかを示すフラグ。可能な値： true：注文の返品不可期日に達しました。 false:注文の返品不可ポイントに達していません。データタイプ：ブーリアン
productOrderItem	製品注文と関連アクションに関連付けられたアイテムを説明するリスト。データタイプ：オブジェクトのアレイ `"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 テーブルの [アクション辞書エントリ (Action Dictionary Entry)] の [選択リスト] タブで定義されます。データタイプ：文字列
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	価格が繰り返し発生する場合は、`month` などの繰り返し期間。データタイプ：文字列
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.product.place.@type	TMF オープン 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	注文品目と製品インベントリの関係のタイプ。可能な値： Requires データタイプ：文字列
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 オープン 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 オープン 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 HasParent 必要 `HasChild` と `HasParent` は親子関係に使用されます。`Requires` は水平関係に使用されます (品目には別の品目が必要です)。データタイプ：文字列
productOrderItem.state	関連する製品アイテムの注文のステータス。データタイプ：文字列
productOrderItem.version	発注バージョン。データタイプ：文字列
productOrderItem.@type	TMF オープン API 標準の一部。製品の注釈。この値は常に `ProductOrderItem` です。この情報は保存されません。データタイプ：文字列
relatedParty	注文の連絡先のリスト。各連絡先はアレイ内のオブジェクトです。顧客アカウントまたはコンシューマーアカウントの情報を含むアイテムを少なくとも 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	顧客のタイプ。可能な値：コンシューマーカスタマー CustomerContact データタイプ：文字列
relatedParty.@type	TMF オープン API 標準の一部。製品の注釈。この値は常に `RelatedParty` です。この情報は保存されません。データタイプ：文字列
requestedCompletionDate	顧客によって要求された配送日。データタイプ：文字列
requestedStartDate	顧客によって要求された注文開始日。データタイプ：文字列
state	注文の現在のステータス。データタイプ：文字列
version	発注バージョン。データタイプ：文字列
@type	TMF オープン 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"
   }
]

製品注文オープン API - GET /sn_ind_tmt_orm/order/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]
注文明細行関連品目 [sn_ind_tmt_orm_order_line_related_items]

URL 形式

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

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

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

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

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

ヘッダー

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

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

ステータスコード

表 : 12. ステータスコード
ステータスコード	説明
200	要求が正常に処理されました。応答で完全なリソースが返されました (ページネーションなし)。選択した注文に処理上の問題がある場合、応答は成功とエラーメッセージを返します。 200 OK 応答は、注文が受信キュー [sn_tmt_core_inbound_queue] テーブルにあり、スケジューラーが処理するレコードを選択するのを待機している場合に発生します。エラーメッセージフィールドには、レコードの詳細が含まれています。たとえば、次のようになります。 `{ "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": "" } ] }` 注文の作成に失敗し、受信キュー [sn_tmt_core_inbound_queue] テーブルのレコードがエラーステータスになっている場合は、200 OK 応答が発生します。エラーメッセージフィールドには、受信キューテーブルレコードの詳細が含まれています。たとえば、次のようになります。 `{ "code": 23, "reason": "Missing body field", "message": "Missing body field", "details": [ { "message": "Invalid payload: orderCurrency is missing", "datapath": "/" } ] }`
206	応答で部分的なリソースが返されました (ページネーションあり)。
400	要求が正しくありません。考えられる理由：無効なパスパラメーター無効な URI
404	レコードが見つかりません。クエリパラメーターに一致するレコードがテーブルに見つかりません。

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


名前	説明
channel	製品の販売に使用するチャネルのリスト。データタイプ：オブジェクトのアレイ `"channel": [ { "id": "String", "name": "String" } ]`
channel.id	関連製品の販売に使用するチャネルの一意の識別子。データタイプ：文字列
channel.name	関連する製品を販売するために使用するチャネルの名前。データタイプ：文字列
committedDueDate	注文に対してアクションを実行する必要がある日時。この値は、各注文明細品目の committedDueDate 値以降である必要があります。データタイプ：文字列
expectedCompletionDate	注文が完了する日付。データタイプ：文字列
href	製品注文レコードへの相対リンク。データタイプ：文字列
id	製品注文の sys_id。データタイプ：文字列
note	注文時に顧客が作成した追加のメモのリスト。データタイプ：オブジェクトのアレイ `"note": [ { "author": "String", "date": "String", "text": "String" } ]`
note.author	関連するメモを作成したユーザーの名前。データタイプ：文字列
note.date	メモが作成された日付。データタイプ：文字列
note.text	注文時に顧客が作成した追加のメモ/コメント。データタイプ：文字列
orderCurrency	注文および発注書明細の通貨コード。データタイプ：文字列
ponr	注文が返品不可期日に達したかどうかを示すフラグ。可能な値： true：注文の返品不可期日に達しました。 false:注文の返品不可ポイントに達していません。データタイプ：ブーリアン
productOrderItem	製品注文と関連アクションに関連付けられたアイテムを説明するリスト。データタイプ：オブジェクトのアレイ `"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	製品に対して実行するアクション。可能なアクションは、sn_ind_tmt_orm_order_line_item テーブルの [アクション辞書エントリ (Action Dictionary Entry)] の [選択リスト] タブで定義されます。データタイプ：文字列
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	価格が繰り返し発生する場合は、`month` などの繰り返し期間。データタイプ：文字列
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.product.place.@type	TMF オープン 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	注文品目と製品インベントリの関係のタイプ。可能な値： Requires データタイプ：文字列
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 オープン 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 オープン 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 HasParent 必要 `HasChild` と `HasParent` は親子関係に使用されます。`Requires` は水平関係に使用されます (品目には別の品目が必要です)。データタイプ：文字列
productOrderItem.state	関連する製品アイテムの注文のステータス。データタイプ：文字列
productOrderItem.version	発注バージョン。データタイプ：文字列
productOrderItem.@type	TMF オープン API 標準の一部。製品の注釈。この値は常に `ProductOrderItem` です。この情報は保存されません。データタイプ：文字列
relatedParty	注文の連絡先のリスト。各連絡先はアレイ内のオブジェクトです。顧客アカウントまたはコンシューマーアカウントの情報を含むアイテムを少なくとも 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	顧客のタイプ。可能な値：コンシューマーカスタマー CustomerContact データタイプ：文字列
relatedParty.@type	TMF オープン API 標準の一部。製品の注釈。この値は常に `RelatedParty` です。この情報は保存されません。データタイプ：文字列
requestedCompletionDate	顧客によって要求された配送日。データタイプ：文字列
requestedStartDate	顧客によって要求された注文開始日。データタイプ：文字列
state	注文の現在のステータス。データタイプ：文字列
version	発注バージョン。データタイプ：文字列
@type	TMF オープン API 標準の一部。製品の注釈。この値は常に `ProductOrder` です。この情報は保存されません。データタイプ：文字列

cURL 要求

この例では、指定された製品注文を取得します。

curl -X GET "https://instance.service-now.com/api/sn_ind_tmt_orm/order/productOrder/8d75939453126010a795ddeeff7b126a" \
-u "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",
         "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"
}

製品注文オープン API - GET /sn_ind_tmt_orm/productorder

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

重要:

Tokyo リリース以降、このエンドポイントは廃止されました。このエンドポイントの新しいバージョンは製品注文オープン 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

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

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

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

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

ヘッダー

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

表 : 17. 応答ヘッダー
ヘッダー	説明
Content-Range	ページネーションされた呼び出しで返されるコンテンツの範囲。たとえば、`offset=2` および `limit=3` の場合、Content-Range ヘッダーの値は `items 3-5` です。
Content-Type	応答本文のデータフォーマット。application/json のみをサポートします。
Link	クエリー結果内を移動するための次のリンクが含まれています。 first last next previous
X-Total-Count	ページネーションされたクエリの場合、このヘッダーはサーバーで利用可能なレコードの合計数を指定します。

ステータスコード

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

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


名前	説明
channel	製品の販売に使用するチャネルのリスト。データタイプ：オブジェクトのアレイ `"channel": [ { "id": "String", "name": "String" } ]`
channel.id	関連製品の販売に使用するチャネルの一意の識別子。データタイプ：文字列
channel.name	関連する製品を販売するために使用するチャネルの名前。データタイプ：文字列
expectedCompletionDate	注文が完了する日付。データタイプ：文字列
note	注文時に顧客が作成した追加のメモのリスト。データタイプ：オブジェクトのアレイ `"note": { "author": "String", "date": "String", "text": "String" }`
note.author	関連するメモを作成したユーザーの名前。データタイプ：文字列
note.date	メモが作成された日付。データタイプ：文字列
note.text	注文時に顧客が作成した追加のメモ/コメント。データタイプ：文字列
ponr	注文が返品不可期日に達したかどうかを示すフラグ。可能な値： true：注文の返品不可期日に達しました。 false:注文の返品不可ポイントに達していません。データタイプ：ブーリアン
productOrderItem	製品注文と関連アクションに関連付けられたアイテムを説明するリスト。データタイプ：オブジェクトのアレイ `"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 テーブルの [アクション辞書エントリ (Action Dictionary Entry)] の [選択リスト] タブで定義されます。データタイプ：文字列
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	価格が繰り返し発生する場合は、`month` などの繰り返し期間。データタイプ：文字列
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.product.place.@type	TMF オープン 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 オープン 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 オープン 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 HasParent 必要 `HasChild` と `HasParent` は親子関係に使用されます。`Requires` は水平関係に使用されます (品目には別の品目が必要です)。データタイプ：文字列
productOrderItem.state	関連する製品アイテムの注文のステータス。データタイプ：文字列
productOrderItem.version	発注バージョン。データタイプ：文字列
productOrderItem.@type	TMF オープン API 標準の一部。製品の注釈。この値は常に `ProductOrderItem` です。この情報は保存されません。データタイプ：文字列
relatedParty	注文の連絡先のリスト。各連絡先はアレイ内のオブジェクトです。顧客アカウントまたはコンシューマーアカウントの情報を含むアイテムを少なくとも 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	顧客のタイプ。可能な値：コンシューマーカスタマー CustomerContact データタイプ：文字列
relatedParty.@type	TMF オープン API 標準の一部。製品の注釈。この値は常に `RelatedParty` です。この情報は保存されません。データタイプ：文字列
requestedCompletionDate	顧客によって要求された配送日。データタイプ：文字列
requestedStartDate	顧客によって要求された注文開始日。データタイプ：文字列
state	注文の現在のステータス。データタイプ：文字列
version	発注バージョン。データタイプ：文字列
@type	TMF オープン 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"
   }
]

製品注文オープン API - GET /sn_ind_tmt_orm/productorder/{id}

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

重要:

Tokyo リリース以降、このエンドポイントは廃止されました。このエンドポイントの新しいバージョンは製品注文オープン API - GET /sn_ind_tmt_orm/order/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}

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

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

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

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

ヘッダー

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

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

ステータスコード

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

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


名前	説明
channel	製品の販売に使用するチャネルのリスト。データタイプ：オブジェクトのアレイ `"channel": [ { "id": "String", "name": "String" } ]`
channel.id	関連製品の販売に使用するチャネルの一意の識別子。データタイプ：文字列
channel.name	関連する製品を販売するために使用するチャネルの名前。データタイプ：文字列
expectedCompletionDate	注文が完了する日付。データタイプ：文字列
注意	注文時に顧客が作成した追加のメモのリスト。データタイプ: オブジェクト `"note": { "author": "String", "date": "String", "text": "String" }`
note.author	関連するメモを作成したユーザーの名前。データタイプ：文字列
note.date	メモが作成された日付。データタイプ：文字列
note.text	注文時に顧客が作成した追加のメモ/コメント。データタイプ：文字列
ponr	注文が返品不可期日に達したかどうかを示すフラグ。可能な値： true：注文の返品不可期日に達しました。 false:注文の返品不可ポイントに達していません。データタイプ：ブーリアン
productOrderItem	製品注文と関連アクションに関連付けられたアイテムを説明するリスト。データタイプ：オブジェクトのアレイ `"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 テーブルの [アクション辞書エントリ (Action Dictionary Entry)] の [選択リスト] タブで定義されます。データタイプ：文字列
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	価格が繰り返し発生する場合は、`month` などの繰り返し期間。データタイプ：文字列
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.product.place.@type	TMF オープン 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 オープン 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 オープン 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 HasParent 必要 `HasChild` と `HasParent` は親子関係に使用されます。`Requires` は水平関係に使用されます (品目には別の品目が必要です)。データタイプ：文字列
productOrderItem.state	関連する製品アイテムの注文のステータス。データタイプ：文字列
productOrderItem.version	発注バージョン。データタイプ：文字列
productOrderItem.@type	TMF オープン API 標準の一部。製品の注釈。この値は常に `ProductOrderItem` です。この情報は保存されません。データタイプ：文字列
relatedParty	注文の連絡先のリスト。各連絡先はアレイ内のオブジェクトです。顧客アカウントまたはコンシューマーアカウントの情報を含むアイテムを少なくとも 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	顧客のタイプ。可能な値：コンシューマーカスタマー CustomerContact データタイプ：文字列
relatedParty.@type	TMF オープン API 標準の一部。製品の注釈。この値は常に `RelatedParty` です。この情報は保存されません。データタイプ：文字列
requestedCompletionDate	顧客によって要求された配送日。データタイプ：文字列
requestedStartDate	顧客によって要求された注文開始日。データタイプ：文字列
state	注文の現在のステータス。データタイプ：文字列
version	発注バージョン。データタイプ：文字列
@type	TMF オープン 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"
}

製品注文オープン API - PATCH /sn_ind_tmt_orm/order/productOrder/{id}

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

URL 形式

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

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

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

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

表 : 27. 要求本文パラメーター (JSON)
名前	説明
チャネル	製品の販売に使用するチャネルのリスト。データタイプ：オブジェクトのアレイ `"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 テーブルの [チャネル辞書エントリ (Channel Dictionary Entry)] の [選択リスト] タブで定義されます。データタイプ：文字列デフォルト：空白の文字列
committedDueDate	注文に対してアクションを実行する必要がある日時。この値は、各注文明細品目の committedDueDate 値以降である必要があります。注文品目のアクションが `[一時停止` ] または `[再開`] の場合、このパラメーターは更新できません。データタイプ：文字列格納場所:sn_ind_tmt_orm_orderテーブルの committed_due_date フィールド。
externalId	顧客注文の一意の識別子。この値は外部システムによって決定されます。データタイプ：文字列格納場所:sn_ind_tmt_orm_orderテーブルの external_id フィールド。デフォルト：空白の文字列
注意	注文時に顧客が作成した追加のメモのリスト。データタイプ：オブジェクトのアレイ `"note": [ { "text": "String" } ]` 保存場所: sn_ind_tmt_orm_order
note.text	注文時に顧客が作成した追加のメモ/コメント。データタイプ：文字列格納場所:sn_ind_tmt_orm_orderテーブルのコメントフィールド。デフォルト：空白の文字列
orderCurrency	注文および発注書明細の通貨コード。既存の注文の通貨コードの更新はサポートされていません。注文に既に関連付けられている通貨コード以外の値を指定すると、更新が拒否されます。データタイプ：文字列
productOrderItem	製品注文と関連アクションに関連付けられたアイテムを説明するリスト。データタイプ：オブジェクトのアレイ `"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.action	productOrderItem パラメーターが使用される場合は必須です。製品に対して実行するアクション。可能なアクションは、sn_ind_tmt_orm_order_line_item テーブルの [アクション辞書エントリ (Action Dictionary Entry)] の [選択リスト] タブで定義されます。可能な値： add change delete no-change 再開停止するデータタイプ：文字列格納場所:sn_ind_tmt_orm_order_line_itemテーブルのアクションフィールド。デフォルト:add
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	注文に対して作成された製品インベントリにマッピングする外部 ID のリスト。データタイプ：オブジェクトのアレイ `"externalProductInventory": [ { "externalProductInventoryId": "String" } ]` 注: 以前は、既に存在する外部プロダクトインベントリ ID を使用して PATCH オーダーを作成すると、操作が中断され、エラーが返されていました。Xanaduリリースでは、既存の外部プロダクトインベントリ ID が指定され、エラーがスローされない場合、このパラメーターは単に無視されます。
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.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	価格が繰り返し発生する場合は、`month` などの繰り返し期間。データタイプ：文字列
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.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.id	productOrderItem.product.place パラメーターが使用される場合は必須です。場所 [cmn_location] テーブルの関連付けられた場所レコードの sys_id。データタイプ：文字列格納場所:sn_ind_tmt_orm_order_line_itemテーブルの [場所] フィールド。デフォルト：空白の文字列
productOrderItem.product.place.@type	TMF オープン API 標準の一部。オーダー品目に関する連絡先の注釈。この値は常に `Place` です。この情報は保存されません。データタイプ：文字列
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.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	製品仕様のバージョン。データタイプ：文字列表:製品仕様 [sn_prd_pm_product_specification]
productOrderItem.product.productSpecification.name	製品仕様の名前。製品仕様 [sn_prd_pm_product_specification] テーブルにあります。データタイプ：文字列
productOrderItem.product.productSpecification.version	製品仕様の external_version。データタイプ：文字列表:製品仕様 [sn_prd_pm_product_specification]
productOrderItem.product.productSpecification.@type	TMF オープン API 標準の一部。この値は常に `ProductSpecificationRef` です。この情報は保存されません。データタイプ：文字列
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.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.product.relatedParty.@referredType	顧客のタイプ。可能な値：OrderLineItemContact データタイプ：文字列
productOrderItem.product.relatedParty.@type	TMF オープン API 標準の一部。オーダー品目に関する連絡先の注釈。この値は常に `RelatedParty` です。この情報は保存されません。データタイプ：文字列
productOrderItem.product.@type	TMF オープン API 標準の一部。製品の注釈。この値は常に `Product` です。この情報は保存されません。データタイプ：文字列
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 フィールドにあります。データタイプ：文字列格納場所:thebsn_ind_tmt_orm_order_line_itemテーブルのparent_line_itemフィールド。デフォルト：空白の文字列
productOrderItem.productOrderItemRelationship.relationshipType	2 つの品目間の関係のタイプ。この情報は、関係階層を識別するために使用されます。可能な値： HasChild HasParent 必要 `HasChild` と `HasParent` は親子関係に使用されます。`Requires` は水平関係に使用されます (品目には別の品目が必要です)。データタイプ：文字列
productOrderItem.quantity	注文されたアイテムの数。データタイプ：数値格納場所:sn_ind_tmt_orm_orderテーブルの数量フィールド。デフォルト：空白の文字列
productOrderItem.revisionOperation	品目で実行する更新のタイプ。この値が空の場合、既存の品目が更新されるか、まだ存在しない場合は新しい品目が追加されます。この値が `cancel` の場合、品目はキャンセルされます。データタイプ：文字列デフォルト：空白の文字列
productOrderItem.@type	TMF オープン API 標準の一部。製品の注釈。この値は常に `ProductOrderItem` です。この情報は保存されません。データタイプ：文字列
relatedParty	注文の連絡先のリスト。各連絡先はアレイ内のオブジェクトです。顧客アカウントまたはコンシューマーアカウントの情報を含むアイテムを少なくとも 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	顧客のタイプ。可能な値：コンシューマーカスタマー CustomerContact データタイプ：文字列
relatedParty.@type	TMF オープン API 標準の一部。製品の注釈。この値は常に `RelatedParty` です。この情報は保存されません。データタイプ：文字列
requestedCompletionDate	顧客によって要求された配送日。データタイプ：文字列格納場所:sn_ind_tmt_orm_orderテーブルのexpected_end_dateフィールド。デフォルト：空白の文字列
requestedStartDate	顧客によって要求された注文開始日。データタイプ：文字列格納場所:sn_ind_tmt_orm_orderテーブルの expected_start_date フィールド。デフォルト：空白の文字列
@type	TMF オープン API 標準の一部。製品の注釈。この値は常に `ProductOrder` です。この情報は保存されません。データタイプ：文字列

ヘッダー

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

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

ステータスコード

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

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


名前	説明
channel	製品の販売に使用するチャネルのリスト。データタイプ：オブジェクトのアレイ `"channel": [ { "id": "String", "name": "String" } ]`
channel.id	関連製品の販売に使用するチャネルの一意の識別子。データタイプ：文字列
channel.name	関連する製品を販売するために使用するチャネルの名前。データタイプ：文字列
committedDueDate	注文に対してアクションを実行する必要がある日時。この値は、各注文明細品目の committedDueDate 値以降である必要があります。データタイプ：文字列
externalId	顧客注文の外部識別子 (発注書番号など)。データタイプ：文字列
href	製品注文レコードへの相対リンク。データタイプ：文字列
id	この要求で更新された顧客注文の sys_id。データタイプ：文字列
note	注文時に顧客が作成した追加のメモのリスト。データタイプ：オブジェクトのアレイ `"note": [ { "text": "String" } ]`
note.text	注文時に顧客が作成した追加のメモ/コメント。データタイプ：文字列
orderCurrency	注文および発注書明細の通貨コード。データタイプ：文字列
productOrderItem	製品注文と関連アクションに関連付けられたアイテムを説明するリスト。データタイプ：オブジェクトのアレイ `"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 テーブルの [アクション辞書エントリ (Action Dictionary Entry)] の [選択リスト] タブで定義されます。データタイプ：文字列
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	価格が繰り返し発生する場合は、`month` などの繰り返し期間。データタイプ：文字列
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.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 オープン 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 オープン API 標準の一部。オーダー品目に関する連絡先の注釈。この値は常に `RelatedParty` です。この情報は保存されません。データタイプ：文字列
productOrderItem.product.@type	TMF オープン 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 オープン API 標準の一部。製品の注釈。この値は常に `ProductOrderItem` です。この情報は保存されません。データタイプ：文字列
relatedParty	注文の連絡先のリスト。各連絡先はアレイ内のオブジェクトです。顧客アカウントまたはコンシューマーアカウントの情報を含むアイテムを少なくとも 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	顧客のタイプ。可能な値：コンシューマーカスタマー CustomerContact データタイプ：文字列
requestedCompletionDate	顧客によって要求された配送日。データタイプ：文字列
requestedStartDate	顧客によって要求された注文開始日。データタイプ：文字列
state	注文の現在のステータス。データタイプ：文字列
@type	TMF オープン API 標準の一部。製品の注釈。この値は常に `ProductOrder` です。この情報は保存されません。データタイプ：文字列

cURL 要求

この例では、製品注文のチャネルを更新します。

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

応答本文。

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

製品注文オープン API - PATCH /sn_ind_tmt_orm/productorder/{id}

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

重要:

Tokyo リリース以降、このエンドポイントは廃止されました。このエンドポイントの新しいバージョンは製品注文オープン API - PATCH /sn_ind_tmt_orm/order/productOrder/{id} です。

URL 形式

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

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

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

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

表 : 33. 要求本文パラメーター (JSON)
名前	説明
チャネル	製品の販売に使用するチャネルのリスト。データタイプ：オブジェクトのアレイ `"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 テーブルの [チャネル辞書エントリ (Channel Dictionary Entry)] の [選択リスト] タブで定義されます。データタイプ：文字列デフォルト：空白の文字列
committedDueDate	注文に対してアクションを実行する必要がある日時。この値は、各注文明細品目の committedDueDate 値以降である必要があります。注文品目のアクションが `[一時停止` ] または `[再開`] の場合、このパラメーターは更新できません。データタイプ：文字列格納場所:sn_ind_tmt_orm_orderテーブルの committed_due_date フィールド。
externalId	顧客注文の一意の識別子。この値は外部システムによって決定されます。データタイプ：文字列格納場所:sn_ind_tmt_orm_orderテーブルの external_id フィールド。デフォルト：空白の文字列
注意	注文時に顧客が作成した追加のメモのリスト。データタイプ：オブジェクトのアレイ `"note": [ { "text": "String" } ]` 保存場所: sn_ind_tmt_orm_order
note.text	注文時に顧客が作成した追加のメモ/コメント。データタイプ：文字列格納場所:sn_ind_tmt_orm_orderテーブルのコメントフィールド。デフォルト：空白の文字列
orderCurrency	注文および発注書明細の通貨コード。既存の注文の通貨コードの更新はサポートされていません。注文に既に関連付けられている通貨コード以外の値を指定すると、更新が拒否されます。データタイプ：文字列
productOrderItem	製品注文と関連アクションに関連付けられたアイテムを説明するリスト。データタイプ：オブジェクトのアレイ `"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.action	productOrderItem パラメーターが使用される場合は必須です。製品に対して実行するアクション。可能なアクションは、sn_ind_tmt_orm_order_line_item テーブルの [アクション辞書エントリ (Action Dictionary Entry)] の [選択リスト] タブで定義されます。可能な値： add change delete no-change 再開停止するデータタイプ：文字列格納場所:sn_ind_tmt_orm_order_line_itemテーブルのアクションフィールド。デフォルト:add
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	注文に対して作成された製品インベントリにマッピングする外部 ID のリスト。データタイプ：オブジェクトのアレイ `"externalProductInventory": [ { "externalProductInventoryId": "String" } ]` 注: 以前は、既に存在する外部プロダクトインベントリ ID を使用して PATCH オーダーを作成すると、操作が中断され、エラーが返されていました。Xanaduリリースでは、既存の外部プロダクトインベントリ ID が指定され、エラーがスローされない場合、このパラメーターは単に無視されます。
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.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	価格が繰り返し発生する場合は、`month` などの繰り返し期間。データタイプ：文字列
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.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.id	productOrderItem.product.place パラメーターが使用される場合は必須です。場所 [cmn_location] テーブルの関連付けられた場所レコードの sys_id。データタイプ：文字列格納場所:sn_ind_tmt_orm_order_line_itemテーブルの [場所] フィールド。デフォルト：空白の文字列
productOrderItem.product.place.@type	TMF オープン API 標準の一部。オーダー品目に関する連絡先の注釈。この値は常に `Place` です。この情報は保存されません。データタイプ：文字列
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.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	製品仕様のバージョン。データタイプ：文字列表:製品仕様 [sn_prd_pm_product_specification]
productOrderItem.product.productSpecification.name	製品仕様の名前。製品仕様 [sn_prd_pm_product_specification] テーブルにあります。データタイプ：文字列
productOrderItem.product.productSpecification.version	製品仕様の external_version。データタイプ：文字列表:製品仕様 [sn_prd_pm_product_specification]
productOrderItem.product.productSpecification.@type	TMF オープン API 標準の一部。この値は常に `ProductSpecificationRef` です。この情報は保存されません。データタイプ：文字列
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.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.product.relatedParty.@referredType	顧客のタイプ。可能な値：OrderLineItemContact データタイプ：文字列
productOrderItem.product.relatedParty.@type	TMF オープン API 標準の一部。オーダー品目に関する連絡先の注釈。この値は常に `RelatedParty` です。この情報は保存されません。データタイプ：文字列
productOrderItem.product.@type	TMF オープン API 標準の一部。製品の注釈。この値は常に `Product` です。この情報は保存されません。データタイプ：文字列
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 フィールドにあります。データタイプ：文字列格納場所:thebsn_ind_tmt_orm_order_line_itemテーブルのparent_line_itemフィールド。デフォルト：空白の文字列
productOrderItem.productOrderItemRelationship.relationshipType	2 つの品目間の関係のタイプ。この情報は、関係階層を識別するために使用されます。可能な値： HasChild HasParent 必要 `HasChild` と `HasParent` は親子関係に使用されます。`Requires` は水平関係に使用されます (品目には別の品目が必要です)。データタイプ：文字列
productOrderItem.quantity	注文されたアイテムの数。データタイプ：数値格納場所:sn_ind_tmt_orm_orderテーブルの数量フィールド。デフォルト：空白の文字列
productOrderItem.revisionOperation	品目で実行する更新のタイプ。この値が空の場合、既存の品目が更新されるか、まだ存在しない場合は新しい品目が追加されます。この値が `cancel` の場合、品目はキャンセルされます。データタイプ：文字列デフォルト：空白の文字列
productOrderItem.@type	TMF オープン API 標準の一部。製品の注釈。この値は常に `ProductOrderItem` です。この情報は保存されません。データタイプ：文字列
relatedParty	注文の連絡先のリスト。各連絡先はアレイ内のオブジェクトです。顧客アカウントまたはコンシューマーアカウントの情報を含むアイテムを少なくとも 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	顧客のタイプ。可能な値：コンシューマーカスタマー CustomerContact データタイプ：文字列
relatedParty.@type	TMF オープン API 標準の一部。製品の注釈。この値は常に `RelatedParty` です。この情報は保存されません。データタイプ：文字列
requestedCompletionDate	顧客によって要求された配送日。データタイプ：文字列格納場所:sn_ind_tmt_orm_orderテーブルのexpected_end_dateフィールド。デフォルト：空白の文字列
requestedStartDate	顧客によって要求された注文開始日。データタイプ：文字列格納場所:sn_ind_tmt_orm_orderテーブルの expected_start_date フィールド。デフォルト：空白の文字列
@type	TMF オープン API 標準の一部。製品の注釈。この値は常に `ProductOrder` です。この情報は保存されません。データタイプ：文字列

ヘッダー

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

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

ステータスコード

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

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


名前	説明
channel	製品の販売に使用するチャネルのリスト。データタイプ：オブジェクトのアレイ `"channel": [ { "id": "String", "name": "String" } ]`
channel.id	関連製品の販売に使用するチャネルの一意の識別子。データタイプ：文字列
channel.name	関連する製品を販売するために使用するチャネルの名前。データタイプ：文字列
id	この要求で更新された顧客注文の sys_id。データタイプ：文字列
externalId	顧客注文の外部識別子 (発注書番号など)。データタイプ：文字列
note	注文時に顧客が作成した追加のメモのリスト。データタイプ：オブジェクトのアレイ `"note": [ { "text": "String" } ]`
note.text	注文時に顧客が作成した追加のメモ/コメント。データタイプ：文字列
productOrderItem	製品注文と関連アクションに関連付けられたアイテムを説明するリスト。データタイプ：オブジェクトのアレイ `"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 テーブルの [アクション辞書エントリ (Action Dictionary Entry)] の [選択リスト] タブで定義されます。データタイプ：文字列
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.taxIncludeAmount	税込みの関連製品の価格の説明。データタイプ: オブジェクト `"taxIncludedAmount": { "unit": "String", "value": Number }`
productOrderItem.itemPrice.price.taxIncludeAmount.unit	価格が表示される通貨コード。データタイプ：文字列
productOrderItem.itemPrice.price.taxIncludeAmount.value	税込みの製品価格。データタイプ：数値
productOrderItem.itemPrice.priceType	アイテムの価格タイプ (繰り返しまたは非繰り返し)。データタイプ：文字列
productOrderItem.itemPrice.recurringChargePeriod	価格が繰り返し発生する場合は、`month` などの繰り返し期間。データタイプ：文字列
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.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", "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.name	製品仕様の名前。製品仕様 [sn_prd_pm_product_specification] テーブルにあります。データタイプ：文字列
productOrderItem.product.productSpecification.@type	TMF オープン 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 オープン API 標準の一部。オーダー品目に関する連絡先の注釈。この値は常に `RelatedParty` です。この情報は保存されません。データタイプ：文字列
productOrderItem.product.@type	TMF オープン API 標準の一部。製品の注釈。この値は常に `Product` です。この情報は保存されません。データタイプ：文字列
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.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 オープン API 標準の一部。製品の注釈。この値は常に `ProductOrderItem` です。この情報は保存されません。データタイプ：文字列
relatedParty	注文の連絡先のリスト。各連絡先はアレイ内のオブジェクトです。顧客アカウントまたはコンシューマーアカウントの情報を含むアイテムを少なくとも 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	顧客のタイプ。可能な値：コンシューマーカスタマー CustomerContact データタイプ：文字列
requestedCompletionDate	顧客によって要求された配送日。データタイプ：文字列
requestedStartDate	顧客によって要求された注文開始日。データタイプ：文字列
state	注文の現在のステータス。データタイプ：文字列
@type	TMF オープン API 標準の一部。製品の注釈。この値は常に `ProductOrder` です。この情報は保存されません。データタイプ：文字列

cURL 要求

次のコード例では、顧客注文のチャネルを更新します。

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

応答本文。

{
    "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"
                        "valueType": "Choice",
                        "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",
                        "valueType": "Choice",
                        "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"
}

製品注文オープン API - POST /sn_ind_tmt_orm/cancelproductorder

指定された顧客注文をキャンセルします。

URL 形式

デフォルトの URL：/api/sn_ind_tmt_orm/cancelproductorder

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

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

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

表 : 39. 要求本文パラメーター (JSON)
名前	説明
cancellationReason	キャンセルの理由。データタイプ：文字列デフォルト：空白の文字列
productOrder	製品注文に関するデータが含まれます。データタイプ：オブジェクト `"productOrder": { "id": "String", "href": "String", "@referredType": "String" }`
productOrder.id	必須です。キャンセルする顧客注文の sys_id。データタイプ：文字列テーブル:顧客注文 [sn_ind_tmt_orm_order]
productOrder.href	キャンセルする顧客注文の URL。データタイプ：文字列デフォルト：空白の文字列
productOrder.@referredType	このパラメーターの値は `ProductOrder` である必要があります。データタイプ：文字列デフォルト：空白の文字列
requestedCancellationDate	注文をキャンセルする日付。データタイプ：文字列デフォルト：空白の文字列
@type	このパラメーターの値は `CancelProductOrder` である必要があります。データタイプ：文字列デフォルト：空白の文字列

ヘッダー

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

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

ステータスコード

表 : 42. ステータスコード
ステータスコード	説明
200	成功。要求が正常に処理されました。
400	要求が正しくありません。以下のいずれかの理由が考えられます。空のペイロード。無効なペイロード。必須フィールドがありません：<フィールド名>。無効な注文 ID。無効な注文 ID: `この注文は顧客注文テーブルにまだ作成されていません`。まだ作成されていない注文のキャンセル要求が行われました。順序は受信キュー [sn_tmt_core_inbound_queue] テーブルにあり、スケジューラーがレコードを取得するのを待機しています。

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


名前	説明
cancellationReason	キャンセルの理由。データタイプ：文字列
href	キャンセルされた注文の URL。データタイプ：文字列
id	キャンセルされた注文の sys_id。データタイプ：文字列
productOrder	製品注文に関するデータ。データタイプ: オブジェクト `"productOrder": { "id": "String", "href": "String", "@referredType": "String" }`
productOrder.id	キャンセルされた注文の sys_id。データタイプ：文字列
productOrder.href	キャンセルされた注文の URL。データタイプ：文字列
productOrder.@referredType	このパラメーターの値は `ProductOrder` です。データタイプ：文字列
requestedCancellationDate	注文をキャンセルする日付。データタイプ：文字列
state	キャンセルのステータス。キャンセル要求が正常に処理された場合 (ステータスコード 201)、このパラメーターの値は `done` になります。データタイプ：文字列
@type	このパラメーターの値は `CancelProductOrder` です。データタイプ：文字列

cURL 要求

次のコード例では、顧客注文をキャンセルします。

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

製品注文オープン API - POST /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]
注文明細行関連品目 [sn_ind_tmt_orm_order_line_related_items]

URL 形式

デフォルトの URL：/api/sn_ind_tmt_orm/order/productOrder

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

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

表 : 44. クエリパラメータ
名前	説明
モード	非同期注文処理を有効にします。つまり、オーダーが受信キュー [sn_tmt_core_inbound_queue] テーブルに追加されて作成されます。含まれていない場合、注文は同期的に処理されます。有効な値:async データタイプ：文字列

表 : 45. 要求本文パラメーター (JSON)
名前	説明
チャネル	製品の販売に使用するチャネルのリスト。データタイプ：オブジェクトのアレイ `"channel": [ { "id": "String", "name": "String" } ]` 保存場所: sn_ind_tmt_orm_order
channel.id	必須です。関連する製品を販売するために使用するチャネルの一意の識別子。チャネル ID の値は、流通チャネル [sn_prd_pm_distribution_channel] テーブルの external_id フィールドにあります。データタイプ：文字列格納場所:sn_ind_tmt_orm_orderテーブルのチャネルフィールド。デフォルト：空白の文字列
channel.name	関連する製品を販売するために使用するチャネルの名前。使用可能なチャネル名は、sn_ind_tmt_orm_order テーブルの [チャネル辞書エントリ (Channel Dictionary Entry)] の [選択リスト] タブで定義されます。データタイプ：文字列デフォルト：空白の文字列
committedDueDate	注文に対してアクションを実行する必要がある日時。この値は、各注文明細品目の committedDueDate 値以降である必要があります。データタイプ：文字列格納場所:sn_ind_tmt_orm_orderテーブルの committed_due_date フィールド。
externalId	顧客注文の一意の識別子。この値は外部システムによって決定されます。データタイプ：文字列格納場所:sn_ind_tmt_orm_orderテーブルの external_id フィールド。デフォルト：空白の文字列
href	リソースレコードへの相対リンク。データタイプ：文字列デフォルト：空白の文字列
注意	注文時に顧客が作成した追加のメモ。データタイプ：オブジェクトのアレイ `"note": [ { "text": "String" } ]` 保存場所: sn_ind_tmt_orm_order
note.text	必須です。注文時に顧客が作成した追加のメモ/コメント。データタイプ：文字列格納場所:sn_ind_tmt_orm_orderテーブルのコメントフィールド。デフォルト：空白の文字列
orderCurrency	必須です。注文および発注書明細の通貨コード。通貨は、注文と発注書明細のすべての要素で同じである必要があります。そうでない場合、エラーが返され、注文は作成されません。注文が作成されると、その通貨コードは変更できません。データタイプ：文字列
productOrderItem	必須。製品注文とそれに関連するアクションに関連付けられたアイテム。データタイプ：オブジェクトのアレイ `"productOrderItem": [ { "action": "String", "actionReason": "String", "committedDueDate": "String", "externalProductInventory": [Array], "id": "String", "itemPrice": [Array], "product": {Object}, "productOffering": {Object}, "productOrderItemRelationship": [Array], "quantity": Number, "@type": "String" } ]` 保存場所:注文明細品目 [sn_ind_tmt_orm_order_line_item]
productOrderItem.action	必須です。製品に対して実行するアクション。可能なアクションは、sn_ind_tmt_orm_order_line_item テーブルの [アクション辞書エントリ (Action Dictionary Entry)] の [選択リスト] タブで定義されます。可能な値： add change delete no-change 再開停止するデータタイプ：文字列保存場所:注文品目 [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	注文に対して作成された製品インベントリにマッピングする外部 ID。データタイプ：オブジェクトのアレイ `"externalProductInventory": [ { "externalProductInventoryId": "String" } ]`
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.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.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.id	必須。関連付けられた場所レコードの sys_id。データタイプ：文字列テーブル:場所 [cmn_location] 保存場所:注文品目 [sn_ind_tmt_orm_order_line_item] テーブルの [場所] フィールド。
productOrderItem.product.place.@type	TMF オープン API 標準の一部。オーダー品目に関する連絡先の注釈。この値は常に `Place` です。この情報は保存されません。データタイプ：文字列
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 Test チェックボックス選択肢日付、住所メール整数、日付/時刻オブジェクト 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.id	必須。製品仕様の初期バージョンまたは外部 ID。初期バージョンは、仕様の最初のバージョン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 オープン API 標準の一部。この値は常に `ProductSpecificationRef` です。この情報は保存されません。データタイプ：文字列
productOrderItem.product.relatedParty	OrderLineItemContact にリンクされている関係者ロールのリスト。データタイプ：オブジェクトのアレイ `"relatedParty": [ { "email": "String", "firstName": "String", "lastName": "String", "phone": "String", "@referredType": "String", "@type": "String" } ]` 保存場所:sn_ind_tmt_orm_order_line_item_contact
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.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.product.relatedParty.@referredType	必須です。顧客のタイプ。可能な値：OrderLineItemContact データタイプ：文字列
productOrderItem.product.relatedParty.@type	TMF オープン API 標準の一部。オーダー品目に関する連絡先の注釈。この値は常に `RelatedParty` です。この情報は保存されません。データタイプ：文字列
productOrderItem.product.@type	TMF オープン API 標準の一部。製品の注釈。この値は常に `Product` です。この情報は保存されません。データタイプ：文字列
productOrderItem.productOffering	必須です。製品に関連付けられた製品オファリングの説明。データタイプ: オブジェクト `"productOffering": { "id": "String", "internalVersion": "String", "name": "String", "version": "String" }` 保存場所: sn_ind_tmt_orm_order_line_item
productOrderItem.productOffering.id	必須。製品オファリングの初期バージョンまたは外部 ID。初期バージョンは、オファリングの最初のバージョン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.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.id値と同じです。親子関係に使用します。データタイプ：文字列格納場所:sn_ind_tmt_orm_order_line_itemテーブルのparent_line_itemフィールド。デフォルト：空白の文字列
productOrderItem.productOrderItemRelationship.relationshipType	必須です。2 つの品目間の関係のタイプ。この情報は、関係階層を識別するために使用されます。可能な値： HasChild HasParent データタイプ：文字列
productOrderItem.quantity	注文されたアイテムの数。データタイプ：数値格納場所:sn_ind_tmt_orm_orderテーブルの数量フィールド。デフォルト：空白の文字列
productOrderItem.@type	TMF オープン API 標準の一部。製品の注釈。この値は常に `ProductOrderItem` です。この情報は保存されません。データタイプ：文字列
relatedParty	注文の連絡先のリスト。各連絡先はアレイ内のオブジェクトです。顧客アカウントまたはコンシューマーアカウントの情報を含むアイテムを少なくとも 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	必須です。顧客のタイプ。可能な値：コンシューマーカスタマー CustomerContact データタイプ：文字列
relatedParty.@type	TMF オープン API 標準の一部。製品の注釈。この値は常に `RelatedParty` です。この情報は保存されません。データタイプ：文字列
requestedCompletionDate	顧客によって要求された配送日。データタイプ：文字列格納場所:sn_ind_tmt_orm_orderテーブルのexpected_end_dateフィールド。デフォルト：空白の文字列
requestedStartDate	顧客によって要求された注文開始日。データタイプ：文字列格納場所:sn_ind_tmt_orm_orderテーブルの expected_start_date フィールド。デフォルト：空白の文字列
@type	TMF オープン API 標準の一部。製品の注釈。この値は常に `ProductOrder` です。この情報は保存されません。データタイプ：文字列

ヘッダー

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

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

ステータスコード

表 : 48. ステータスコード
ステータスコード	説明
201	成功。特性または特性オプション情報に問題がある場合、エンドポイントは関連する顧客オーダー品目レコードの作業メモフィールドに次のコメントを保存します。 `次の注文アイテム特性は存在しません：仕様 <characteristic.name> を確認し、注文を承認する前に発注書明細の特性と特性オプションを修正してください。` `注文アイテム特性：<characteristic.name> と特性値：<characteristic.value> は無効です。注文を承認する前に特性値を修正してください。`
202	受け入れ済み。非同期モードで注文の要求が成功しました。つまり、要求は mode パラメーターを `非同期` に設定して行われ、レコードは受信キュー [sn_tmt_core_inbound_queue] テーブルで処理されるようにスケジュールされています。
400	要求が正しくありません。以下のいずれかの理由が考えられます。 `無効なペイロード：要求本文がありません` - ペイロードが要求本文で渡されませんでした。 `無効なペイロード：productOrderItem がありません` - 製品オーダー品目オブジェクトまたは JSON がありません。 `無効なペイロード：productOrderItem がありません` - ペイロードの製品オーダー品目に id パラメーターがありません。 `無効なペイロード：productOrderItem action がありません` - ペイロードの製品オーダー品目に action パラメーターがありません。 `無効なペイロード：productOrderItem productOffering がありません` - ペイロードの製品オーダー品目に製品オファリングオブジェクトまたは JSON がありません。 `無効なペイロード：productOffering id がありません` - ペイロードの製品オファリングオブジェクトの製品オーダー品目に id パラメーターがありません。 `無効なペイロード：製品オファリングが存在しません` - 製品オーダー品目の製品オファリングが有効ではありません。 `無効なペイロード：productOrderItem product がありません` - ペイロードの製品オーダー品目に製品オブジェクトまたは JSON がありません。 `無効なペイロード：product productSpecification がありません` - ペイロードの製品オーダー品目に製品仕様オブジェクトまたは JSON がありません。 `無効なペイロード：productSpecification id がありません` - ペイロードの製品仕様オブジェクトの製品オーダー品目に id パラメーターがありません。 `無効なペイロード：製品仕様が存在しません` - 製品オーダー品目の製品仕様が有効ではありません。 `無効なペイロード：製品在庫が存在しません` - 変更指示 (action = change) で、アイテムの数量が在庫数を超えています。 `無効なペイロード：製品在庫 ID がありません` - 変更指示で、ペイロードに product.id がありません。 `無効なペイロード：販売済み製品が非アクティブです` - 変更指示で、ペイロードで指定された製品が非アクティブです。 `無効なペイロード：relatedParty がありません` - 関係者オブジェクトがペイロードにありません。 `無効なペイロード:顧客アカウントまたはコンシューマーがありません` :関係者の顧客またはコンシューマーオブジェクトがペイロードにありません。 `無効なペイロード:コンシューマーが存在しません` :指定された関係者コンシューマーが ServiceNow インスタンスに存在しません。 `無効なペイロード：顧客アカウントが存在しません` - 指定された関係者顧客が ServiceNow インスタンスに存在しません。 `無効なペイロード：注文の作成に失敗しました` - 要求されたオーダーを作成できません。 `無効なペイロード：orderCurrency が必要です` - orderCurrency パラメーターがペイロードにありません。 `非アクティブな通貨コード：<通貨>` - 指定された通貨は ServiceNow インスタンスで非アクティブです。 `1 つ以上の品目に注文通貨と異なる通貨コードがあります` - すべての品目に注文通貨と同じ通貨コードがあるわけではありません。 `注文通貨への実行中の変更はサポートされていません` - オーダーが作成された後は orderCurrency パラメーターを更新できません。

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


名前	説明
channel	製品の販売に使用するチャネルのリスト。データタイプ：オブジェクトのアレイ `"channel": [ { "id": "String", "name": "String" } ]`
channel.id	関連製品の販売に使用するチャネルの一意の識別子。データタイプ：文字列
channel.name	関連する製品を販売するために使用するチャネルの名前。データタイプ：文字列
committedDueDate	注文に対してアクションを実行する必要がある日時。この値は、各注文明細品目の committedDueDate 値以降である必要があります。データタイプ：文字列
externalId	顧客注文の外部識別子 (発注書番号など)。データタイプ：文字列
href	製品注文レコードへの相対リンク。データタイプ：文字列
id	この要求で作成された顧客注文の sys_id。データタイプ：文字列
note	注文時に顧客が作成した追加のメモのリスト。データタイプ：オブジェクトのアレイ `"note": [ { "text": "String" } ]`
note.text	注文時に顧客が作成した追加のメモ/コメント。データタイプ：文字列
orderCurrency	注文および発注書明細の通貨コード。データタイプ：文字列
orderId	作成するオーダーのSys_id。要求が正常に完了すると、処理するスケジュールで注文が受信キュー [sn_tmt_core_inbound_queue] テーブルに追加されます。注: この値は、注文が mode クエリパラメーターを使用して非同期で作成された場合にのみ発生します。 `{ "orderId": "b0fc877ac3ab5110856d73ce3640dde0" }` データタイプ：文字列
productOrderItem	製品注文と関連アクションに関連付けられたアイテムを説明するリスト。データタイプ：オブジェクトのアレイ `"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 テーブルの [アクション辞書エントリ (Action Dictionary Entry)] の [選択リスト] タブで定義されます。データタイプ：文字列
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.taxIncludeAmount	税込みの関連製品の価格の説明。データタイプ: オブジェクト `"taxIncludedAmount": { "unit": "String", "value": Number }`
productOrderItem.itemPrice.price.taxIncludeAmount.unit	価格が表示される通貨コード。データタイプ：文字列
productOrderItem.itemPrice.price.taxIncludeAmount.value	税込みの製品価格。データタイプ：数値
productOrderItem.itemPrice.priceType	アイテムの価格タイプ (繰り返しまたは非繰り返し)。データタイプ：文字列
productOrderItem.itemPrice.recurringChargePeriod	価格が繰り返し発生する場合は、`month` などの繰り返し期間。データタイプ：文字列
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.action`変更または削除の`場合にのみ返されます。sys_id と external_id の両方が存在する場合は、external_id が返されます。データタイプ：文字列
productOrderItem.product.place	製品をインストールする場所のマップ。データタイプ: オブジェクト `"place": { "id": "String", "@type": "String" }`
productOrderItem.product.place.id	場所 [cmn_location] テーブルの関連付けられた場所レコードの 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.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	注文品目と製品インベントリの関係のタイプ。可能な値： Requires データタイプ：文字列
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 フィールドにあります。sys_id と external_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 オープン API 標準の一部。この値は常に `ProductSpecificationRef` です。この情報は保存されません。データタイプ：文字列
productOrderItem.product.relatedParty	品目の連絡先のリスト。データタイプ：オブジェクトのアレイ `"relatedParty:" [ { "email": "String", "firstName": "String", "lastName": "String", "phone": "String", "@referredType": "String", "@type": "String" } ]`
productOrderItem.product.relatedParty.email	連絡先のメールアドレス。データタイプ：文字列
productOrderItem.product.relatedParty.firstName	担当者の名。データタイプ：文字列
productOrderItem.product.relatedParty.lastName	担当者の姓。データタイプ：文字列データタイプ：文字列
productOrderItem.product.relatedParty.phone	担当者の勤務先電話番号。データタイプ：文字列
productOrderItem.product.relatedParty.@referredType	顧客のタイプ。可能な値：OrderLineItemContact データタイプ：文字列
productOrderItem.product.relatedParty.@type	TMF オープン API 標準の一部。オーダー品目に関する連絡先の注釈。この値は常に `RelatedParty` です。この情報は保存されません。データタイプ：文字列
productOrderItem.product.@type	TMF オープン 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 フィールドにあります。sys_id と external_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 つの品目間の関係のタイプ。この情報は、関係階層を識別するために使用されます。可能な値： HasChild HasParent 必要 `HasChild` と `HasParent` は親子関係に使用されます。`Requires` は水平関係に使用されます (品目には別の品目が必要です)。データタイプ：文字列
productOrderItem.quantity	注文する関連アイテムの数。データタイプ：数値
productOrderItem.state	製品オーダーアイテムの現在のステータス。この値は常に `new` です。データタイプ：文字列
productOrderItem.@type	TMF オープン API 標準の一部。製品の注釈。この値は常に `ProductOrderItem` です。この情報は保存されません。データタイプ：文字列
relatedParty	注文の連絡先のリスト。各連絡先はアレイ内のオブジェクトです。顧客アカウントまたはコンシューマーアカウントの情報を含むアイテムを少なくとも 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	顧客のタイプ。可能な値：コンシューマーカスタマー CustomerContact データタイプ：文字列
requestedCompletionDate	顧客によって要求された配送日。データタイプ：文字列
requestedStartDate	顧客によって要求された注文開始日。データタイプ：文字列
state	注文の現在のステータス。このエンドポイントでは、この値は常に `new` です。データタイプ：文字列
@type	TMF オープン API 標準の一部。製品の注釈。この値は常に `ProductOrder` です。この情報は保存されません。データタイプ：文字列

非同期処理

この例では、 mode クエリパラメーターを使用して順序を非同期的に作成する方法を示します。オーダーは、作成するスケジュールで受信キュー [sn_tmt_core_inbound_queue] テーブルに追加されます。

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

応答本文。

{
  "orderId": "304e877ac3ab5110856d73ce3640dde5"
}

同期処理中 (デフォルト)

次の例は、製品注文を作成する方法を示しています。

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

応答本文。

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

製品注文オープン API - POST /sn_ind_tmt_orm/productorder

指定された顧客注文および顧客オーダー品目を作成します。

重要:

Tokyo リリース以降、このエンドポイントは廃止されました。このエンドポイントの新しいバージョンは製品注文オープン API - POST /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

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

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

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

表 : 51. 要求本文パラメーター (JSON)
名前	説明
チャネル	製品の販売に使用するチャネルのリスト。データタイプ：オブジェクトのアレイ `"channel": [ { "id": "String", "name": "String" } ]` 保存場所: sn_ind_tmt_orm_order
channel.id	必須です。関連する製品を販売するために使用するチャネルの一意の識別子。チャネル ID の値は、流通チャネル [sn_prd_pm_distribution_channel] テーブルの external_id フィールドにあります。データタイプ：文字列格納場所:sn_ind_tmt_orm_orderテーブルのチャネルフィールド。デフォルト：空白の文字列
channel.name	関連する製品を販売するために使用するチャネルの名前。使用可能なチャネル名は、sn_ind_tmt_orm_order テーブルの [チャネル辞書エントリ (Channel Dictionary Entry)] の [選択リスト] タブで定義されます。データタイプ：文字列デフォルト：空白の文字列
committedDueDate	注文に対してアクションを実行する必要がある日時。この値は、各注文明細品目の committedDueDate 値以降である必要があります。データタイプ：文字列格納場所:sn_ind_tmt_orm_orderテーブルの committed_due_date フィールド。
externalId	顧客注文の一意の識別子。この値は外部システムによって決定されます。データタイプ：文字列格納場所:sn_ind_tmt_orm_orderテーブルの external_id フィールド。デフォルト：空白の文字列
href	リソースレコードへの相対リンク。データタイプ：文字列デフォルト：空白の文字列
注意	注文時に顧客が作成した追加のメモ。データタイプ：オブジェクトのアレイ `"note": [ { "text": "String" } ]` 保存場所: sn_ind_tmt_orm_order
note.text	必須です。注文時に顧客が作成した追加のメモ/コメント。データタイプ：文字列格納場所:sn_ind_tmt_orm_orderテーブルのコメントフィールド。デフォルト：空白の文字列
orderCurrency	必須です。注文および発注書明細の通貨コード。通貨は、注文と発注書明細のすべての要素で同じである必要があります。そうでない場合、エラーが返され、注文は作成されません。注文が作成されると、その通貨コードは変更できません。データタイプ：文字列
productOrderItem	必須。製品注文とそれに関連するアクションに関連付けられたアイテム。データタイプ：オブジェクトのアレイ `"productOrderItem": [ { "action": "String", "actionReason": "String", "committedDueDate": "String", "externalProductInventory": [Array], "id": "String", "itemPrice": [Array], "product": {Object}, "productOffering": {Object}, "productOrderItemRelationship": [Array], "quantity": Number, "@type": "String" } ]` 保存場所:注文明細品目 [sn_ind_tmt_orm_order_line_item]
productOrderItem.action	必須です。製品に対して実行するアクション。可能なアクションは、sn_ind_tmt_orm_order_line_item テーブルの [アクション辞書エントリ (Action Dictionary Entry)] の [選択リスト] タブで定義されます。可能な値： add change delete no-change 再開停止するデータタイプ：文字列保存場所:注文品目 [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	注文に対して作成された製品インベントリにマッピングする外部 ID。データタイプ：オブジェクトのアレイ `"externalProductInventory": [ { "externalProductInventoryId": "String" } ]`
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.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.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.id	必須。関連付けられた場所レコードの sys_id。データタイプ：文字列テーブル:場所 [cmn_location] 保存場所:注文品目 [sn_ind_tmt_orm_order_line_item] テーブルの [場所] フィールド。
productOrderItem.product.place.@type	TMF オープン API 標準の一部。オーダー品目に関する連絡先の注釈。この値は常に `Place` です。この情報は保存されません。データタイプ：文字列
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 Test チェックボックス選択肢日付、住所メール整数、日付/時刻オブジェクト 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.id	必須。製品仕様の初期バージョンまたは外部 ID。初期バージョンは、仕様の最初のバージョン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 オープン API 標準の一部。この値は常に `ProductSpecificationRef` です。この情報は保存されません。データタイプ：文字列
productOrderItem.product.relatedParty	OrderLineItemContact にリンクされている関係者ロールのリスト。データタイプ：オブジェクトのアレイ `"relatedParty": [ { "email": "String", "firstName": "String", "lastName": "String", "phone": "String", "@referredType": "String", "@type": "String" } ]` 保存場所:sn_ind_tmt_orm_order_line_item_contact
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.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.product.relatedParty.@referredType	必須です。顧客のタイプ。可能な値：OrderLineItemContact データタイプ：文字列
productOrderItem.product.relatedParty.@type	TMF オープン API 標準の一部。オーダー品目に関する連絡先の注釈。この値は常に `RelatedParty` です。この情報は保存されません。データタイプ：文字列
productOrderItem.product.@type	TMF オープン API 標準の一部。製品の注釈。この値は常に `Product` です。この情報は保存されません。データタイプ：文字列
productOrderItem.productOffering	必須です。製品に関連付けられた製品オファリングの説明。データタイプ: オブジェクト `"productOffering": { "id": "String", "internalVersion": "String", "name": "String", "version": "String" }` 保存場所: sn_ind_tmt_orm_order_line_item
productOrderItem.productOffering.id	必須。製品オファリングの初期バージョンまたは外部 ID。初期バージョンは、オファリングの最初のバージョン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.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.id値と同じです。親子関係に使用します。データタイプ：文字列格納場所:sn_ind_tmt_orm_order_line_itemテーブルのparent_line_itemフィールド。デフォルト：空白の文字列
productOrderItem.productOrderItemRelationship.relationshipType	必須です。2 つの品目間の関係のタイプ。この情報は、関係階層を識別するために使用されます。可能な値： HasChild HasParent データタイプ：文字列
productOrderItem.quantity	注文されたアイテムの数。データタイプ：数値格納場所:sn_ind_tmt_orm_orderテーブルの数量フィールド。デフォルト：空白の文字列
productOrderItem.@type	TMF オープン API 標準の一部。製品の注釈。この値は常に `ProductOrderItem` です。この情報は保存されません。データタイプ：文字列
relatedParty	注文の連絡先のリスト。各連絡先はアレイ内のオブジェクトです。顧客アカウントまたはコンシューマーアカウントの情報を含むアイテムを少なくとも 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	必須です。顧客のタイプ。可能な値：コンシューマーカスタマー CustomerContact データタイプ：文字列
relatedParty.@type	TMF オープン API 標準の一部。製品の注釈。この値は常に `RelatedParty` です。この情報は保存されません。データタイプ：文字列
requestedCompletionDate	顧客によって要求された配送日。データタイプ：文字列格納場所:sn_ind_tmt_orm_orderテーブルのexpected_end_dateフィールド。デフォルト：空白の文字列
requestedStartDate	顧客によって要求された注文開始日。データタイプ：文字列格納場所:sn_ind_tmt_orm_orderテーブルの expected_start_date フィールド。デフォルト：空白の文字列
@type	TMF オープン API 標準の一部。製品の注釈。この値は常に `ProductOrder` です。この情報は保存されません。データタイプ：文字列

ヘッダー

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

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

ステータスコード

表 : 54. ステータスコード
ステータスコード	説明
201	成功。特性または特性オプション情報に問題がある場合、エンドポイントは関連する顧客オーダー品目レコードの作業メモフィールドに次のコメントを保存します。 `次の注文アイテム特性は存在しません：仕様 <characteristic.name> を確認し、注文を承認する前に発注書明細の特性と特性オプションを修正してください。` `注文アイテム特性：<characteristic.name> と特性値：<characteristic.value> は無効です。注文を承認する前に特性値を修正してください。`
400	要求が正しくありません。以下のいずれかの理由が考えられます。 `無効なペイロード：要求本文がありません` - ペイロードが要求本文で渡されませんでした。 `無効なペイロード：productOrderItem がありません` - 製品オーダー品目オブジェクトまたは JSON がありません。 `無効なペイロード：productOrderItem がありません` - ペイロードの製品オーダー品目に id パラメーターがありません。 `無効なペイロード：productOrderItem action がありません` - ペイロードの製品オーダー品目に action パラメーターがありません。 `無効なペイロード：productOrderItem productOffering がありません` - ペイロードの製品オーダー品目に製品オファリングオブジェクトまたは JSON がありません。 `無効なペイロード：productOffering id がありません` - ペイロードの製品オファリングオブジェクトの製品オーダー品目に id パラメーターがありません。 `無効なペイロード：製品オファリングが存在しません` - 製品オーダー品目の製品オファリングが有効ではありません。 `無効なペイロード：productOrderItem product がありません` - ペイロードの製品オーダー品目に製品オブジェクトまたは JSON がありません。 `無効なペイロード：product productSpecification がありません` - ペイロードの製品オーダー品目に製品仕様オブジェクトまたは JSON がありません。 `無効なペイロード：productSpecification id がありません` - ペイロードの製品仕様オブジェクトの製品オーダー品目に id パラメーターがありません。 `無効なペイロード：製品仕様が存在しません` - 製品オーダー品目の製品仕様が有効ではありません。 `無効なペイロード：製品在庫が存在しません` - 変更指示 (action = change) で、アイテムの数量が在庫数を超えています。 `無効なペイロード：製品在庫 ID がありません` - 変更指示で、ペイロードに product.id がありません。 `無効なペイロード：販売済み製品が非アクティブです` - 変更指示で、ペイロードで指定された製品が非アクティブです。 `無効なペイロード：relatedParty がありません` - 関係者オブジェクトがペイロードにありません。 `無効なペイロード:顧客アカウントまたはコンシューマーがありません` :関係者の顧客またはコンシューマーオブジェクトがペイロードにありません。 `無効なペイロード:コンシューマーが存在しません` :指定された関係者コンシューマーが ServiceNow インスタンスに存在しません。 `無効なペイロード：顧客アカウントが存在しません` - 指定された関係者顧客が ServiceNow インスタンスに存在しません。 `無効なペイロード：注文の作成に失敗しました` - 要求されたオーダーを作成できません。

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


名前	説明
channel	製品の販売に使用するチャネルのリスト。データタイプ：オブジェクトのアレイ `"channel": [ { "id": "String", "name": "String" } ]`
channel.id	関連製品の販売に使用するチャネルの一意の識別子。データタイプ：文字列
channel.name	関連する製品を販売するために使用するチャネルの名前。データタイプ：文字列
id	この要求で作成された顧客注文の sys_id。データタイプ：文字列
externalId	顧客注文の外部識別子 (発注書番号など)。データタイプ：文字列
note	注文時に顧客が作成した追加のメモのリスト。データタイプ：オブジェクトのアレイ `"note": [ { "text": "String" } ]`
note.text	注文時に顧客が作成した追加のメモ/コメント。データタイプ：文字列
productOrderItem	製品注文と関連アクションに関連付けられたアイテムを説明するリスト。データタイプ：オブジェクトのアレイ `"productOrderItem:" [ { "action": "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 テーブルの [アクション辞書エントリ (Action Dictionary Entry)] の [選択リスト] タブで定義されます。データタイプ：文字列
productOderItem.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.taxIncludeAmount	税込みの関連製品の価格の説明。データタイプ: オブジェクト `"taxIncludedAmount": { "unit": "String", "value": Number }`
productOrderItem.itemPrice.price.taxIncludeAmount.unit	価格が表示される通貨コード。データタイプ：文字列
productOrderItem.itemPrice.price.taxIncludeAmount.value	税込みの製品価格。データタイプ：数値
productOrderItem.itemPrice.priceType	アイテムの価格タイプ (繰り返しまたは非繰り返し)。データタイプ：文字列
productOrderItem.itemPrice.recurringChargePeriod	価格が繰り返し発生する場合は、`month` などの繰り返し期間。データタイプ：文字列
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.action`変更または削除の`場合にのみ返されます。sys_id と external_id の両方が存在する場合は、external_id が返されます。データタイプ：文字列
productOrderItem.product.place	製品をインストールする場所のマップ。データタイプ: オブジェクト `"place": { "id": "String", "@type": "String" }`
productOrderItem.product.place.id	場所 [cmn_location] テーブルの関連付けられた場所レコードの 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.productCharacteristic.valueType	特性値のタイプ。可能な値： Array.Date Array.Datetime Array.Decimal Array.Integer Array.Object Array.Single Line Test チェックボックス選択肢日付、住所メール整数、日付/時刻オブジェクト 1 行テキストはい/いいえデータタイプ：文字列
productOrderItem.product.productSpecification	製品に関連付けられた製品仕様の説明。データタイプ: オブジェクト `"productSpecification": { "id": "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 フィールドにあります。sys_id と external_id の両方が存在する場合は、external_id が返されます。データタイプ：文字列
productOrderItem.product.productSpecification.name	製品仕様の名前。製品仕様 [sn_prd_pm_product_specification] テーブルにあります。データタイプ：文字列
productOrderItem.product.productSpecification.@type	TMF オープン API 標準の一部。この値は常に `ProductSpecificationRef` です。この情報は保存されません。データタイプ：文字列
productOrderItem.product.relatedParty	品目の連絡先のリスト。データタイプ：オブジェクトのアレイ `"relatedParty:" [ { "email": "String", "firstName": "String", "lastName": "String", "phone": "String", "@referredType": "String", "@type": "String" } ]`
productOrderItem.product.relatedParty.email	連絡先のメールアドレス。データタイプ：文字列
productOrderItem.product.relatedParty.firstName	担当者の名。データタイプ：文字列
productOrderItem.product.relatedParty.lastName	担当者の姓。データタイプ：文字列データタイプ：文字列
productOrderItem.product.relatedParty.phone	担当者の勤務先電話番号。データタイプ：文字列
productOrderItem.product.relatedParty.@referredType	顧客のタイプ。可能な値：OrderLineItemContact データタイプ：文字列
productOrderItem.product.relatedParty.@type	TMF オープン API 標準の一部。オーダー品目に関する連絡先の注釈。この値は常に `RelatedParty` です。この情報は保存されません。データタイプ：文字列
productOrderItem.product.@type	TMF オープン API 標準の一部。製品の注釈。この値は常に `Product` です。この情報は保存されません。データタイプ：文字列
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 フィールドにあります。sys_id と external_id の両方が存在する場合は、external_id が返されます。データタイプ：文字列
productOrderItem.productOffering.name	製品オファリングの名前。製品オファリング [sn_prd_pm_product_offering] テーブルにあります。データタイプ：文字列
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	製品オーダーアイテムの現在のステータス。この値は常に `new` です。データタイプ：文字列
productOrderItem.@type	TMF オープン API 標準の一部。製品の注釈。この値は常に `ProductOrderItem` です。この情報は保存されません。データタイプ：文字列
relatedParty	注文の連絡先のリスト。各連絡先はアレイ内のオブジェクトです。顧客アカウントまたはコンシューマーアカウントの情報を含むアイテムを少なくとも 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	顧客のタイプ。可能な値：コンシューマーカスタマー CustomerContact データタイプ：文字列
requestedCompletionDate	顧客によって要求された配送日。データタイプ：文字列
requestedStartDate	顧客によって要求された注文開始日。データタイプ：文字列
state	注文の現在のステータス。このエンドポイントでは、この値は常に `new` です。データタイプ：文字列
@type	TMF オープン API 標準の一部。製品の注釈。この値は常に `ProductOrder` です。この情報は保存されません。データタイプ：文字列

cURL 要求

次のコード例では、顧客注文を作成します。

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",
            "valueType": "Object",
            "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",
            "valueType": "Object",
            "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"
}

応答本文。

{
    "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",
                        "valueType": "Object",
                        "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",
                        "valueType": "Object",
                        "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"
}