--- sourceDocument: オーストラリア API リファレンス sourceDocumentLink: https://servicenow-prod.fluidtopics.net/r/ja-JP/api-reference Release : - australia ft:locale : - ja-JP ft:publication_title : - オーストラリア API リファレンス ft:clusterId : - crapiref bundleId : - crapiref workflow : - Creator --- # 製品注文オープン API # 製品注文オープン API {#ariaid-title1} * リリースバージョン: Australia * * 更新日 2026年03月12日 * * ![](https://www.servicenow.com/docs/portal-asset/ico-clock) 所要時間：372分 Product Order Open API は、製品を注文するための標準化されたメカニズムを有効にするエンドポイントを提供します。 製品注文は、製品カタログで定義および公開されている製品オファリングに基づいて作成されます。製品オファリングは、顧客が利用可能な製品または製品セットを識別し、製品の一意のオプションをキャプチャする関連する製品特性と、価格、契約条件、可用性などのその他の関連属性を含みます。 この API にアクセスするには、 通信事業向け注文管理 (sn_ind_tmt_orm) プラグインを有効にする必要があります。詳細については、「[Install Order Management](https://www.servicenow.com/docs/access?context=order-mgt-install-providers&version=australia&pubname=australia-order-management&ft:locale=en-US)」を参照してください。注文管理テーブルとロールの詳細については、「[Components installed with Order Management](https://www.servicenow.com/docs/access?context=components-installed-with-order-management&version=australia&pubname=australia-order-management&ft:locale=en-US)」を参照してください。 この API は、 `sn_ind_tmt_orm` 名前空間内で提供されます。 呼び出し元ユーザーには sn_ind_tmt_orm.order_integrator ロールが必要です。 この API を拡張して、必須パラメーター、要求本文の検証、追加の REST 操作、およびフィールドマッピングをカスタマイズできます。詳細については、「[製品注文オープン API 開発者ガイド。](https://servicenow-prod.fluidtopics.net/XwksWSzgDEsfw6djmYgzHQ#product-order_dev-guide "Product Order Open API を使用して、製品注文情報を作成、更新、および取得します。") 製品注文オープン API は、TM フォーラムの製品注文管理 API 仕様のServiceNow®実装です。この実装は、 [TMF622 製品注文管理 API ユーザーガイド v5.0.0](https://www.tmforum.org/resources/specifications/tmf622-product-ordering-management-api-user-guide-v5-0-0/) (2024 年 9 月) に基づいています。Product Order Open API は、TM フォーラムによって適合性認定を受けています。 ## Product Order Open API - GET /sn_ind_tmt_orm/order/productOrder {#ariaid-title2} すべての製品注文を取得します。 このエンドポイントは、次のテーブルから注文情報を取得します。 * 顧客注文 \[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\] {#tmf_prod_order-GET-ord-productOrder__ul_lxc_kxm_t4b} ### URL 形式 {#tmf_prod_order-GET-ord-productOrder__section_mbm_2ct_t4b} デフォルト URL: /api/sn_ind_tmt_orm/order/productOrder ### サポートされている要求パラメーター {#tmf_prod_order-GET-ord-productOrder__table_ofr_vgy_fsb__entry__2} | 名前 | 説明 | |-|-| | なし | | [表 : 1. パスパラメーター] {#tmf_prod_order-GET-ord-productOrder__table_ofr_vgy_fsb} {#tmf_prod_order-GET-ord-productOrder__table_pfr_vgy_fsb__entry__2} | 名前 | 説明 | |-|-| | フィールド | 応答で返すフィールドのリスト。無効なフィールドは無視されます。 データタイプ：文字列 デフォルト:すべてのフィールドが返されます。 | | limit | 返されるレコードの最大数。このレコード数を超える要求の場合は、 offset パラメーターを使用してレコード取得をページネーションします。 データタイプ：数値 デフォルト値：20 最大:100 | | オフセット | レコードの取得を開始する開始インデックス。この値を使用して、レコード取得をページネーションします。この機能を使用すると、レコードの数に関係なく、すべてのレコードを小さな管理可能なチャンクで取得できます。 データタイプ：数値 デフォルト：0 | | 状況 | 注文をステータスでフィルタリングします。このパラメーターの値と一致するステータスの注文のみが応答に返されます。 データタイプ：文字列 デフォルト:ステータス順に並べ替えません。 | [表 : 2. クエリパラメーター] {#tmf_prod_order-GET-ord-productOrder__table_pfr_vgy_fsb} {#tmf_prod_order-GET-ord-productOrder__table_xcm_cvr_nsb__entry__2} | 名前 | 説明 | |-|-| | なし | | [表 : 3. 要求本文パラメーター (JSON)] {#tmf_prod_order-GET-ord-productOrder__table_xcm_cvr_nsb} ### ヘッダー 次の要求ヘッダーと応答ヘッダーは、この HTTP アクションにのみ適用されるか、別の方法でこのアクションに適用されます。REST API で使用される一般的なヘッダーのリストについては、「 [サポートされている REST API ヘッダー」](https://servicenow-prod.fluidtopics.net/lLW_uT5I5_l1aD8yR4Jt9A "REST (REpresentational State Transfer) は、Web 上のコンピューター システム間の標準を提供するシンプルなステートレス アーキテクチャであり、コンピューター システム間の通信を容易にします。")を参照してください。 {#tmf_prod_order-GET-ord-productOrder__table_kqy_wgy_fsb__entry__2} | ヘッダー | 説明 | |-|-| | なし | | [表 : 4. 要求ヘッダー] {#tmf_prod_order-GET-ord-productOrder__table_kqy_wgy_fsb} {#tmf_prod_order-GET-ord-productOrder__table_h4r_fxr_nsb__entry__2}{#tmf_prod_order-GET-ord-productOrder__content-range-row}{#tmf_prod_order-GET-ord-productOrder__content-type-row}{#tmf_prod_order-GET-ord-productOrder__links-pagination-row}{#tmf_prod_order-GET-ord-productOrder__x-total-count-descr} | ヘッダー | 説明 | |-|-| | Content-Range | ページネーションされた呼び出しで返されるコンテンツの範囲。 たとえば、 `offset=2` で `limit=3` の場合、 Content-Range ヘッダーの値は `アイテム 3 から 5` です。 | | Content-Type | 応答本文のデータフォーマット。application/json のみをサポートします。 | | 「リンク」 | クエリ結果間を移動するための次のリンクが含まれています。 * 第 1 * 最終 * 次へ * 前へ {#tmf_prod_order-GET-ord-productOrder__ul_zzk_sdm_lsb} | | X-合計-数 | ページネーションされたクエリの場合、このヘッダーはサーバーで使用可能なレコードの合計数を指定します。 | [表 : 5. 応答ヘッダー] {#tmf_prod_order-GET-ord-productOrder__table_h4r_fxr_nsb} ### ステータスコード この HTTP アクションには、次のステータスコードが適用されます。REST API で使用される可能性のあるステータスコードのリストについては、「 [REST API HTTP 応答コード](https://servicenow-prod.fluidtopics.net/lLW_uT5I5_l1aD8yR4Jt9A "REST (REpresentational State Transfer) は、Web 上のコンピューター システム間の標準を提供するシンプルなステートレス アーキテクチャであり、コンピューター システム間の通信を容易にします。")」を参照してください。 {#tmf_prod_order-GET-ord-productOrder__table_wdl_3xr_nsb__entry__2}{#tmf_prod_order-GET-ord-productOrder__tmf-get-status-200-p}{#tmf_prod_order-GET-ord-productOrder__tmf-get-status-206-entry}{#tmf_prod_order-GET-ord-productOrder__tmf-get-status-400-entry}{#tmf_prod_order-GET-ord-productOrder__tmf-get-status-404-entry} | ステータスコード | 説明 | |-|-| | 200 | 要求が正常に処理されました。応答で返された完全なリソース (ページネーションなし)。 | | 206 | 応答で返された部分的なリソース (ページネーションあり)。 | | 400 | 要求が正しくありません。考えられる理由: * 無効なパスパラメーター * 無効な URI {#tmf_prod_order-GET-ord-productOrder__ul_rys_1gy_fsb} | | 404 | レコードが見つかりません。クエリパラメーターに一致するレコードがテーブルに見つかりません。 | [表 : 6. ステータスコード] {#tmf_prod_order-GET-ord-productOrder__table_wdl_3xr_nsb} ### 応答本文のパラメーター (JSON) {#tmf_prod_order-GET-ord-productOrder__section_hnf_kxr_nsb} {#tmf_prod_order-GET-ord-productOrder__table_inf_kxr_nsb__entry__2}{#tmf_prod_order-GET-ord-productOrder__externalProdInv-resp-descr}{#tmf_prod_order-GET-ord-productOrder__externalProdInvId-resp-descr} | 名前 | 説明 | |-|-| | チャネル | 製品の販売に使用するチャネルのリスト。 データタイプ：オブジェクトのアレイ "channel": [ { "id": "String", "name": "String" } ] | | channel.id | 関連製品の販売に使用するチャネルの一意の識別子。 データタイプ：文字列 | | channel.name | 関連製品の販売に使用するチャネルの名前。 データタイプ：文字列 | | committedDueDate | 注文に対してアクションを実行する必要がある日時。 この値は、各注文品目の committedDueDate 値と同じかそれ以降にする必要があります。 データタイプ：文字列 | | 完了予定日 | 注文が完了する日付。 データタイプ：文字列 | | href | 製品注文レコードへの相対リンク。 データタイプ：文字列 | | ID | 製品注文の sys_id。 データタイプ：文字列 | | 注意 | 注文時に顧客が行った追加のメモのリスト。 データタイプ：オブジェクトのアレイ "note": [ { "author": "String", "date": "String", "text": "String" } ] | | note.author | 関連するメモの作成者のユーザー名。 データタイプ：文字列 | | note.date | メモが作成された日付。 データタイプ：文字列 | | note.text | 注文時に顧客が行った追加のメモ/コメント。 データタイプ：文字列 | | orderCurrency | 注文と注文明細品目の通貨コード。 データタイプ：文字列 | | PONR | 注文のリターンノーポイントに達したかどうかを示すフラグ。 可能な値： * true:注文は戻れないポイントに達しました。 * false:注文の戻り不能ポイントに達していません。 {#tmf_prod_order-GET-ord-productOrder__ul_tdq_rw1_hqb} データタイプ：ブーリアン | | 製品注文アイテム | 製品注文とそれに関連するアクションに関連付けられたアイテムを説明するリスト。 データタイプ：オブジェクトのアレイ "productOrderItem:" [ { "action": "String", "committedDueDate": "String", "externalProductInventory": [Array], "id": "String", "itemPrice": [Array], "product": {Object}, "productOffering": {Object}, "productOrderItemReleationship": [Array], "quantity": Number, "state": "String", "@type": "String" } ] | | productOrderItem.action | 製品に対して実行するアクション。可能なアクションは、sn_ind_tmt_orm_order_line_itemテーブルのアクション辞書エントリの \[選択リスト\] タブで定義されます。 データタイプ：文字列 | | productOrderItem.actionReason | 注文明細品目を追加する理由。 データタイプ：文字列 格納場所:sn_ind_tmt_orm_order_line_itemテーブルのaction_reasonフィールド。 | | productOrderItem.committedDueDate | 注文品目に対してアクションを実行する必要がある日時。 データタイプ：文字列 | | productOrderItem.externalProductInventory | 注文に対して作成された製品インベントリにマッピングされた外部 ID のリスト。 データタイプ：オブジェクトのアレイ "externalProductInventory": [ { "externalProductInventoryId": "String" } ] | | productOrderItem.externalProductInventory.externalProductInventoryId | 製品インベントリにマッピングされた外部 ID。 データタイプ：文字列 | | productOrderItem.id | 品目の一意の識別子。注文明細品目 \[sn_ind_tmt_orm_order_line_item\] テーブルの sn_ind_tmt_orm_external_id フィールドにあります。 データタイプ：文字列 | | productOrderItem.itemPrice | 製品に関連付けられた価格を説明するリスト。 データタイプ：オブジェクトのアレイ "itemPrice": [ { "price": {Object}, "priceType": "String", "recurringChargePeriod": "String" } ] | | productOrderItem.itemPrice.price | 関連製品の価格の説明。 データタイプ: オブジェクト "price": { "taxIncludedAmount": {Object} } | | productOrderItem.itemPrice.price.taxIncludedAmount | 税を含む関連製品の価格の説明。 データタイプ: オブジェクト "taxIncludedAmount": { "unit": "String", "value": Number } | | productOrderItem.itemPrice.price.taxIncludedAmount.unit | 価格を表す通貨コード。 データタイプ：文字列 | | productOrderItem.itemPrice.price.taxIncludedAmount.value | 製品の価格 (税込み)。 データタイプ：数値 | | productOrderItem.itemPrice.priceType | アイテム価格のタイプ (繰り返しまたは非繰り返し)。 データタイプ：文字列 | | productOrderItem.itemPrice.recurringChargePeriod | 価格が繰り返し発生する場合は、 月などの繰り返し期間。 データタイプ：文字列 | | productOrderItem.ponr | 注文のリターンノーポイントに達したかどうかを示すフラグ。 可能な値： * true:注文は戻れないポイントに達しました。 * false:注文の戻り不能ポイントに達していません。 {#tmf_prod_order-GET-ord-productOrder__d3728e2780} データタイプ：ブーリアン | | productOrderItem.product | 顧客が購入した製品のインスタンス詳細の説明。 データタイプ: オブジェクト "product:" { "place": {Object}, "productCharacteristic": [Array], "productRelationship": [Array], "productSpecification": {Object}, "relatedParty": {Object}, "@type": "String" } | | productOrderItem.product.place | 製品を設置する場所のマップ。 データタイプ: オブジェクト "place": { "id": "String", "@type": "String" } | | productOrderItem.product.place.id | 場所 \[cmn_location\] テーブル内の関連する場所レコードのSys_id。製品注文アイテムに対して ( productOrderItem.action パラメーターを使用して) 変更アクションを使用する場合、要求を新しい場所sys_id更新すると、注文は変更されず、新しい場所で履行される移動オーダーが作成されます。 データタイプ：文字列 | | productOrderItem.product.place.@type | TMF Open API 標準の一部です。注文明細品目の連絡先の注釈。この値は常に Place です。この情報は保存されません。 データタイプ：文字列 | | productOrderItem.product.productCharacteristic | 関連製品の特性のリスト。 valueがpreviousValueと異なる製品特性のみが返されます。 データタイプ：オブジェクトのアレイ "productCharacteristic": [ { "name": "String", "previousValue": "String", "value": "String", "valueType": "String" } ] | | productOrderItem.product.productCharacteristic.name | 製品に関連付ける特性レコードの名前。特性 \[sn_prd_pm_characteristic\] テーブルにあります。 データタイプ：文字列 | | productOrderItem.product.productCharacteristic.previousValue | 更新が変更指示用である場合の以前の特性オプションの値。productOrderItem.actionパラメーターが add 以外の場合、要求は変更指示です。特性オプション値の詳細については、「 [Create product characteristics and characteristic options](https://www.servicenow.com/docs/access?context=som-product-config-add-characteristics&version=australia&pubname=australia-order-management&ft:locale=en-US)」を参照してください。 データタイプ：文字列 | | productOrderItem.product.productCharacteristic.value | 製品に関連付けられた特性オプション値。特性オプション値の詳細については、「 [Create product characteristics and characteristic options](https://www.servicenow.com/docs/access?context=som-product-config-add-characteristics&version=australia&pubname=australia-order-management&ft:locale=en-US)」を参照してください。 データタイプ：文字列 | | productOrderItem.product.productCharacteristic.valueType | 特性値のタイプ。 可能な値： * Array.Date * Array.Datetime * Array.Decimal * Array.Integer * Array.Object * Array.Single Line Test * チェックボックス * 選択肢 * 日付、住所 * メール * 整数、日付/時刻 * オブジェクト * 1 行テキスト * はい/いいえ {#tmf_prod_order-GET-ord-productOrder__ul_kxx_njw_xfc} データタイプ：文字列 | | productOrderItem.product.productRelationship | 注文品目の製品リレーションシップの詳細のリスト。 データタイプ：オブジェクトのアレイ "productRelationship": [ { "id": "String", "relationshipType": "String" } ] | | productOrderItem.product.productRelationship.id | 製品インベントリのSys_idまたはsn_prd_invt_external_id。 データタイプ：文字列 テーブル:製品インベントリ \[sn_prd_invt_product_inventory\] テーブルのsys_idまたはsn_prd_invt_external_idフィールド内。 | | productOrderItem.product.productRelationship.relationshipType | 注文品目と製品インベントリの間の関係のタイプ。 可能な値:必要 データタイプ：文字列 | | productOrderItem.product.productSpecification | 製品に関連付けられた製品仕様の説明。 データタイプ: オブジェクト "productSpecification:" { "id": "String", "internalId": "String", "internalVersion": "String", "name": "String", "version": "String", "@type": "String" } | | productOrderItem.product.productSpecification.id | 製品仕様のInitial_versionまたはexternal_id。initial_versionは仕様の最初のバージョンのsys_idです。製品仕様 \[sn_prd_pm_product_specification\] テーブルの \[sys_id\] または \[external_id\] フィールドにあります。 データタイプ：文字列 | | productOrderItem.product.productSpecification.internalId | 製品仕様の初期バージョン。初期バージョンは、仕様の最初のバージョンのsys_idです。 データタイプ：文字列 表:製品仕様 \[sn_prd_pm_product_specification\] | | productOrderItem.product.productSpecification.internalVersion | 製品仕様のバージョン。 データタイプ：文字列 テーブル:製品仕様 \[sn_prd_pm_product_specification\] テーブルのバージョンフィールド。 | | productOrderItem.product.productSpecification.name | 製品仕様の名前。製品仕様 \[sn_prd_pm_product_specification\] テーブルにあります。 データタイプ：文字列 | | productOrderItem.product.productSpecification.version | 製品仕様の外部バージョン。 データタイプ：文字列 テーブル:製品仕様 \[sn_prd_pm_product_specification\] テーブルの external_version フィールド。 | | productOrderItem.product.productSpecification.@type | TMF Open API 標準の一部です。この値は常に ProductSpecificationRef です。この情報は保存されません。 データタイプ：文字列 | | productOrderItem.product.relatedParty | 品目の連絡先のリスト。 データタイプ：オブジェクトのアレイ "relatedParty:" [ { "email": "String", "firstName": "String", "id": "String", "lastName": "String", "phone": "String", "@referredType": "String", "@type": "String" } ] | | productOrderItem.product.relatedParty.email | 連絡先のメールアドレス。 データタイプ：文字列 | | productOrderItem.product.relatedParty.firstName | 連絡先の名。 データタイプ：文字列 | | productOrderItem.product.relatedParty.id | 注文品目に関連付けられた品目連絡先のSys_id。注文明細品目連絡先 \[sn_ind_tmt_orm_order_line_item_contact\] テーブルにあります。 データタイプ：文字列 | | productOrderItem.product.relatedParty.lastName | 連絡先の名前 (姓)。 データタイプ：文字列 データタイプ：文字列 | | productOrderItem.product.relatedParty.phone | 連絡先の勤務先電話番号。 データタイプ：文字列 | | productOrderItem.product.relatedParty.@referredType | 顧客のタイプ。 可能な値:OrderLineItemContact データタイプ：文字列 | | productOrderItem.product.relatedParty.@type | TMF Open API 標準の一部です。注文明細品目の連絡先の注釈。この値は常に RelatedParty です。この情報は保存されません。 データタイプ：文字列 | | productOrderItem.productOffering | 製品に関連付けられた製品オファリングの説明。 データタイプ: オブジェクト "productOffering:" { "id": "String", "internalId": "String", "internalVersion": "String", "name": "String", "version": "String" } | | productOrderItem.productOffering.id | 製品オファリングのInitial_versionまたはexternal_id。initial_versionは、オファリングの最初のバージョンのsys_idです。製品オファリング \[sn_prd_pm_product_offering\] テーブルの sys_id または external_id フィールドにあります。 データタイプ：文字列 | | productOrderItem.productOffering.internalId | 製品オファリングの初期バージョン。初期バージョンは、オファリングの最初のバージョンのsys_idです。 データタイプ：文字列 テーブル:製品オファリング \[sn_prd_pm_product_offering\] | | productOrderItem.productOffering.internalVersion | 製品オファリングのバージョン。 データタイプ：文字列 テーブル:製品オファリング \[sn_prd_pm_product_offering\] テーブル、フィールドバージョン。 | | productOrderItem.productOffering.name | 製品オファリングの名前。製品オファリング \[sn_prd_pm_product_offering\] テーブルにあります。 データタイプ：文字列 | | productOrderItem.productOffering.version | 製品オファリングの外部バージョン。 データタイプ：文字列 テーブル:製品オファリング \[sn_prd_pm_product_offering\] テーブルの \[external_version\] フィールド。 | | productOrderItem.quantity | 購入した製品アイテムの数。 データタイプ：数値 | | productOrderItem.productOrderItemRelationship | 注文品目間の関係のリスト。 データタイプ：オブジェクトのアレイ "productOrderItemRelationship": [ { "id": "String", "relationshipType": "String" } ] | | productOrderItem.productOrderItemRelationship.id | 関連品目の一意の識別子。注文明細品目 \[sn_ind_tmt_orm_order_line_item\] テーブルの sn_ind_tmt_orm_external_id フィールドにあります。 データタイプ：文字列 | | productOrderItem.productOrderItemRelationship.relationshipType | 2 つの品目間の関係のタイプ。この情報は、関係階層を識別するために使用されます。 可能な値： * HasChild * 親がある * 必要 {#tmf_prod_order-GET-ord-productOrder__ul_yqf_2ty_54b} `HasChild` と `HasParent` は、親子関係に使用されます。\[`必須]` は水平関係に使用されます (品目には別の品目が必要です)。 データタイプ：文字列 | | productOrderItem.state | 関連製品アイテムの注文状況。 データタイプ：文字列 | | productOrderItem.version | 注文バージョン。 データタイプ：文字列 | | productOrderItem.@type | TMF Open API 標準の一部です。製品の注釈。この値は常に ProductOrderItem です。この情報は保存されません。 データタイプ：文字列 | | 関連パーティー | 注文の連絡先のリスト。各連絡先はアレイ内のオブジェクトです。顧客アカウントまたはコンシューマーアカウント情報を含むアイテムを少なくとも 1 つリストする必要があります。 データタイプ：オブジェクトのアレイ "relatedParty:" [ { "id": "String", "name": "String", "@referredType": "String", "@type": "String" } ] | | relatedParty.id | 注文に関連付けられたアカウント、顧客連絡先、またはコンシューマーのSys_idまたはexternal_id。アカウント \[customer_account\]、連絡先 \[customer_contact\] テーブル、またはコンシューマー \[csm_consumer\] テーブルにあります。 データタイプ：文字列 | | relatedParty.name | アカウント、顧客、またはコンシューマーの名前。 データタイプ：文字列 | | relatedParty.@referredType | 顧客のタイプ。 可能な値： * コンシューマー * 顧客 * 顧客連絡先 {#tmf_prod_order-GET-ord-productOrder__ul_lcq_jwm_t4b} データタイプ：文字列 | | relatedParty.@type | TMF Open API 標準の一部です。製品の注釈。この値は常に RelatedParty です。この情報は保存されません。 データタイプ：文字列 | | requestedCompletionDate | 顧客が要求した配送日。 データタイプ：文字列 | | requestedStartDate | 顧客が要求した注文開始日。 データタイプ：文字列 | | 状況 | 注文の現在のステータス。 データタイプ：文字列 | | version | 注文バージョン。 データタイプ：文字列 | | @type | TMF Open API 標準の一部です。製品の注釈。この値は常に ProductOrder です。この情報は保存されません。 データタイプ：文字列 | [ ] {#tmf_prod_order-GET-ord-productOrder__table_inf_kxr_nsb} ### cURL 要求 この例では、すべての製品注文を取得します。 curl --location --request GET 'https://instance.service-now.com/api/sn_ind_tmt_orm/order/productOrder' \ --user 'username':'password' 応答本文。 [ { "id": "8d75939453126010a795ddeeff7b126a", "href": "/api/sn_ind_tmt_orm/order/productOrder/8d75939453126010a795ddeeff7b126a", "ponr": "false", "orderCurrency": "USD", "expectedCompletionDate": "2021-05-02T08:13:59.000Z", "requestedCompletionDate": "2021-05-02T08:13:59.000Z", "requestedStartDate": "2020-05-03T08:13:59.000Z", "channel": [ { "id": "1", "name": "Agent Assist" } ], "note": [ { "author": "System Administrator", "date": "2021-02-25T14:22:07.000Z", "text": "This is a TMF product order illustration no 2" }, { "author": "System Administrator", "date": "2021-02-25T14:22:06.000Z", "text": "This is a TMF product order illustration" } ], "productOrderItem": [ { "id": "POI130", "ponr": "false", "quantity": 1, "action": "add", "actionReason": "adding service package OLI", "itemPrice": [ { "priceType": "recurring", "price": { "taxIncludedAmount": { "unit": "USD", "value": 20 } } }, { "priceType": "nonRecurring", "price": { "taxIncludedAmount": { "unit": "INR", "value": 0 } } } ], "product": { "@type": "Product", "productCharacteristic": [ { "name": "Security Type", "valueType": "Choice", "value": "Base", "previousValue": "" } ], "productSpecification": { "id": "a6514bd3534560102f18ddeeff7b1247", "name": "SD-WAN Security", "version": "v1", "internalVersion": "1", "internalId": "a6514bd3534560102f18ddeeff7b1247", "@type": "ProductSpecificationRef" }, "relatedParty": [ { "id": "4175939453126010a795ddeeff7b127d", "name": "John Smith", "email": "abc2@example.com", "phone": "32456768", "@type": "RelatedParty", "@referredType": "OrderLineItemContact" }, { "id": "c175939453126010a795ddeeff7b127c", "name": "Joe Doe", "email": "abc@example.com", "phone": "1234567890", "@type": "RelatedParty", "@referredType": "OrderLineItemContact" } ] }, "productOffering": { "id": "69017a0f536520103b6bddeeff7b127d", "name": "Premium SD-WAN Offering", "version": "v1", "internalId": "69017a0f536520103b6bddeeff7b127d", "internalVersion": "1" }, "productOrderItemRelationship": [ { "id": "POI100", "relationshipType": "HasParent" } ], "state": "in_progress", "version": "1", "@type": "ProductOrderItem" }, { "id": "POI100", "ponr": "false", "quantity": 1, "action": "add", "itemPrice": [ { "priceType": "recurring", "price": { "taxIncludedAmount": { "unit": "INR", "value": 0 } } }, { "priceType": "nonRecurring", "price": { "taxIncludedAmount": { "unit": "INR", "value": 0 } } } ], "product": { "@type": "Product", "productSpecification": { "id": "cfe5ef6a53702010cd6dddeeff7b12f6", "name": "SD-WAN Service Package", "version": "v1", "internalVersion": "1", "internalId": "cfe5ef6a53702010cd6dddeeff7b12f6", "@type": "ProductSpecificationRef" } }, "productOffering": { "id": "69017a0f536520103b6bddeeff7b127d", "name": "Premium SD-WAN Offering", "version": "v1", "internalId": "69017a0f536520103b6bddeeff7b127d", "internalVersion": "1" }, "productOrderItemRelationship": [ { "id": "POI130", "relationshipType": "HasChild" }, { "id": "POI120", "relationshipType": "HasChild" }, { "id": "POI110", "relationshipType": "HasChild" } ], "state": "in_progress", "version": "1", "@type": "ProductOrderItem" }, { "id": "POI120", "ponr": "false", "quantity": 1, "action": "add", "itemPrice": [ { "priceType": "recurring", "price": { "taxIncludedAmount": { "unit": "USD", "value": 20 } } }, { "priceType": "nonRecurring", "price": { "taxIncludedAmount": { "unit": "INR", "value": 0 } } } ], "product": { "@type": "Product", "productCharacteristic": [ { "name": "CPE Type", "valueType": "Choice", "value": "Physical", "previousValue": "" }, { "name": "WAN Optimization", "valueType": "Choice", "value": "Advance", "previousValue": "" }, { "name": "Routing", "valueType": "Choice", "value": "Premium", "previousValue": "" }, { "name": "CPE Model", "valueType": "Choice", "value": "ASR", "previousValue": "" } ], "productSpecification": { "id": "39b627aa53702010cd6dddeeff7b1202", "name": "SD-WAN Edge Device", "version": "v1", "internalVersion": "1", "internalId": "39b627aa53702010cd6dddeeff7b1202", "@type": "ProductSpecificationRef" }, "productRelationship": [ { "id": "326d13f45b5620102dff5e92dc81c785", "relationshipType": "Requires" } ] }, "productOffering": { "id": "69017a0f536520103b6bddeeff7b127d", "name": "Premium SD-WAN Offering", "version": "v1", "internalVersion": "1", "internalId": "69017a0f536520103b6bddeeff7b127d" }, "productOrderItemRelationship": [ { "id": "POI100", "relationshipType": "HasParent" }, { "id": "POI110", "relationshipType": "Requires" } ], "state": "in_progress", "version": "1", "@type": "ProductOrderItem" }, { "id": "POI110", "ponr": "false", "quantity": 1, "action": "add", "itemPrice": [ { "priceType": "recurring", "price": { "taxIncludedAmount": { "unit": "INR", "value": 0 } } }, { "priceType": "nonRecurring", "price": { "taxIncludedAmount": { "unit": "USD", "value": 5 } } } ], "product": { "@type": "Product", "productCharacteristic": [ { "name": "Tenancy", "valueType": "Choice", "value": "Base (10 site)", "previousValue": "" } ], "productSpecification": { "id": "216663aa53702010cd6dddeeff7b12b5", "name": "SD-WAN Controller", "version": "v1", "internalVersion": "1", "internalId": "216663aa53702010cd6dddeeff7b12b5", "@type": "ProductSpecificationRef" }, "place": { "id": "25ab9c4d0a0a0bb300f7dabdc0ca7c1c", "@type": "Place" } }, "productOffering": { "id": "69017a0f536520103b6bddeeff7b127d", "name": "Premium SD-WAN Offering", "version": "v1", "internalId": "69017a0f536520103b6bddeeff7b127d", "internalVersion": "1" }, "productOrderItemRelationship": [ { "id": "POI100", "relationshipType": "HasParent" } ], "state": "in_progress", "version": "1", "@type": "ProductOrderItem" } ], "relatedParty": [ { "id": "eaf68911c35420105252716b7d40ddde", "name": "Sally Thomas", "@type": "RelatedParty", "@referredType": "CustomerContact" }, { "id": "ffc68911c35420105252716b7d40dd55", "name": "Funco Intl", "@type": "RelatedParty", "@referredType": "Customer" }, { "id": "59f16de1c3b67110ff00ed23a140dd9e", "name": "Funco External", "@type": "RelatedParty", "@referredType": "Consumer" } ], "state": "in_progress", "version": "1", "@type": "ProductOrder" } ] ## Product Order Open API - GET /sn_ind_tmt_orm/productorder {#ariaid-title3} すべての製品注文を取得します。 重要: Tokyoリリース以降、このエンドポイントは廃止されました。このエンドポイントの新しいバージョンは [Product Order Open API - GET /sn_ind_tmt_orm/order/productOrder](https://servicenow-prod.fluidtopics.net/JmfbW68d5V7q7_xA6oKRug#tmf_prod_order-GET-ord-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\] {#tmf_prod_order-GET-productorder__ul_lxc_kxm_t4b} ### URL 形式 {#tmf_prod_order-GET-productorder__section_mbm_2ct_t4b} デフォルト URL: /api/sn_ind_tmt_orm/productorder ### サポートされている要求パラメーター {#tmf_prod_order-GET-productorder__table_ofr_vgy_fsb__entry__2} | 名前 | 説明 | |-|-| | なし | | [表 : 7. パスパラメーター] {#tmf_prod_order-GET-productorder__table_ofr_vgy_fsb} {#tmf_prod_order-GET-productorder__table_pfr_vgy_fsb__entry__2} | 名前 | 説明 | |-|-| | フィールド | 応答で返すフィールドのリスト。無効なフィールドは無視されます。 データタイプ：文字列 デフォルト:すべてのフィールドが返されます。 | | limit | 返されるレコードの最大数。このレコード数を超える要求の場合は、 offset パラメーターを使用してレコード取得をページネーションします。 データタイプ：数値 デフォルト値：20 最大:100 | | オフセット | レコードの取得を開始する開始インデックス。この値を使用して、レコード取得をページネーションします。この機能を使用すると、レコードの数に関係なく、すべてのレコードを小さな管理可能なチャンクで取得できます。 データタイプ：数値 デフォルト：0 | | 状況 | 注文をステータスでフィルタリングします。このパラメーターの値と一致するステータスの注文のみが応答に返されます。 データタイプ：文字列 デフォルト:すべてのステータスが返されます。 | [表 : 8. クエリパラメーター] {#tmf_prod_order-GET-productorder__table_pfr_vgy_fsb} {#tmf_prod_order-GET-productorder__table_xcm_cvr_nsb__entry__2} | 名前 | 説明 | |-|-| | なし | | [表 : 9. 要求本文パラメーター (JSON)] {#tmf_prod_order-GET-productorder__table_xcm_cvr_nsb} ### ヘッダー 次の要求ヘッダーと応答ヘッダーは、この HTTP アクションにのみ適用されるか、別の方法でこのアクションに適用されます。REST API で使用される一般的なヘッダーのリストについては、「 [サポートされている REST API ヘッダー」](https://servicenow-prod.fluidtopics.net/lLW_uT5I5_l1aD8yR4Jt9A "REST (REpresentational State Transfer) は、Web 上のコンピューター システム間の標準を提供するシンプルなステートレス アーキテクチャであり、コンピューター システム間の通信を容易にします。")を参照してください。 {#tmf_prod_order-GET-productorder__table_kqy_wgy_fsb__entry__2} | ヘッダー | 説明 | |-|-| | なし | | [表 : 10. 要求ヘッダー] {#tmf_prod_order-GET-productorder__table_kqy_wgy_fsb} {#tmf_prod_order-GET-productorder__table_h4r_fxr_nsb__entry__2}{#tmf_prod_order-GET-productorder__content-range-row}{#tmf_prod_order-GET-productorder__content-type-row}{#tmf_prod_order-GET-productorder__links-pagination-row}{#tmf_prod_order-GET-productorder__x-total-count-descr} | ヘッダー | 説明 | |-|-| | Content-Range | ページネーションされた呼び出しで返されるコンテンツの範囲。 たとえば、 `offset=2` で `limit=3` の場合、 Content-Range ヘッダーの値は `アイテム 3 から 5` です。 | | Content-Type | 応答本文のデータフォーマット。application/json のみをサポートします。 | | 「リンク」 | クエリ結果間を移動するための次のリンクが含まれています。 * 第 1 * 最終 * 次へ * 前へ {#tmf_prod_order-GET-productorder__ul_zzk_sdm_lsb} | | X-合計-数 | ページネーションされたクエリの場合、このヘッダーはサーバーで使用可能なレコードの合計数を指定します。 | [表 : 11. 応答ヘッダー] {#tmf_prod_order-GET-productorder__table_h4r_fxr_nsb} ### ステータスコード この HTTP アクションには、次のステータスコードが適用されます。REST API で使用される可能性のあるステータスコードのリストについては、「 [REST API HTTP 応答コード](https://servicenow-prod.fluidtopics.net/lLW_uT5I5_l1aD8yR4Jt9A "REST (REpresentational State Transfer) は、Web 上のコンピューター システム間の標準を提供するシンプルなステートレス アーキテクチャであり、コンピューター システム間の通信を容易にします。")」を参照してください。 {#tmf_prod_order-GET-productorder__table_wdl_3xr_nsb__entry__2}{#tmf_prod_order-GET-productorder__tmf-get-status-200-p}{#tmf_prod_order-GET-productorder__tmf-get-status-206-entry}{#tmf_prod_order-GET-productorder__tmf-get-status-400-entry}{#tmf_prod_order-GET-productorder__tmf-get-status-404-entry} | ステータスコード | 説明 | |-|-| | 200 | 要求が正常に処理されました。応答で返された完全なリソース (ページネーションなし)。 | | 206 | 応答で返された部分的なリソース (ページネーションあり)。 | | 400 | 要求が正しくありません。考えられる理由: * 無効なパスパラメーター * 無効な URI {#tmf_prod_order-GET-productorder__ul_rys_1gy_fsb} | | 404 | レコードが見つかりません。クエリパラメーターに一致するレコードがテーブルに見つかりません。 | [表 : 12. ステータスコード] {#tmf_prod_order-GET-productorder__table_wdl_3xr_nsb} ### 応答本文のパラメーター (JSON) {#tmf_prod_order-GET-productorder__section_hnf_kxr_nsb} {#tmf_prod_order-GET-productorder__table_inf_kxr_nsb__entry__2} | 名前 | 説明 | |-|-| | チャネル | 製品の販売に使用するチャネルのリスト。 データタイプ：オブジェクトのアレイ "channel": [ { "id": "String", "name": "String" } ] | | channel.id | 関連製品の販売に使用するチャネルの一意の識別子。 データタイプ：文字列 | | channel.name | 関連製品の販売に使用するチャネルの名前。 データタイプ：文字列 | | 完了予定日 | 注文が完了する日付。 データタイプ：文字列 | | 注意 | 注文時に顧客が行った追加のメモのリスト。 データタイプ：オブジェクトのアレイ "note": { "author": "String", "date": "String", "text": "String" } | | note.author | 関連するメモの作成者のユーザー名。 データタイプ：文字列 | | note.date | メモが作成された日付。 データタイプ：文字列 | | note.text | 注文時に顧客が行った追加のメモ/コメント。 データタイプ：文字列 | | PONR | 注文のリターンノーポイントに達したかどうかを示すフラグ。 可能な値： * true:注文は戻れないポイントに達しました。 * false:注文の戻り不能ポイントに達していません。 {#tmf_prod_order-GET-productorder__ul_tdq_rw1_hqb} データタイプ：ブーリアン | | 製品注文アイテム | 製品注文とそれに関連するアクションに関連付けられたアイテムを説明するリスト。 データタイプ：オブジェクトのアレイ "productOrderItem:" [ { "action": "String", "actionReason": "String", "id": "String", "itemPrice": [Array], "product": {Object}, "productOffering": {Object}, "productOrderItemReleationship": [Array], "quantity": Number, "state": "String", "@type": "String" } ] | | productOrderItem.action | 製品に対して実行するアクション。可能なアクションは、sn_ind_tmt_orm_order_line_itemテーブルのアクション辞書エントリの \[選択リスト\] タブで定義されます。 データタイプ：文字列 | | productOrderItem.actionReason | 注文明細品目を追加する理由。 データタイプ：文字列 格納場所:sn_ind_tmt_orm_order_line_itemテーブルのaction_reasonフィールド。 | | productOrderItem.id | 品目の一意の識別子。注文明細品目 \[sn_ind_tmt_orm_order_line_item\] テーブルの sn_ind_tmt_orm_external_id フィールドにあります。 データタイプ：文字列 | | productOrderItem.itemPrice | 製品に関連付けられた価格を説明するリスト。 データタイプ：オブジェクトのアレイ "itemPrice": [ { "price": {Object}, "priceType": "String", "recurringChargePeriod": "String" } ] | | productOrderItem.itemPrice.price | 関連製品の価格の説明。 データタイプ: オブジェクト "price": { "taxIncludedAmount": {Object} } | | productOrderItem.itemPrice.price.taxIncludedAmount | 税を含む関連製品の価格の説明。 データタイプ: オブジェクト "taxIncludedAmount": { "unit": "String", "value": Number } | | productOrderItem.itemPrice.price.taxIncludedAmount.unit | 価格を表す通貨コード。 データタイプ：文字列 | | productOrderItem.itemPrice.price.taxIncludedAmount.value | 製品の価格 (税込み)。 データタイプ：数値 | | productOrderItem.itemPrice.priceType | アイテム価格のタイプ (繰り返しまたは非繰り返し)。 データタイプ：文字列 | | productOrderItem.itemPrice.recurringChargePeriod | 価格が繰り返し発生する場合は、 月などの繰り返し期間。 データタイプ：文字列 | | productOrderItem.ponr | 注文のリターンノーポイントに達したかどうかを示すフラグ。 可能な値： * true:注文は戻れないポイントに達しました。 * false:注文の戻り不能ポイントに達していません。 {#tmf_prod_order-GET-productorder__d3728e2780} データタイプ：ブーリアン | | productOrderItem.product | 顧客が購入した製品のインスタンス詳細の説明。 データタイプ: オブジェクト "product:" { "place": {Object}, "productCharacteristic": [Array], "productSpecification": {Object}, "relatedParty": {Object}, "@type": "String" } | | productOrderItem.product.place | 製品を設置する場所のマップ。 データタイプ: オブジェクト "place": { "id": "String", "@type": "String" } | | productOrderItem.product.place.id | 場所 \[cmn_location\] テーブル内の関連する場所レコードのSys_id。製品注文アイテムに対して ( productOrderItem.action パラメーターを使用して) 変更アクションを使用する場合、要求を新しい場所sys_id更新すると、注文は変更されず、新しい場所で履行される移動オーダーが作成されます。 データタイプ：文字列 | | productOrderItem.product.place.@type | TMF Open API 標準の一部です。注文明細品目の連絡先の注釈。この値は常に Place です。この情報は保存されません。 データタイプ：文字列 | | productOrderItem.product.productCharacteristic | 関連製品の特性のリスト。 valueがpreviousValueと異なる製品特性のみが返されます。 データタイプ：オブジェクトのアレイ "productCharacteristic": [ { "name": "String", "previousValue": "String", "value": "String", "valueType": "String" } ] | | productOrderItem.product.productCharacteristic.name | 製品に関連付ける特性レコードの名前。特性 \[sn_prd_pm_characteristic\] テーブルにあります。 データタイプ：文字列 | | productOrderItem.product.productCharacteristic.previousValue | 更新が変更指示用である場合の以前の特性オプションの値。productOrderItem.actionパラメーターが add 以外の場合、要求は変更指示です。特性オプション値の詳細については、「 [Create product characteristics and characteristic options](https://www.servicenow.com/docs/access?context=som-product-config-add-characteristics&version=australia&pubname=australia-order-management&ft:locale=en-US)」を参照してください。 データタイプ：文字列 | | productOrderItem.product.productCharacteristic.value | 製品に関連付けられた特性オプション値。特性オプション値の詳細については、「 [Create product characteristics and characteristic options](https://www.servicenow.com/docs/access?context=som-product-config-add-characteristics&version=australia&pubname=australia-order-management&ft:locale=en-US)」を参照してください。 データタイプ：文字列 | | productOrderItem.product.productCharacteristic.valueType | 特性値のタイプ。 可能な値： * Array.Date * Array.Datetime * Array.Decimal * Array.Integer * Array.Object * Array.Single Line Test * チェックボックス * 選択肢 * 日付、住所 * メール * 整数、日付/時刻 * オブジェクト * 1 行テキスト * はい/いいえ {#tmf_prod_order-GET-productorder__ul_kxx_njw_xfc} データタイプ：文字列 | | productOrderItem.product.productSpecification | 製品に関連付けられた製品仕様の説明。 データタイプ: オブジェクト "productSpecification:" { "id": "String", "name": "String", "@type": "String" } | | productOrderItem.product.productSpecification.id | 製品仕様のInitial_versionまたはexternal_id。initial_versionは仕様の最初のバージョンのsys_idです。製品仕様 \[sn_prd_pm_product_specification\] テーブルの \[sys_id\] または \[external_id\] フィールドにあります。 データタイプ：文字列 | | productOrderItem.product.productSpecification.name | 製品仕様の名前。製品仕様 \[sn_prd_pm_product_specification\] テーブルにあります。 データタイプ：文字列 | | productOrderItem.product.productSpecification.@type | TMF Open API 標準の一部です。この値は常に ProductSpecificationRef です。この情報は保存されません。 データタイプ：文字列 | | productOrderItem.product.relatedParty | 品目の連絡先のリスト。 データタイプ：オブジェクトのアレイ "relatedParty:" { "email": "String", "firstName": "String", "id": "String", "lastName": "String", "phone": "String", "@referredType": "String", "@type": "String" } | | productOrderItem.product.relatedParty.email | 連絡先のメールアドレス。 データタイプ：文字列 | | productOrderItem.product.relatedParty.firstName | 連絡先の名。 データタイプ：文字列 | | productOrderItem.product.relatedParty.id | 注文品目に関連付けられた品目連絡先のSys_id。注文明細品目連絡先 \[sn_ind_tmt_orm_order_line_item_contact\] テーブルにあります。 データタイプ：文字列 | | productOrderItem.product.relatedParty.lastName | 連絡先の名前 (姓)。 データタイプ：文字列 データタイプ：文字列 | | productOrderItem.product.relatedParty.phone | 連絡先の勤務先電話番号。 データタイプ：文字列 | | productOrderItem.product.relatedParty.@referredType | 顧客のタイプ。 可能な値:OrderLineItemContact データタイプ：文字列 | | productOrderItem.product.relatedParty.@type | TMF Open API 標準の一部です。注文明細品目の連絡先の注釈。この値は常に RelatedParty です。この情報は保存されません。 データタイプ：文字列 | | productOrderItem.productOffering | 製品に関連付けられた製品オファリングの説明。 データタイプ: オブジェクト "productOffering": { "id": "String", "internalVersion": "String", "name": "String", "version": "String" } | | productOrderItem.productOffering.id | 製品オファリングのInitial_versionまたはexternal_id。initial_versionは、オファリングの最初のバージョンのsys_idです。製品オファリング \[sn_prd_pm_product_offering\] テーブルの sys_id または external_id フィールドにあります。 データタイプ：文字列 | | productOrderItem.productOffering.name | 製品オファリングの名前。製品オファリング \[sn_prd_pm_product_offering\] テーブルにあります。 データタイプ：文字列 | | productOrderItem.quantity | 購入した製品アイテムの数。 データタイプ：数値 | | productOrderItem.productOrderItemRelationship | 注文品目間の関係のリスト。 データタイプ：オブジェクトのアレイ "productOrderItemRelationship": [ { "id": "String", "relationshipType": "String" } ] | | productOrderItem.productOrderItemRelationship.id | 関連品目の一意の識別子。注文明細品目 \[sn_ind_tmt_orm_order_line_item\] テーブルの sn_ind_tmt_orm_external_id フィールドにあります。 データタイプ：文字列 | | productOrderItem.productOrderItemRelationship.relationshipType | 2 つの品目間の関係のタイプ。この情報は、関係階層を識別するために使用されます。 可能な値： * HasChild * 親がある * 必要 {#tmf_prod_order-GET-productorder__ul_yqf_2ty_54b} `HasChild` と `HasParent` は、親子関係に使用されます。\[`必須]` は水平関係に使用されます (品目には別の品目が必要です)。 データタイプ：文字列 | | productOrderItem.state | 関連製品アイテムの注文状況。 データタイプ：文字列 | | productOrderItem.version | 注文バージョン。 データタイプ：文字列 | | productOrderItem.@type | TMF Open API 標準の一部です。製品の注釈。この値は常に ProductOrderItem です。この情報は保存されません。 データタイプ：文字列 | | 関連パーティー | 注文の連絡先のリスト。各連絡先はアレイ内のオブジェクトです。顧客アカウントまたはコンシューマーアカウント情報を含むアイテムを少なくとも 1 つリストする必要があります。 データタイプ：オブジェクトのアレイ "relatedParty:" [ { "id": "String", "name": "String", "@referredType": "String", "@type": "String" } ] | | relatedParty.id | 注文に関連付けられたアカウント、顧客連絡先、またはコンシューマーのSys_idまたはexternal_id。アカウント \[customer_account\]、連絡先 \[customer_contact\] テーブル、またはコンシューマー \[csm_consumer\] テーブルにあります。 データタイプ：文字列 | | relatedParty.name | アカウント、顧客、またはコンシューマーの名前。 データタイプ：文字列 | | relatedParty.@referredType | 顧客のタイプ。 可能な値： * コンシューマー * 顧客 * 顧客連絡先 {#tmf_prod_order-GET-productorder__ul_lcq_jwm_t4b} データタイプ：文字列 | | relatedParty.@type | TMF Open API 標準の一部です。製品の注釈。この値は常に RelatedParty です。この情報は保存されません。 データタイプ：文字列 | | requestedCompletionDate | 顧客が要求した配送日。 データタイプ：文字列 | | requestedStartDate | 顧客が要求した注文開始日。 データタイプ：文字列 | | 状況 | 注文の現在のステータス。 データタイプ：文字列 | | version | 注文バージョン。 データタイプ：文字列 | | @type | TMF Open API 標準の一部です。製品の注釈。この値は常に ProductOrder です。この情報は保存されません。 データタイプ：文字列 | [ ] {#tmf_prod_order-GET-productorder__table_inf_kxr_nsb} ### cURL 要求 この例では、すべての製品注文を取得します。 curl --location --request GET 'https://instance.servicenow.com/api/sn_ind_tmt_orm/productorder' \ --user 'username':'password' 応答本文。 [ { "id": "8d75939453126010a795ddeeff7b126a", "ponr": "false", "expectedCompletionDate": "2021-05-02T08:13:59.000Z", "requestedCompletionDate": "2021-05-02T08:13:59.000Z", "requestedStartDate": "2020-05-03T08:13:59.000Z", "channel": [ { "id": "1", "name": "Agent Assist" } ], "note": [ { "author": "System Administrator", "date": "2021-02-25T14:22:07.000Z", "text": "This is a TMF product order illustration no 2" }, { "author": "System Administrator", "date": "2021-02-25T14:22:06.000Z", "text": "This is a TMF product order illustration" } ], "productOrderItem": [ { "id": "POI130", "ponr": "false", "quantity": 1, "action": "add", "actionReason": "adding service package OLI", "itemPrice": [ { "priceType": "recurring", "price": { "taxIncludedAmount": { "unit": "USD", "value": 20 } } }, { "priceType": "nonRecurring", "price": { "taxIncludedAmount": { "unit": "INR", "value": 0 } } } ], "product": { "@type": "Product", "productCharacteristic": [ { "name": "Security Type", "valueType": "Choice", "value": "Base", "previousValue": "" } ], "productSpecification": { "id": "a6514bd3534560102f18ddeeff7b1247", "name": "SD-WAN Security", "@type": "ProductSpecificationRef" }, "relatedParty": [ { "id": "4175939453126010a795ddeeff7b127d", "name": "John Smith", "email": "abc2@example.com", "phone": "32456768", "@type": "RelatedParty", "@referredType": "OrderLineItemContact" }, { "id": "c175939453126010a795ddeeff7b127c", "name": "Joe Doe", "email": "abc@example.com", "phone": "1234567890", "@type": "RelatedParty", "@referredType": "OrderLineItemContact" } ] }, "productOffering": { "id": "69017a0f536520103b6bddeeff7b127d", "name": "Premium SD-WAN Offering" }, "productOrderItemRelationship": [ { "id": "POI100", "relationshipType": "HasParent" } ], "state": "in_progress", "version": "1", "@type": "ProductOrderItem" }, { "id": "POI100", "ponr": "false", "quantity": 1, "action": "add", "itemPrice": [ { "priceType": "recurring", "price": { "taxIncludedAmount": { "unit": "INR", "value": 0 } } }, { "priceType": "nonRecurring", "price": { "taxIncludedAmount": { "unit": "INR", "value": 0 } } } ], "product": { "@type": "Product", "productSpecification": { "id": "cfe5ef6a53702010cd6dddeeff7b12f6", "name": "SD-WAN Service Package", "@type": "ProductSpecificationRef" } }, "productOffering": { "id": "69017a0f536520103b6bddeeff7b127d", "name": "Premium SD-WAN Offering" }, "productOrderItemRelationship": [ { "id": "POI130", "relationshipType": "HasChild" }, { "id": "POI120", "relationshipType": "HasChild" }, { "id": "POI110", "relationshipType": "HasChild" } ], "state": "in_progress", "version": "1", "@type": "ProductOrderItem" }, { "id": "POI120", "ponr": "false", "quantity": 1, "action": "add", "actionReason":"adding service package OLI", "itemPrice": [ { "priceType": "recurring", "price": { "taxIncludedAmount": { "unit": "USD", "value": 20 } } }, { "priceType": "nonRecurring", "price": { "taxIncludedAmount": { "unit": "INR", "value": 0 } } } ], "product": { "@type": "Product", "productCharacteristic": [ { "name": "CPE Type", "valueType": "Choice", "value": "Physical", "previousValue": "" }, { "name": "WAN Optimization", "valueType": "Choice", "value": "Advance", "previousValue": "" }, { "name": "Routing", "valueType": "Choice", "value": "Premium", "previousValue": "" }, { "name": "CPE Model", "valueType": "Choice", "value": "ASR", "previousValue": "" } ], "productSpecification": { "id": "39b627aa53702010cd6dddeeff7b1202", "name": "SD-WAN Edge Device", "@type": "ProductSpecificationRef" } }, "productOffering": { "id": "69017a0f536520103b6bddeeff7b127d", "name": "Premium SD-WAN Offering" }, "productOrderItemRelationship": [ { "id": "POI100", "relationshipType": "HasParent" } ], "state": "in_progress", "version": "1", "@type": "ProductOrderItem" }, { "id": "POI110", "ponr": "false", "quantity": 1, "action": "add", "actionReason": "adding service package OLI", "itemPrice": [ { "priceType": "recurring", "price": { "taxIncludedAmount": { "unit": "INR", "value": 0 } } }, { "priceType": "nonRecurring", "price": { "taxIncludedAmount": { "unit": "USD", "value": 5 } } } ], "product": { "@type": "Product", "productCharacteristic": [ { "name": "Tenancy", "valueType": "Choice", "value": "Base (10 site)", "previousValue": "" } ], "productSpecification": { "id": "216663aa53702010cd6dddeeff7b12b5", "name": "SD-WAN Controller", "@type": "ProductSpecificationRef" }, "place": { "id": "25ab9c4d0a0a0bb300f7dabdc0ca7c1c", "@type": "Place" } }, "productOffering": { "id": "69017a0f536520103b6bddeeff7b127d", "name": "Premium SD-WAN Offering" }, "productOrderItemRelationship": [ { "id": "POI100", "relationshipType": "HasParent" } ], "state": "in_progress", "version": "1", "@type": "ProductOrderItem" } ], "relatedParty": [ { "id": "eaf68911c35420105252716b7d40ddde", "name": "Sally Thomas", "@type": "RelatedParty", "@referredType": "CustomerContact" }, { "id": "ffc68911c35420105252716b7d40dd55", "name": "Funco Intl", "@type": "RelatedParty", "@referredType": "Customer" }, { "id": "59f16de1c3b67110ff00ed23a140dd9e", "name": "Funco External", "@type": "RelatedParty", "@referredType": "Consumer" } ], "state": "in_progress", "version": "1", "@type": "ProductOrder" } ] ## Product Order Open API - GET /sn_ind_tmt_orm/productorder/{id} {#ariaid-title4} 指定された製品注文を取得します。 重要: Tokyoリリース以降、このエンドポイントは廃止されました。このエンドポイントの新しいバージョンは [Product Order Open API - GET /sn_ind_tmt_orm/productorder/{id}](https://servicenow-prod.fluidtopics.net/JmfbW68d5V7q7_xA6oKRug#tmf_prod_order-GET-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\] {#tmf_prod_order-GET-productOrder-id__ul_lxc_kxm_t4b} ### URL 形式 {#tmf_prod_order-GET-productOrder-id__section_mbm_2ct_t4b} デフォルト URL: /api/sn_ind_tmt_orm/productorder/{id} ### サポートされている要求パラメーター {#tmf_prod_order-GET-productOrder-id__entry__2} | 名前 | 説明 | |-|-| | ID | 取得する顧客注文のSys_idまたはexternal_id。 データタイプ：文字列 テーブル:顧客注文 \[sn_ind_tmt_orm_order\] | [表 : 13. パスパラメーター] {#tmf_prod_order-GET-productOrder-id__entry__6} | 名前 | 説明 | |-|-| | なし | | [表 : 14. クエリパラメーター] {#tmf_prod_order-GET-productOrder-id__entry__10} | 名前 | 説明 | |-|-| | なし | | [表 : 15. 要求本文パラメーター (JSON)] ### ヘッダー 次の要求ヘッダーと応答ヘッダーは、この HTTP アクションにのみ適用されるか、別の方法でこのアクションに適用されます。REST API で使用される一般的なヘッダーのリストについては、「 [サポートされている REST API ヘッダー」](https://servicenow-prod.fluidtopics.net/lLW_uT5I5_l1aD8yR4Jt9A "REST (REpresentational State Transfer) は、Web 上のコンピューター システム間の標準を提供するシンプルなステートレス アーキテクチャであり、コンピューター システム間の通信を容易にします。")を参照してください。 {#tmf_prod_order-GET-productOrder-id__table_kqy_wgy_fsb__entry__2} | ヘッダー | 説明 | |-|-| | なし | | [表 : 16. 要求ヘッダー] {#tmf_prod_order-GET-productOrder-id__table_kqy_wgy_fsb} {#tmf_prod_order-GET-productOrder-id__table_tzy_thy_ksb__entry__2} | ヘッダー | 説明 | |-|-| | Content-Type | 応答本文のデータフォーマット。application/json のみをサポートします。 | [表 : 17. 応答ヘッダー] {#tmf_prod_order-GET-productOrder-id__table_tzy_thy_ksb} ### ステータスコード この HTTP アクションには、次のステータスコードが適用されます。REST API で使用される可能性のあるステータスコードのリストについては、「 [REST API HTTP 応答コード](https://servicenow-prod.fluidtopics.net/lLW_uT5I5_l1aD8yR4Jt9A "REST (REpresentational State Transfer) は、Web 上のコンピューター システム間の標準を提供するシンプルなステートレス アーキテクチャであり、コンピューター システム間の通信を容易にします。")」を参照してください。 {#tmf_prod_order-GET-productOrder-id__entry__22}{#tmf_prod_order-GET-productOrder-id__entry-404-status-code} | ステータスコード | 説明 | |-|-| | 201 | 成功。要求が正常に処理されました。 | | 400 | 要求が正しくありません。次のいずれかの理由が考えられます。 * クエリパラメーターがありません * 無効な URI | | 404 | 見つかりません。要求されたアイテムが見つかりませんでした。 | [表 : 18. ステータスコード] ### 応答本文のパラメーター (JSON) {#tmf_prod_order-GET-productOrder-id__entry__30} | 名前 | 説明 | |-|-| | チャネル | 製品の販売に使用するチャネルのリスト。 データタイプ：オブジェクトのアレイ "channel": [ { "id": "String", "name": "String" } ] | | channel.id | 関連製品の販売に使用するチャネルの一意の識別子。 データタイプ：文字列 | | channel.name | 関連製品の販売に使用するチャネルの名前。 データタイプ：文字列 | | 完了予定日 | 注文が完了する日付。 データタイプ：文字列 | | 注意 | 注文時に顧客が行った追加のメモのリスト。 データタイプ: オブジェクト "note": { "author": "String", "date": "String", "text": "String" } | | note.author | 関連するメモの作成者のユーザー名。 データタイプ：文字列 | | note.date | メモが作成された日付。 データタイプ：文字列 | | note.text | 注文時に顧客が行った追加のメモ/コメント。 データタイプ：文字列 | | PONR | 注文のリターンノーポイントに達したかどうかを示すフラグ。 可能な値： * true:注文は戻れないポイントに達しました。 * false:注文の戻り不能ポイントに達していません。 {#tmf_prod_order-GET-productOrder-id__ul_tdq_rw1_hqb} データタイプ：ブーリアン | | 製品注文アイテム | 製品注文とそれに関連するアクションに関連付けられたアイテムを説明するリスト。 データタイプ：オブジェクトのアレイ "productOrderItem:" [ { "action": "String", "actionReason": "String", "id": "String", "itemPrice": [Array], "product": {Object}, "productOffering": {Object}, "productOrderItemReleationship": [Array], "quantity": Number, "state": "String", "@type": "String" } ] | | productOrderItem.action | 製品に対して実行するアクション。可能なアクションは、sn_ind_tmt_orm_order_line_itemテーブルのアクション辞書エントリの \[選択リスト\] タブで定義されます。 データタイプ：文字列 | | productOrderItem.actionReason | 注文明細品目を追加する理由。 データタイプ：文字列 格納場所:sn_ind_tmt_orm_order_line_itemテーブルのaction_reasonフィールド。 | | productOrderItem.id | 品目の一意の識別子。注文明細品目 \[sn_ind_tmt_orm_order_line_item\] テーブルの sn_ind_tmt_orm_external_id フィールドにあります。 データタイプ：文字列 | | productOrderItem.itemPrice | 製品に関連付けられた価格を説明するリスト。 データタイプ：オブジェクトのアレイ "itemPrice": [ { "price": {Object}, "priceType": "String", "recurringChargePeriod": "String" } ] | | productOrderItem.itemPrice.price | 関連製品の価格の説明。 データタイプ: オブジェクト "price": { "taxIncludedAmount": {Object} } | | productOrderItem.itemPrice.price.taxIncludedAmount | 税を含む関連製品の価格の説明。 データタイプ: オブジェクト "taxIncludedAmount": { "unit": "String", "value": Number } | | productOrderItem.itemPrice.price.taxIncludedAmount.unit | 価格を表す通貨コード。 データタイプ：文字列 | | productOrderItem.itemPrice.price.taxIncludedAmount.value | 製品の価格 (税込み)。 データタイプ：数値 | | productOrderItem.itemPrice.priceType | アイテム価格のタイプ (繰り返しまたは非繰り返し)。 データタイプ：文字列 | | productOrderItem.itemPrice.recurringChargePeriod | 価格が繰り返し発生する場合は、 月などの繰り返し期間。 データタイプ：文字列 | | productOrderItem.ponr | 注文のリターンノーポイントに達したかどうかを示すフラグ。 可能な値： * true:注文は戻れないポイントに達しました。 * false:注文の戻り不能ポイントに達していません。 {#tmf_prod_order-GET-productOrder-id__d3728e2780} データタイプ：ブーリアン | | productOrderItem.product | 顧客が購入した製品のインスタンス詳細の説明。 データタイプ: オブジェクト "product:" { "place": {Object}, "productCharacteristic": [Array], "productSpecification": {Object}, "relatedParty": {Object}, "@type": "String" } | | productOrderItem.product.place | 製品を設置する場所のマップ。 データタイプ: オブジェクト "place": { "id": "String", "@type": "String" } | | productOrderItem.product.place.id | 場所 \[cmn_location\] テーブル内の関連する場所レコードのSys_id。製品注文アイテムに対して ( productOrderItem.action パラメーターを使用して) 変更アクションを使用する場合、要求を新しい場所sys_id更新すると、注文は変更されず、新しい場所で履行される移動オーダーが作成されます。 データタイプ：文字列 | | productOrderItem.product.place.@type | TMF Open API 標準の一部です。注文明細品目の連絡先の注釈。この値は常に Place です。この情報は保存されません。 データタイプ：文字列 | | productOrderItem.product.productCharacteristic | 関連製品の特性のリスト。 valueがpreviousValueと異なる製品特性のみが返されます。 データタイプ：オブジェクトのアレイ "productCharacteristic": [ { "name": "String", "previousValue": "String", "value": "String", "valueType": "String" } ] | | productOrderItem.product.productCharacteristic.name | 製品に関連付ける特性レコードの名前。特性 \[sn_prd_pm_characteristic\] テーブルにあります。 データタイプ：文字列 | | productOrderItem.product.productCharacteristic.previousValue | 更新が変更指示用である場合の以前の特性オプションの値。productOrderItem.actionパラメーターが add 以外の場合、要求は変更指示です。特性オプション値の詳細については、「 [Create product characteristics and characteristic options](https://www.servicenow.com/docs/access?context=som-product-config-add-characteristics&version=australia&pubname=australia-order-management&ft:locale=en-US)」を参照してください。 データタイプ：文字列 | | productOrderItem.product.productCharacteristic.value | 製品に関連付けられた特性オプション値。特性オプション値の詳細については、「 [Create product characteristics and characteristic options](https://www.servicenow.com/docs/access?context=som-product-config-add-characteristics&version=australia&pubname=australia-order-management&ft:locale=en-US)」を参照してください。 データタイプ：文字列 | | productOrderItem.product.productCharacteristic.valueType | 特性値のタイプ。 可能な値： * Array.Date * Array.Datetime * Array.Decimal * Array.Integer * Array.Object * Array.Single Line Test * チェックボックス * 選択肢 * 日付、住所 * メール * 整数、日付/時刻 * オブジェクト * 1 行テキスト * はい/いいえ {#tmf_prod_order-GET-productOrder-id__ul_kxx_njw_xfc} データタイプ：文字列 | | productOrderItem.product.productSpecification | 製品に関連付けられた製品仕様の説明。 データタイプ: オブジェクト "productSpecification:" { "id": "String", "name": "String", "@type": "String" } | | productOrderItem.product.productSpecification.id | 製品仕様のInitial_versionまたはexternal_id。initial_versionは仕様の最初のバージョンのsys_idです。製品仕様 \[sn_prd_pm_product_specification\] テーブルの \[sys_id\] または \[external_id\] フィールドにあります。 データタイプ：文字列 | | productOrderItem.product.productSpecification.name | 製品仕様の名前。製品仕様 \[sn_prd_pm_product_specification\] テーブルにあります。 データタイプ：文字列 | | productOrderItem.product.productSpecification.@type | TMF Open API 標準の一部です。この値は常に ProductSpecificationRef です。この情報は保存されません。 データタイプ：文字列 | | productOrderItem.product.relatedParty | 品目の連絡先のリスト。 データタイプ: オブジェクト "relatedParty:" { "email": "String", "firstName": "String", "id": "String", "lastName": "String", "phone": "String", "@referredType": "String", "@type": "String" } | | productOrderItem.product.relatedParty.email | 連絡先のメールアドレス。 データタイプ：文字列 | | productOrderItem.product.relatedParty.firstName | 連絡先の名。 データタイプ：文字列 | | productOrderItem.product.relatedParty.id | 注文品目に関連付けられた品目連絡先のSys_id。注文明細品目連絡先 \[sn_ind_tmt_orm_order_line_item_contact\] テーブルにあります。 データタイプ：文字列 | | productOrderItem.product.relatedParty.lastName | 連絡先の名前 (姓)。 データタイプ：文字列 | | productOrderItem.product.relatedParty.phone | 連絡先の勤務先電話番号。 データタイプ：文字列 | | productOrderItem.product.relatedParty.@referredType | 顧客のタイプ。 可能な値:OrderLineItemContact データタイプ：文字列 | | productOrderItem.product.relatedParty.@type | TMF Open API 標準の一部です。注文明細品目の連絡先の注釈。この値は常に RelatedParty です。この情報は保存されません。 データタイプ：文字列 | | productOrderItem.productOffering | 製品に関連付けられた製品オファリングの説明。 データタイプ: オブジェクト "productOffering": { "id": "String", "internalVersion": "String", "name": "String", "version": "String" } | | productOrderItem.productOffering.id | 製品オファリングのInitial_versionまたはexternal_id。initial_versionは、オファリングの最初のバージョンのsys_idです。製品オファリング \[sn_prd_pm_product_offering\] テーブルの sys_id または external_id フィールドにあります。 データタイプ：文字列 | | productOrderItem.productOffering.name | 製品オファリングの名前。製品オファリング \[sn_prd_pm_product_offering\] テーブルにあります。 データタイプ：文字列 | | productOrderItem.quantity | 購入した製品アイテムの数。 データタイプ：数値 | | productOrderItem.productOrderItemRelationship | 注文品目間の関係のリスト。 データタイプ：オブジェクトのアレイ "productOrderItemRelationship": [ { "id": "String", "relationshipType": "String" } ] | | productOrderItem.productOrderItemRelationship.id | 関連品目の一意の識別子。注文明細品目 \[sn_ind_tmt_orm_order_line_item\] テーブルの sn_ind_tmt_orm_external_id フィールドにあります。 データタイプ：文字列 | | productOrderItem.productOrderItemRelationship.relationshipType | 2 つの品目間の関係のタイプ。この情報は、関係階層を識別するために使用されます。 可能な値： * HasChild * 親がある * 必要 {#tmf_prod_order-GET-productOrder-id__ul_yqf_2ty_54b} `HasChild` と `HasParent` は、親子関係に使用されます。\[`必須]` は水平関係に使用されます (品目には別の品目が必要です)。 データタイプ：文字列 | | productOrderItem.state | 関連製品アイテムの注文状況。 データタイプ：文字列 | | productOrderItem.version | 注文バージョン。 データタイプ：文字列 | | productOrderItem.@type | TMF Open API 標準の一部です。製品の注釈。この値は常に ProductOrderItem です。この情報は保存されません。 データタイプ：文字列 | | 関連パーティー | 注文の連絡先のリスト。各連絡先はアレイ内のオブジェクトです。顧客アカウントまたはコンシューマーアカウント情報を含むアイテムを少なくとも 1 つリストする必要があります。 データタイプ：オブジェクトのアレイ "relatedParty:" [ { "id": "String", "name": "String", "@referredType": "String", "@type": "String" } ] | | relatedParty.id | 注文に関連付けられたアカウント、顧客連絡先、またはコンシューマーのSys_idまたはexternal_id。アカウント \[customer_account\]、連絡先 \[customer_contact\] テーブル、またはコンシューマー \[csm_consumer\] テーブルにあります。 データタイプ：文字列 | | relatedParty.name | アカウント、顧客、またはコンシューマーの名前。 データタイプ：文字列 | | relatedParty.@referredType | 顧客のタイプ。 可能な値： * コンシューマー * 顧客 * 顧客連絡先 {#tmf_prod_order-GET-productOrder-id__ul_lcq_jwm_t4b} データタイプ：文字列 | | relatedParty.@type | TMF Open API 標準の一部です。製品の注釈。この値は常に RelatedParty です。この情報は保存されません。 データタイプ：文字列 | | requestedCompletionDate | 顧客が要求した配送日。 データタイプ：文字列 | | requestedStartDate | 顧客が要求した注文開始日。 データタイプ：文字列 | | 状況 | 注文の現在のステータス。 データタイプ：文字列 | | version | 注文バージョン。 データタイプ：文字列 | | @type | TMF Open API 標準の一部です。製品の注釈。この値は常に ProductOrder です。この情報は保存されません。 データタイプ：文字列 | [ ] ### cURL 要求 次のコード例は、既存の顧客の注文を要求します。 curl -X GET "https://servicenow-instance/api/sn_ind_tmt_orm/productorder/8d75939453126010a795ddeeff7b126a" \ -u "username":"password" 応答本文。 { "id": "8d75939453126010a795ddeeff7b126a", "ponr": "false", "expectedCompletionDate": "2021-05-02T08:13:59.000Z", "requestedCompletionDate": "2021-05-02T08:13:59.000Z", "requestedStartDate": "2020-05-03T08:13:59.000Z", "channel": [ { "id": "1", "name": "Agent Assist" } ], "note": [ { "author": "System Administrator", "date": "2021-02-25T14:22:07.000Z", "text": "This is a TMF product order illustration no 2" }, { "author": "System Administrator", "date": "2021-02-25T14:22:06.000Z", "text": "This is a TMF product order illustration" } ], "productOrderItem": [ { "id": "POI130", "ponr": "false", "quantity": 1, "action": "add", "actionReason":"adding service package OLI", "itemPrice": [ { "priceType": "recurring", "price": { "taxIncludedAmount": { "unit": "USD", "value": 20 } } }, { "priceType": "nonRecurring", "price": { "taxIncludedAmount": { "unit": "INR", "value": 0 } } } ], "product": { "@type": "Product", "productCharacteristic": [ { "name": "Security Type", "valueType": "Choice", "value": "Base", "previousValue": "" } ], "productSpecification": { "id": "a6514bd3534560102f18ddeeff7b1247", "name": "SD-WAN Security", "@type": "ProductSpecificationRef" }, "relatedParty": [ { "id": "4175939453126010a795ddeeff7b127d", "name": "John Smith", "email": "abc2@example.com", "phone": "32456768", "@type": "RelatedParty", "@referredType": "OrderLineItemContact" }, { "id": "c175939453126010a795ddeeff7b127c", "name": "Joe Doe", "email": "abc@example.com", "phone": "1234567890", "@type": "RelatedParty", "@referredType": "OrderLineItemContact" } ] }, "productOffering": { "id": "69017a0f536520103b6bddeeff7b127d", "name": "Premium SD-WAN Offering" }, "productOrderItemRelationship": [ { "id": "POI100", "relationshipType": "HasParent" } ], "state": "in_progress", "version": "1", "@type": "ProductOrderItem" }, { "id": "POI100", "ponr": "false", "quantity": 1, "action": "add", "itemPrice": [ { "priceType": "recurring", "price": { "taxIncludedAmount": { "unit": "INR", "value": 0 } } }, { "priceType": "nonRecurring", "price": { "taxIncludedAmount": { "unit": "INR", "value": 0 } } } ], "product": { "@type": "Product", "productSpecification": { "id": "cfe5ef6a53702010cd6dddeeff7b12f6", "name": "SD-WAN Service Package", "@type": "ProductSpecificationRef" } }, "productOffering": { "id": "69017a0f536520103b6bddeeff7b127d", "name": "Premium SD-WAN Offering" }, "productOrderItemRelationship": [ { "id": "POI130", "relationshipType": "HasChild" }, { "id": "POI120", "relationshipType": "HasChild" }, { "id": "POI110", "relationshipType": "HasChild" } ], "state": "in_progress", "version": "1", "@type": "ProductOrderItem" }, { "id": "POI120", "ponr": "false", "quantity": 1, "action": "add", "itemPrice": [ { "priceType": "recurring", "price": { "taxIncludedAmount": { "unit": "USD", "value": 20 } } }, { "priceType": "nonRecurring", "price": { "taxIncludedAmount": { "unit": "INR", "value": 0 } } } ], "product": { "@type": "Product", "productCharacteristic": [ { "name": "CPE Type", "valueType": "Choice", "value": "Physical", "previousValue": "" }, { "name": "WAN Optimization", "valueType": "Choice", "value": "Advance", "previousValue": "" }, { "name": "Routing", "valueType": "Choice", "value": "Premium", "previousValue": "" }, { "name": "CPE Model", "valueType": "Choice", "value": "ASR", "previousValue": "" } ], "productSpecification": { "id": "39b627aa53702010cd6dddeeff7b1202", "name": "SD-WAN Edge Device", "@type": "ProductSpecificationRef" } }, "productOffering": { "id": "69017a0f536520103b6bddeeff7b127d", "name": "Premium SD-WAN Offering" }, "productOrderItemRelationship": [ { "id": "POI100", "relationshipType": "HasParent" } ], "state": "in_progress", "version": "1", "@type": "ProductOrderItem" }, { "id": "POI110", "ponr": "false", "quantity": 1, "action": "add", "actionReason":"adding service package OLI", "itemPrice": [ { "priceType": "recurring", "price": { "taxIncludedAmount": { "unit": "INR", "value": 0 } } }, { "priceType": "nonRecurring", "price": { "taxIncludedAmount": { "unit": "USD", "value": 5 } } } ], "product": { "@type": "Product", "productCharacteristic": [ { "name": "Tenancy", "valueType": "Choice", "value": "Base (10 site)", "previousValue": "" } ], "productSpecification": { "id": "216663aa53702010cd6dddeeff7b12b5", "name": "SD-WAN Controller", "@type": "ProductSpecificationRef" }, "place": { "id": "25ab9c4d0a0a0bb300f7dabdc0ca7c1c", "@type": "Place" } }, "productOffering": { "id": "69017a0f536520103b6bddeeff7b127d", "name": "Premium SD-WAN Offering" }, "productOrderItemRelationship": [ { "id": "POI100", "relationshipType": "HasParent" } ], "state": "in_progress", "version": "1", "@type": "ProductOrderItem" } ], "relatedParty": [ { "id": "eaf68911c35420105252716b7d40ddde", "name": "Sally Thomas", "@type": "RelatedParty", "@referredType": "CustomerContact" }, { "id": "ffc68911c35420105252716b7d40dd55", "name": "Funco Intl", "@type": "RelatedParty", "@referredType": "Customer" }, { "id": "59f16de1c3b67110ff00ed23a140dd9e", "name": "Funco External", "@type": "RelatedParty", "@referredType": "Consumer" } ], "state": "in_progress", "version": "1", "@type": "ProductOrder" } ## Product Order Open API - GET /sn_ind_tmt_orm/order/productOrder/{id} {#ariaid-title5} 指定された顧客注文を更新します。 ### URL 形式 デフォルト URL: /api/sn_ind_tmt_orm/order/productOrder/{id} ### サポートされている要求パラメーター {#tmf_prod_order-GET-ord-productOrder-id__entry__2} | 名前 | 説明 | |-|-| | ID | 更新する顧客注文のSys_id。 データタイプ：文字列 テーブル:顧客注文 \[sn_ind_tmt_orm_order\] | [表 : 19. パスパラメーター] {#tmf_prod_order-GET-ord-productOrder-id__entry__6} | 名前 | 説明 | |-|-| | なし | | [表 : 20. クエリパラメーター] {#tmf_prod_order-GET-ord-productOrder-id__id_vk2_p5n_t4b__entry__2}{#tmf_prod_order-GET-ord-productOrder-id__type-entry-tmf622}{#tmf_prod_order-GET-ord-productOrder-id__channel-ph-tmf622}{#tmf_prod_order-GET-ord-productOrder-id__channel_id-ph-tmf622}{#tmf_prod_order-GET-ord-productOrder-id__channel_name-ph-tmf622}{#tmf_prod_order-GET-ord-productOrder-id__due-date-PATCH}{#tmf_prod_order-GET-ord-productOrder-id__externalId-ph-tmf622}{#tmf_prod_order-GET-ord-productOrder-id__tmf622-response-externalSystem}{#tmf_prod_order-GET-ord-productOrder-id__note-ph-tmf622}{#tmf_prod_order-GET-ord-productOrder-id__note_text-ph-tmf622}{#tmf_prod_order-GET-ord-productOrder-id__prodOrdItem-ph-tmf622}{#tmf_prod_order-GET-ord-productOrder-id__prodOrdItem_type-entry-tmf622}{#tmf_prod_order-GET-ord-productOrder-id__prodOrdItem_action-ph-tmf622}{#tmf_prod_order-GET-ord-productOrder-id__prodOrdItem_actionReason-response-tmf622}{#tmf_prod_order-GET-ord-productOrder-id__due-date-item-PATCH}{#tmf_prod_order-GET-ord-productOrder-id__externalProdInvId-decsr}{#tmf_prod_order-GET-ord-productOrder-id__externalProdInv-descr-PATCH}{#tmf_prod_order-GET-ord-productOrder-id__prodOrdItem_id-ph-tmf622}{#tmf_prod_order-GET-ord-productOrder-id__itemPrice-ph-tmf622}{#tmf_prod_order-GET-ord-productOrder-id__itemPrice_price-ph-tmf622}{#tmf_prod_order-GET-ord-productOrder-id__itemPrice_price_taxIncludedAmt-ph-tmf622}{#tmf_prod_order-GET-ord-productOrder-id__itemPrice_price_taxIncludedAmt_unit-ph-tmf622}{#tmf_prod_order-GET-ord-productOrder-id__itemPrice_price_taxIncludedAmt_value-ph-tmf622}{#tmf_prod_order-GET-ord-productOrder-id__itemPrice_priceType_data_type-p-tmf622}{#tmf_prod_order-GET-ord-productOrder-id__itemPrice_recurringChargePeriod_data_type-p-tmf622}{#tmf_prod_order-GET-ord-productOrder-id__product-p-tmf622}{#tmf_prod_order-GET-ord-productOrder-id__product_type_data_type-p-tmf622}{#tmf_prod_order-GET-ord-productOrder-id__product_id-ph-tmf622}{#tmf_prod_order-GET-ord-productOrder-id__product_place-ph-tmf622}{#tmf_prod_order-GET-ord-productOrder-id__product_place_type_data_type-p-tmf622}{#tmf_prod_order-GET-ord-productOrder-id__product_place_id-ph-tmf622}{#tmf_prod_order-GET-ord-productOrder-id__prod_prodChar-ph-tmf622}{#tmf_prod_order-GET-ord-productOrder-id__prod_prodChar_name-ph-tmf622}{#tmf_prod_order-GET-ord-productOrder-id__prod_prodChar_previousValue-ph-tmf622}{#tmf_prod_order-GET-ord-productOrder-id__prod_prodChar_value-ph-tmf622}{#tmf_prod_order-GET-ord-productOrder-id__prod_prodSpec-ph-tmf622}{#tmf_prod_order-GET-ord-productOrder-id__prod_prodSpec_type_data_type-p-tmf622}{#tmf_prod_order-GET-ord-productOrder-id__prod_prodSpec_id_data_type-p-tmf622}{#tmf_prod_order-GET-ord-productOrder-id__tmf622-response-internalVersion}{#tmf_prod_order-GET-ord-productOrder-id__prod_prodSpec_name_data_type-p-tmf622}{#tmf_prod_order-GET-ord-productOrder-id__tmf622-response-version}{#tmf_prod_order-GET-ord-productOrder-id__prod_relParty-ph-tmf622}{#tmf_prod_order-GET-ord-productOrder-id__prod_relParty_refType_data_type-p-tmf622}{#tmf_prod_order-GET-ord-productOrder-id__product_relatedParty_type_data_type-row-tmf622}{#tmf_prod_order-GET-ord-productOrder-id__prod_relParty_email-ph-tmf622}{#tmf_prod_order-GET-ord-productOrder-id__prod_relParty_firstName-ph-tmf622}{#tmf_prod_order-GET-ord-productOrder-id__prod_relParty_id-ph-tmf622}{#tmf_prod_order-GET-ord-productOrder-id__prod_relParty_lastName-ph-tmf622}{#tmf_prod_order-GET-ord-productOrder-id__prod_relParty_phone-ph-tmf622}{#tmf_prod_order-GET-ord-productOrder-id__productOffer-ph-tmf622}{#tmf_prod_order-GET-ord-productOrder-id__prodOffer_id_data_type-p-tmf622}{#tmf_prod_order-GET-ord-productOrder-id__prodOffer_name_data_type-p-tmf622}{#tmf_prod_order-GET-ord-productOrder-id__prodOrdItem_quantity-ph-tmf622}{#tmf_prod_order-GET-ord-productOrder-id__prodOrderItemRel-ph-tmf622}{#tmf_prod_order-GET-ord-productOrder-id__prodOrderItemRel_id-ph-tmf622}{#tmf_prod_order-GET-ord-productOrder-id__prodOrderItemRel_relType_data_type-p-tmf622}{#tmf_prod_order-GET-ord-productOrder-id__relatedParty-ph-tmf622}{#tmf_prod_order-GET-ord-productOrder-id__relatedParty_refType_data_type-p-tmf622}{#tmf_prod_order-GET-ord-productOrder-id__relatedParty_type_data_type-p-tmf622}{#tmf_prod_order-GET-ord-productOrder-id__relatedParty_id_data_type-p-tmf622}{#tmf_prod_order-GET-ord-productOrder-id__relatedParty_name_data_type-p-tmf622}{#tmf_prod_order-GET-ord-productOrder-id__requestedCompletionDate-ph-tmf622}{#tmf_prod_order-GET-ord-productOrder-id__reqStartDate-ph-tmf622} | 名前 | 説明 | |-|-| | @type | TMF Open API 標準の一部です。製品の注釈。この値は常に ProductOrder です。この情報は保存されません。 データタイプ：文字列 | | チャネル | 製品の販売に使用するチャネルのリスト。 データタイプ：オブジェクトのアレイ{#tmf_prod_order-GET-ord-productOrder-id__channel_data_type-p-tmf622} "channel": [ { "id": "String", "name": "String" } ] {#tmf_prod_order-GET-ord-productOrder-id__channel_obj_def-codeblock-tmf622} 保存場所:sn_ind_tmt_orm_order | | channel.id | channelパラメーターを使用する場合は必須です。関連製品の販売に使用するチャネルの一意の識別子。 データタイプ：文字列{#tmf_prod_order-GET-ord-productOrder-id__channel_id_data_type-p-tmf622} テーブル:流通チャネル \[sn_prd_pm_distribution_channel\] テーブルの external_id フィールド内。 格納場所:sn_ind_tmt_orm_orderテーブルのチャネルフィールド。 デフォルト：空白の文字列 | | channel.name | 関連製品の販売に使用するチャネルの名前。可能なチャネル名は、sn_ind_tmt_orm_orderテーブルのチャネル辞書エントリの \[選択リスト\] タブで定義されます。 データタイプ：文字列{#tmf_prod_order-GET-ord-productOrder-id__channel_name_data_type-p-tmf622} デフォルト：空白の文字列 | | committedDueDate | 注文に対してアクションを実行する必要がある日時。 この値は、各注文品目の committedDueDate 値と同じかそれ以降にする必要があります。 注文品目のアクションが 一時停止 または 再開の場合、このパラメーターは更新できません。 データタイプ：文字列 格納場所:sn_ind_tmt_orm_orderテーブルのcommitted_due_dateフィールド。 | | externalId | 顧客注文の一意の識別子。この値は外部システムによって決定されます。 データタイプ：文字列{#tmf_prod_order-GET-ord-productOrder-id__externalId_data_type-p-tmf622} 格納場所:sn_ind_tmt_orm_orderテーブルのexternal_idフィールド。 デフォルト：空白の文字列 | | 外部システム | `TMF622` が追加されたサービス注文の外部システム。 たとえば、外部システムが ABC の場合、 externalSystem に `ABC-TMF622` と入力します。 データタイプ:文字列 | | 注意 | 注文時に顧客が行った追加のメモのリスト。 データタイプ：オブジェクトのアレイ{#tmf_prod_order-GET-ord-productOrder-id__note_data_type-p-tmf622} "note": [ { "text": "String" } ] {#tmf_prod_order-GET-ord-productOrder-id__note-codeblock-tmf622} 保存場所:sn_ind_tmt_orm_order | | note.text | 注文時に顧客が行った追加のメモ/コメント。 データタイプ：文字列{#tmf_prod_order-GET-ord-productOrder-id__note_text_data_type-p-tmf622} 格納場所:sn_ind_tmt_orm_orderテーブルのコメントフィールド。 デフォルト：空白の文字列 | | orderCurrency | 注文と注文明細品目の通貨コード。既存の注文の通貨コードの更新はサポートされていません。注文に既に関連付けられている通貨コード以外の値を指定すると、更新が却下されます。 データタイプ：文字列 | | 製品注文アイテム | 製品注文とそれに関連するアクションに関連付けられたアイテムを説明するリスト。 データタイプ：オブジェクトのアレイ{#tmf_prod_order-GET-ord-productOrder-id__prodOrdItem_data_type-p-tmf622} "productOrderItem": [ { "action": "String", "actionReason": "String", "committedDueDate": "String", "externalProductInventory": [Array], "id": "String", "itemPrice": [Array], "product": {Object}, "productOffering": {Object}, "productOrderItemRelationship": [Array], "quantity": Number, "revisionOperation": "String", "@type": "String" } ] {#tmf_prod_order-GET-ord-productOrder-id__prodOrdItem-codeblock-tmf622} 格納場所:sn_ind_tmt_orm_order_line_item | | productOrderItem.@type | TMF Open API 標準の一部です。製品の注釈。この値は常に ProductOrderItem です。この情報は保存されません。 データタイプ：文字列 | | productOrderItem.action | productOrderItemパラメーターを使用する場合は必須です。製品に対して実行するアクション。可能なアクションは、sn_ind_tmt_orm_order_line_itemテーブルのアクション辞書エントリの \[選択リスト\] タブで定義されます。 可能な値： * 追加 * 変更 注: productOrderItem.product.place.idを介して新しいサービスの場所を含む変更ペイロードを送信すると、移動オーダーとして処理されます。 * delete * 変更なし * 再開 * 停止する {#tmf_prod_order-GET-ord-productOrder-id__ul_zwn_nxp_ysb} データタイプ：文字列{#tmf_prod_order-GET-ord-productOrder-id__prodOrdItem_action_data_type-p-tmf622} 格納場所:sn_ind_tmt_orm_order_line_itemテーブルのアクションフィールド。 デフォルト:追加 | | productOrderItem.actionReason | 注文明細品目を追加する理由。 データタイプ：文字列 格納場所:sn_ind_tmt_orm_order_line_itemテーブルのaction_reasonフィールド。 | | productOrderItem.committedDueDate | 注文品目に対してアクションを実行する必要がある日時。 アイテムのアクションが 一時停止 または 再開の場合、このパラメーターは更新できません。 データタイプ：文字列 格納場所:sn_ind_tmt_orm_order_line_itemテーブルのcommitted_due_dateフィールド。 | | productOrderItem.externalProductInventory.externalProductInventoryId | 製品インベントリにマッピングする外部 ID。 データタイプ：文字列 格納場所:sn_ind_tmt_orm_order_line_itemテーブルのexternal_inventory_idフィールドとsn_prd_invt_product_inventoryテーブルのsn_prd_invt_external_idフィールド。 | | productOrderItem.externalProductInventory | 注文に対して作成された製品在庫にマッピングする外部 ID のリスト。 データタイプ：オブジェクトのアレイ "externalProductInventory": [ { "externalProductInventoryId": "String" } ] 注: 以前は、既に存在する外部製品インベントリ ID を使用して PATCH 注文を作成すると、操作が中断され、エラーが返されていました。Xanaduリリースでは、既存の外部プロダクトインベントリ ID が指定されていて、エラーがスローされない場合、このパラメーターは単純に無視されます。 | | productOrderItem.id | productOrderItemパラメーターを使用する場合は必須です。品目の一意の識別子。注文明細品目 \[sn_ind_tmt_orm_order_line_item\] テーブルの sn_ind_tmt_orm_external_id フィールドにあります。 データタイプ：文字列{#tmf_prod_order-GET-ord-productOrder-id__prodOrdItem_id_data_type-p-tmf622} 格納場所:sn_ind_tmt_orm_order_line_itemテーブルのexternal_idフィールド。 最大長：40 デフォルト：空白の文字列 | | productOrderItem.itemPrice | 製品に関連付けられた価格を説明するリスト。 データタイプ：オブジェクトのアレイ{#tmf_prod_order-GET-ord-productOrder-id__itemPrice_data_type-p-tmf622} "itemPrice": [ { "price": {Object}, "priceType": "String", "recurringChargePeriod": "String" } ] {#tmf_prod_order-GET-ord-productOrder-id__itemPrice-codeblock-tmf622} 保存場所:sn_ind_tmt_orm_order デフォルト：空白の文字列 | | productOrderItem.itemPrice.price | 関連製品の価格の説明。 データタイプ: オブジェクト{#tmf_prod_order-GET-ord-productOrder-id__itemPrice_price_data_type-p-tmf622} "price": { "taxIncludedAmount": {Object} } {#tmf_prod_order-GET-ord-productOrder-id__itemPrice_price-codeblock-tmf622} 格納場所:sn_ind_tmt_orm_order_line_item デフォルト：空白の文字列 | | productOrderItem.itemPrice.price.taxIncludedAmount | 税を含む関連製品の価格の説明。 データタイプ: オブジェクト{#tmf_prod_order-GET-ord-productOrder-id__itemPrice_price_taxIncludedAmt_data_type-p-tmf622} "taxIncludedAmount": { "unit": "String", "value": Number } {#tmf_prod_order-GET-ord-productOrder-id__itemPrice_price_taxIncludedAmt-codeblock-tmf622} 格納場所:sn_ind_tmt_orm_order_line_item | | productOrderItem.itemPrice.price.taxIncludedAmount.unit | 価格を表す通貨コード。 データタイプ：文字列{#tmf_prod_order-GET-ord-productOrder-id__itemPrice_price_taxIncludedAmt_unit_data_type-p-tmf622} 格納場所:sn_ind_tmt_orm_order_line_itemテーブルの mrc または nrc フィールド。 | | productOrderItem.itemPrice.price.taxIncludedAmount.value | 製品の価格 (税込み)。 データタイプ：数値{#tmf_prod_order-GET-ord-productOrder-id__itemPrice_price_taxIncludedAmt_value_data_type-p-tmf622} 格納場所:sn_ind_tmt_orm_order_line_itemテーブルの mrc または nrc フィールド。 | | productOrderItem.itemPrice.priceType | アイテム価格のタイプ (繰り返しまたは非繰り返し)。 データタイプ：文字列 | | productOrderItem.itemPrice.recurringChargePeriod | 価格が繰り返し発生する場合は、 月などの繰り返し期間。 データタイプ：文字列 | | productOrderItem.product | productOrderItem.actionが変更または削除の場合は必須です。顧客が購入した製品のインスタンス詳細の説明。 データタイプ: オブジェクト{#tmf_prod_order-GET-ord-productOrder-id__product_data_type-p-tmf622} "product": { "id": "String", "place": {Object}, "productCharacteristic": [Array], "productSpecification": {Object}, "relatedParty": {Object}, "@type": "String" } {#tmf_prod_order-GET-ord-productOrder-id__product-codeblock-tmf622} 格納場所:sn_ind_tmt_orm_order_line_item | | productOrderItem.product.@type | TMF Open API 標準の一部です。製品の注釈。この値は常に Product です。この情報は保存されません。 データタイプ：文字列 | | productOrderItem.product.id | productOrderItem.actionが変更または削除の場合は必須です。販売された製品の一意の識別子。製品インベントリ \[sn_ind_tmt_orm_product_inventory\] テーブルのsys_idまたはsn_ind_tmt_orm_external_idフィールドにあります。 データタイプ：文字列{#tmf_prod_order-GET-ord-productOrder-id__product_id_data_type-p-tmf622} デフォルト：空白の文字列 | | productOrderItem.product.place | 製品を設置する場所のマップ。 データタイプ: オブジェクト{#tmf_prod_order-GET-ord-productOrder-id__product_place_data_type-p-tmf622} "place": { "id": "String", "@type": "String" } {#tmf_prod_order-GET-ord-productOrder-id__product_place-codeblock-tmf622} 格納場所:sn_ind_tmt_orm_order_line_item | | productOrderItem.product.place.@type | TMF Open API 標準の一部です。注文明細品目の連絡先の注釈。この値は常に Place です。この情報は保存されません。 データタイプ：文字列 | | productOrderItem.product.place.id | productOrderItem.product.placeパラメーターを使用する場合は必須です。場所 \[cmn_location\] テーブル内の関連する場所レコードのSys_id。製品注文アイテムに対して ( productOrderItem.action パラメーターを使用して) 変更アクションを使用する場合、要求を新しい場所sys_id更新すると、注文は変更されず、新しい場所で履行される移動オーダーが作成されます。 データタイプ：文字列{#tmf_prod_order-GET-ord-productOrder-id__product_place_id_data_type-p-tmf622} 格納場所:sn_ind_tmt_orm_order_line_itemテーブルの場所フィールド。 デフォルト：空白の文字列 | | productOrderItem.product.productCharacteristic | 関連製品の特性のリスト。 データタイプ：オブジェクトのアレイ{#tmf_prod_order-GET-ord-productOrder-id__prod_prodChar_data_type-p-tmf622} "productCharacteristic": [ { "name": "String", "previousValue": "String", "value": "String", "valueType": "String" } ] {#tmf_prod_order-GET-ord-productOrder-id__prod_prodChar-codeblock-tmf622} 格納場所:sn_ind_tmt_orm_order_characteristic_value | | productOrderItem.product.productCharacteristic.name | 製品に関連付ける特性レコードの名前。特性 \[sn_prd_pm_characteristic\] テーブルにあります。 データタイプ：文字列{#tmf_prod_order-GET-ord-productOrder-id__prod_prodChar_name_data_type-p-tmf622} 格納場所:sn_ind_tmt_orm_order_characteristic_valueテーブルの特性フィールド。 デフォルト：空白の文字列 | | productOrderItem.product.productCharacteristic.previousValue | 更新が変更指示用である場合の以前の特性オプションの値。productOrderItem.actionパラメーターが add 以外の場合、要求は変更指示です。特性オプション値の詳細については、「 [Create product characteristics and characteristic options](https://www.servicenow.com/docs/access?context=som-product-config-add-characteristics&version=australia&pubname=australia-order-management&ft:locale=en-US)」を参照してください。 データタイプ：文字列{#tmf_prod_order-GET-ord-productOrder-id__prod_prodChar_previousValue_data_type-p-tmf622} 格納場所:sn_ind_tmt_orm_order_characteristic_valueテーブルのprevious_characteristic_option_value。 デフォルト：空白の文字列 | | productOrderItem.product.productCharacteristic.value | 製品に関連付けられた特性オプション値。特性オプション値の詳細については、「 [Create product characteristics and characteristic options](https://www.servicenow.com/docs/access?context=som-product-config-add-characteristics&version=australia&pubname=australia-order-management&ft:locale=en-US)」を参照してください。 データタイプ：文字列{#tmf_prod_order-GET-ord-productOrder-id__prod_prodChar_value_data_type-p-tmf622} 格納場所: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 行テキスト * はい/いいえ {#tmf_prod_order-GET-ord-productOrder-id__ul_j4j_pjw_xfc} | | productOrderItem.product.productSpecification | 製品に関連付けられた製品仕様の説明。 注: 変更指示 (productOrderItem.action が `変更`) は、 sn_ind_tmt_orm.allowSpecVersionUpdateInChangeOrder システムプロパティの値に基づいて異なる方法で処理されます。このシステムプロパティの値は、製品インベントリが注文に示されているバージョンと異なる場合の注文の処理方法を決定します。 * このシステムプロパティが true (デフォルト) に設定されている場合、製品インベントリは、参照されている製品仕様を変更することによって注文のバージョンに自動的にアップグレードされます。これにより、注文を正常に処理できます。 * このシステムプロパティが false に設定されている場合、製品インベントリが注文に示されているバージョンと異なる場合、バージョンの不一致により注文は失敗します。 {#tmf_prod_order-GET-ord-productOrder-id__ul_sgb_q5y_hbc} データタイプ: オブジェクト{#tmf_prod_order-GET-ord-productOrder-id__prod_prodSpec_data_type-p-tmf622} "productSpecification": { "id": "String", "internalVersion": "String", "name": "String", "version": "String", "@type": "String" } {#tmf_prod_order-GET-ord-productOrder-id__prod_prodSpec-codeblock-tmf622} 格納場所:sn_ind_tmt_orm_order_line_item | | productOrderItem.product.productSpecification.@type | TMF Open API 標準の一部です。この値は常に ProductSpecificationRef です。この情報は保存されません。 データタイプ：文字列 | | productOrderItem.product.productSpecification.id | productOrderItem.product.productSpecificationパラメーターを使用する場合は必須です。製品仕様のInitial_versionまたはexternal_id。initial_versionは仕様の最初のバージョンのsys_idです。製品仕様 \[sn_prd_pm_product_specification\] テーブルの \[sys_id\] または \[external_id\] フィールドにあります。 データタイプ：文字列 | | productOrderItem.product.productSpecification.internalVersion | 製品仕様の内部バージョン。version の値と一致する必要があります。一致しない場合、エラーがスローされます。 データタイプ:文字列 表:製品仕様 \[sn_prd_pm_product_specification\] | | productOrderItem.product.productSpecification.name | 製品仕様の名前。製品仕様 \[sn_prd_pm_product_specification\] テーブルにあります。 データタイプ：文字列 | | productOrderItem.product.productSpecification.version | 製品仕様の外部バージョン。internalVersion の値と一致する必要があります。一致しない場合、エラーがスローされます。 データタイプ:文字列 表:製品仕様 \[sn_prd_pm_product_specification\] | | productOrderItem.product.relatedParty | 品目の連絡先のリスト。 データタイプ：オブジェクトのアレイ{#tmf_prod_order-GET-ord-productOrder-id__prod_relParty_data_type-p-tmf622} "relatedParty": [ { "email": "String", "firstName": "String", "id": "String", "lastName": "String", "phone": "String", "@referredType": "String", "@type": "String" } ] {#tmf_prod_order-GET-ord-productOrder-id__prod_relParty-codeblock-tmf622} 格納場所:sn_ind_tmt_orm_order_line_item_contact | | productOrderItem.product.relatedParty.@referredType | 顧客のタイプ。 可能な値:OrderLineItemContact{#tmf_prod_order-GET-ord-productOrder-id__prod_relParty_refType-p-tmf622} データタイプ：文字列 | | productOrderItem.product.relatedParty.@type | TMF Open API 標準の一部です。注文明細品目の連絡先の注釈。この値は常に RelatedParty です。この情報は保存されません。 データタイプ：文字列 | | productOrderItem.product.relatedParty.email | 連絡先のメールアドレス。 データタイプ：文字列{#tmf_prod_order-GET-ord-productOrder-id__prod_relParty_email_data_type-p-tmf622} 格納場所:sn_ind_tmt_orm_order_line_item_contactテーブルのメールフィールド。 デフォルト：空白の文字列 | | productOrderItem.product.relatedParty.firstName | 連絡先の名。 データタイプ：文字列{#tmf_prod_order-GET-ord-productOrder-id__prod_relParty_firstName_data_type-p-tmf622} 格納場所:sn_ind_tmt_orm_order_line_item_contactテーブルのfirst_nameフィールド。 デフォルト：空白の文字列 | | productOrderItem.product.relatedParty.id | 注文品目に関連付けられた品目連絡先のSys_id。注文明細品目連絡先 \[sn_ind_tmt_orm_order_line_item_contact\] テーブルにあります。 データタイプ：文字列{#tmf_prod_order-GET-ord-productOrder-id__prod_relParty_id_data_type-p-tmf622} 格納場所:sn_ind_tmt_orm_order_line_item_contactテーブルのsys_idフィールド。 デフォルト：空白の文字列 | | productOrderItem.product.relatedParty.lastName | 連絡先の名前 (姓)。 データタイプ：文字列{#tmf_prod_order-GET-ord-productOrder-id__prod_relParty_lastName_data_type-p-tmf622} 格納場所:sn_ind_tmt_orm_order_line_item_contactテーブルの lastName フィールド。 デフォルト：空白の文字列 | | productOrderItem.product.relatedParty.phone | 連絡先の勤務先電話番号。 データタイプ：文字列{#tmf_prod_order-GET-ord-productOrder-id__prod_relParty_phone_data_type-p-tmf622} 格納場所:sn_ind_tmt_orm_order_line_item_contactテーブルのbusiness_phoneフィールド。 デフォルト：空白の文字列 | | productOrderItem.productOffering | 製品に関連付けられた製品オファリングの説明。 データタイプ: オブジェクト{#tmf_prod_order-GET-ord-productOrder-id__prodOffer_data_type-p-tmf622} "productOffering": { "id": "String", "internalVersion": "String", "name": "String", "version": "String" } {#tmf_prod_order-GET-ord-productOrder-id__prodOffer-codeblock-tmf622} 格納場所: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 | 注文する関連アイテムの数。 データタイプ：数値{#tmf_prod_order-GET-ord-productOrder-id__prodOrdItem_quantity_data_type-p-tmf622} 格納場所:sn_ind_tmt_orm_orderの数量フィールド。 デフォルト値:null | | productOrderItem.productOrderItemRelationship | 注文品目間の関係のリスト。 データタイプ：オブジェクトのアレイ{#tmf_prod_order-GET-ord-productOrder-id__prodOrderItemRel_data_type-p-tmf622} "productOrderItemRelationship": [ { "id": "String", "relationshipType": "String" } ] {#tmf_prod_order-GET-ord-productOrder-id__prodOrderItemRel-codeblock-tmf622} 格納場所: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 フィールドにあります。 データタイプ：文字列{#tmf_prod_order-GET-ord-productOrder-id__prodOrderItemRel_id_data_type-p-tmf622} 格納場所:テーブルのparent_line_itemフィールドthebsn_ind_tmt_orm_order_line_item。 デフォルト：空白の文字列 | | productOrderItem.productOrderItemRelationship.relationshipType | 2 つの品目間の関係のタイプ。この情報は、関係階層を識別するために使用されます。 可能な値： * HasChild * 親がある * 必要 {#tmf_prod_order-GET-ord-productOrder-id__ul_yqf_2ty_54b} `HasChild` と `HasParent` は、親子関係に使用されます。\[`必須]` は水平関係に使用されます (品目には別の品目が必要です)。 データタイプ：文字列 | | productOrderItem.quantity | 注文されたアイテムの数。 データタイプ：数値 格納場所:sn_ind_tmt_orm_orderテーブルの数量フィールド。 デフォルト：空白の文字列 | | productOrderItem.revisionOperation | 品目に対して実行する更新のタイプ。この値が空の場合、既存の品目が更新されるか、まだ存在しない場合は新しい品目が追加されます。この値が cancel の場合、品目はキャンセルされます。 データタイプ：文字列 デフォルト：空白の文字列 | | 関連パーティー | 注文の連絡先のリスト。各連絡先はアレイ内のオブジェクトです。顧客アカウントまたはコンシューマーアカウント情報を含むアイテムを少なくとも 1 つリストする必要があります。 データタイプ：オブジェクトのアレイ{#tmf_prod_order-GET-ord-productOrder-id__relatedParty_data_type-p-tmf622} "relatedParty": [ { "id": "String", "name": "String", "@referredType": "String", "@type": "String" } ] {#tmf_prod_order-GET-ord-productOrder-id__relatedParty-codeblock-tmf622} | | relatedParty.@referredType | 顧客のタイプ。 可能な値： * コンシューマー * 顧客 * 顧客連絡先 {#tmf_prod_order-GET-ord-productOrder-id__ul_lcq_jwm_t4b} データタイプ：文字列 | | relatedParty.@type | TMF Open API 標準の一部です。製品の注釈。この値は常に RelatedParty です。この情報は保存されません。 データタイプ：文字列 | | relatedParty.id | 注文に関連付けられたアカウント、顧客連絡先、またはコンシューマーのSys_idまたはexternal_id。アカウント \[customer_account\]、連絡先 \[customer_contact\] テーブル、またはコンシューマー \[csm_consumer\] テーブルにあります。 データタイプ：文字列 | | relatedParty.name | アカウント、顧客、またはコンシューマーの名前。 データタイプ：文字列 | | requestedCompletionDate | 顧客が要求した配送日。 データタイプ：文字列{#tmf_prod_order-GET-ord-productOrder-id__reqCompDate_data_type-p-tmf622} 格納場所:sn_ind_tmt_orm_orderテーブルのexpected_end_dateフィールド。 デフォルト：空白の文字列 | | requestedStartDate | 顧客が要求した注文開始日。 データタイプ：文字列{#tmf_prod_order-GET-ord-productOrder-id__reqStartDate_data_type-p-tmf622} 格納場所:sn_ind_tmt_orm_orderテーブルのexpected_start_dateフィールド。 デフォルト：空白の文字列 | [表 : 21. 要求本文パラメーター (JSON)] {#tmf_prod_order-GET-ord-productOrder-id__id_vk2_p5n_t4b} ### ヘッダー 次の要求ヘッダーと応答ヘッダーは、この HTTP アクションにのみ適用されるか、別の方法でこのアクションに適用されます。REST API で使用される一般的なヘッダーのリストについては、「 [サポートされている REST API ヘッダー」](https://servicenow-prod.fluidtopics.net/lLW_uT5I5_l1aD8yR4Jt9A "REST (REpresentational State Transfer) は、Web 上のコンピューター システム間の標準を提供するシンプルなステートレス アーキテクチャであり、コンピューター システム間の通信を容易にします。")を参照してください。 {#tmf_prod_order-GET-ord-productOrder-id__table_omb_dvk_5rb__entry__2}{#tmf_prod_order-GET-ord-productOrder-id__accept-JSON-only-entry-RESTAPI}{#tmf_prod_order-GET-ord-productOrder-id__content_type-JSON-only-entry-RESTAPI} | ヘッダー | 説明 | |-|-| | 承認 | 応答本文のデータフォーマット。application/json のみをサポートします。 | | Content-Type | 要求本文のデータ形式。application/json のみをサポートします。 | [表 : 22. 要求ヘッダー] {#tmf_prod_order-GET-ord-productOrder-id__table_omb_dvk_5rb} {#tmf_prod_order-GET-ord-productOrder-id__table_tzy_thy_ksb__entry__2} | ヘッダー | 説明 | |-|-| | Content-Type | 応答本文のデータフォーマット。application/json のみをサポートします。 | [表 : 23. 応答ヘッダー] {#tmf_prod_order-GET-ord-productOrder-id__table_tzy_thy_ksb} ### ステータスコード この HTTP アクションには、次のステータスコードが適用されます。REST API で使用される可能性のあるステータスコードのリストについては、「 [REST API HTTP 応答コード](https://servicenow-prod.fluidtopics.net/lLW_uT5I5_l1aD8yR4Jt9A "REST (REpresentational State Transfer) は、Web 上のコンピューター システム間の標準を提供するシンプルなステートレス アーキテクチャであり、コンピューター システム間の通信を容易にします。")」を参照してください。 {#tmf_prod_order-GET-ord-productOrder-id__table_xfv_2vk_5rb__entry__2} | ステータスコード | 説明 | |-|-| | 201 | 成功。 特性または特性オプション情報に問題がある場合、エンドポイントは関連する顧客発注書明細レコードの作業メモフィールドに次のコメントを保存します。 * 次の注文品目特性が存在しません。注文を承認する前に、仕様\を確認し、注文明細品目の特性と特性オプションを修正してください。 * 注文アイテム特性:特性値\を持つ\は無効です。注文を承認する前に特性値を修正してください。 {#tmf_prod_order-GET-ord-productOrder-id__ul_xtx_xym_t4b} | | 400 | 要求が正しくありません。以下のいずれかの理由が考えられます。 * 無効なペイロード:要求本文がありません:ペ イロードが要求本文で渡されませんでした。 * 無効なペイロード:productOrderItem がありません :製品の注文明細品目オブジェクトまたは JSON がありません。 * 無効なペイロード:productOrderItem id がありません :ペイロードの製品注文明細品目に id パラメーターがありません。 * 無効なペイロード:productOrderItem アクションがありません: ペイロードの製品注文明細品目に action パラメーターがありません。 * 無効なペイロード:productOrderItem productOffering がありません :ペイロードの製品注文明細品目に製品オファリングオブジェクトまたは JSON がありません。 * 無効なペイロード:productOffering id がありません :ペイロード内の製品オファリングオブジェクトの製品注文明細品目に id パラメーターがありません。 * 無効なペイロード:製品オファリングが存在しません :製品注文明細品目の製品オファリングが無効です。 * 無効なペイロード:productOrderItem 製品がありません: 製品注文明細品目の製品オブジェクトまたは JSON がペイロードにありません。 * 無効なペイロード:製品 productSpecification がありません :製品注文明細品目の製品仕様オブジェクトまたは JSON がペイロードにありません。 * 無効なペイロード:productSpecification id がありません :製品仕様オブジェクトの製品注文明細品目の id パラメーターがペイロードにありません。 * 無効なペイロード:製品仕様が存在しません :製品注文明細品目の製品仕様が無効です。 * 無効なペイロード:プロダクトインベントリが存在しません : 変更指示 (アクション = 変更) で、アイテムの数量が在庫数量を上回っています。 * 無効なペイロード:製品インベントリ ID がありません: 変更注文で、ペイロードに product.id がありません。 * 無効なペイロード:販売済み製品は非アクティブです :変更指示で、ペイロードに指定された製品が非アクティブです。 * 無効なペイロード:relatedParty がありません :関係者オブジェクトがペイロードにありません。 * 顧客アカウントまたはコンシューマーがありません: 関係者顧客またはコンシューマーオブジェクトがペイロードにありません。 * 無効なペイロード:コンシューマーが存在しません :指定された関係者コンシューマーが ServiceNow インスタンスに存在しません。 * 無効なペイロード:顧客アカウントが存在しません :指定された関係者顧客が ServiceNow インスタンスに存在しません。 * 無効なペイロード:注文の作成に失敗しました。 要求された注文を作成できません。 * 注文通貨の実行中の改訂はサポートされていません :注文の作成後に orderCurrency パラメーターを更新することはできません。 * この注文はまだ顧客注文テーブルで作成されていません。詳細については、受信キューでチェックインしてください。 -- 指定された注文 ID が顧客注文テーブルにありません。 * 注文のフルフィルメントタイプが「配送」ではないため、パッチ要求を作成できません。 -- パッチ要求は、配送以外の履行タイプの注文に対して行われました。 {#tmf_prod_order-GET-ord-productOrder-id__ul_g2v_rzm_t4b} | [表 : 24. ステータスコード] {#tmf_prod_order-GET-ord-productOrder-id__table_xfv_2vk_5rb} ### 応答本文のパラメーター (JSON) {#tmf_prod_order-GET-ord-productOrder-id__section_b1v_xpk_5rb} {#tmf_prod_order-GET-ord-productOrder-id__table_c1v_xpk_5rb__entry__2}{#tmf_prod_order-GET-ord-productOrder-id__d3728e1758}{#tmf_prod_order-GET-ord-productOrder-id__externalProdInvId-resp-descr} | 名前 | 説明 | |-|-| | チャネル | 製品の販売に使用するチャネルのリスト。 データタイプ：オブジェクトのアレイ "channel": [ { "id": "String", "name": "String" } ] | | channel.id | 関連製品の販売に使用するチャネルの一意の識別子。 データタイプ：文字列 | | channel.name | 関連製品の販売に使用するチャネルの名前。 データタイプ：文字列 | | committedDueDate | 注文に対してアクションを実行する必要がある日時。 この値は、各注文品目の committedDueDate 値と同じかそれ以降にする必要があります。 データタイプ：文字列 | | externalId | 発注書番号などの顧客注文の外部識別子。 データタイプ：文字列 | | href | 製品注文レコードへの相対リンク。 データタイプ：文字列 | | ID | この要求に対して更新された顧客注文のSys_id。 データタイプ：文字列 | | 注意 | 注文時に顧客が行った追加のメモのリスト。 データタイプ：オブジェクトのアレイ "note": [ { "text": "String" } ] | | note.text | 注文時に顧客が行った追加のメモ/コメント。 データタイプ：文字列 | | orderCurrency | 注文と注文明細品目の通貨コード。 データタイプ：文字列 | | 製品注文アイテム | 製品注文とそれに関連するアクションに関連付けられたアイテムを説明するリスト。 データタイプ：オブジェクトのアレイ "productOrderItem:" [ { "action": "String", "committedDueDate": "String", "externalProductInventory": [Array], "id": "String", "itemPrice": [Array], "product": {Object}, "productOffering": {Object}, "productOrderItemReleationship": [Array], "quantity": Number, "state": "String", "@type": "String" } ] | | productOrderItem.action | 製品に対して実行するアクション。可能なアクションは、sn_ind_tmt_orm_order_line_itemテーブルのアクション辞書エントリの \[選択リスト\] タブで定義されます。 データタイプ：文字列 | | productOrderItem.actionReason | 注文明細品目を追加する理由。 データタイプ：文字列 格納場所:sn_ind_tmt_orm_order_line_itemテーブルのaction_reasonフィールド。 | | productOrderItem.committedDueDate | 注文品目に対してアクションを実行する必要がある日時。 データタイプ：文字列 | | productOrderItem.externalProductInventory | 注文に対して作成された製品在庫にマッピングする外部 ID のリスト。 データタイプ：オブジェクトのアレイ "externalProductInventory": [ { "externalProductInventoryId": "String" } ] 注: 以前は、既に存在する外部製品インベントリ ID を使用して PATCH 注文を作成すると、操作が中断され、エラーが返されていました。Xanaduリリースでは、既存の外部プロダクトインベントリ ID が指定されていて、エラーがスローされない場合、このパラメーターは単純に無視されます。 | | productOrderItem.externalProductInventory.externalProductInventoryId | 製品インベントリにマッピングされた外部 ID。 データタイプ：文字列 | | productOrderItem.id | 品目の一意の識別子。注文明細品目 \[sn_ind_tmt_orm_order_line_item\] テーブルの sn_ind_tmt_orm_external_id フィールドにあります。 データタイプ：文字列 | | productOrderItem.itemPrice | 製品に関連付けられた価格を説明するリスト。 データタイプ：オブジェクトのアレイ "itemPrice": [ { "price": {Object}, "priceType": "String", "recurringChargePeriod": "String" } ] | | productOrderItem.itemPrice.price | 関連製品の価格の説明。 データタイプ: オブジェクト "price": { "taxIncludedAmount": {Object} } | | productOrderItem.itemPrice.price.taxIncludeAmount | 税を含む関連製品の価格の説明。 データタイプ: オブジェクト "taxIncludedAmount": { "unit": "String", "value": Number } | | productOrderItem.itemPrice.price.taxIncludeAmount.unit | 価格を表す通貨コード。 データタイプ：文字列 | | productOrderItem.itemPrice.price.taxIncludeAmount.value | 製品の価格 (税込み)。 データタイプ：数値 | | productOrderItem.itemPrice.priceType | アイテム価格のタイプ (繰り返しまたは非繰り返し)。 データタイプ：文字列 | | productOrderItem.itemPrice.recurringChargePeriod | 価格が繰り返し発生する場合は、 月などの繰り返し期間。 データタイプ：文字列 | | productOrderItem.product | 顧客が購入した製品のインスタンス詳細の説明。 データタイプ: オブジェクト "product": { "id": "String", "place": {Object}, "productCharacteristic": [Array], "productSpecification": {Object}, "relatedParty": {Object}, "@type": "String" } | | productOrderItem.product.id | 販売された製品の一意の識別子。製品インベントリ \[sn_ind_tmt_orm_product_inventory\] テーブルのsys_idまたはsn_ind_tmt_orm_external_idフィールドにあります。 データタイプ：文字列 | | productOrderItem.product.place | 製品を設置する場所のマップ。 データタイプ: オブジェクト "place": { "id": "String", "@type": "String" } | | productOrderItem.product.place.id | 場所 \[cmn_location\] テーブル内の関連する場所レコードのSys_id。製品注文アイテムに対して ( productOrderItem.action パラメーターを使用して) 変更アクションを使用する場合、要求を新しい場所sys_id更新すると、注文は変更されず、新しい場所で履行される移動オーダーが作成されます。 データタイプ：文字列 | | productOrderItem.product.productCharacteristic | 関連製品の特性のリスト。 データタイプ：オブジェクトのアレイ "productCharacteristic": [ { "name": "String", "previousValue": "String", "value": "String", "valueType": "String" } ] | | productOrderItem.product.productCharacteristic.name | 製品に関連付ける特性レコードの名前。特性 \[sn_prd_pm_characteristic\] テーブルにあります。 データタイプ：文字列 | | productOrderItem.product.productCharacteristic.previousValue | 更新が変更指示用である場合の以前の特性オプションの値。productOrderItem.actionパラメーターが add 以外の場合、要求は変更指示です。特性オプション値の詳細については、「 [Create product characteristics and characteristic options](https://www.servicenow.com/docs/access?context=som-product-config-add-characteristics&version=australia&pubname=australia-order-management&ft:locale=en-US)」を参照してください。 データタイプ：文字列 | | productOrderItem.product.productCharacteristic.value | 製品に関連付けられた特性オプション値。特性オプション値の詳細については、「 [Create product characteristics and characteristic options](https://www.servicenow.com/docs/access?context=som-product-config-add-characteristics&version=australia&pubname=australia-order-management&ft:locale=en-US)」を参照してください。 データタイプ：文字列 | | productOrderItem.product.productSpecification | 製品に関連付けられた製品仕様の説明。 データタイプ: オブジェクト "productSpecification:" { "id": "String", "internalId": "String", "internalVersion": "String", "name": "String", "version": "String", "@type": "String" } | | productOrderItem.product.productSpecification.id | 製品仕様のInitial_versionまたはexternal_id。initial_versionは仕様の最初のバージョンのsys_idです。製品仕様 \[sn_prd_pm_product_specification\] テーブルの \[sys_id\] または \[external_id\] フィールドにあります。 データタイプ：文字列 | | productOrderItem.product.productSpecification.internalId | 製品仕様の初期バージョン。初期バージョンは、仕様の最初のバージョンのsys_idです。 データタイプ：文字列 表:製品仕様 \[sn_prd_pm_product_specification\] | | productOrderItem.product.productSpecification.internalVersion | 製品仕様のバージョン。 データタイプ：文字列 テーブル:製品仕様 \[sn_prd_pm_product_specification\] テーブルのバージョンフィールド。 | | productOrderItem.product.productSpecification.name | 製品仕様の名前。製品仕様 \[sn_prd_pm_product_specification\] テーブルにあります。 データタイプ：文字列 | | productOrderItem.product.productSpecification.version | 製品仕様の外部バージョン。 データタイプ：文字列 テーブル:製品仕様 \[sn_prd_pm_product_specification\] テーブルの external_version フィールド。 | | productOrderItem.product.productSpecification.@type | TMF Open API 標準の一部です。この値は常に ProductSpecificationRef です。この情報は保存されません。 データタイプ：文字列 | | productOrderItem.product.relatedParty | 品目の連絡先のリスト。 データタイプ：オブジェクトのアレイ "relatedParty": [ { "email": "String", "firstName": "String", "id": "String", "lastName": "String", "phone": "String", "@referredType": "String", "@type": "String" } ] | | productOrderItem.product.relatedParty.email | 連絡先のメールアドレス。 データタイプ：文字列 | | productOrderItem.product.relatedParty.firstName | 連絡先の名。 データタイプ：文字列 | | productOrderItem.product.relatedParty.id | 注文品目に関連付けられた品目連絡先のSys_id。注文明細品目連絡先 \[sn_ind_tmt_orm_order_line_item_contact\] テーブルにあります。 データタイプ：文字列 | | productOrderItem.product.relatedParty.lastName | 連絡先の名前 (姓)。 データタイプ：文字列 | | productOrderItem.product.relatedParty.phone | 連絡先の勤務先電話番号。 データタイプ：文字列 | | productOrderItem.product.relatedParty.@referredType | 顧客のタイプ。 可能な値:OrderLineItemContact データタイプ：文字列 | | productOrderItem.product.relatedParty.@type | TMF Open API 標準の一部です。注文明細品目の連絡先の注釈。この値は常に RelatedParty です。この情報は保存されません。 データタイプ：文字列 | | productOrderItem.product.@type | TMF Open API 標準の一部です。製品の注釈。この値は常に Product です。この情報は保存されません。 データタイプ：文字列 | | productOrderItem.productOffering | 製品に関連付けられた製品オファリングの説明。 データタイプ: オブジェクト "productOffering:" { "id": "String", "internalId": "String", "internalVersion": "String", "name": "String", "version": "String" } | | productOrderItem.productOffering.id | 製品オファリングのInitial_versionまたはexternal_id。initial_versionは、オファリングの最初のバージョンのsys_idです。製品オファリング \[sn_prd_pm_product_offering\] テーブルの sys_id または external_id フィールドにあります。 データタイプ：文字列 | | productOrderItem.productOffering.internalId | 製品オファリングの初期バージョン。初期バージョンは、オファリングの最初のバージョンのsys_idです。 データタイプ：文字列 テーブル:製品オファリング \[sn_prd_pm_product_offering\] | | productOrderItem.productOffering.internalVersion | 製品オファリングのバージョン。 データタイプ：文字列 テーブル:製品オファリング \[sn_prd_pm_product_offering\] テーブル、フィールドバージョン。 | | productOrderItem.productOffering.name | 製品オファリングの名前。製品オファリング \[sn_prd_pm_product_offering\] テーブルにあります。 データタイプ：文字列 | | productOrderItem.productOffering.version | 製品オファリングの外部バージョン。 データタイプ：文字列 テーブル:製品オファリング \[sn_prd_pm_product_offering\] テーブルの \[external_version\] フィールド。 | | productOrderItem.productOrderItemRelationship | 注文品目間の関係のリスト。 データタイプ：オブジェクトのアレイ "productOrderItemRelationship": [ { "id": "String", "relationshipType": "String" } ] | | productOrderItem.productOrderItemRelationship.id | 関連品目の一意の識別子。注文明細品目 \[sn_ind_tmt_orm_order_line_item\] テーブルの sn_ind_tmt_orm_external_id フィールドにあります。 データタイプ：文字列 | | productOrderItem.productOrderItemRelationship.relationshipType | 2 つの品目間の関係のタイプ。この情報は、関係階層を識別するために使用されます。 データタイプ：文字列 | | productOrderItem.quantity | 注文する関連アイテムの数。 データタイプ：数値 | | productOrderItem.state | 製品注文アイテムの現在のステータス。 データタイプ：文字列 | | productOrderItem.@type | TMF Open API 標準の一部です。製品の注釈。この値は常に ProductOrderItem です。この情報は保存されません。 データタイプ：文字列 | | 関連パーティー | 注文の連絡先のリスト。各連絡先はアレイ内のオブジェクトです。顧客アカウントまたはコンシューマーアカウント情報を含むアイテムを少なくとも 1 つリストする必要があります。 データタイプ：オブジェクトのアレイ "relatedParty": [ { "id": "String", "name": "String", "@referredType": "String", "@type": "String" } ] | | relatedParty.id | 注文に関連付けられたアカウント、顧客連絡先、またはコンシューマーのSys_idまたはexternal_id。アカウント \[customer_account\]、連絡先 \[customer_contact\] テーブル、またはコンシューマー \[csm_consumer\] テーブルにあります。 データタイプ：文字列 | | relatedParty.name | アカウント、顧客、またはコンシューマーの名前。 データタイプ：文字列 | | relatedParty.type | 顧客のタイプ。 可能な値： * コンシューマー * 顧客 * 顧客連絡先 {#tmf_prod_order-GET-ord-productOrder-id__d3728e2631} データタイプ：文字列 | | requestedCompletionDate | 顧客が要求した配送日。 データタイプ：文字列 | | requestedStartDate | 顧客が要求した注文開始日。 データタイプ：文字列 | | 状況 | 注文の現在のステータス。 データタイプ：文字列 | | @type | TMF Open API 標準の一部です。製品の注釈。この値は常に ProductOrder です。この情報は保存されません。 データタイプ：文字列 | [ ] {#tmf_prod_order-GET-ord-productOrder-id__table_c1v_xpk_5rb} ### cURL 要求 {#tmf_prod_order-GET-ord-productOrder-id__example_jsc_1dc_vrb} この例では、ID 8d75939453126010a795ddeeff7b126a に関連付けられた指定された製品注文を取得します。 curl -X GET "https://instance.service-now.com/api/sn_ind_tmt_orm/order/productOrder/8d75939453126010a795ddeeff7b126a" \ -H "Accept: application/json" \ -H "Content-Type: application/json" \ -u "username":"password" \ -d { "channel": [ { "id": "1", "name": "Agent Assist" } ] } 応答本文。 { "id": "8d75939453126010a795ddeeff7b126a", "href": "/api/sn_ind_tmt_orm/order/productOrder/8d75939453126010a795ddeeff7b126a", "expectedCompletionDate": "2021-05-02T08:13:59.000Z", "requestedCompletionDate": "2021-05-02T08:13:59.000Z", "requestedStartDate": "2020-05-03T08:13:59.000Z", "externalId": "PO-456", "orderCurrency": "USD", "channel": [ { "id": "1", "name": "Agent Assist" } ], "note": [ { "author": "System Administrator", "date": "2021-02-25T14:22:07.000Z", "text": "This is a TMF product order illustration no 2" }, { "author": "System Administrator", "date": "2021-02-25T14:22:06.000Z", "text": "This is a TMF product order illustration" } ], "productOrderItem": [ { "id": "POI130", "ponr": "false", "quantity": 1, "action": "add", "actionReason": "adding service package OLI", "itemPrice": [ { "priceType": "recurring", "price": { "taxIncludedAmount": { "unit": "USD", "value": 20 } } }, { "priceType": "nonRecurring", "price": { "taxIncludedAmount": { "unit": "INR", "value": 0 } } } ], "product": { "@type": "Product", "productCharacteristic": [ { "name": "Security Type", "valueType": "Choice", "value": "Base", "previousValue": "" } ], "productSpecification": { "id": "a6514bd3534560102f18ddeeff7b1247", "name": "SD-WAN Security", "version": "v1", "internalVersion": "1", "internalId": "a6514bd3534560102f18ddeeff7b1247", "@type": "ProductSpecificationRef" }, "relatedParty": [ { "id": "4175939453126010a795ddeeff7b127d", "name": "John Smith", "email": "abc2@example.com", "phone": "32456768", "@type": "RelatedParty", "@referredType": "OrderLineItemContact" }, { "id": "c175939453126010a795ddeeff7b127c", "name": "Joe Doe", "email": "abc@example.com", "phone": "1234567890", "@type": "RelatedParty", "@referredType": "OrderLineItemContact" } ] }, "productOffering": { "id": "69017a0f536520103b6bddeeff7b127d", "name": "Premium SD-WAN Offering", "version": "v1", "internalId": "69017a0f536520103b6bddeeff7b127d", "internalVersion": "1" }, "productOrderItemRelationship": [ { "id": "POI100", "relationshipType": "HasParent" } ], "state": "in_progress", "version": "1", "@type": "ProductOrderItem" }, { "id": "POI100", "ponr": "false", "quantity": 1, "action": "add", "itemPrice": [ { "priceType": "recurring", "price": { "taxIncludedAmount": { "unit": "INR", "value": 0 } } }, { "priceType": "nonRecurring", "price": { "taxIncludedAmount": { "unit": "INR", "value": 0 } } } ], "product": { "@type": "Product", "productSpecification": { "id": "cfe5ef6a53702010cd6dddeeff7b12f6", "name": "SD-WAN Service Package", "version": "v1", "internalVersion": "1", "internalId": "cfe5ef6a53702010cd6dddeeff7b12f6", "@type": "ProductSpecificationRef" } }, "productOffering": { "id": "69017a0f536520103b6bddeeff7b127d", "name": "Premium SD-WAN Offering", "version": "v1", "internalId": "69017a0f536520103b6bddeeff7b127d", "internalVersion": "1" }, "productOrderItemRelationship": [ { "id": "POI130", "relationshipType": "HasChild" }, { "id": "POI120", "relationshipType": "HasChild" }, { "id": "POI110", "relationshipType": "HasChild" } ], "state": "in_progress", "version": "1", "@type": "ProductOrderItem" }, { "id": "POI120", "ponr": "false", "quantity": 1, "action": "add", "actionReason": "adding service package OLI", "itemPrice": [ { "priceType": "recurring", "price": { "taxIncludedAmount": { "unit": "USD", "value": 20 } } }, { "priceType": "nonRecurring", "price": { "taxIncludedAmount": { "unit": "INR", "value": 0 } } } ], "product": { "@type": "Product", "productCharacteristic": [ { "name": "CPE Type", "valueType": "Choice", "value": "Physical", "previousValue": "" }, { "name": "WAN Optimization", "valueType": "Choice", "value": "Advance", "previousValue": "" }, { "name": "Routing", "valueType": "Choice", "value": "Premium", "previousValue": "" }, { "name": "CPE Model", "valueType": "Choice", "value": "ASR", "previousValue": "" } ], "productSpecification": { "id": "39b627aa53702010cd6dddeeff7b1202", "name": "SD-WAN Edge Device", "version": "v1", "internalVersion": "1", "internalId": "39b627aa53702010cd6dddeeff7b1202", "@type": "ProductSpecificationRef" } }, "productOffering": { "id": "69017a0f536520103b6bddeeff7b127d", "name": "Premium SD-WAN Offering", "version": "v1", "internalVersion": "1", "internalId": "69017a0f536520103b6bddeeff7b127d" }, "productOrderItemRelationship": [ { "id": "POI100", "relationshipType": "HasParent" } ], "state": "in_progress", "version": "1", "@type": "ProductOrderItem" }, { "id": "POI110", "ponr": "false", "quantity": 1, "action": "add", "actionReason":"adding service package OLI", "itemPrice": [ { "priceType": "recurring", "price": { "taxIncludedAmount": { "unit": "INR", "value": 0 } } }, { "priceType": "nonRecurring", "price": { "taxIncludedAmount": { "unit": "USD", "value": 5 } } } ], "product": { "@type": "Product", "productCharacteristic": [ { "name": "Tenancy", "valueType": "Choice", "value": "Base (10 site)", "previousValue": "" } ], "productSpecification": { "id": "216663aa53702010cd6dddeeff7b12b5", "name": "SD-WAN Controller", "version": "v1", "internalVersion": "1", "internalId": "216663aa53702010cd6dddeeff7b12b5", "@type": "ProductSpecificationRef" }, "place": { "id": "25ab9c4d0a0a0bb300f7dabdc0ca7c1c", "@type": "Place" } }, "productOffering": { "id": "69017a0f536520103b6bddeeff7b127d", "name": "Premium SD-WAN Offering", "version": "v1", "internalId": "69017a0f536520103b6bddeeff7b127d", "internalVersion": "1" }, "productOrderItemRelationship": [ { "id": "POI100", "relationshipType": "HasParent" } ], "state": "in_progress", "version": "1", "@type": "ProductOrderItem" } ], "relatedParty": [ { "id": "eaf68911c35420105252716b7d40ddde", "name": "Sally Thomas", "@type": "RelatedParty", "@referredType": "CustomerContact" }, { "id": "ffc68911c35420105252716b7d40dd55", "name": "Funco Intl", "@type": "RelatedParty", "@referredType": "Customer" }, { "id": "59f16de1c3b67110ff00ed23a140dd9e", "name": "Funco External", "@type": "RelatedParty", "@referredType": "Consumer" } ], "state": "in_progress", "@type": "ProductOrder" } ## 製品注文オープン API - PATCH /sn_ind_tmt_orm/order/productOrder/{id} {#ariaid-title6} 指定された顧客注文を更新します。 ### URL 形式 デフォルト URL: /api/sn_ind_tmt_orm/order/productOrder/{id} ### サポートされている要求パラメーター {#tmf_prod_order-PATCH-ord-productOrder-id__entry__2} | 名前 | 説明 | |-|-| | ID | 更新する顧客注文のSys_id。 データタイプ：文字列 テーブル:顧客注文 \[sn_ind_tmt_orm_order\] | [表 : 25. パスパラメーター] {#tmf_prod_order-PATCH-ord-productOrder-id__entry__6} | 名前 | 説明 | |-|-| | なし | | [表 : 26. クエリパラメーター] {#tmf_prod_order-PATCH-ord-productOrder-id__id_vk2_p5n_t4b__entry__2}{#tmf_prod_order-PATCH-ord-productOrder-id__type-entry-tmf622}{#tmf_prod_order-PATCH-ord-productOrder-id__channel-ph-tmf622}{#tmf_prod_order-PATCH-ord-productOrder-id__channel_id-ph-tmf622}{#tmf_prod_order-PATCH-ord-productOrder-id__channel_name-ph-tmf622}{#tmf_prod_order-PATCH-ord-productOrder-id__due-date-PATCH}{#tmf_prod_order-PATCH-ord-productOrder-id__externalId-ph-tmf622}{#tmf_prod_order-PATCH-ord-productOrder-id__tmf622-response-externalSystem}{#tmf_prod_order-PATCH-ord-productOrder-id__note-ph-tmf622}{#tmf_prod_order-PATCH-ord-productOrder-id__note_text-ph-tmf622}{#tmf_prod_order-PATCH-ord-productOrder-id__prodOrdItem-ph-tmf622}{#tmf_prod_order-PATCH-ord-productOrder-id__prodOrdItem_type-entry-tmf622}{#tmf_prod_order-PATCH-ord-productOrder-id__prodOrdItem_action-ph-tmf622}{#tmf_prod_order-PATCH-ord-productOrder-id__prodOrdItem_actionReason-response-tmf622}{#tmf_prod_order-PATCH-ord-productOrder-id__due-date-item-PATCH}{#tmf_prod_order-PATCH-ord-productOrder-id__externalProdInvId-decsr}{#tmf_prod_order-PATCH-ord-productOrder-id__externalProdInv-descr-PATCH}{#tmf_prod_order-PATCH-ord-productOrder-id__prodOrdItem_id-ph-tmf622}{#tmf_prod_order-PATCH-ord-productOrder-id__itemPrice-ph-tmf622}{#tmf_prod_order-PATCH-ord-productOrder-id__itemPrice_price-ph-tmf622}{#tmf_prod_order-PATCH-ord-productOrder-id__itemPrice_price_taxIncludedAmt-ph-tmf622}{#tmf_prod_order-PATCH-ord-productOrder-id__itemPrice_price_taxIncludedAmt_unit-ph-tmf622}{#tmf_prod_order-PATCH-ord-productOrder-id__itemPrice_price_taxIncludedAmt_value-ph-tmf622}{#tmf_prod_order-PATCH-ord-productOrder-id__itemPrice_priceType_data_type-p-tmf622}{#tmf_prod_order-PATCH-ord-productOrder-id__itemPrice_recurringChargePeriod_data_type-p-tmf622}{#tmf_prod_order-PATCH-ord-productOrder-id__product-p-tmf622}{#tmf_prod_order-PATCH-ord-productOrder-id__product_type_data_type-p-tmf622}{#tmf_prod_order-PATCH-ord-productOrder-id__product_id-ph-tmf622}{#tmf_prod_order-PATCH-ord-productOrder-id__product_place-ph-tmf622}{#tmf_prod_order-PATCH-ord-productOrder-id__product_place_type_data_type-p-tmf622}{#tmf_prod_order-PATCH-ord-productOrder-id__product_place_id-ph-tmf622}{#tmf_prod_order-PATCH-ord-productOrder-id__prod_prodChar-ph-tmf622}{#tmf_prod_order-PATCH-ord-productOrder-id__prod_prodChar_name-ph-tmf622}{#tmf_prod_order-PATCH-ord-productOrder-id__prod_prodChar_previousValue-ph-tmf622}{#tmf_prod_order-PATCH-ord-productOrder-id__prod_prodChar_value-ph-tmf622}{#tmf_prod_order-PATCH-ord-productOrder-id__prod_prodSpec-ph-tmf622}{#tmf_prod_order-PATCH-ord-productOrder-id__prod_prodSpec_type_data_type-p-tmf622}{#tmf_prod_order-PATCH-ord-productOrder-id__prod_prodSpec_id_data_type-p-tmf622}{#tmf_prod_order-PATCH-ord-productOrder-id__tmf622-response-internalVersion}{#tmf_prod_order-PATCH-ord-productOrder-id__prod_prodSpec_name_data_type-p-tmf622}{#tmf_prod_order-PATCH-ord-productOrder-id__tmf622-response-version}{#tmf_prod_order-PATCH-ord-productOrder-id__prod_relParty-ph-tmf622}{#tmf_prod_order-PATCH-ord-productOrder-id__prod_relParty_refType_data_type-p-tmf622}{#tmf_prod_order-PATCH-ord-productOrder-id__product_relatedParty_type_data_type-row-tmf622}{#tmf_prod_order-PATCH-ord-productOrder-id__prod_relParty_email-ph-tmf622}{#tmf_prod_order-PATCH-ord-productOrder-id__prod_relParty_firstName-ph-tmf622}{#tmf_prod_order-PATCH-ord-productOrder-id__prod_relParty_id-ph-tmf622}{#tmf_prod_order-PATCH-ord-productOrder-id__prod_relParty_lastName-ph-tmf622}{#tmf_prod_order-PATCH-ord-productOrder-id__prod_relParty_phone-ph-tmf622}{#tmf_prod_order-PATCH-ord-productOrder-id__productOffer-ph-tmf622}{#tmf_prod_order-PATCH-ord-productOrder-id__prodOffer_id_data_type-p-tmf622}{#tmf_prod_order-PATCH-ord-productOrder-id__prodOffer_name_data_type-p-tmf622}{#tmf_prod_order-PATCH-ord-productOrder-id__prodOrdItem_quantity-ph-tmf622}{#tmf_prod_order-PATCH-ord-productOrder-id__prodOrderItemRel-ph-tmf622}{#tmf_prod_order-PATCH-ord-productOrder-id__prodOrderItemRel_id-ph-tmf622}{#tmf_prod_order-PATCH-ord-productOrder-id__prodOrderItemRel_relType_data_type-p-tmf622}{#tmf_prod_order-PATCH-ord-productOrder-id__relatedParty-ph-tmf622}{#tmf_prod_order-PATCH-ord-productOrder-id__relatedParty_refType_data_type-p-tmf622}{#tmf_prod_order-PATCH-ord-productOrder-id__relatedParty_type_data_type-p-tmf622}{#tmf_prod_order-PATCH-ord-productOrder-id__relatedParty_id_data_type-p-tmf622}{#tmf_prod_order-PATCH-ord-productOrder-id__relatedParty_name_data_type-p-tmf622}{#tmf_prod_order-PATCH-ord-productOrder-id__requestedCompletionDate-ph-tmf622}{#tmf_prod_order-PATCH-ord-productOrder-id__reqStartDate-ph-tmf622} | 名前 | 説明 | |-|-| | @type | TMF Open API 標準の一部です。製品の注釈。この値は常に ProductOrder です。この情報は保存されません。 データタイプ：文字列 | | チャネル | 製品の販売に使用するチャネルのリスト。 データタイプ：オブジェクトのアレイ{#tmf_prod_order-PATCH-ord-productOrder-id__channel_data_type-p-tmf622} "channel": [ { "id": "String", "name": "String" } ] {#tmf_prod_order-PATCH-ord-productOrder-id__channel_obj_def-codeblock-tmf622} 保存場所:sn_ind_tmt_orm_order | | channel.id | channelパラメーターを使用する場合は必須です。関連製品の販売に使用するチャネルの一意の識別子。 データタイプ：文字列{#tmf_prod_order-PATCH-ord-productOrder-id__channel_id_data_type-p-tmf622} テーブル:流通チャネル \[sn_prd_pm_distribution_channel\] テーブルの external_id フィールド内。 格納場所:sn_ind_tmt_orm_orderテーブルのチャネルフィールド。 デフォルト：空白の文字列 | | channel.name | 関連製品の販売に使用するチャネルの名前。可能なチャネル名は、sn_ind_tmt_orm_orderテーブルのチャネル辞書エントリの \[選択リスト\] タブで定義されます。 データタイプ：文字列{#tmf_prod_order-PATCH-ord-productOrder-id__channel_name_data_type-p-tmf622} デフォルト：空白の文字列 | | committedDueDate | 注文に対してアクションを実行する必要がある日時。 この値は、各注文品目の committedDueDate 値と同じかそれ以降にする必要があります。 注文品目のアクションが 一時停止 または 再開の場合、このパラメーターは更新できません。 データタイプ：文字列 格納場所:sn_ind_tmt_orm_orderテーブルのcommitted_due_dateフィールド。 | | externalId | 顧客注文の一意の識別子。この値は外部システムによって決定されます。 データタイプ：文字列{#tmf_prod_order-PATCH-ord-productOrder-id__externalId_data_type-p-tmf622} 格納場所:sn_ind_tmt_orm_orderテーブルのexternal_idフィールド。 デフォルト：空白の文字列 | | 外部システム | `TMF622` が追加されたサービス注文の外部システム。 たとえば、外部システムが ABC の場合、 externalSystem に `ABC-TMF622` と入力します。 データタイプ:文字列 | | 注意 | 注文時に顧客が行った追加のメモのリスト。 データタイプ：オブジェクトのアレイ{#tmf_prod_order-PATCH-ord-productOrder-id__note_data_type-p-tmf622} "note": [ { "text": "String" } ] {#tmf_prod_order-PATCH-ord-productOrder-id__note-codeblock-tmf622} 保存場所:sn_ind_tmt_orm_order | | note.text | 注文時に顧客が行った追加のメモ/コメント。 データタイプ：文字列{#tmf_prod_order-PATCH-ord-productOrder-id__note_text_data_type-p-tmf622} 格納場所:sn_ind_tmt_orm_orderテーブルのコメントフィールド。 デフォルト：空白の文字列 | | orderCurrency | 注文と注文明細品目の通貨コード。既存の注文の通貨コードの更新はサポートされていません。注文に既に関連付けられている通貨コード以外の値を指定すると、更新が却下されます。 データタイプ：文字列 | | 製品注文アイテム | 製品注文とそれに関連するアクションに関連付けられたアイテムを説明するリスト。 データタイプ：オブジェクトのアレイ{#tmf_prod_order-PATCH-ord-productOrder-id__prodOrdItem_data_type-p-tmf622} "productOrderItem": [ { "action": "String", "actionReason": "String", "committedDueDate": "String", "externalProductInventory": [Array], "id": "String", "itemPrice": [Array], "product": {Object}, "productOffering": {Object}, "productOrderItemRelationship": [Array], "quantity": Number, "revisionOperation": "String", "@type": "String" } ] {#tmf_prod_order-PATCH-ord-productOrder-id__prodOrdItem-codeblock-tmf622} 格納場所:sn_ind_tmt_orm_order_line_item | | productOrderItem.@type | TMF Open API 標準の一部です。製品の注釈。この値は常に ProductOrderItem です。この情報は保存されません。 データタイプ：文字列 | | productOrderItem.action | productOrderItemパラメーターを使用する場合は必須です。製品に対して実行するアクション。可能なアクションは、sn_ind_tmt_orm_order_line_itemテーブルのアクション辞書エントリの \[選択リスト\] タブで定義されます。 可能な値： * 追加 * 変更 注: productOrderItem.product.place.idを介して新しいサービスの場所を含む変更ペイロードを送信すると、移動オーダーとして処理されます。 * delete * 変更なし * 再開 * 停止する {#tmf_prod_order-PATCH-ord-productOrder-id__ul_zwn_nxp_ysb} データタイプ：文字列{#tmf_prod_order-PATCH-ord-productOrder-id__prodOrdItem_action_data_type-p-tmf622} 格納場所:sn_ind_tmt_orm_order_line_itemテーブルのアクションフィールド。 デフォルト:追加 | | productOrderItem.actionReason | 注文明細品目を追加する理由。 データタイプ：文字列 格納場所:sn_ind_tmt_orm_order_line_itemテーブルのaction_reasonフィールド。 | | productOrderItem.committedDueDate | 注文品目に対してアクションを実行する必要がある日時。 アイテムのアクションが 一時停止 または 再開の場合、このパラメーターは更新できません。 データタイプ：文字列 格納場所:sn_ind_tmt_orm_order_line_itemテーブルのcommitted_due_dateフィールド。 | | productOrderItem.externalProductInventory.externalProductInventoryId | 製品インベントリにマッピングする外部 ID。 データタイプ：文字列 格納場所:sn_ind_tmt_orm_order_line_itemテーブルのexternal_inventory_idフィールドとsn_prd_invt_product_inventoryテーブルのsn_prd_invt_external_idフィールド。 | | productOrderItem.externalProductInventory | 注文に対して作成された製品在庫にマッピングする外部 ID のリスト。 データタイプ：オブジェクトのアレイ "externalProductInventory": [ { "externalProductInventoryId": "String" } ] 注: 以前は、既に存在する外部製品インベントリ ID を使用して PATCH 注文を作成すると、操作が中断され、エラーが返されていました。Xanaduリリースでは、既存の外部プロダクトインベントリ ID が指定されていて、エラーがスローされない場合、このパラメーターは単純に無視されます。 | | productOrderItem.id | productOrderItemパラメーターを使用する場合は必須です。品目の一意の識別子。注文明細品目 \[sn_ind_tmt_orm_order_line_item\] テーブルの sn_ind_tmt_orm_external_id フィールドにあります。 データタイプ：文字列{#tmf_prod_order-PATCH-ord-productOrder-id__prodOrdItem_id_data_type-p-tmf622} 格納場所:sn_ind_tmt_orm_order_line_itemテーブルのexternal_idフィールド。 最大長：40 デフォルト：空白の文字列 | | productOrderItem.itemPrice | 製品に関連付けられた価格を説明するリスト。 データタイプ：オブジェクトのアレイ{#tmf_prod_order-PATCH-ord-productOrder-id__itemPrice_data_type-p-tmf622} "itemPrice": [ { "price": {Object}, "priceType": "String", "recurringChargePeriod": "String" } ] {#tmf_prod_order-PATCH-ord-productOrder-id__itemPrice-codeblock-tmf622} 保存場所:sn_ind_tmt_orm_order デフォルト：空白の文字列 | | productOrderItem.itemPrice.price | 関連製品の価格の説明。 データタイプ: オブジェクト{#tmf_prod_order-PATCH-ord-productOrder-id__itemPrice_price_data_type-p-tmf622} "price": { "taxIncludedAmount": {Object} } {#tmf_prod_order-PATCH-ord-productOrder-id__itemPrice_price-codeblock-tmf622} 格納場所:sn_ind_tmt_orm_order_line_item デフォルト：空白の文字列 | | productOrderItem.itemPrice.price.taxIncludedAmount | 税を含む関連製品の価格の説明。 データタイプ: オブジェクト{#tmf_prod_order-PATCH-ord-productOrder-id__itemPrice_price_taxIncludedAmt_data_type-p-tmf622} "taxIncludedAmount": { "unit": "String", "value": Number } {#tmf_prod_order-PATCH-ord-productOrder-id__itemPrice_price_taxIncludedAmt-codeblock-tmf622} 格納場所:sn_ind_tmt_orm_order_line_item | | productOrderItem.itemPrice.price.taxIncludedAmount.unit | 価格を表す通貨コード。 データタイプ：文字列{#tmf_prod_order-PATCH-ord-productOrder-id__itemPrice_price_taxIncludedAmt_unit_data_type-p-tmf622} 格納場所:sn_ind_tmt_orm_order_line_itemテーブルの mrc または nrc フィールド。 | | productOrderItem.itemPrice.price.taxIncludedAmount.value | 製品の価格 (税込み)。 データタイプ：数値{#tmf_prod_order-PATCH-ord-productOrder-id__itemPrice_price_taxIncludedAmt_value_data_type-p-tmf622} 格納場所:sn_ind_tmt_orm_order_line_itemテーブルの mrc または nrc フィールド。 | | productOrderItem.itemPrice.priceType | アイテム価格のタイプ (繰り返しまたは非繰り返し)。 データタイプ：文字列 | | productOrderItem.itemPrice.recurringChargePeriod | 価格が繰り返し発生する場合は、 月などの繰り返し期間。 データタイプ：文字列 | | productOrderItem.product | productOrderItem.actionが変更または削除の場合は必須です。顧客が購入した製品のインスタンス詳細の説明。 データタイプ: オブジェクト{#tmf_prod_order-PATCH-ord-productOrder-id__product_data_type-p-tmf622} "product": { "id": "String", "place": {Object}, "productCharacteristic": [Array], "productSpecification": {Object}, "relatedParty": {Object}, "@type": "String" } {#tmf_prod_order-PATCH-ord-productOrder-id__product-codeblock-tmf622} 格納場所:sn_ind_tmt_orm_order_line_item | | productOrderItem.product.@type | TMF Open API 標準の一部です。製品の注釈。この値は常に Product です。この情報は保存されません。 データタイプ：文字列 | | productOrderItem.product.id | productOrderItem.actionが変更または削除の場合は必須です。販売された製品の一意の識別子。製品インベントリ \[sn_ind_tmt_orm_product_inventory\] テーブルのsys_idまたはsn_ind_tmt_orm_external_idフィールドにあります。 データタイプ：文字列{#tmf_prod_order-PATCH-ord-productOrder-id__product_id_data_type-p-tmf622} デフォルト：空白の文字列 | | productOrderItem.product.place | 製品を設置する場所のマップ。 データタイプ: オブジェクト{#tmf_prod_order-PATCH-ord-productOrder-id__product_place_data_type-p-tmf622} "place": { "id": "String", "@type": "String" } {#tmf_prod_order-PATCH-ord-productOrder-id__product_place-codeblock-tmf622} 格納場所:sn_ind_tmt_orm_order_line_item | | productOrderItem.product.place.@type | TMF Open API 標準の一部です。注文明細品目の連絡先の注釈。この値は常に Place です。この情報は保存されません。 データタイプ：文字列 | | productOrderItem.product.place.id | productOrderItem.product.placeパラメーターを使用する場合は必須です。場所 \[cmn_location\] テーブル内の関連する場所レコードのSys_id。製品注文アイテムに対して ( productOrderItem.action パラメーターを使用して) 変更アクションを使用する場合、要求を新しい場所sys_id更新すると、注文は変更されず、新しい場所で履行される移動オーダーが作成されます。 データタイプ：文字列{#tmf_prod_order-PATCH-ord-productOrder-id__product_place_id_data_type-p-tmf622} 格納場所:sn_ind_tmt_orm_order_line_itemテーブルの場所フィールド。 デフォルト：空白の文字列 | | productOrderItem.product.productCharacteristic | 関連製品の特性のリスト。 データタイプ：オブジェクトのアレイ{#tmf_prod_order-PATCH-ord-productOrder-id__prod_prodChar_data_type-p-tmf622} "productCharacteristic": [ { "name": "String", "previousValue": "String", "value": "String", "valueType": "String" } ] {#tmf_prod_order-PATCH-ord-productOrder-id__prod_prodChar-codeblock-tmf622} 格納場所:sn_ind_tmt_orm_order_characteristic_value | | productOrderItem.product.productCharacteristic.name | 製品に関連付ける特性レコードの名前。特性 \[sn_prd_pm_characteristic\] テーブルにあります。 データタイプ：文字列{#tmf_prod_order-PATCH-ord-productOrder-id__prod_prodChar_name_data_type-p-tmf622} 格納場所:sn_ind_tmt_orm_order_characteristic_valueテーブルの特性フィールド。 デフォルト：空白の文字列 | | productOrderItem.product.productCharacteristic.previousValue | 更新が変更指示用である場合の以前の特性オプションの値。productOrderItem.actionパラメーターが add 以外の場合、要求は変更指示です。特性オプション値の詳細については、「 [Create product characteristics and characteristic options](https://www.servicenow.com/docs/access?context=som-product-config-add-characteristics&version=australia&pubname=australia-order-management&ft:locale=en-US)」を参照してください。 データタイプ：文字列{#tmf_prod_order-PATCH-ord-productOrder-id__prod_prodChar_previousValue_data_type-p-tmf622} 格納場所:sn_ind_tmt_orm_order_characteristic_valueテーブルのprevious_characteristic_option_value。 デフォルト：空白の文字列 | | productOrderItem.product.productCharacteristic.value | 製品に関連付けられた特性オプション値。特性オプション値の詳細については、「 [Create product characteristics and characteristic options](https://www.servicenow.com/docs/access?context=som-product-config-add-characteristics&version=australia&pubname=australia-order-management&ft:locale=en-US)」を参照してください。 データタイプ：文字列{#tmf_prod_order-PATCH-ord-productOrder-id__prod_prodChar_value_data_type-p-tmf622} 格納場所: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 行テキスト * はい/いいえ {#tmf_prod_order-PATCH-ord-productOrder-id__ul_j4j_pjw_xfc} | | productOrderItem.product.productSpecification | 製品に関連付けられた製品仕様の説明。 注: 変更指示 (productOrderItem.action が `変更`) は、 sn_ind_tmt_orm.allowSpecVersionUpdateInChangeOrder システムプロパティの値に基づいて異なる方法で処理されます。このシステムプロパティの値は、製品インベントリが注文に示されているバージョンと異なる場合の注文の処理方法を決定します。 * このシステムプロパティが true (デフォルト) に設定されている場合、製品インベントリは、参照されている製品仕様を変更することによって注文のバージョンに自動的にアップグレードされます。これにより、注文を正常に処理できます。 * このシステムプロパティが false に設定されている場合、製品インベントリが注文に示されているバージョンと異なる場合、バージョンの不一致により注文は失敗します。 {#tmf_prod_order-PATCH-ord-productOrder-id__ul_sgb_q5y_hbc} データタイプ: オブジェクト{#tmf_prod_order-PATCH-ord-productOrder-id__prod_prodSpec_data_type-p-tmf622} "productSpecification": { "id": "String", "internalVersion": "String", "name": "String", "version": "String", "@type": "String" } {#tmf_prod_order-PATCH-ord-productOrder-id__prod_prodSpec-codeblock-tmf622} 格納場所:sn_ind_tmt_orm_order_line_item | | productOrderItem.product.productSpecification.@type | TMF Open API 標準の一部です。この値は常に ProductSpecificationRef です。この情報は保存されません。 データタイプ：文字列 | | productOrderItem.product.productSpecification.id | productOrderItem.product.productSpecificationパラメーターを使用する場合は必須です。製品仕様のInitial_versionまたはexternal_id。initial_versionは仕様の最初のバージョンのsys_idです。製品仕様 \[sn_prd_pm_product_specification\] テーブルの \[sys_id\] または \[external_id\] フィールドにあります。 データタイプ：文字列 | | productOrderItem.product.productSpecification.internalVersion | 製品仕様の内部バージョン。version の値と一致する必要があります。一致しない場合、エラーがスローされます。 データタイプ:文字列 表:製品仕様 \[sn_prd_pm_product_specification\] | | productOrderItem.product.productSpecification.name | 製品仕様の名前。製品仕様 \[sn_prd_pm_product_specification\] テーブルにあります。 データタイプ：文字列 | | productOrderItem.product.productSpecification.version | 製品仕様の外部バージョン。internalVersion の値と一致する必要があります。一致しない場合、エラーがスローされます。 データタイプ:文字列 表:製品仕様 \[sn_prd_pm_product_specification\] | | productOrderItem.product.relatedParty | 品目の連絡先のリスト。 データタイプ：オブジェクトのアレイ{#tmf_prod_order-PATCH-ord-productOrder-id__prod_relParty_data_type-p-tmf622} "relatedParty": [ { "email": "String", "firstName": "String", "id": "String", "lastName": "String", "phone": "String", "@referredType": "String", "@type": "String" } ] {#tmf_prod_order-PATCH-ord-productOrder-id__prod_relParty-codeblock-tmf622} 格納場所:sn_ind_tmt_orm_order_line_item_contact | | productOrderItem.product.relatedParty.@referredType | 顧客のタイプ。 可能な値:OrderLineItemContact{#tmf_prod_order-PATCH-ord-productOrder-id__prod_relParty_refType-p-tmf622} データタイプ：文字列 | | productOrderItem.product.relatedParty.@type | TMF Open API 標準の一部です。注文明細品目の連絡先の注釈。この値は常に RelatedParty です。この情報は保存されません。 データタイプ：文字列 | | productOrderItem.product.relatedParty.email | 連絡先のメールアドレス。 データタイプ：文字列{#tmf_prod_order-PATCH-ord-productOrder-id__prod_relParty_email_data_type-p-tmf622} 格納場所:sn_ind_tmt_orm_order_line_item_contactテーブルのメールフィールド。 デフォルト：空白の文字列 | | productOrderItem.product.relatedParty.firstName | 連絡先の名。 データタイプ：文字列{#tmf_prod_order-PATCH-ord-productOrder-id__prod_relParty_firstName_data_type-p-tmf622} 格納場所:sn_ind_tmt_orm_order_line_item_contactテーブルのfirst_nameフィールド。 デフォルト：空白の文字列 | | productOrderItem.product.relatedParty.id | 注文品目に関連付けられた品目連絡先のSys_id。注文明細品目連絡先 \[sn_ind_tmt_orm_order_line_item_contact\] テーブルにあります。 データタイプ：文字列{#tmf_prod_order-PATCH-ord-productOrder-id__prod_relParty_id_data_type-p-tmf622} 格納場所:sn_ind_tmt_orm_order_line_item_contactテーブルのsys_idフィールド。 デフォルト：空白の文字列 | | productOrderItem.product.relatedParty.lastName | 連絡先の名前 (姓)。 データタイプ：文字列{#tmf_prod_order-PATCH-ord-productOrder-id__prod_relParty_lastName_data_type-p-tmf622} 格納場所:sn_ind_tmt_orm_order_line_item_contactテーブルの lastName フィールド。 デフォルト：空白の文字列 | | productOrderItem.product.relatedParty.phone | 連絡先の勤務先電話番号。 データタイプ：文字列{#tmf_prod_order-PATCH-ord-productOrder-id__prod_relParty_phone_data_type-p-tmf622} 格納場所:sn_ind_tmt_orm_order_line_item_contactテーブルのbusiness_phoneフィールド。 デフォルト：空白の文字列 | | productOrderItem.productOffering | 製品に関連付けられた製品オファリングの説明。 データタイプ: オブジェクト{#tmf_prod_order-PATCH-ord-productOrder-id__prodOffer_data_type-p-tmf622} "productOffering": { "id": "String", "internalVersion": "String", "name": "String", "version": "String" } {#tmf_prod_order-PATCH-ord-productOrder-id__prodOffer-codeblock-tmf622} 格納場所: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 | 注文する関連アイテムの数。 データタイプ：数値{#tmf_prod_order-PATCH-ord-productOrder-id__prodOrdItem_quantity_data_type-p-tmf622} 格納場所:sn_ind_tmt_orm_orderの数量フィールド。 デフォルト値:null | | productOrderItem.productOrderItemRelationship | 注文品目間の関係のリスト。 データタイプ：オブジェクトのアレイ{#tmf_prod_order-PATCH-ord-productOrder-id__prodOrderItemRel_data_type-p-tmf622} "productOrderItemRelationship": [ { "id": "String", "relationshipType": "String" } ] {#tmf_prod_order-PATCH-ord-productOrder-id__prodOrderItemRel-codeblock-tmf622} 格納場所: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 フィールドにあります。 データタイプ：文字列{#tmf_prod_order-PATCH-ord-productOrder-id__prodOrderItemRel_id_data_type-p-tmf622} 格納場所:テーブルのparent_line_itemフィールドthebsn_ind_tmt_orm_order_line_item。 デフォルト：空白の文字列 | | productOrderItem.productOrderItemRelationship.relationshipType | 2 つの品目間の関係のタイプ。この情報は、関係階層を識別するために使用されます。 可能な値： * HasChild * 親がある * 必要 {#tmf_prod_order-PATCH-ord-productOrder-id__ul_yqf_2ty_54b} `HasChild` と `HasParent` は、親子関係に使用されます。\[`必須]` は水平関係に使用されます (品目には別の品目が必要です)。 データタイプ：文字列 | | productOrderItem.quantity | 注文されたアイテムの数。 データタイプ：数値 格納場所:sn_ind_tmt_orm_orderテーブルの数量フィールド。 デフォルト：空白の文字列 | | productOrderItem.revisionOperation | 品目に対して実行する更新のタイプ。この値が空の場合、既存の品目が更新されるか、まだ存在しない場合は新しい品目が追加されます。この値が cancel の場合、品目はキャンセルされます。 データタイプ：文字列 デフォルト：空白の文字列 | | 関連パーティー | 注文の連絡先のリスト。各連絡先はアレイ内のオブジェクトです。顧客アカウントまたはコンシューマーアカウント情報を含むアイテムを少なくとも 1 つリストする必要があります。 データタイプ：オブジェクトのアレイ{#tmf_prod_order-PATCH-ord-productOrder-id__relatedParty_data_type-p-tmf622} "relatedParty": [ { "id": "String", "name": "String", "@referredType": "String", "@type": "String" } ] {#tmf_prod_order-PATCH-ord-productOrder-id__relatedParty-codeblock-tmf622} | | relatedParty.@referredType | 顧客のタイプ。 可能な値： * コンシューマー * 顧客 * 顧客連絡先 {#tmf_prod_order-PATCH-ord-productOrder-id__ul_lcq_jwm_t4b} データタイプ：文字列 | | relatedParty.@type | TMF Open API 標準の一部です。製品の注釈。この値は常に RelatedParty です。この情報は保存されません。 データタイプ：文字列 | | relatedParty.id | 注文に関連付けられたアカウント、顧客連絡先、またはコンシューマーのSys_idまたはexternal_id。アカウント \[customer_account\]、連絡先 \[customer_contact\] テーブル、またはコンシューマー \[csm_consumer\] テーブルにあります。 データタイプ：文字列 | | relatedParty.name | アカウント、顧客、またはコンシューマーの名前。 データタイプ：文字列 | | requestedCompletionDate | 顧客が要求した配送日。 データタイプ：文字列{#tmf_prod_order-PATCH-ord-productOrder-id__reqCompDate_data_type-p-tmf622} 格納場所:sn_ind_tmt_orm_orderテーブルのexpected_end_dateフィールド。 デフォルト：空白の文字列 | | requestedStartDate | 顧客が要求した注文開始日。 データタイプ：文字列{#tmf_prod_order-PATCH-ord-productOrder-id__reqStartDate_data_type-p-tmf622} 格納場所:sn_ind_tmt_orm_orderテーブルのexpected_start_dateフィールド。 デフォルト：空白の文字列 | [表 : 27. 要求本文パラメーター (JSON)] {#tmf_prod_order-PATCH-ord-productOrder-id__id_vk2_p5n_t4b} ### ヘッダー 次の要求ヘッダーと応答ヘッダーは、この HTTP アクションにのみ適用されるか、別の方法でこのアクションに適用されます。REST API で使用される一般的なヘッダーのリストについては、「 [サポートされている REST API ヘッダー」](https://servicenow-prod.fluidtopics.net/lLW_uT5I5_l1aD8yR4Jt9A "REST (REpresentational State Transfer) は、Web 上のコンピューター システム間の標準を提供するシンプルなステートレス アーキテクチャであり、コンピューター システム間の通信を容易にします。")を参照してください。 {#tmf_prod_order-PATCH-ord-productOrder-id__table_omb_dvk_5rb__entry__2}{#tmf_prod_order-PATCH-ord-productOrder-id__accept-JSON-only-entry-RESTAPI}{#tmf_prod_order-PATCH-ord-productOrder-id__content_type-JSON-only-entry-RESTAPI} | ヘッダー | 説明 | |-|-| | 承認 | 応答本文のデータフォーマット。application/json のみをサポートします。 | | Content-Type | 要求本文のデータ形式。application/json のみをサポートします。 | [表 : 28. 要求ヘッダー] {#tmf_prod_order-PATCH-ord-productOrder-id__table_omb_dvk_5rb} {#tmf_prod_order-PATCH-ord-productOrder-id__table_tzy_thy_ksb__entry__2} | ヘッダー | 説明 | |-|-| | Content-Type | 応答本文のデータフォーマット。application/json のみをサポートします。 | [表 : 29. 応答ヘッダー] {#tmf_prod_order-PATCH-ord-productOrder-id__table_tzy_thy_ksb} ### ステータスコード この HTTP アクションには、次のステータスコードが適用されます。REST API で使用される可能性のあるステータスコードのリストについては、「 [REST API HTTP 応答コード](https://servicenow-prod.fluidtopics.net/lLW_uT5I5_l1aD8yR4Jt9A "REST (REpresentational State Transfer) は、Web 上のコンピューター システム間の標準を提供するシンプルなステートレス アーキテクチャであり、コンピューター システム間の通信を容易にします。")」を参照してください。 {#tmf_prod_order-PATCH-ord-productOrder-id__table_xfv_2vk_5rb__entry__2} | ステータスコード | 説明 | |-|-| | 201 | 成功。 特性または特性オプション情報に問題がある場合、エンドポイントは関連する顧客発注書明細レコードの作業メモフィールドに次のコメントを保存します。 * 次の注文品目特性が存在しません。注文を承認する前に、仕様\を確認し、注文明細品目の特性と特性オプションを修正してください。 * 注文アイテム特性:特性値\を持つ\は無効です。注文を承認する前に特性値を修正してください。 {#tmf_prod_order-PATCH-ord-productOrder-id__ul_xtx_xym_t4b} | | 400 | 要求が正しくありません。以下のいずれかの理由が考えられます。 * 無効なペイロード:要求本文がありません:ペ イロードが要求本文で渡されませんでした。 * 無効なペイロード:productOrderItem がありません :製品の注文明細品目オブジェクトまたは JSON がありません。 * 無効なペイロード:productOrderItem id がありません :ペイロードの製品注文明細品目に id パラメーターがありません。 * 無効なペイロード:productOrderItem アクションがありません: ペイロードの製品注文明細品目に action パラメーターがありません。 * 無効なペイロード:productOrderItem productOffering がありません :ペイロードの製品注文明細品目に製品オファリングオブジェクトまたは JSON がありません。 * 無効なペイロード:productOffering id がありません :ペイロード内の製品オファリングオブジェクトの製品注文明細品目に id パラメーターがありません。 * 無効なペイロード:製品オファリングが存在しません :製品注文明細品目の製品オファリングが無効です。 * 無効なペイロード:productOrderItem 製品がありません: 製品注文明細品目の製品オブジェクトまたは JSON がペイロードにありません。 * 無効なペイロード:製品 productSpecification がありません :製品注文明細品目の製品仕様オブジェクトまたは JSON がペイロードにありません。 * 無効なペイロード:productSpecification id がありません :製品仕様オブジェクトの製品注文明細品目の id パラメーターがペイロードにありません。 * 無効なペイロード:製品仕様が存在しません :製品注文明細品目の製品仕様が無効です。 * 無効なペイロード:プロダクトインベントリが存在しません : 変更指示 (アクション = 変更) で、アイテムの数量が在庫数量を上回っています。 * 無効なペイロード:製品インベントリ ID がありません: 変更注文で、ペイロードに product.id がありません。 * 無効なペイロード:販売済み製品は非アクティブです :変更指示で、ペイロードに指定された製品が非アクティブです。 * 無効なペイロード:relatedParty がありません :関係者オブジェクトがペイロードにありません。 * 顧客アカウントまたはコンシューマーがありません: 関係者顧客またはコンシューマーオブジェクトがペイロードにありません。 * 無効なペイロード:コンシューマーが存在しません :指定された関係者コンシューマーが ServiceNow インスタンスに存在しません。 * 無効なペイロード:顧客アカウントが存在しません :指定された関係者顧客が ServiceNow インスタンスに存在しません。 * 無効なペイロード:注文の作成に失敗しました。 要求された注文を作成できません。 * 注文通貨の実行中の改訂はサポートされていません :注文の作成後に orderCurrency パラメーターを更新することはできません。 * この注文はまだ顧客注文テーブルで作成されていません。詳細については、受信キューでチェックインしてください。 -- 指定された注文 ID が顧客注文テーブルにありません。 * 注文のフルフィルメントタイプが「配送」ではないため、パッチ要求を作成できません。 -- パッチ要求は、配送以外の履行タイプの注文に対して行われました。 {#tmf_prod_order-PATCH-ord-productOrder-id__ul_g2v_rzm_t4b} | [表 : 30. ステータスコード] {#tmf_prod_order-PATCH-ord-productOrder-id__table_xfv_2vk_5rb} ### 応答本文のパラメーター (JSON) {#tmf_prod_order-PATCH-ord-productOrder-id__section_b1v_xpk_5rb} {#tmf_prod_order-PATCH-ord-productOrder-id__table_c1v_xpk_5rb__entry__2}{#tmf_prod_order-PATCH-ord-productOrder-id__d3728e1758}{#tmf_prod_order-PATCH-ord-productOrder-id__externalProdInvId-resp-descr} | 名前 | 説明 | |-|-| | チャネル | 製品の販売に使用するチャネルのリスト。 データタイプ：オブジェクトのアレイ "channel": [ { "id": "String", "name": "String" } ] | | channel.id | 関連製品の販売に使用するチャネルの一意の識別子。 データタイプ：文字列 | | channel.name | 関連製品の販売に使用するチャネルの名前。 データタイプ：文字列 | | committedDueDate | 注文に対してアクションを実行する必要がある日時。 この値は、各注文品目の committedDueDate 値と同じかそれ以降にする必要があります。 データタイプ：文字列 | | externalId | 発注書番号などの顧客注文の外部識別子。 データタイプ：文字列 | | href | 製品注文レコードへの相対リンク。 データタイプ：文字列 | | ID | この要求に対して更新された顧客注文のSys_id。 データタイプ：文字列 | | 注意 | 注文時に顧客が行った追加のメモのリスト。 データタイプ：オブジェクトのアレイ "note": [ { "text": "String" } ] | | note.text | 注文時に顧客が行った追加のメモ/コメント。 データタイプ：文字列 | | orderCurrency | 注文と注文明細品目の通貨コード。 データタイプ：文字列 | | 製品注文アイテム | 製品注文とそれに関連するアクションに関連付けられたアイテムを説明するリスト。 データタイプ：オブジェクトのアレイ "productOrderItem:" [ { "action": "String", "committedDueDate": "String", "externalProductInventory": [Array], "id": "String", "itemPrice": [Array], "product": {Object}, "productOffering": {Object}, "productOrderItemReleationship": [Array], "quantity": Number, "state": "String", "@type": "String" } ] | | productOrderItem.action | 製品に対して実行するアクション。可能なアクションは、sn_ind_tmt_orm_order_line_itemテーブルのアクション辞書エントリの \[選択リスト\] タブで定義されます。 データタイプ：文字列 | | productOrderItem.actionReason | 注文明細品目を追加する理由。 データタイプ：文字列 格納場所:sn_ind_tmt_orm_order_line_itemテーブルのaction_reasonフィールド。 | | productOrderItem.committedDueDate | 注文品目に対してアクションを実行する必要がある日時。 データタイプ：文字列 | | productOrderItem.externalProductInventory | 注文に対して作成された製品在庫にマッピングする外部 ID のリスト。 データタイプ：オブジェクトのアレイ "externalProductInventory": [ { "externalProductInventoryId": "String" } ] 注: 以前は、既に存在する外部製品インベントリ ID を使用して PATCH 注文を作成すると、操作が中断され、エラーが返されていました。Xanaduリリースでは、既存の外部プロダクトインベントリ ID が指定されていて、エラーがスローされない場合、このパラメーターは単純に無視されます。 | | productOrderItem.externalProductInventory.externalProductInventoryId | 製品インベントリにマッピングされた外部 ID。 データタイプ：文字列 | | productOrderItem.id | 品目の一意の識別子。注文明細品目 \[sn_ind_tmt_orm_order_line_item\] テーブルの sn_ind_tmt_orm_external_id フィールドにあります。 データタイプ：文字列 | | productOrderItem.itemPrice | 製品に関連付けられた価格を説明するリスト。 データタイプ：オブジェクトのアレイ "itemPrice": [ { "price": {Object}, "priceType": "String", "recurringChargePeriod": "String" } ] | | productOrderItem.itemPrice.price | 関連製品の価格の説明。 データタイプ: オブジェクト "price": { "taxIncludedAmount": {Object} } | | productOrderItem.itemPrice.price.taxIncludeAmount | 税を含む関連製品の価格の説明。 データタイプ: オブジェクト "taxIncludedAmount": { "unit": "String", "value": Number } | | productOrderItem.itemPrice.price.taxIncludeAmount.unit | 価格を表す通貨コード。 データタイプ：文字列 | | productOrderItem.itemPrice.price.taxIncludeAmount.value | 製品の価格 (税込み)。 データタイプ：数値 | | productOrderItem.itemPrice.priceType | アイテム価格のタイプ (繰り返しまたは非繰り返し)。 データタイプ：文字列 | | productOrderItem.itemPrice.recurringChargePeriod | 価格が繰り返し発生する場合は、 月などの繰り返し期間。 データタイプ：文字列 | | productOrderItem.product | 顧客が購入した製品のインスタンス詳細の説明。 データタイプ: オブジェクト "product": { "id": "String", "place": {Object}, "productCharacteristic": [Array], "productSpecification": {Object}, "relatedParty": {Object}, "@type": "String" } | | productOrderItem.product.id | 販売された製品の一意の識別子。製品インベントリ \[sn_ind_tmt_orm_product_inventory\] テーブルのsys_idまたはsn_ind_tmt_orm_external_idフィールドにあります。 データタイプ：文字列 | | productOrderItem.product.place | 製品を設置する場所のマップ。 データタイプ: オブジェクト "place": { "id": "String", "@type": "String" } | | productOrderItem.product.place.id | 場所 \[cmn_location\] テーブル内の関連する場所レコードのSys_id。製品注文アイテムに対して ( productOrderItem.action パラメーターを使用して) 変更アクションを使用する場合、要求を新しい場所sys_id更新すると、注文は変更されず、新しい場所で履行される移動オーダーが作成されます。 データタイプ：文字列 | | productOrderItem.product.productCharacteristic | 関連製品の特性のリスト。 データタイプ：オブジェクトのアレイ "productCharacteristic": [ { "name": "String", "previousValue": "String", "value": "String", "valueType": "String" } ] | | productOrderItem.product.productCharacteristic.name | 製品に関連付ける特性レコードの名前。特性 \[sn_prd_pm_characteristic\] テーブルにあります。 データタイプ：文字列 | | productOrderItem.product.productCharacteristic.previousValue | 更新が変更指示用である場合の以前の特性オプションの値。productOrderItem.actionパラメーターが add 以外の場合、要求は変更指示です。特性オプション値の詳細については、「 [Create product characteristics and characteristic options](https://www.servicenow.com/docs/access?context=som-product-config-add-characteristics&version=australia&pubname=australia-order-management&ft:locale=en-US)」を参照してください。 データタイプ：文字列 | | productOrderItem.product.productCharacteristic.value | 製品に関連付けられた特性オプション値。特性オプション値の詳細については、「 [Create product characteristics and characteristic options](https://www.servicenow.com/docs/access?context=som-product-config-add-characteristics&version=australia&pubname=australia-order-management&ft:locale=en-US)」を参照してください。 データタイプ：文字列 | | productOrderItem.product.productSpecification | 製品に関連付けられた製品仕様の説明。 データタイプ: オブジェクト "productSpecification:" { "id": "String", "internalId": "String", "internalVersion": "String", "name": "String", "version": "String", "@type": "String" } | | productOrderItem.product.productSpecification.id | 製品仕様のInitial_versionまたはexternal_id。initial_versionは仕様の最初のバージョンのsys_idです。製品仕様 \[sn_prd_pm_product_specification\] テーブルの \[sys_id\] または \[external_id\] フィールドにあります。 データタイプ：文字列 | | productOrderItem.product.productSpecification.internalId | 製品仕様の初期バージョン。初期バージョンは、仕様の最初のバージョンのsys_idです。 データタイプ：文字列 表:製品仕様 \[sn_prd_pm_product_specification\] | | productOrderItem.product.productSpecification.internalVersion | 製品仕様のバージョン。 データタイプ：文字列 テーブル:製品仕様 \[sn_prd_pm_product_specification\] テーブルのバージョンフィールド。 | | productOrderItem.product.productSpecification.name | 製品仕様の名前。製品仕様 \[sn_prd_pm_product_specification\] テーブルにあります。 データタイプ：文字列 | | productOrderItem.product.productSpecification.version | 製品仕様の外部バージョン。 データタイプ：文字列 テーブル:製品仕様 \[sn_prd_pm_product_specification\] テーブルの external_version フィールド。 | | productOrderItem.product.productSpecification.@type | TMF Open API 標準の一部です。この値は常に ProductSpecificationRef です。この情報は保存されません。 データタイプ：文字列 | | productOrderItem.product.relatedParty | 品目の連絡先のリスト。 データタイプ：オブジェクトのアレイ "relatedParty": [ { "email": "String", "firstName": "String", "id": "String", "lastName": "String", "phone": "String", "@referredType": "String", "@type": "String" } ] | | productOrderItem.product.relatedParty.email | 連絡先のメールアドレス。 データタイプ：文字列 | | productOrderItem.product.relatedParty.firstName | 連絡先の名。 データタイプ：文字列 | | productOrderItem.product.relatedParty.id | 注文品目に関連付けられた品目連絡先のSys_id。注文明細品目連絡先 \[sn_ind_tmt_orm_order_line_item_contact\] テーブルにあります。 データタイプ：文字列 | | productOrderItem.product.relatedParty.lastName | 連絡先の名前 (姓)。 データタイプ：文字列 | | productOrderItem.product.relatedParty.phone | 連絡先の勤務先電話番号。 データタイプ：文字列 | | productOrderItem.product.relatedParty.@referredType | 顧客のタイプ。 可能な値:OrderLineItemContact データタイプ：文字列 | | productOrderItem.product.relatedParty.@type | TMF Open API 標準の一部です。注文明細品目の連絡先の注釈。この値は常に RelatedParty です。この情報は保存されません。 データタイプ：文字列 | | productOrderItem.product.@type | TMF Open API 標準の一部です。製品の注釈。この値は常に Product です。この情報は保存されません。 データタイプ：文字列 | | productOrderItem.productOffering | 製品に関連付けられた製品オファリングの説明。 データタイプ: オブジェクト "productOffering:" { "id": "String", "internalId": "String", "internalVersion": "String", "name": "String", "version": "String" } | | productOrderItem.productOffering.id | 製品オファリングのInitial_versionまたはexternal_id。initial_versionは、オファリングの最初のバージョンのsys_idです。製品オファリング \[sn_prd_pm_product_offering\] テーブルの sys_id または external_id フィールドにあります。 データタイプ：文字列 | | productOrderItem.productOffering.internalId | 製品オファリングの初期バージョン。初期バージョンは、オファリングの最初のバージョンのsys_idです。 データタイプ：文字列 テーブル:製品オファリング \[sn_prd_pm_product_offering\] | | productOrderItem.productOffering.internalVersion | 製品オファリングのバージョン。 データタイプ：文字列 テーブル:製品オファリング \[sn_prd_pm_product_offering\] テーブル、フィールドバージョン。 | | productOrderItem.productOffering.name | 製品オファリングの名前。製品オファリング \[sn_prd_pm_product_offering\] テーブルにあります。 データタイプ：文字列 | | productOrderItem.productOffering.version | 製品オファリングの外部バージョン。 データタイプ：文字列 テーブル:製品オファリング \[sn_prd_pm_product_offering\] テーブルの \[external_version\] フィールド。 | | productOrderItem.productOrderItemRelationship | 注文品目間の関係のリスト。 データタイプ：オブジェクトのアレイ "productOrderItemRelationship": [ { "id": "String", "relationshipType": "String" } ] | | productOrderItem.productOrderItemRelationship.id | 関連品目の一意の識別子。注文明細品目 \[sn_ind_tmt_orm_order_line_item\] テーブルの sn_ind_tmt_orm_external_id フィールドにあります。 データタイプ：文字列 | | productOrderItem.productOrderItemRelationship.relationshipType | 2 つの品目間の関係のタイプ。この情報は、関係階層を識別するために使用されます。 データタイプ：文字列 | | productOrderItem.quantity | 注文する関連アイテムの数。 データタイプ：数値 | | productOrderItem.state | 製品注文アイテムの現在のステータス。 データタイプ：文字列 | | productOrderItem.@type | TMF Open API 標準の一部です。製品の注釈。この値は常に ProductOrderItem です。この情報は保存されません。 データタイプ：文字列 | | 関連パーティー | 注文の連絡先のリスト。各連絡先はアレイ内のオブジェクトです。顧客アカウントまたはコンシューマーアカウント情報を含むアイテムを少なくとも 1 つリストする必要があります。 データタイプ：オブジェクトのアレイ "relatedParty": [ { "id": "String", "name": "String", "@referredType": "String", "@type": "String" } ] | | relatedParty.id | 注文に関連付けられたアカウント、顧客連絡先、またはコンシューマーのSys_idまたはexternal_id。アカウント \[customer_account\]、連絡先 \[customer_contact\] テーブル、またはコンシューマー \[csm_consumer\] テーブルにあります。 データタイプ：文字列 | | relatedParty.name | アカウント、顧客、またはコンシューマーの名前。 データタイプ：文字列 | | relatedParty.type | 顧客のタイプ。 可能な値： * コンシューマー * 顧客 * 顧客連絡先 {#tmf_prod_order-PATCH-ord-productOrder-id__d3728e2631} データタイプ：文字列 | | requestedCompletionDate | 顧客が要求した配送日。 データタイプ：文字列 | | requestedStartDate | 顧客が要求した注文開始日。 データタイプ：文字列 | | 状況 | 注文の現在のステータス。 データタイプ：文字列 | | @type | TMF Open API 標準の一部です。製品の注釈。この値は常に ProductOrder です。この情報は保存されません。 データタイプ：文字列 | [ ] {#tmf_prod_order-PATCH-ord-productOrder-id__table_c1v_xpk_5rb} ### cURL 要求 {#tmf_prod_order-PATCH-ord-productOrder-id__example_jsc_1dc_vrb} この例では、製品注文のチャネルを更新します。 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} {#ariaid-title7} 指定された顧客注文を更新します。 重要: Tokyoリリース以降、このエンドポイントは廃止されました。このエンドポイントの新しいバージョンは [製品注文オープン API - PATCH /sn_ind_tmt_orm/order/productOrder/{id}](https://servicenow-prod.fluidtopics.net/JmfbW68d5V7q7_xA6oKRug#tmf_prod_order-PATCH-ord-productOrder-id "指定された顧客注文を更新します。") です。 ### URL 形式 デフォルト URL: /api/sn_ind_tmt_orm/productorder/{id} ### サポートされている要求パラメーター {#tmf_prod_order-PATCH-productorder-id__entry__2} | 名前 | 説明 | |-|-| | ID | 更新する顧客注文のSys_id。 データタイプ：文字列 テーブル:顧客注文 \[sn_ind_tmt_orm_order\] | [表 : 31. パスパラメーター] {#tmf_prod_order-PATCH-productorder-id__entry__6} | 名前 | 説明 | |-|-| | なし | | [表 : 32. クエリパラメーター] {#tmf_prod_order-PATCH-productorder-id__id_vk2_p5n_t4b__entry__2}{#tmf_prod_order-PATCH-productorder-id__type-entry-tmf622}{#tmf_prod_order-PATCH-productorder-id__channel-ph-tmf622}{#tmf_prod_order-PATCH-productorder-id__channel_id-ph-tmf622}{#tmf_prod_order-PATCH-productorder-id__channel_name-ph-tmf622}{#tmf_prod_order-PATCH-productorder-id__due-date-PATCH}{#tmf_prod_order-PATCH-productorder-id__externalId-ph-tmf622}{#tmf_prod_order-PATCH-productorder-id__tmf622-response-externalSystem}{#tmf_prod_order-PATCH-productorder-id__note-ph-tmf622}{#tmf_prod_order-PATCH-productorder-id__note_text-ph-tmf622}{#tmf_prod_order-PATCH-productorder-id__prodOrdItem-ph-tmf622}{#tmf_prod_order-PATCH-productorder-id__prodOrdItem_type-entry-tmf622}{#tmf_prod_order-PATCH-productorder-id__prodOrdItem_action-ph-tmf622}{#tmf_prod_order-PATCH-productorder-id__prodOrdItem_actionReason-response-tmf622}{#tmf_prod_order-PATCH-productorder-id__due-date-item-PATCH}{#tmf_prod_order-PATCH-productorder-id__externalProdInvId-decsr}{#tmf_prod_order-PATCH-productorder-id__externalProdInv-descr-PATCH}{#tmf_prod_order-PATCH-productorder-id__prodOrdItem_id-ph-tmf622}{#tmf_prod_order-PATCH-productorder-id__itemPrice-ph-tmf622}{#tmf_prod_order-PATCH-productorder-id__itemPrice_price-ph-tmf622}{#tmf_prod_order-PATCH-productorder-id__itemPrice_price_taxIncludedAmt-ph-tmf622}{#tmf_prod_order-PATCH-productorder-id__itemPrice_price_taxIncludedAmt_unit-ph-tmf622}{#tmf_prod_order-PATCH-productorder-id__itemPrice_price_taxIncludedAmt_value-ph-tmf622}{#tmf_prod_order-PATCH-productorder-id__itemPrice_priceType_data_type-p-tmf622}{#tmf_prod_order-PATCH-productorder-id__itemPrice_recurringChargePeriod_data_type-p-tmf622}{#tmf_prod_order-PATCH-productorder-id__product-p-tmf622}{#tmf_prod_order-PATCH-productorder-id__product_type_data_type-p-tmf622}{#tmf_prod_order-PATCH-productorder-id__product_id-ph-tmf622}{#tmf_prod_order-PATCH-productorder-id__product_place-ph-tmf622}{#tmf_prod_order-PATCH-productorder-id__product_place_type_data_type-p-tmf622}{#tmf_prod_order-PATCH-productorder-id__product_place_id-ph-tmf622}{#tmf_prod_order-PATCH-productorder-id__prod_prodChar-ph-tmf622}{#tmf_prod_order-PATCH-productorder-id__prod_prodChar_name-ph-tmf622}{#tmf_prod_order-PATCH-productorder-id__prod_prodChar_previousValue-ph-tmf622}{#tmf_prod_order-PATCH-productorder-id__prod_prodChar_value-ph-tmf622}{#tmf_prod_order-PATCH-productorder-id__prod_prodSpec-ph-tmf622}{#tmf_prod_order-PATCH-productorder-id__prod_prodSpec_type_data_type-p-tmf622}{#tmf_prod_order-PATCH-productorder-id__prod_prodSpec_id_data_type-p-tmf622}{#tmf_prod_order-PATCH-productorder-id__tmf622-response-internalVersion}{#tmf_prod_order-PATCH-productorder-id__prod_prodSpec_name_data_type-p-tmf622}{#tmf_prod_order-PATCH-productorder-id__tmf622-response-version}{#tmf_prod_order-PATCH-productorder-id__prod_relParty-ph-tmf622}{#tmf_prod_order-PATCH-productorder-id__prod_relParty_refType_data_type-p-tmf622}{#tmf_prod_order-PATCH-productorder-id__product_relatedParty_type_data_type-row-tmf622}{#tmf_prod_order-PATCH-productorder-id__prod_relParty_email-ph-tmf622}{#tmf_prod_order-PATCH-productorder-id__prod_relParty_firstName-ph-tmf622}{#tmf_prod_order-PATCH-productorder-id__prod_relParty_id-ph-tmf622}{#tmf_prod_order-PATCH-productorder-id__prod_relParty_lastName-ph-tmf622}{#tmf_prod_order-PATCH-productorder-id__prod_relParty_phone-ph-tmf622}{#tmf_prod_order-PATCH-productorder-id__productOffer-ph-tmf622}{#tmf_prod_order-PATCH-productorder-id__prodOffer_id_data_type-p-tmf622}{#tmf_prod_order-PATCH-productorder-id__prodOffer_name_data_type-p-tmf622}{#tmf_prod_order-PATCH-productorder-id__prodOrdItem_quantity-ph-tmf622}{#tmf_prod_order-PATCH-productorder-id__prodOrderItemRel-ph-tmf622}{#tmf_prod_order-PATCH-productorder-id__prodOrderItemRel_id-ph-tmf622}{#tmf_prod_order-PATCH-productorder-id__prodOrderItemRel_relType_data_type-p-tmf622}{#tmf_prod_order-PATCH-productorder-id__relatedParty-ph-tmf622}{#tmf_prod_order-PATCH-productorder-id__relatedParty_refType_data_type-p-tmf622}{#tmf_prod_order-PATCH-productorder-id__relatedParty_type_data_type-p-tmf622}{#tmf_prod_order-PATCH-productorder-id__relatedParty_id_data_type-p-tmf622}{#tmf_prod_order-PATCH-productorder-id__relatedParty_name_data_type-p-tmf622}{#tmf_prod_order-PATCH-productorder-id__requestedCompletionDate-ph-tmf622}{#tmf_prod_order-PATCH-productorder-id__reqStartDate-ph-tmf622} | 名前 | 説明 | |-|-| | @type | TMF Open API 標準の一部です。製品の注釈。この値は常に ProductOrder です。この情報は保存されません。 データタイプ：文字列 | | チャネル | 製品の販売に使用するチャネルのリスト。 データタイプ：オブジェクトのアレイ{#tmf_prod_order-PATCH-productorder-id__channel_data_type-p-tmf622} "channel": [ { "id": "String", "name": "String" } ] {#tmf_prod_order-PATCH-productorder-id__channel_obj_def-codeblock-tmf622} 保存場所:sn_ind_tmt_orm_order | | channel.id | channelパラメーターを使用する場合は必須です。関連製品の販売に使用するチャネルの一意の識別子。 データタイプ：文字列{#tmf_prod_order-PATCH-productorder-id__channel_id_data_type-p-tmf622} テーブル:流通チャネル \[sn_prd_pm_distribution_channel\] テーブルの external_id フィールド内。 格納場所:sn_ind_tmt_orm_orderテーブルのチャネルフィールド。 デフォルト：空白の文字列 | | channel.name | 関連製品の販売に使用するチャネルの名前。可能なチャネル名は、sn_ind_tmt_orm_orderテーブルのチャネル辞書エントリの \[選択リスト\] タブで定義されます。 データタイプ：文字列{#tmf_prod_order-PATCH-productorder-id__channel_name_data_type-p-tmf622} デフォルト：空白の文字列 | | committedDueDate | 注文に対してアクションを実行する必要がある日時。 この値は、各注文品目の committedDueDate 値と同じかそれ以降にする必要があります。 注文品目のアクションが 一時停止 または 再開の場合、このパラメーターは更新できません。 データタイプ：文字列 格納場所:sn_ind_tmt_orm_orderテーブルのcommitted_due_dateフィールド。 | | externalId | 顧客注文の一意の識別子。この値は外部システムによって決定されます。 データタイプ：文字列{#tmf_prod_order-PATCH-productorder-id__externalId_data_type-p-tmf622} 格納場所:sn_ind_tmt_orm_orderテーブルのexternal_idフィールド。 デフォルト：空白の文字列 | | 外部システム | `TMF622` が追加されたサービス注文の外部システム。 たとえば、外部システムが ABC の場合、 externalSystem に `ABC-TMF622` と入力します。 データタイプ:文字列 | | 注意 | 注文時に顧客が行った追加のメモのリスト。 データタイプ：オブジェクトのアレイ{#tmf_prod_order-PATCH-productorder-id__note_data_type-p-tmf622} "note": [ { "text": "String" } ] {#tmf_prod_order-PATCH-productorder-id__note-codeblock-tmf622} 保存場所:sn_ind_tmt_orm_order | | note.text | 注文時に顧客が行った追加のメモ/コメント。 データタイプ：文字列{#tmf_prod_order-PATCH-productorder-id__note_text_data_type-p-tmf622} 格納場所:sn_ind_tmt_orm_orderテーブルのコメントフィールド。 デフォルト：空白の文字列 | | orderCurrency | 注文と注文明細品目の通貨コード。既存の注文の通貨コードの更新はサポートされていません。注文に既に関連付けられている通貨コード以外の値を指定すると、更新が却下されます。 データタイプ：文字列 | | 製品注文アイテム | 製品注文とそれに関連するアクションに関連付けられたアイテムを説明するリスト。 データタイプ：オブジェクトのアレイ{#tmf_prod_order-PATCH-productorder-id__prodOrdItem_data_type-p-tmf622} "productOrderItem": [ { "action": "String", "actionReason": "String", "committedDueDate": "String", "externalProductInventory": [Array], "id": "String", "itemPrice": [Array], "product": {Object}, "productOffering": {Object}, "productOrderItemRelationship": [Array], "quantity": Number, "revisionOperation": "String", "@type": "String" } ] {#tmf_prod_order-PATCH-productorder-id__prodOrdItem-codeblock-tmf622} 格納場所:sn_ind_tmt_orm_order_line_item | | productOrderItem.@type | TMF Open API 標準の一部です。製品の注釈。この値は常に ProductOrderItem です。この情報は保存されません。 データタイプ：文字列 | | productOrderItem.action | productOrderItemパラメーターを使用する場合は必須です。製品に対して実行するアクション。可能なアクションは、sn_ind_tmt_orm_order_line_itemテーブルのアクション辞書エントリの \[選択リスト\] タブで定義されます。 可能な値： * 追加 * 変更 注: productOrderItem.product.place.idを介して新しいサービスの場所を含む変更ペイロードを送信すると、移動オーダーとして処理されます。 * delete * 変更なし * 再開 * 停止する {#tmf_prod_order-PATCH-productorder-id__ul_zwn_nxp_ysb} データタイプ：文字列{#tmf_prod_order-PATCH-productorder-id__prodOrdItem_action_data_type-p-tmf622} 格納場所:sn_ind_tmt_orm_order_line_itemテーブルのアクションフィールド。 デフォルト:追加 | | productOrderItem.actionReason | 注文明細品目を追加する理由。 データタイプ：文字列 格納場所:sn_ind_tmt_orm_order_line_itemテーブルのaction_reasonフィールド。 | | productOrderItem.committedDueDate | 注文品目に対してアクションを実行する必要がある日時。 アイテムのアクションが 一時停止 または 再開の場合、このパラメーターは更新できません。 データタイプ：文字列 格納場所:sn_ind_tmt_orm_order_line_itemテーブルのcommitted_due_dateフィールド。 | | productOrderItem.externalProductInventory.externalProductInventoryId | 製品インベントリにマッピングする外部 ID。 データタイプ：文字列 格納場所:sn_ind_tmt_orm_order_line_itemテーブルのexternal_inventory_idフィールドとsn_prd_invt_product_inventoryテーブルのsn_prd_invt_external_idフィールド。 | | productOrderItem.externalProductInventory | 注文に対して作成された製品在庫にマッピングする外部 ID のリスト。 データタイプ：オブジェクトのアレイ "externalProductInventory": [ { "externalProductInventoryId": "String" } ] 注: 以前は、既に存在する外部製品インベントリ ID を使用して PATCH 注文を作成すると、操作が中断され、エラーが返されていました。Xanaduリリースでは、既存の外部プロダクトインベントリ ID が指定されていて、エラーがスローされない場合、このパラメーターは単純に無視されます。 | | productOrderItem.id | productOrderItemパラメーターを使用する場合は必須です。品目の一意の識別子。注文明細品目 \[sn_ind_tmt_orm_order_line_item\] テーブルの sn_ind_tmt_orm_external_id フィールドにあります。 データタイプ：文字列{#tmf_prod_order-PATCH-productorder-id__prodOrdItem_id_data_type-p-tmf622} 格納場所:sn_ind_tmt_orm_order_line_itemテーブルのexternal_idフィールド。 最大長：40 デフォルト：空白の文字列 | | productOrderItem.itemPrice | 製品に関連付けられた価格を説明するリスト。 データタイプ：オブジェクトのアレイ{#tmf_prod_order-PATCH-productorder-id__itemPrice_data_type-p-tmf622} "itemPrice": [ { "price": {Object}, "priceType": "String", "recurringChargePeriod": "String" } ] {#tmf_prod_order-PATCH-productorder-id__itemPrice-codeblock-tmf622} 保存場所:sn_ind_tmt_orm_order デフォルト：空白の文字列 | | productOrderItem.itemPrice.price | 関連製品の価格の説明。 データタイプ: オブジェクト{#tmf_prod_order-PATCH-productorder-id__itemPrice_price_data_type-p-tmf622} "price": { "taxIncludedAmount": {Object} } {#tmf_prod_order-PATCH-productorder-id__itemPrice_price-codeblock-tmf622} 格納場所:sn_ind_tmt_orm_order_line_item デフォルト：空白の文字列 | | productOrderItem.itemPrice.price.taxIncludedAmount | 税を含む関連製品の価格の説明。 データタイプ: オブジェクト{#tmf_prod_order-PATCH-productorder-id__itemPrice_price_taxIncludedAmt_data_type-p-tmf622} "taxIncludedAmount": { "unit": "String", "value": Number } {#tmf_prod_order-PATCH-productorder-id__itemPrice_price_taxIncludedAmt-codeblock-tmf622} 格納場所:sn_ind_tmt_orm_order_line_item | | productOrderItem.itemPrice.price.taxIncludedAmount.unit | 価格を表す通貨コード。 データタイプ：文字列{#tmf_prod_order-PATCH-productorder-id__itemPrice_price_taxIncludedAmt_unit_data_type-p-tmf622} 格納場所:sn_ind_tmt_orm_order_line_itemテーブルの mrc または nrc フィールド。 | | productOrderItem.itemPrice.price.taxIncludedAmount.value | 製品の価格 (税込み)。 データタイプ：数値{#tmf_prod_order-PATCH-productorder-id__itemPrice_price_taxIncludedAmt_value_data_type-p-tmf622} 格納場所:sn_ind_tmt_orm_order_line_itemテーブルの mrc または nrc フィールド。 | | productOrderItem.itemPrice.priceType | アイテム価格のタイプ (繰り返しまたは非繰り返し)。 データタイプ：文字列 | | productOrderItem.itemPrice.recurringChargePeriod | 価格が繰り返し発生する場合は、 月などの繰り返し期間。 データタイプ：文字列 | | productOrderItem.product | productOrderItem.actionが変更または削除の場合は必須です。顧客が購入した製品のインスタンス詳細の説明。 データタイプ: オブジェクト{#tmf_prod_order-PATCH-productorder-id__product_data_type-p-tmf622} "product": { "id": "String", "place": {Object}, "productCharacteristic": [Array], "productSpecification": {Object}, "relatedParty": {Object}, "@type": "String" } {#tmf_prod_order-PATCH-productorder-id__product-codeblock-tmf622} 格納場所:sn_ind_tmt_orm_order_line_item | | productOrderItem.product.@type | TMF Open API 標準の一部です。製品の注釈。この値は常に Product です。この情報は保存されません。 データタイプ：文字列 | | productOrderItem.product.id | productOrderItem.actionが変更または削除の場合は必須です。販売された製品の一意の識別子。製品インベントリ \[sn_ind_tmt_orm_product_inventory\] テーブルのsys_idまたはsn_ind_tmt_orm_external_idフィールドにあります。 データタイプ：文字列{#tmf_prod_order-PATCH-productorder-id__product_id_data_type-p-tmf622} デフォルト：空白の文字列 | | productOrderItem.product.place | 製品を設置する場所のマップ。 データタイプ: オブジェクト{#tmf_prod_order-PATCH-productorder-id__product_place_data_type-p-tmf622} "place": { "id": "String", "@type": "String" } {#tmf_prod_order-PATCH-productorder-id__product_place-codeblock-tmf622} 格納場所:sn_ind_tmt_orm_order_line_item | | productOrderItem.product.place.@type | TMF Open API 標準の一部です。注文明細品目の連絡先の注釈。この値は常に Place です。この情報は保存されません。 データタイプ：文字列 | | productOrderItem.product.place.id | productOrderItem.product.placeパラメーターを使用する場合は必須です。場所 \[cmn_location\] テーブル内の関連する場所レコードのSys_id。製品注文アイテムに対して ( productOrderItem.action パラメーターを使用して) 変更アクションを使用する場合、要求を新しい場所sys_id更新すると、注文は変更されず、新しい場所で履行される移動オーダーが作成されます。 データタイプ：文字列{#tmf_prod_order-PATCH-productorder-id__product_place_id_data_type-p-tmf622} 格納場所:sn_ind_tmt_orm_order_line_itemテーブルの場所フィールド。 デフォルト：空白の文字列 | | productOrderItem.product.productCharacteristic | 関連製品の特性のリスト。 データタイプ：オブジェクトのアレイ{#tmf_prod_order-PATCH-productorder-id__prod_prodChar_data_type-p-tmf622} "productCharacteristic": [ { "name": "String", "previousValue": "String", "value": "String", "valueType": "String" } ] {#tmf_prod_order-PATCH-productorder-id__prod_prodChar-codeblock-tmf622} 格納場所:sn_ind_tmt_orm_order_characteristic_value | | productOrderItem.product.productCharacteristic.name | 製品に関連付ける特性レコードの名前。特性 \[sn_prd_pm_characteristic\] テーブルにあります。 データタイプ：文字列{#tmf_prod_order-PATCH-productorder-id__prod_prodChar_name_data_type-p-tmf622} 格納場所:sn_ind_tmt_orm_order_characteristic_valueテーブルの特性フィールド。 デフォルト：空白の文字列 | | productOrderItem.product.productCharacteristic.previousValue | 更新が変更指示用である場合の以前の特性オプションの値。productOrderItem.actionパラメーターが add 以外の場合、要求は変更指示です。特性オプション値の詳細については、「 [Create product characteristics and characteristic options](https://www.servicenow.com/docs/access?context=som-product-config-add-characteristics&version=australia&pubname=australia-order-management&ft:locale=en-US)」を参照してください。 データタイプ：文字列{#tmf_prod_order-PATCH-productorder-id__prod_prodChar_previousValue_data_type-p-tmf622} 格納場所:sn_ind_tmt_orm_order_characteristic_valueテーブルのprevious_characteristic_option_value。 デフォルト：空白の文字列 | | productOrderItem.product.productCharacteristic.value | 製品に関連付けられた特性オプション値。特性オプション値の詳細については、「 [Create product characteristics and characteristic options](https://www.servicenow.com/docs/access?context=som-product-config-add-characteristics&version=australia&pubname=australia-order-management&ft:locale=en-US)」を参照してください。 データタイプ：文字列{#tmf_prod_order-PATCH-productorder-id__prod_prodChar_value_data_type-p-tmf622} 格納場所: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 行テキスト * はい/いいえ {#tmf_prod_order-PATCH-productorder-id__ul_j4j_pjw_xfc} | | productOrderItem.product.productSpecification | 製品に関連付けられた製品仕様の説明。 注: 変更指示 (productOrderItem.action が `変更`) は、 sn_ind_tmt_orm.allowSpecVersionUpdateInChangeOrder システムプロパティの値に基づいて異なる方法で処理されます。このシステムプロパティの値は、製品インベントリが注文に示されているバージョンと異なる場合の注文の処理方法を決定します。 * このシステムプロパティが true (デフォルト) に設定されている場合、製品インベントリは、参照されている製品仕様を変更することによって注文のバージョンに自動的にアップグレードされます。これにより、注文を正常に処理できます。 * このシステムプロパティが false に設定されている場合、製品インベントリが注文に示されているバージョンと異なる場合、バージョンの不一致により注文は失敗します。 {#tmf_prod_order-PATCH-productorder-id__ul_sgb_q5y_hbc} データタイプ: オブジェクト{#tmf_prod_order-PATCH-productorder-id__prod_prodSpec_data_type-p-tmf622} "productSpecification": { "id": "String", "internalVersion": "String", "name": "String", "version": "String", "@type": "String" } {#tmf_prod_order-PATCH-productorder-id__prod_prodSpec-codeblock-tmf622} 格納場所:sn_ind_tmt_orm_order_line_item | | productOrderItem.product.productSpecification.@type | TMF Open API 標準の一部です。この値は常に ProductSpecificationRef です。この情報は保存されません。 データタイプ：文字列 | | productOrderItem.product.productSpecification.id | productOrderItem.product.productSpecificationパラメーターを使用する場合は必須です。製品仕様のInitial_versionまたはexternal_id。initial_versionは仕様の最初のバージョンのsys_idです。製品仕様 \[sn_prd_pm_product_specification\] テーブルの \[sys_id\] または \[external_id\] フィールドにあります。 データタイプ：文字列 | | productOrderItem.product.productSpecification.internalVersion | 製品仕様の内部バージョン。version の値と一致する必要があります。一致しない場合、エラーがスローされます。 データタイプ:文字列 表:製品仕様 \[sn_prd_pm_product_specification\] | | productOrderItem.product.productSpecification.name | 製品仕様の名前。製品仕様 \[sn_prd_pm_product_specification\] テーブルにあります。 データタイプ：文字列 | | productOrderItem.product.productSpecification.version | 製品仕様の外部バージョン。internalVersion の値と一致する必要があります。一致しない場合、エラーがスローされます。 データタイプ:文字列 表:製品仕様 \[sn_prd_pm_product_specification\] | | productOrderItem.product.relatedParty | 品目の連絡先のリスト。 データタイプ：オブジェクトのアレイ{#tmf_prod_order-PATCH-productorder-id__prod_relParty_data_type-p-tmf622} "relatedParty": [ { "email": "String", "firstName": "String", "id": "String", "lastName": "String", "phone": "String", "@referredType": "String", "@type": "String" } ] {#tmf_prod_order-PATCH-productorder-id__prod_relParty-codeblock-tmf622} 格納場所:sn_ind_tmt_orm_order_line_item_contact | | productOrderItem.product.relatedParty.@referredType | 顧客のタイプ。 可能な値:OrderLineItemContact{#tmf_prod_order-PATCH-productorder-id__prod_relParty_refType-p-tmf622} データタイプ：文字列 | | productOrderItem.product.relatedParty.@type | TMF Open API 標準の一部です。注文明細品目の連絡先の注釈。この値は常に RelatedParty です。この情報は保存されません。 データタイプ：文字列 | | productOrderItem.product.relatedParty.email | 連絡先のメールアドレス。 データタイプ：文字列{#tmf_prod_order-PATCH-productorder-id__prod_relParty_email_data_type-p-tmf622} 格納場所:sn_ind_tmt_orm_order_line_item_contactテーブルのメールフィールド。 デフォルト：空白の文字列 | | productOrderItem.product.relatedParty.firstName | 連絡先の名。 データタイプ：文字列{#tmf_prod_order-PATCH-productorder-id__prod_relParty_firstName_data_type-p-tmf622} 格納場所:sn_ind_tmt_orm_order_line_item_contactテーブルのfirst_nameフィールド。 デフォルト：空白の文字列 | | productOrderItem.product.relatedParty.id | 注文品目に関連付けられた品目連絡先のSys_id。注文明細品目連絡先 \[sn_ind_tmt_orm_order_line_item_contact\] テーブルにあります。 データタイプ：文字列{#tmf_prod_order-PATCH-productorder-id__prod_relParty_id_data_type-p-tmf622} 格納場所:sn_ind_tmt_orm_order_line_item_contactテーブルのsys_idフィールド。 デフォルト：空白の文字列 | | productOrderItem.product.relatedParty.lastName | 連絡先の名前 (姓)。 データタイプ：文字列{#tmf_prod_order-PATCH-productorder-id__prod_relParty_lastName_data_type-p-tmf622} 格納場所:sn_ind_tmt_orm_order_line_item_contactテーブルの lastName フィールド。 デフォルト：空白の文字列 | | productOrderItem.product.relatedParty.phone | 連絡先の勤務先電話番号。 データタイプ：文字列{#tmf_prod_order-PATCH-productorder-id__prod_relParty_phone_data_type-p-tmf622} 格納場所:sn_ind_tmt_orm_order_line_item_contactテーブルのbusiness_phoneフィールド。 デフォルト：空白の文字列 | | productOrderItem.productOffering | 製品に関連付けられた製品オファリングの説明。 データタイプ: オブジェクト{#tmf_prod_order-PATCH-productorder-id__prodOffer_data_type-p-tmf622} "productOffering": { "id": "String", "internalVersion": "String", "name": "String", "version": "String" } {#tmf_prod_order-PATCH-productorder-id__prodOffer-codeblock-tmf622} 格納場所: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 | 注文する関連アイテムの数。 データタイプ：数値{#tmf_prod_order-PATCH-productorder-id__prodOrdItem_quantity_data_type-p-tmf622} 格納場所:sn_ind_tmt_orm_orderの数量フィールド。 デフォルト値:null | | productOrderItem.productOrderItemRelationship | 注文品目間の関係のリスト。 データタイプ：オブジェクトのアレイ{#tmf_prod_order-PATCH-productorder-id__prodOrderItemRel_data_type-p-tmf622} "productOrderItemRelationship": [ { "id": "String", "relationshipType": "String" } ] {#tmf_prod_order-PATCH-productorder-id__prodOrderItemRel-codeblock-tmf622} 格納場所: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 フィールドにあります。 データタイプ：文字列{#tmf_prod_order-PATCH-productorder-id__prodOrderItemRel_id_data_type-p-tmf622} 格納場所:テーブルのparent_line_itemフィールドthebsn_ind_tmt_orm_order_line_item。 デフォルト：空白の文字列 | | productOrderItem.productOrderItemRelationship.relationshipType | 2 つの品目間の関係のタイプ。この情報は、関係階層を識別するために使用されます。 可能な値： * HasChild * 親がある * 必要 {#tmf_prod_order-PATCH-productorder-id__ul_yqf_2ty_54b} `HasChild` と `HasParent` は、親子関係に使用されます。\[`必須]` は水平関係に使用されます (品目には別の品目が必要です)。 データタイプ：文字列 | | productOrderItem.quantity | 注文されたアイテムの数。 データタイプ：数値 格納場所:sn_ind_tmt_orm_orderテーブルの数量フィールド。 デフォルト：空白の文字列 | | productOrderItem.revisionOperation | 品目に対して実行する更新のタイプ。この値が空の場合、既存の品目が更新されるか、まだ存在しない場合は新しい品目が追加されます。この値が cancel の場合、品目はキャンセルされます。 データタイプ：文字列 デフォルト：空白の文字列 | | 関連パーティー | 注文の連絡先のリスト。各連絡先はアレイ内のオブジェクトです。顧客アカウントまたはコンシューマーアカウント情報を含むアイテムを少なくとも 1 つリストする必要があります。 データタイプ：オブジェクトのアレイ{#tmf_prod_order-PATCH-productorder-id__relatedParty_data_type-p-tmf622} "relatedParty": [ { "id": "String", "name": "String", "@referredType": "String", "@type": "String" } ] {#tmf_prod_order-PATCH-productorder-id__relatedParty-codeblock-tmf622} | | relatedParty.@referredType | 顧客のタイプ。 可能な値： * コンシューマー * 顧客 * 顧客連絡先 {#tmf_prod_order-PATCH-productorder-id__ul_lcq_jwm_t4b} データタイプ：文字列 | | relatedParty.@type | TMF Open API 標準の一部です。製品の注釈。この値は常に RelatedParty です。この情報は保存されません。 データタイプ：文字列 | | relatedParty.id | 注文に関連付けられたアカウント、顧客連絡先、またはコンシューマーのSys_idまたはexternal_id。アカウント \[customer_account\]、連絡先 \[customer_contact\] テーブル、またはコンシューマー \[csm_consumer\] テーブルにあります。 データタイプ：文字列 | | relatedParty.name | アカウント、顧客、またはコンシューマーの名前。 データタイプ：文字列 | | requestedCompletionDate | 顧客が要求した配送日。 データタイプ：文字列{#tmf_prod_order-PATCH-productorder-id__reqCompDate_data_type-p-tmf622} 格納場所:sn_ind_tmt_orm_orderテーブルのexpected_end_dateフィールド。 デフォルト：空白の文字列 | | requestedStartDate | 顧客が要求した注文開始日。 データタイプ：文字列{#tmf_prod_order-PATCH-productorder-id__reqStartDate_data_type-p-tmf622} 格納場所:sn_ind_tmt_orm_orderテーブルのexpected_start_dateフィールド。 デフォルト：空白の文字列 | [表 : 33. 要求本文パラメーター (JSON)] {#tmf_prod_order-PATCH-productorder-id__id_vk2_p5n_t4b} ### ヘッダー 次の要求ヘッダーと応答ヘッダーは、この HTTP アクションにのみ適用されるか、別の方法でこのアクションに適用されます。REST API で使用される一般的なヘッダーのリストについては、「 [サポートされている REST API ヘッダー」](https://servicenow-prod.fluidtopics.net/lLW_uT5I5_l1aD8yR4Jt9A "REST (REpresentational State Transfer) は、Web 上のコンピューター システム間の標準を提供するシンプルなステートレス アーキテクチャであり、コンピューター システム間の通信を容易にします。")を参照してください。 {#tmf_prod_order-PATCH-productorder-id__table_omb_dvk_5rb__entry__2}{#tmf_prod_order-PATCH-productorder-id__accept-JSON-only-entry-RESTAPI}{#tmf_prod_order-PATCH-productorder-id__content_type-JSON-only-entry-RESTAPI} | ヘッダー | 説明 | |-|-| | 承認 | 応答本文のデータフォーマット。application/json のみをサポートします。 | | Content-Type | 要求本文のデータ形式。application/json のみをサポートします。 | [表 : 34. 要求ヘッダー] {#tmf_prod_order-PATCH-productorder-id__table_omb_dvk_5rb} {#tmf_prod_order-PATCH-productorder-id__table_tzy_thy_ksb__entry__2} | ヘッダー | 説明 | |-|-| | Content-Type | 応答本文のデータフォーマット。application/json のみをサポートします。 | [表 : 35. 応答ヘッダー] {#tmf_prod_order-PATCH-productorder-id__table_tzy_thy_ksb} ### ステータスコード この HTTP アクションには、次のステータスコードが適用されます。REST API で使用される可能性のあるステータスコードのリストについては、「 [REST API HTTP 応答コード](https://servicenow-prod.fluidtopics.net/lLW_uT5I5_l1aD8yR4Jt9A "REST (REpresentational State Transfer) は、Web 上のコンピューター システム間の標準を提供するシンプルなステートレス アーキテクチャであり、コンピューター システム間の通信を容易にします。")」を参照してください。 {#tmf_prod_order-PATCH-productorder-id__table_xfv_2vk_5rb__entry__2} | ステータスコード | 説明 | |-|-| | 201 | 成功。 特性または特性オプション情報に問題がある場合、エンドポイントは関連する顧客発注書明細レコードの作業メモフィールドに次のコメントを保存します。 * 次の注文品目特性が存在しません。注文を承認する前に、仕様\を確認し、注文明細品目の特性と特性オプションを修正してください。 * 注文アイテム特性:特性値\を持つ\は無効です。注文を承認する前に特性値を修正してください。 {#tmf_prod_order-PATCH-productorder-id__ul_xtx_xym_t4b} | | 400 | 要求が正しくありません。以下のいずれかの理由が考えられます。 * 無効なペイロード:要求本文がありません:ペ イロードが要求本文で渡されませんでした。 * 無効なペイロード:productOrderItem がありません :製品の注文明細品目オブジェクトまたは JSON がありません。 * 無効なペイロード:productOrderItem id がありません :ペイロードの製品注文明細品目に id パラメーターがありません。 * 無効なペイロード:productOrderItem アクションがありません: ペイロードの製品注文明細品目に action パラメーターがありません。 * 無効なペイロード:productOrderItem productOffering がありません :ペイロードの製品注文明細品目に製品オファリングオブジェクトまたは JSON がありません。 * 無効なペイロード:productOffering id がありません :ペイロード内の製品オファリングオブジェクトの製品注文明細品目に id パラメーターがありません。 * 無効なペイロード:製品オファリングが存在しません :製品注文明細品目の製品オファリングが無効です。 * 無効なペイロード:productOrderItem 製品がありません: 製品注文明細品目の製品オブジェクトまたは JSON がペイロードにありません。 * 無効なペイロード:製品 productSpecification がありません :製品注文明細品目の製品仕様オブジェクトまたは JSON がペイロードにありません。 * 無効なペイロード:productSpecification id がありません :製品仕様オブジェクトの製品注文明細品目の id パラメーターがペイロードにありません。 * 無効なペイロード:製品仕様が存在しません :製品注文明細品目の製品仕様が無効です。 * 無効なペイロード:プロダクトインベントリが存在しません : 変更指示 (アクション = 変更) で、アイテムの数量が在庫数量を上回っています。 * 無効なペイロード:製品インベントリ ID がありません: 変更注文で、ペイロードに product.id がありません。 * 無効なペイロード:販売済み製品は非アクティブです :変更指示で、ペイロードに指定された製品が非アクティブです。 * 無効なペイロード:relatedParty がありません :関係者オブジェクトがペイロードにありません。 * 無効なペイロード:顧客アカウントまたはコンシューマーがありません :関係者顧客またはコンシューマーオブジェクトがペイロードにありません。 * 無効なペイロード:コンシューマーが存在しません :指定された関係者コンシューマーが ServiceNow インスタンスに存在しません。 * 無効なペイロード:顧客アカウントが存在しません :指定された関係者顧客が ServiceNow インスタンスに存在しません。 * 無効なペイロード:注文の作成に失敗しました。 要求された注文を作成できません。 * 無効なペイロード:この注文はまだ顧客注文テーブルで作成されていません。詳細については、受信キューでチェックインしてください。- パッチ要求は、まだ顧客注文テーブルに含まれていない注文に対して行われました。注文は受信キュー \[sn_tmt_core_inbound_queue\] テーブルにあり、スケジューラーが処理するレコードを選択するのを待機しています。 * 無効なペイロード:注文のフルフィルメントタイプが「配送」ではないため、パッチ要求を行うことができません。- パッチ要求は、履行タイプが deliver 以外である注文に対して行われました。 {#tmf_prod_order-PATCH-productorder-id__ul_g2v_rzm_t4b} | [表 : 36. ステータスコード] {#tmf_prod_order-PATCH-productorder-id__table_xfv_2vk_5rb} ### 応答本文のパラメーター (JSON) {#tmf_prod_order-PATCH-productorder-id__section_b1v_xpk_5rb} {#tmf_prod_order-PATCH-productorder-id__table_c1v_xpk_5rb__entry__2} | 名前 | 説明 | |-|-| | チャネル | 製品の販売に使用するチャネルのリスト。 データタイプ：オブジェクトのアレイ "channel": [ { "id": "String", "name": "String" } ] | | channel.id | 関連製品の販売に使用するチャネルの一意の識別子。 データタイプ：文字列 | | channel.name | 関連製品の販売に使用するチャネルの名前。 データタイプ：文字列 | | ID | この要求に対して更新された顧客注文のSys_id。 データタイプ：文字列 | | externalId | 発注書番号などの顧客注文の外部識別子。 データタイプ：文字列 | | 注意 | 注文時に顧客が行った追加のメモのリスト。 データタイプ：オブジェクトのアレイ "note": [ { "text": "String" } ] | | note.text | 注文時に顧客が行った追加のメモ/コメント。 データタイプ：文字列 | | 製品注文アイテム | 製品注文とそれに関連するアクションに関連付けられたアイテムを説明するリスト。 データタイプ：オブジェクトのアレイ "productOrderItem:" [ { "action": "String", "actionReason": "String", "id": "String", "itemPrice": [Array], "product": {Object}, "productOffering": {Object}, "productOrderItemReleationship": [Array], "quantity": Number, "state": "String", "@type": "String" } ] | | productOrderItem.action | 製品に対して実行するアクション。可能なアクションは、sn_ind_tmt_orm_order_line_itemテーブルのアクション辞書エントリの \[選択リスト\] タブで定義されます。 データタイプ：文字列 | | productOrderItem.actionReason | 注文明細品目を追加する理由。 データタイプ：文字列 格納場所:sn_ind_tmt_orm_order_line_itemテーブルのaction_reasonフィールド。 | | productOrderItem.id | 品目の一意の識別子。注文明細品目 \[sn_ind_tmt_orm_order_line_item\] テーブルの sn_ind_tmt_orm_external_id フィールドにあります。 データタイプ：文字列 | | productOrderItem.itemPrice | 製品に関連付けられた価格を説明するリスト。 データタイプ：オブジェクトのアレイ "itemPrice": [ { "price": {Object}, "priceType": "String", "recurringChargePeriod": "String" } ] | | productOrderItem.itemPrice.price | 関連製品の価格の説明。 データタイプ: オブジェクト "price": { "taxIncludedAmount": {Object} } | | productOrderItem.itemPrice.price.taxIncludeAmount | 税を含む関連製品の価格の説明。 データタイプ: オブジェクト "taxIncludedAmount": { "unit": "String", "value": Number } | | productOrderItem.itemPrice.price.taxIncludeAmount.unit | 価格を表す通貨コード。 データタイプ：文字列 | | productOrderItem.itemPrice.price.taxIncludeAmount.value | 製品の価格 (税込み)。 データタイプ：数値 | | productOrderItem.itemPrice.priceType | アイテム価格のタイプ (繰り返しまたは非繰り返し)。 データタイプ：文字列 | | productOrderItem.itemPrice.recurringChargePeriod | 価格が繰り返し発生する場合は、 月などの繰り返し期間。 データタイプ：文字列 | | productOrderItem.product | 顧客が購入した製品のインスタンス詳細の説明。 データタイプ: オブジェクト "product": { "id": "String", "place": {Object}, "productCharacteristic": [Array], "productSpecification": {Object}, "relatedParty": {Object}, "@type": "String" } | | productOrderItem.product.id | 販売された製品の一意の識別子。製品インベントリ \[sn_ind_tmt_orm_product_inventory\] テーブルのsys_idまたはsn_ind_tmt_orm_external_idフィールドにあります。 データタイプ：文字列 | | productOrderItem.product.place | 製品を設置する場所のマップ。 データタイプ: オブジェクト "place": { "id": "String", "@type": "String" } | | productOrderItem.product.place.id | 場所 \[cmn_location\] テーブル内の関連する場所レコードのSys_id。製品注文アイテムに対して ( productOrderItem.action パラメーターを使用して) 変更アクションを使用する場合、要求を新しい場所sys_id更新すると、注文は変更されず、新しい場所で履行される移動オーダーが作成されます。 データタイプ：文字列 | | productOrderItem.product.productCharacteristic | 関連製品の特性のリスト。 データタイプ：オブジェクトのアレイ "productCharacteristic": [ { "name": "String", "previousValue": "String", "value": "String", "valueType": "String" } ] | | productOrderItem.product.productCharacteristic.name | 製品に関連付ける特性レコードの名前。特性 \[sn_prd_pm_characteristic\] テーブルにあります。 データタイプ：文字列 | | productOrderItem.product.productCharacteristic.previousValue | 更新が変更指示用である場合の以前の特性オプションの値。productOrderItem.actionパラメーターが add 以外の場合、要求は変更指示です。特性オプション値の詳細については、「 [Create product characteristics and characteristic options](https://www.servicenow.com/docs/access?context=som-product-config-add-characteristics&version=australia&pubname=australia-order-management&ft:locale=en-US)」を参照してください。 データタイプ：文字列 | | productOrderItem.product.productCharacteristic.value | 製品に関連付けられた特性オプション値。特性オプション値の詳細については、「 [Create product characteristics and characteristic options](https://www.servicenow.com/docs/access?context=som-product-config-add-characteristics&version=australia&pubname=australia-order-management&ft:locale=en-US)」を参照してください。 データタイプ：文字列 | | 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 Open API 標準の一部です。この値は常に ProductSpecificationRef です。この情報は保存されません。 データタイプ：文字列 | | productOrderItem.product.productSpecification.internalVersion | 製品仕様の内部バージョン。version の値と一致する必要があります。一致しない場合、エラーがスローされます。 データタイプ:文字列 表:製品仕様 \[sn_prd_pm_product_specification\] | | productOrderItem.product.productSpecification.version | 製品仕様の外部バージョン。internalVersion の値と一致する必要があります。一致しない場合、エラーがスローされます。 データタイプ:文字列 表:製品仕様 \[sn_prd_pm_product_specification\] | | productOrderItem.product.relatedParty | 品目の連絡先のリスト。 データタイプ：オブジェクトのアレイ "relatedParty": [ { "email": "String", "firstName": "String", "id": "String", "lastName": "String", "phone": "String", "@referredType": "String", "@type": "String" } ] | | productOrderItem.product.relatedParty.email | 連絡先のメールアドレス。 データタイプ：文字列 | | productOrderItem.product.relatedParty.firstName | 連絡先の名。 データタイプ：文字列 | | productOrderItem.product.relatedParty.id | 注文品目に関連付けられた品目連絡先のSys_id。注文明細品目連絡先 \[sn_ind_tmt_orm_order_line_item_contact\] テーブルにあります。 データタイプ：文字列 | | productOrderItem.product.relatedParty.lastName | 連絡先の名前 (姓)。 データタイプ：文字列 データタイプ：文字列 | | productOrderItem.product.relatedParty.phone | 連絡先の勤務先電話番号。 データタイプ：文字列 | | productOrderItem.product.relatedParty.@referredType | 顧客のタイプ。 可能な値:OrderLineItemContact データタイプ：文字列 | | productOrderItem.product.relatedParty.@type | TMF Open API 標準の一部です。注文明細品目の連絡先の注釈。この値は常に RelatedParty です。この情報は保存されません。 データタイプ：文字列 | | productOrderItem.product.@type | TMF Open API 標準の一部です。製品の注釈。この値は常に Product です。この情報は保存されません。 データタイプ：文字列 | | productOrderItem.productOffering | 製品に関連付けられた製品オファリングの説明。 データタイプ: オブジェクト "productOffering": { "id": "String", "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 Open API 標準の一部です。製品の注釈。この値は常に ProductOrderItem です。この情報は保存されません。 データタイプ：文字列 | | 関連パーティー | 注文の連絡先のリスト。各連絡先はアレイ内のオブジェクトです。顧客アカウントまたはコンシューマーアカウント情報を含むアイテムを少なくとも 1 つリストする必要があります。 データタイプ：オブジェクトのアレイ "relatedParty": [ { "id": "String", "name": "String", "@referredType": "String", "@type": "String" } ] | | relatedParty.id | 注文に関連付けられたアカウント、顧客連絡先、またはコンシューマーのSys_idまたはexternal_id。アカウント \[customer_account\]、連絡先 \[customer_contact\] テーブル、またはコンシューマー \[csm_consumer\] テーブルにあります。 データタイプ：文字列 | | relatedParty.name | アカウント、顧客、またはコンシューマーの名前。 データタイプ：文字列 | | relatedParty.type | 顧客のタイプ。 可能な値： * コンシューマー * 顧客 * 顧客連絡先 {#tmf_prod_order-PATCH-productorder-id__d3728e2631} データタイプ：文字列 | | requestedCompletionDate | 顧客が要求した配送日。 データタイプ：文字列 | | requestedStartDate | 顧客が要求した注文開始日。 データタイプ：文字列 | | 状況 | 注文の現在のステータス。 データタイプ：文字列 | | @type | TMF Open API 標準の一部です。製品の注釈。この値は常に ProductOrder です。この情報は保存されません。 データタイプ：文字列 | [ ] {#tmf_prod_order-PATCH-productorder-id__table_c1v_xpk_5rb} ### cURL 要求 {#tmf_prod_order-PATCH-productorder-id__example_jsc_1dc_vrb} 次のコード例では、顧客注文のチャネルを更新します。 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", "externalSystem": "Salesforce -- TMF 641", "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", "externalVersion": "1", "@version": "v1" }, "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" "externalVersion": "1", "@version": "v1" }, "relatedParty": [ { "id": "51670151c35420105252716b7d40ddfe", "firstName": "Joe", "lastName": "Doe", "email": "abc@example.com", "phone": "1234567890", "@type": "RelatedParty", "@referredType": "OrderLineItemContact" } ], "place": { "id": "25ab9c4d0a0a0bb300f7dabdc0ca7c1c", "@type": "Place" } }, "productOffering": { "id": "69017a0f536520103b6bddeeff7b127d", "name": "Premium SD-WAN Offering" }, "productOrderItemRelationship": [ { "id": "POI100", "relationshipType": "HasParent" } ], "@type": "ProductOrderItem", "state": "new" } ], "relatedParty": [ { "id": "eaf68911c35420105252716b7d40ddde", "name": "Sally Thomas", "@type": "RelatedParty", "@referredType": "CustomerContact" }, { "id": "ffc68911c35420105252716b7d40dd55", "name": "Funco Intl", "@type": "RelatedParty", "@referredType": "Customer" }, { "id": "59f16de1c3b67110ff00ed23a140dd9e", "name": "Funco External", "@type": "RelatedParty", "@referredType": "Consumer" } ], "@type": "ProductOrder", "id": "6be0a925c3a220103e2e73ce3640ddfe", "state": "in_progress" } ## Product Order Open API - POST /sn_ind_tmt_orm/cancelproductorder {#ariaid-title8} 指定された顧客注文をキャンセルします。 ### URL 形式 デフォルト URL: /api/sn_ind_tmt_orm/cancelproductorder ### サポートされている要求パラメーター {#tmf_prod_order-POST-cancelproductorder__entry__2} | 名前 | 説明 | |-|-| | なし | | [表 : 37. パスパラメーター] {#tmf_prod_order-POST-cancelproductorder__entry__6} | 名前 | 説明 | |-|-| | なし | | [表 : 38. クエリパラメーター] {#tmf_prod_order-POST-cancelproductorder__entry__10} | 名前 | 説明 | |-|-| | キャンセルの理由 | キャンセルの理由。 データタイプ：文字列 デフォルト：空白の文字列 | | 製品注文 | 製品注文に関するデータが含まれています。 データタイプ: オブジェクト "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` である必要があります。 データタイプ：文字列 デフォルト：空白の文字列 | [表 : 39. 要求本文パラメーター (JSON)] ### ヘッダー 次の要求ヘッダーと応答ヘッダーは、この HTTP アクションにのみ適用されるか、別の方法でこのアクションに適用されます。REST API で使用される一般的なヘッダーのリストについては、「 [サポートされている REST API ヘッダー」](https://servicenow-prod.fluidtopics.net/lLW_uT5I5_l1aD8yR4Jt9A "REST (REpresentational State Transfer) は、Web 上のコンピューター システム間の標準を提供するシンプルなステートレス アーキテクチャであり、コンピューター システム間の通信を容易にします。")を参照してください。 {#tmf_prod_order-POST-cancelproductorder__table_omb_dvk_5rb__entry__2}{#tmf_prod_order-POST-cancelproductorder__accept-JSON-only-entry-RESTAPI}{#tmf_prod_order-POST-cancelproductorder__content_type-JSON-only-entry-RESTAPI} | ヘッダー | 説明 | |-|-| | 承認 | 応答本文のデータフォーマット。application/json のみをサポートします。 | | Content-Type | 要求本文のデータ形式。application/json のみをサポートします。 | [表 : 40. 要求ヘッダー] {#tmf_prod_order-POST-cancelproductorder__table_omb_dvk_5rb} {#tmf_prod_order-POST-cancelproductorder__table_tzy_thy_ksb__entry__2} | ヘッダー | 説明 | |-|-| | Content-Type | 応答本文のデータフォーマット。application/json のみをサポートします。 | [表 : 41. 応答ヘッダー] {#tmf_prod_order-POST-cancelproductorder__table_tzy_thy_ksb} ### ステータスコード この HTTP アクションには、次のステータスコードが適用されます。REST API で使用される可能性のあるステータスコードのリストについては、「 [REST API HTTP 応答コード](https://servicenow-prod.fluidtopics.net/lLW_uT5I5_l1aD8yR4Jt9A "REST (REpresentational State Transfer) は、Web 上のコンピューター システム間の標準を提供するシンプルなステートレス アーキテクチャであり、コンピューター システム間の通信を容易にします。")」を参照してください。 {#tmf_prod_order-POST-cancelproductorder__entry__36} | ステータスコード | 説明 | |-|-| | 200 | 成功。要求が正常に処理されました。 | | 400 | 要求が正しくありません。以下のいずれかの理由が考えられます。 * 空のペイロード。{#tmf_prod_order-POST-cancelproductorder__tmf-api-post-400-empty-li} {#tmf_prod_order-POST-cancelproductorder__tmf-api-post-400-empty-li} * 無効なペイロードです。必須フィールドがありません:\<フィールド名\>。{#tmf_prod_order-POST-cancelproductorder__tmf-api-post-400-invalid-li} {#tmf_prod_order-POST-cancelproductorder__tmf-api-post-400-invalid-li} * 無効な注文 ID。 * 無効な注文 ID: この注文はまだ顧客注文テーブルで作成されていません。まだ作成されていない注文に対してキャンセル要求が行われました。注文は受信キュー \[sn_tmt_core_inbound_queue\] テーブルにあり、スケジューラーがレコードを取得するのを待機しています。 {#tmf_prod_order-POST-cancelproductorder__ul_lg1_5vt_5rb} | [表 : 42. ステータスコード] ### 応答本文のパラメーター (JSON) {#tmf_prod_order-POST-cancelproductorder__entry__42} | 名前 | 説明 | |-|-| | キャンセルの理由 | キャンセルの理由。 データタイプ：文字列 | | href | キャンセルされた注文の URL。 データタイプ：文字列 | | ID | キャンセルされた注文のSys_id。 データタイプ：文字列 | | 製品注文 | 製品注文に関するデータ。 データタイプ: オブジェクト "productOrder": { "id": "String", "href": "String", "@referredType": "String" } | | productOrder.id | キャンセルされた注文のSys_id。 データタイプ：文字列 | | productOrder.href | キャンセルされた注文の URL。 データタイプ：文字列 | | productOrder.@referredType | このパラメーターの値は `ProductOrder` です。 データタイプ：文字列 | | productOrder.@referredType | このパラメーターの値は `ProductOrderRef` です。 データタイプ：文字列 | | requestedCancellationDate | 注文をキャンセルする日付。 データタイプ：文字列 | | 状況 | キャンセルのステータス。キャンセル要求が正常に処理された場合 (ステータスコード 201)、このパラメーターの値は `完了`します。 データタイプ：文字列 | | @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 {#ariaid-title9} 指定された顧客注文と顧客注文明細品目を作成します。 処理が完了すると、次のテーブルにレコードが作成されます。 * 顧客注文 \[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\] {#tmf_prod_order-POST-ord-productOrder__ul_hxq_vdb_hqb} ### URL 形式 デフォルト URL: /api/sn_ind_tmt_orm/order/productOrder ### サポートされている要求パラメーター {#tmf_prod_order-POST-ord-productOrder__entry__2} | 名前 | 説明 | |-|-| | なし | | [表 : 43. パスパラメーター] {#tmf_prod_order-POST-ord-productOrder__entry__6} | 名前 | 説明 | |-|-| | mode | 非同期注文処理を有効にします。つまり、オーダーが受信キュー \[sn_tmt_core_inbound_queue\] テーブルに追加されて作成されます。含まれていない場合、注文は同期的に処理されます。 有効な値:非同期 データタイプ：文字列 | [表 : 44. クエリパラメーター] {#tmf_prod_order-POST-ord-productOrder__id_vk2_p5n_t4b__entry__2}{#tmf_prod_order-POST-ord-productOrder__due-date-entry}{#tmf_prod_order-POST-ord-productOrder__productOrder-href-request}{#tmf_prod_order-POST-ord-productOrder__productOrder-addReason-request}{#tmf_prod_order-POST-ord-productOrder__due-date-item-entry}{#tmf_prod_order-POST-ord-productOrder__externalProductInventoryId-desc}{#tmf_prod_order-POST-ord-productOrder__externalProductInventory-GET-desc-request}{#tmf_prod_order-POST-ord-productOrder__tmf-prod-order_prodChar.valueType} | 名前 | 説明 | |-|-| | @type | TMF Open API 標準の一部です。製品の注釈。この値は常に ProductOrder です。この情報は保存されません。 データタイプ：文字列 | | チャネル | 製品の販売に使用するチャネルのリスト。 データタイプ：オブジェクトのアレイ "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テーブルのチャネル辞書エントリの \[選択リスト\] タブで定義されます。 データタイプ：文字列 デフォルト：空白の文字列 | | committedDueDate | 注文に対してアクションを実行する必要がある日時。 この値は、各注文品目の committedDueDate 値と同じかそれ以降にする必要があります。 データタイプ：文字列 格納場所:sn_ind_tmt_orm_orderテーブルのcommitted_due_dateフィールド。 | | externalId | 顧客注文の一意の識別子。この値は外部システムによって決定されます。 データタイプ：文字列 格納場所:sn_ind_tmt_orm_orderテーブルのexternal_idフィールド。 デフォルト：空白の文字列 | | 外部システム | `TMF622` が追加された製品注文の外部システム。 たとえば、外部システムが ABC の場合、 externalSystem に `ABC-TMF622` と入力します。 データタイプ:文字列 | | href | リソースレコードへの相対リンク。 データタイプ：文字列 デフォルト：空白の文字列 | | 注意 | 注文時に顧客が記入する追加のメモ。 データタイプ：オブジェクトのアレイ "note": [ { "text": "String" } ] 保存場所:sn_ind_tmt_orm_order | | note.text | 必須です。注文時に顧客が行った追加のメモ/コメント。 データタイプ：文字列 格納場所:sn_ind_tmt_orm_orderテーブルのコメントフィールド。 デフォルト：空白の文字列 | | orderCurrency | 必須です。注文と注文明細品目の通貨コード。通貨は注文と注文品目のすべての要素で同じである必要があります。それ以外の場合はエラーが返され、注文は作成されません。注文が作成されると、その通貨コードは変更できません。 データタイプ：文字列 | | 製品注文アイテム | 必須です。製品注文とそれに関連するアクションに関連付けられたアイテム。 データタイプ：オブジェクトのアレイ "productOrderItem": [ { "action": "String", "actionReason": "String", "committedDueDate": "String", "externalProductInventory": [Array], "id": "String", "itemPrice": [Array], "product": {Object}, "productOffering": {Object}, "productOrderItemRelationship": [Array], "quantity": Number, "@type": "String" } ] 保存場所:注文明細品目 \[sn_ind_tmt_orm_order_line_item\] | | productOrderItem.@type | TMF Open API 標準の一部です。製品の注釈。この値は常に ProductOrderItem です。この情報は保存されません。 データタイプ：文字列 | | productOrderItem.action | 必須です。製品に対して実行するアクション。可能なアクションは、sn_ind_tmt_orm_order_line_itemテーブルのアクション辞書エントリの \[選択リスト\] タブで定義されます。 可能な値： * 追加 * 変更 注: productOrderItem.product.place.idを介して新しいサービスの場所を含む変更ペイロードを送信すると、移動オーダーとして処理されます。 * delete * 変更なし * 再開 * 停止する {#tmf_prod_order-POST-ord-productOrder__ul_qbd_dyp_ysb} データタイプ：文字列 保存場所:注文明細品目 \[sn_ind_tmt_orm_order_line_item\] テーブルのアクションフィールド。 | | productOrderItem.actionReason | オプション。注文明細品目の理由の説明。 データタイプ：文字列 保存場所:注文明細品目 \[sn_ind_tmt_orm_order_line_item\] テーブルのaction_reasonフィールド。 | | productOrderItem.committedDueDate | 注文品目に対してアクションを実行する必要がある日時。 データタイプ：文字列 保存場所:注文明細品目 \[sn_ind_tmt_orm_order_line_item\] テーブルのcommitted_due_dateフィールド。 | | productOrderItem.externalProductInventory.externalProductInventoryId | 製品インベントリにマッピングする外部 ID。 データタイプ：文字列 格納場所:注文明細品目 \[sn_ind_tmt_orm_order_line_item\] テーブルの external_inventory_id フィールドとsn_prd_invt_product_inventoryテーブルの sn_prd_invt_external_id フィールド。 | | productOrderItem.externalProductInventory | 注文に対して作成された製品在庫にマッピングする外部 ID。 データタイプ：オブジェクトのアレイ "externalProductInventory": [ { "externalProductInventoryId": "String" } ] | | 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.@type | TMF Open API 標準の一部です。製品の注釈。この値は常に Product です。この情報は保存されません。 データタイプ：文字列 | | productOrderItem.product.id | productOrderItem.actionが変更または削除の場合は必須です。販売された製品の一意の識別子。 データタイプ：文字列 デフォルト：空白の文字列 テーブル:製品インベントリ \[sn_ind_tmt_orm_product_inventory\] テーブルの sys_id または sn_ind_tmt_orm_external_id フィールド。 | | productOrderItem.product.place | 製品を設置する場所のマップ。 データタイプ: オブジェクト "place": { "id": "String", "@type": "String" } 保存場所:注文明細品目 \[sn_ind_tmt_orm_order_line_item\] | | productOrderItem.product.place.@type | TMF Open API 標準の一部です。注文明細品目の連絡先の注釈。この値は常に Place です。この情報は保存されません。 データタイプ：文字列 | | productOrderItem.product.place.id | 必須です。関連付けられた場所レコードのSys_id。 製品注文アイテムに対して ( productOrderItem.action パラメーターを使用して) 変更アクションを使用する場合、要求を新しい場所sys_id更新すると、注文は変更されず、新しい場所で履行される移動オーダーが作成されます。 データタイプ：文字列 テーブル:場所 \[cmn_location\] 保存場所:注文明細品目 \[sn_ind_tmt_orm_order_line_item\] テーブルの場所フィールド。 | | productOrderItem.product.productCharacteristic | 関連製品の特性。 データタイプ：オブジェクトのアレイ "productCharacteristic": [ { "name": "String", "previousValue": "String", "value": "String", "valueType": "String" } ] 格納場所:sn_ind_tmt_orm_order_characteristic_value | | productOrderItem.product.productCharacteristic.name | 製品に関連付けられた特性レコードの名前。 データタイプ：文字列 テーブル:特性 \[sn_prd_pm_characteristic\] 格納場所:sn_ind_tmt_orm_order_characteristic_valueテーブルの特性フィールド。 デフォルト：空白の文字列 | | productOrderItem.product.productCharacteristic.previousValue | 更新が変更オーダー用である場合の以前の特性オプションの値。productOrderItem.actionパラメーターが add 以外の場合、要求は変更指示です。特性オプション値の詳細については、「 [Create product characteristics and characteristic options](https://www.servicenow.com/docs/access?context=som-product-config-add-characteristics&version=australia&pubname=australia-order-management&ft:locale=en-US)」を参照してください。 データタイプ：文字列 格納場所:sn_ind_tmt_orm_order_characteristic_valueテーブルのprevious_characteristic_option_valueフィールド。 デフォルト：空白の文字列 | | productOrderItem.product.productCharacteristic.value | 製品に関連付けられた特性オプション値。特性オプション値の詳細については、「 [Create product characteristics and characteristic options](https://www.servicenow.com/docs/access?context=som-product-config-add-characteristics&version=australia&pubname=australia-order-management&ft:locale=en-US)」を参照してください。 データタイプ：文字列 格納場所: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 行テキスト * はい/いいえ {#tmf_prod_order-POST-ord-productOrder__ul_kxx_njw_xfc} データタイプ：文字列 | | productOrderItem.product.productSpecification | オプション。製品に関連付けられた製品仕様の説明。 注: 変更指示 (productOrderItem.action が `変更`) は、 sn_ind_tmt_orm.allowSpecVersionUpdateInChangeOrder システムプロパティの値に基づいて異なる方法で処理されます。このシステムプロパティの値は、製品インベントリが注文に示されているバージョンと異なる場合の注文の処理方法を決定します。 * このシステムプロパティが true (デフォルト) に設定されている場合、製品インベントリは、参照されている製品仕様を変更することによって注文のバージョンに自動的にアップグレードされます。これにより、注文を正常に処理できます。 * このシステムプロパティが false に設定されている場合、製品インベントリが注文に示されているバージョンと異なる場合、バージョンの不一致により注文は失敗します。 {#tmf_prod_order-POST-ord-productOrder__ul_zbw_sdz_dbc} データタイプ: オブジェクト "productSpecification": { "id": "String", "internalVersion": "String", "name": "String", "version": "String", "@type": "String" } 格納場所:sn_ind_tmt_orm_order_line_item | | productOrderItem.product.productSpecification.@type | TMF Open API 標準の一部です。この値は常に ProductSpecificationRef です。この情報は保存されません。 データタイプ：文字列 | | productOrderItem.product.productSpecification.id | 必須です。製品仕様の初期バージョンまたは外部 ID。初期バージョンは、仕様の最初のバージョンのsys_idです。 データタイプ：文字列 表:製品仕様 \[sn_prd_pm_product_specification\] | | productOrderItem.product.productSpecification.internalVersion | 製品仕様のバージョン。 データタイプ：文字列 テーブル:製品仕様 \[sn_prd_pm_product_specification\] テーブルのバージョンフィールド。 | | productOrderItem.product.productSpecification.internalVersion | サービス仕様の内部バージョン。version の値と一致する必要があります。一致しない場合、エラーがスローされます。 データタイプ:文字列 | | productOrderItem.product.productSpecification.name | 製品仕様の名前。 データタイプ：文字列 表:製品仕様 \[sn_prd_pm_product_specification\] | | productOrderItem.product.productSpecification.version | 製品仕様の外部バージョン。 データタイプ：文字列 テーブル:製品仕様 \[sn_prd_pm_product_specification\] テーブルの external_version フィールド。 | | productOrderItem.product.productSpecification.version | サービス仕様の外部バージョン。internalVersion の値と一致する必要があります。一致しない場合、エラーがスローされます。 データタイプ:文字列 | | 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.@referredType | 必須です。顧客のタイプ。 可能な値:OrderLineItemContact データタイプ：文字列 | | productOrderItem.product.relatedParty.@type | TMF Open API 標準の一部です。注文明細品目の連絡先の注釈。この値は常に RelatedParty です。この情報は保存されません。 データタイプ：文字列 | | productOrderItem.product.relatedParty.email | 連絡先のメールアドレス。 データタイプ：文字列 格納場所:sn_ind_tmt_orm_order_line_item_contactテーブルのメールフィールド。 デフォルト：空白の文字列 | | productOrderItem.product.relatedParty.firstName | 連絡先の名。 データタイプ：文字列 格納場所:sn_ind_tmt_orm_order_line_item_contactテーブルのfirst_nameフィールド。 デフォルト：空白の文字列 | | productOrderItem.product.relatedParty.lastName | 連絡先の名前 (姓)。 データタイプ：文字列 格納場所:sn_ind_tmt_orm_order_line_item_contactテーブルの lastName フィールド。 デフォルト：空白の文字列 | | productOrderItem.product.relatedParty.phone | 連絡先の勤務先電話番号。 データタイプ：文字列 格納場所:sn_ind_tmt_orm_order_line_item_contactテーブルのbusiness_phoneフィールド。 デフォルト：空白の文字列 | | productOrderItem.productOffering | 必須です。製品に関連付けられた製品オファリングの説明。 データタイプ: オブジェクト "productOffering": { "id": "String", "internalVersion": "String", "name": "String", "version": "String" } 格納場所:sn_ind_tmt_orm_order_line_item | | productOrderItem.productOffering.id | 必須です。製品オファリングの初期バージョンまたは外部 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 * 親がある {#tmf_prod_order-POST-ord-productOrder__ul_rmq_vrk_5rb} データタイプ：文字列 | | productOrderItem.quantity | 注文されたアイテムの数。 データタイプ：数値 格納場所:sn_ind_tmt_orm_orderテーブルの数量フィールド。 デフォルト：空白の文字列 | | 関連パーティー | 注文の連絡先のリスト。各連絡先はアレイ内のオブジェクトです。顧客アカウントまたはコンシューマーアカウント情報を含むアイテムを少なくとも 1 つリストする必要があります。 データタイプ：オブジェクトのアレイ "relatedParty": [ { "id": "String", "name": "String", "@referredType": "String", "@type": "String" } ] | | relatedParty.@referredType | 必須です。顧客のタイプ。 可能な値： * コンシューマー * 顧客 * 顧客連絡先 {#tmf_prod_order-POST-ord-productOrder__ul_smq_vrk_5rb} データタイプ：文字列 | | relatedParty.@type | TMF Open API 標準の一部です。製品の注釈。この値は常に RelatedParty です。この情報は保存されません。 データタイプ：文字列 | | relatedParty.id | 注文に関連付けられたアカウントまたは顧客の連絡先のSys_idまたはexternal_id。 データタイプ：文字列 テーブル:アカウント \[customer_account\]、連絡先 \[customer_contact\] テーブル、またはコンシューマー \[csm_consumer\] | | relatedParty.name | アカウント、顧客、またはコンシューマーの名前。 データタイプ：文字列 | | requestedCompletionDate | 顧客が要求した配送日。 データタイプ：文字列 格納場所:sn_ind_tmt_orm_orderテーブルのexpected_end_dateフィールド。 デフォルト：空白の文字列 | | requestedStartDate | 顧客が要求した注文開始日。 データタイプ：文字列 格納場所:sn_ind_tmt_orm_orderテーブルのexpected_start_dateフィールド。 デフォルト：空白の文字列 | [表 : 45. 要求本文パラメーター (JSON)] {#tmf_prod_order-POST-ord-productOrder__id_vk2_p5n_t4b} ### ヘッダー 次の要求ヘッダーと応答ヘッダーは、この HTTP アクションにのみ適用されるか、別の方法でこのアクションに適用されます。REST API で使用される一般的なヘッダーのリストについては、「 [サポートされている REST API ヘッダー」](https://servicenow-prod.fluidtopics.net/lLW_uT5I5_l1aD8yR4Jt9A "REST (REpresentational State Transfer) は、Web 上のコンピューター システム間の標準を提供するシンプルなステートレス アーキテクチャであり、コンピューター システム間の通信を容易にします。")を参照してください。 {#tmf_prod_order-POST-ord-productOrder__table_omb_dvk_5rb__entry__2}{#tmf_prod_order-POST-ord-productOrder__accept-JSON-only-entry-RESTAPI}{#tmf_prod_order-POST-ord-productOrder__content_type-JSON-only-entry-RESTAPI} | ヘッダー | 説明 | |-|-| | 承認 | 応答本文のデータフォーマット。application/json のみをサポートします。 | | Content-Type | 要求本文のデータ形式。application/json のみをサポートします。 | [表 : 46. 要求ヘッダー] {#tmf_prod_order-POST-ord-productOrder__table_omb_dvk_5rb} {#tmf_prod_order-POST-ord-productOrder__table_tzy_thy_ksb__entry__2} | ヘッダー | 説明 | |-|-| | Content-Type | 応答本文のデータフォーマット。application/json のみをサポートします。 | [表 : 47. 応答ヘッダー] {#tmf_prod_order-POST-ord-productOrder__table_tzy_thy_ksb} ### ステータスコード この HTTP アクションには、次のステータスコードが適用されます。REST API で使用される可能性のあるステータスコードのリストについては、「 [REST API HTTP 応答コード](https://servicenow-prod.fluidtopics.net/lLW_uT5I5_l1aD8yR4Jt9A "REST (REpresentational State Transfer) は、Web 上のコンピューター システム間の標準を提供するシンプルなステートレス アーキテクチャであり、コンピューター システム間の通信を容易にします。")」を参照してください。 {#tmf_prod_order-POST-ord-productOrder__entry__160} | ステータスコード | 説明 | |-|-| | 201 | 成功。 特性または特性オプション情報に問題がある場合、エンドポイントは関連する顧客発注書明細レコードの作業メモフィールドに次のコメントを保存します。 * 次の注文品目特性が存在しません。注文を承認する前に、仕様\を確認し、注文明細品目の特性と特性オプションを修正してください。 * 注文アイテム特性:特性値\を持つ\は無効です。注文を承認する前に特性値を修正してください。 {#tmf_prod_order-POST-ord-productOrder__ul_xtx_xym_t4b} | | 202 | 承認済み。非同期モードで注文が正常に要求されました。つまり、 mode パラメーターが `非同期` に設定された状態で要求が行われ、レコードは受信キュー \[sn_tmt_core_inbound_queue\] テーブルで処理されるようにスケジュールされています。 | | 400 | 要求が正しくありません。以下のいずれかの理由が考えられます。 * 無効なペイロード:要求本文がありません:ペ イロードが要求本文で渡されませんでした。 * 無効なペイロード:productOrderItem がありません :製品の注文明細品目オブジェクトまたは JSON がありません。 * 無効なペイロード:productOrderItem id がありません :ペイロードの製品注文明細品目に id パラメーターがありません。 * 無効なペイロード:productOrderItem アクションがありません: ペイロードの製品注文明細品目に action パラメーターがありません。 * 無効なペイロード:productOrderItem productOffering がありません :ペイロードの製品注文明細品目に製品オファリングオブジェクトまたは JSON がありません。 * 無効なペイロード:productOffering id がありません :ペイロード内の製品オファリングオブジェクトの製品注文明細品目に id パラメーターがありません。 * 無効なペイロード:製品オファリングが存在しません :製品注文明細品目の製品オファリングが無効です。 * 無効なペイロード:productOrderItem 製品がありません: 製品注文明細品目の製品オブジェクトまたは JSON がペイロードにありません。 * 無効なペイロード:製品 productSpecification がありません :製品注文明細品目の製品仕様オブジェクトまたは JSON がペイロードにありません。 * 無効なペイロード:productSpecification id がありません :製品仕様オブジェクトの製品注文明細品目の id パラメーターがペイロードにありません。 * 無効なペイロード:製品仕様が存在しません :製品注文明細品目の製品仕様が無効です。 * 無効なペイロード:プロダクトインベントリが存在しません : 変更指示 (アクション = 変更) で、アイテムの数量が在庫数量を上回っています。 * 無効なペイロード:製品インベントリ ID がありません :注文変更では、ペイロードに product.id がありません。 * 無効なペイロード:販売済み製品は非アクティブです :変更指示で、ペイロードに指定された製品が非アクティブです。 * 無効なペイロード:relatedParty がありません :関係者オブジェクトがペイロードにありません。 * 無効なペイロード:顧客アカウントまたはコンシューマーがありません :関係者顧客またはコンシューマーオブジェクトがペイロードにありません。 * 無効なペイロード:コンシューマーが存在しません :指定された関係者コンシューマーが ServiceNow インスタンスに存在しません。 * 無効なペイロード:顧客アカウントが存在しません :指定された関係者顧客が ServiceNow インスタンスに存在しません。 * 無効なペイロード:注文の作成に失敗しました。 要求された注文を作成できません。 * 無効なペイロード:orderCurrency が必要です: ペイロードに orderCurrency パラメーターがありません。 * 非アクティブな通貨コード:\ :指定された通貨は ServiceNow インスタンスで非アクティブです。 * 1 つ以上の明細品目の通貨コードが発注通貨と異なる :すべての明細品目の通貨コードが発注通貨とは限りません。 * 注文通貨の実行中の改訂はサポートされていません :注文の作成後に orderCurrency パラメーターを更新することはできません。 {#tmf_prod_order-POST-ord-productOrder__ul_g2v_rzm_t4b} | [表 : 48. ステータスコード] ### 応答本文のパラメーター (JSON) {#tmf_prod_order-POST-ord-productOrder__entry__168}{#tmf_prod_order-POST-ord-productOrder__externalProdInv-resp-descr}{#tmf_prod_order-POST-ord-productOrder__externalProdInvId-resp-descr} | 名前 | 説明 | |-|-| | チャネル | 製品の販売に使用するチャネルのリスト。 データタイプ：オブジェクトのアレイ "channel": [ { "id": "String", "name": "String" } ] | | channel.id | 関連製品の販売に使用するチャネルの一意の識別子。 データタイプ：文字列 | | channel.name | 関連製品の販売に使用するチャネルの名前。 データタイプ：文字列 | | committedDueDate | 注文に対してアクションを実行する必要がある日時。 この値は、各注文品目の committedDueDate 値と同じかそれ以降にする必要があります。 データタイプ：文字列 | | externalId | 発注書番号などの顧客注文の外部識別子。 データタイプ：文字列 | | href | 製品注文レコードへの相対リンク。 データタイプ：文字列 | | ID | この要求に対して作成された顧客注文のSys_id。 データタイプ：文字列 | | 注意 | 注文時に顧客が行った追加のメモのリスト。 データタイプ：オブジェクトのアレイ "note": [ { "text": "String" } ] | | note.text | 注文時に顧客が行った追加のメモ/コメント。 データタイプ：文字列 | | orderCurrency | 注文と注文明細品目の通貨コード。 データタイプ：文字列 | | orderId | 作成する注文のSys_id。成功した要求に応じて、注文は処理対象のスケジュールに従って受信キュー \[sn_tmt_core_inbound_queue\] テーブルに追加されます。 注: この値は、注文が mode クエリパラメーターを使用して非同期に作成された場合の唯一の結果です。 { "orderId": "b0fc877ac3ab5110856d73ce3640dde0" } データタイプ：文字列 | | 製品注文アイテム | 製品注文とそれに関連するアクションに関連付けられたアイテムを説明するリスト。 データタイプ：オブジェクトのアレイ "productOrderItem:" [ { "action": "String", "committedDueDate": "String", "externalProductInventory": [Array], "id": "String", "itemPrice": [Array], "product": {Object}, "productOffering": {Object}, "productOrderItemReleationship": [Array], "quantity": Number, "state": "String", "@type": "String" } ] | | productOrderItem.action | 製品に対して実行するアクション。可能なアクションは、sn_ind_tmt_orm_order_line_itemテーブルのアクション辞書エントリの \[選択リスト\] タブで定義されます。 データタイプ：文字列 | | productOrderItem.actionReason | 注文明細品目を追加する理由。 データタイプ：文字列 格納場所:sn_ind_tmt_orm_order_line_itemテーブルのaction_reasonフィールド。 | | productOrderItem.committedDueDate | 注文品目に対してアクションを実行する必要がある日時。 データタイプ：文字列 | | productOrderItem.externalProductInventory | 注文に対して作成された製品インベントリにマッピングされた外部 ID のリスト。 データタイプ：オブジェクトのアレイ "externalProductInventory": [ { "externalProductInventoryId": "String" } ] | | productOrderItem.externalProductInventory.externalProductInventoryId | 製品インベントリにマッピングされた外部 ID。 データタイプ：文字列 | | productOrderItem.id | 品目の一意の識別子。注文明細品目 \[sn_ind_tmt_orm_order_line_item\] テーブルの sn_ind_tmt_orm_external_id フィールドにあります。 データタイプ：文字列 | | productOrderItem.itemPrice | 製品に関連付けられた価格を説明するリスト。 データタイプ：オブジェクトのアレイ "itemPrice": [ { "price": {Object}, "priceType": "String", "recurringChargePeriod": "String" } ] | | productOrderItem.itemPrice.price | 関連製品の価格の説明。 データタイプ: オブジェクト "price": { "taxIncludedAmount": {Object} } | | productOrderItem.itemPrice.price.taxIncludeAmount | 税を含む関連製品の価格の説明。 データタイプ: オブジェクト "taxIncludedAmount": { "unit": "String", "value": Number } | | productOrderItem.itemPrice.price.taxIncludeAmount.unit | 価格を表す通貨コード。 データタイプ：文字列 | | productOrderItem.itemPrice.price.taxIncludeAmount.value | 製品の価格 (税込み)。 データタイプ：数値 | | productOrderItem.itemPrice.priceType | アイテム価格のタイプ (繰り返しまたは非繰り返し)。 データタイプ：文字列 | | productOrderItem.itemPrice.recurringChargePeriod | 価格が繰り返し発生する場合は、 月などの繰り返し期間。 データタイプ：文字列 | | productOrderItem.product | 顧客が購入した製品のインスタンス詳細の説明。 データタイプ: オブジェクト "product": { "id": "String", "place": {Object}, "productCharacteristic": [Array], "productSpecification": {Object}, "relatedParty": {Object}, "@type": "String" } | | productOrderItem.product.id | 販売された製品の一意の識別子。製品インベントリ \[sn_ind_tmt_orm_product_inventory\] テーブルのsys_idまたはsn_ind_tmt_orm_external_idフィールドにあります。このパラメーターは、productOrderItem.actionが変更または削除の場合にのみ返されます。sys_idとexternal_idの両方が存在する場合は、external_idが返されます。 データタイプ：文字列 | | productOrderItem.product.place | 製品を設置する場所のマップ。 データタイプ: オブジェクト "place": { "id": "String", "@type": "String" } | | productOrderItem.product.place.id | 場所 \[cmn_location\] テーブル内の関連する場所レコードのSys_id。製品注文アイテムに対して ( productOrderItem.action パラメーターを使用して) 変更アクションを使用する場合、要求を新しい場所sys_id更新すると、注文は変更されず、新しい場所で履行される移動オーダーが作成されます。 データタイプ：文字列 | | productOrderItem.product.productCharacteristic | 関連製品の特性のリスト。 データタイプ：オブジェクトのアレイ "productCharacteristic": [ { "name": "String", "previousValue": "String", "value": "String", "valueType": "String" } ] | | productOrderItem.product.productCharacteristic.name | 製品に関連付ける特性レコードの名前。特性 \[sn_prd_pm_characteristic\] テーブルにあります。 データタイプ：文字列 | | productOrderItem.product.productCharacteristic.previousValue | 更新が変更指示用である場合の以前の特性オプションの値。productOrderItem.actionパラメーターが add 以外の場合、要求は変更指示です。特性オプション値の詳細については、「 [Create product characteristics and characteristic options](https://www.servicenow.com/docs/access?context=som-product-config-add-characteristics&version=australia&pubname=australia-order-management&ft:locale=en-US)」を参照してください。 データタイプ：文字列 | | productOrderItem.product.productCharacteristic.value | 製品に関連付けられた特性オプション値。特性オプション値の詳細については、「 [Create product characteristics and characteristic options](https://www.servicenow.com/docs/access?context=som-product-config-add-characteristics&version=australia&pubname=australia-order-management&ft:locale=en-US)」を参照してください。 データタイプ：文字列 | | productOrderItem.product.productRelationship | 注文品目の製品リレーションシップの詳細のリスト。 データタイプ：アレイ "productRelationship": [ { "id": "String", "relationshipType": "String" } ] | | productOrderItem.product.productRelationship.id | 製品インベントリのSys_idまたはsn_prd_invt_external_id。 データタイプ：文字列 テーブル:製品インベントリ \[sn_prd_invt_product_inventory\] テーブルのSys_idまたはsn_prd_invt_external_idフィールド。 | | productOrderItem.product.productRelationship.relationshipType | 注文品目と製品インベントリの間の関係のタイプ。 可能な値:必要 データタイプ：文字列 | | productOrderItem.product.productSpecification | 製品に関連付けられた製品仕様の説明。 データタイプ: オブジェクト "productSpecification:" { "id": "String", "internalId": "String", "internalVersion": "String", "name": "String", "version": "String", "@type": "String" } | | productOrderItem.product.productSpecification.id | 製品仕様のInitial_versionまたはexternal_id。initial_versionは仕様の最初のバージョンのsys_idです。製品仕様 \[sn_prd_pm_product_specification\] テーブルの \[sys_id\] または \[external_id\] フィールドにあります。 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 Open 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 Open API 標準の一部です。注文明細品目の連絡先の注釈。この値は常に RelatedParty です。この情報は保存されません。 データタイプ：文字列 | | productOrderItem.product.@type | TMF Open API 標準の一部です。製品の注釈。この値は常に Product です。この情報は保存されません。 データタイプ：文字列 | | productOrderItem.productOffering | 製品に関連付けられた製品オファリングの説明。 データタイプ: オブジェクト "productOffering:" { "id": "String", "internalId": "String", "internalVersion": "String", "name": "String", "version": "String" } | | productOrderItem.productOffering.id | 製品オファリングのInitial_versionまたはexternal_id。initial_versionは、オファリングの最初のバージョンのsys_idです。製品オファリング \[sn_prd_pm_product_offering\] テーブルの sys_id または external_id フィールドにあります。 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 * 親がある * 必要 {#tmf_prod_order-POST-ord-productOrder__ul_yqf_2ty_54b} `HasChild` と `HasParent` は、親子関係に使用されます。\[`必須]` は水平関係に使用されます (品目には別の品目が必要です)。 データタイプ：文字列 | | productOrderItem.quantity | 注文する関連アイテムの数。 データタイプ：数値 | | productOrderItem.state | 製品注文アイテムの現在のステータス。この値は常に 新規です。 データタイプ：文字列 | | productOrderItem.@type | TMF Open API 標準の一部です。製品の注釈。この値は常に ProductOrderItem です。この情報は保存されません。 データタイプ：文字列 | | 関連パーティー | 注文の連絡先のリスト。各連絡先はアレイ内のオブジェクトです。顧客アカウントまたはコンシューマーアカウント情報を含むアイテムを少なくとも 1 つリストする必要があります。 データタイプ：オブジェクトのアレイ "relatedParty": [ { "id": "String", "name": "String", "@referredType": "String", "@type": "String" } ] | | relatedParty.id | 注文に関連付けられたアカウント、顧客連絡先、またはコンシューマーのSys_idまたはexternal_id。アカウント \[customer_account\]、連絡先 \[customer_contact\] テーブル、またはコンシューマー \[csm_consumer\] テーブルにあります。 データタイプ：文字列 | | relatedParty.name | アカウント、顧客、またはコンシューマーの名前。 データタイプ：文字列 | | relatedParty.type | 顧客のタイプ。 可能な値： * コンシューマー * 顧客 * 顧客連絡先 {#tmf_prod_order-POST-ord-productOrder__ul_lcq_jwm_t4b} データタイプ：文字列 | | requestedCompletionDate | 顧客が要求した配送日。 データタイプ：文字列 | | requestedStartDate | 顧客が要求した注文開始日。 データタイプ：文字列 | | 状況 | 注文の現在のステータス。このエンドポイントの場合、この値は常に 新規です。 データタイプ：文字列 | | @type | TMF Open API 標準の一部です。製品の注釈。この値は常に ProductOrder です。この情報は保存されません。 データタイプ：文字列 | [ ] ### 非同期処理 {#tmf_prod_order-POST-ord-productOrder__example_ynv_vhx_fwb} この例では、 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 {#ariaid-title10} 指定された顧客注文と顧客注文明細品目を作成します。 重要: Tokyoリリース以降、このエンドポイントは廃止されました。このエンドポイントの新しいバージョンは [製品注文オープン API - POST /sn_ind_tmt_orm/order/productOrder](https://servicenow-prod.fluidtopics.net/JmfbW68d5V7q7_xA6oKRug#tmf_prod_order-POST-ord-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\] {#tmf_prod_order-POST-productOrder__ul_hxq_vdb_hqb} ### URL 形式 デフォルト URL: /api/sn_ind_tmt_orm/productorder ### サポートされている要求パラメーター {#tmf_prod_order-POST-productOrder__entry__2} | 名前 | 説明 | |-|-| | なし | | [表 : 49. パスパラメーター] {#tmf_prod_order-POST-productOrder__entry__6} | 名前 | 説明 | |-|-| | なし | | [表 : 50. クエリパラメーター] {#tmf_prod_order-POST-productOrder__id_vk2_p5n_t4b__entry__2}{#tmf_prod_order-POST-productOrder__due-date-entry}{#tmf_prod_order-POST-productOrder__productOrder-href-request}{#tmf_prod_order-POST-productOrder__productOrder-addReason-request}{#tmf_prod_order-POST-productOrder__due-date-item-entry}{#tmf_prod_order-POST-productOrder__externalProductInventoryId-desc}{#tmf_prod_order-POST-productOrder__externalProductInventory-GET-desc-request}{#tmf_prod_order-POST-productOrder__tmf-prod-order_prodChar.valueType} | 名前 | 説明 | |-|-| | @type | TMF Open API 標準の一部です。製品の注釈。この値は常に ProductOrder です。この情報は保存されません。 データタイプ：文字列 | | チャネル | 製品の販売に使用するチャネルのリスト。 データタイプ：オブジェクトのアレイ "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テーブルのチャネル辞書エントリの \[選択リスト\] タブで定義されます。 データタイプ：文字列 デフォルト：空白の文字列 | | committedDueDate | 注文に対してアクションを実行する必要がある日時。 この値は、各注文品目の committedDueDate 値と同じかそれ以降にする必要があります。 データタイプ：文字列 格納場所:sn_ind_tmt_orm_orderテーブルのcommitted_due_dateフィールド。 | | externalId | 顧客注文の一意の識別子。この値は外部システムによって決定されます。 データタイプ：文字列 格納場所:sn_ind_tmt_orm_orderテーブルのexternal_idフィールド。 デフォルト：空白の文字列 | | 外部システム | `TMF622` が追加された製品注文の外部システム。 たとえば、外部システムが ABC の場合、 externalSystem に `ABC-TMF622` と入力します。 データタイプ:文字列 | | href | リソースレコードへの相対リンク。 データタイプ：文字列 デフォルト：空白の文字列 | | 注意 | 注文時に顧客が記入する追加のメモ。 データタイプ：オブジェクトのアレイ "note": [ { "text": "String" } ] 保存場所:sn_ind_tmt_orm_order | | note.text | 必須です。注文時に顧客が行った追加のメモ/コメント。 データタイプ：文字列 格納場所:sn_ind_tmt_orm_orderテーブルのコメントフィールド。 デフォルト：空白の文字列 | | orderCurrency | 必須です。注文と注文明細品目の通貨コード。通貨は注文と注文品目のすべての要素で同じである必要があります。それ以外の場合はエラーが返され、注文は作成されません。注文が作成されると、その通貨コードは変更できません。 データタイプ：文字列 | | 製品注文アイテム | 必須です。製品注文とそれに関連するアクションに関連付けられたアイテム。 データタイプ：オブジェクトのアレイ "productOrderItem": [ { "action": "String", "actionReason": "String", "committedDueDate": "String", "externalProductInventory": [Array], "id": "String", "itemPrice": [Array], "product": {Object}, "productOffering": {Object}, "productOrderItemRelationship": [Array], "quantity": Number, "@type": "String" } ] 保存場所:注文明細品目 \[sn_ind_tmt_orm_order_line_item\] | | productOrderItem.@type | TMF Open API 標準の一部です。製品の注釈。この値は常に ProductOrderItem です。この情報は保存されません。 データタイプ：文字列 | | productOrderItem.action | 必須です。製品に対して実行するアクション。可能なアクションは、sn_ind_tmt_orm_order_line_itemテーブルのアクション辞書エントリの \[選択リスト\] タブで定義されます。 可能な値： * 追加 * 変更 注: productOrderItem.product.place.idを介して新しいサービスの場所を含む変更ペイロードを送信すると、移動オーダーとして処理されます。 * delete * 変更なし * 再開 * 停止する {#tmf_prod_order-POST-productOrder__ul_qbd_dyp_ysb} データタイプ：文字列 保存場所:注文明細品目 \[sn_ind_tmt_orm_order_line_item\] テーブルのアクションフィールド。 | | productOrderItem.actionReason | オプション。注文明細品目の理由の説明。 データタイプ：文字列 保存場所:注文明細品目 \[sn_ind_tmt_orm_order_line_item\] テーブルのaction_reasonフィールド。 | | productOrderItem.committedDueDate | 注文品目に対してアクションを実行する必要がある日時。 データタイプ：文字列 保存場所:注文明細品目 \[sn_ind_tmt_orm_order_line_item\] テーブルのcommitted_due_dateフィールド。 | | productOrderItem.externalProductInventory.externalProductInventoryId | 製品インベントリにマッピングする外部 ID。 データタイプ：文字列 格納場所:注文明細品目 \[sn_ind_tmt_orm_order_line_item\] テーブルの external_inventory_id フィールドとsn_prd_invt_product_inventoryテーブルの sn_prd_invt_external_id フィールド。 | | productOrderItem.externalProductInventory | 注文に対して作成された製品在庫にマッピングする外部 ID。 データタイプ：オブジェクトのアレイ "externalProductInventory": [ { "externalProductInventoryId": "String" } ] | | 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.@type | TMF Open API 標準の一部です。製品の注釈。この値は常に Product です。この情報は保存されません。 データタイプ：文字列 | | productOrderItem.product.id | productOrderItem.actionが変更または削除の場合は必須です。販売された製品の一意の識別子。 データタイプ：文字列 デフォルト：空白の文字列 テーブル:製品インベントリ \[sn_ind_tmt_orm_product_inventory\] テーブルの sys_id または sn_ind_tmt_orm_external_id フィールド。 | | productOrderItem.product.place | 製品を設置する場所のマップ。 データタイプ: オブジェクト "place": { "id": "String", "@type": "String" } 保存場所:注文明細品目 \[sn_ind_tmt_orm_order_line_item\] | | productOrderItem.product.place.@type | TMF Open API 標準の一部です。注文明細品目の連絡先の注釈。この値は常に Place です。この情報は保存されません。 データタイプ：文字列 | | productOrderItem.product.place.id | 必須です。関連付けられた場所レコードのSys_id。 製品注文アイテムに対して ( productOrderItem.action パラメーターを使用して) 変更アクションを使用する場合、要求を新しい場所sys_id更新すると、注文は変更されず、新しい場所で履行される移動オーダーが作成されます。 データタイプ：文字列 テーブル:場所 \[cmn_location\] 保存場所:注文明細品目 \[sn_ind_tmt_orm_order_line_item\] テーブルの場所フィールド。 | | productOrderItem.product.productCharacteristic | 関連製品の特性。 データタイプ：オブジェクトのアレイ "productCharacteristic": [ { "name": "String", "previousValue": "String", "value": "String", "valueType": "String" } ] 格納場所:sn_ind_tmt_orm_order_characteristic_value | | productOrderItem.product.productCharacteristic.name | 製品に関連付けられた特性レコードの名前。 データタイプ：文字列 テーブル:特性 \[sn_prd_pm_characteristic\] 格納場所:sn_ind_tmt_orm_order_characteristic_valueテーブルの特性フィールド。 デフォルト：空白の文字列 | | productOrderItem.product.productCharacteristic.previousValue | 更新が変更オーダー用である場合の以前の特性オプションの値。productOrderItem.actionパラメーターが add 以外の場合、要求は変更指示です。特性オプション値の詳細については、「 [Create product characteristics and characteristic options](https://www.servicenow.com/docs/access?context=som-product-config-add-characteristics&version=australia&pubname=australia-order-management&ft:locale=en-US)」を参照してください。 データタイプ：文字列 格納場所:sn_ind_tmt_orm_order_characteristic_valueテーブルのprevious_characteristic_option_valueフィールド。 デフォルト：空白の文字列 | | productOrderItem.product.productCharacteristic.value | 製品に関連付けられた特性オプション値。特性オプション値の詳細については、「 [Create product characteristics and characteristic options](https://www.servicenow.com/docs/access?context=som-product-config-add-characteristics&version=australia&pubname=australia-order-management&ft:locale=en-US)」を参照してください。 データタイプ：文字列 格納場所: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 行テキスト * はい/いいえ {#tmf_prod_order-POST-productOrder__ul_kxx_njw_xfc} データタイプ：文字列 | | productOrderItem.product.productSpecification | オプション。製品に関連付けられた製品仕様の説明。 注: 変更指示 (productOrderItem.action が `変更`) は、 sn_ind_tmt_orm.allowSpecVersionUpdateInChangeOrder システムプロパティの値に基づいて異なる方法で処理されます。このシステムプロパティの値は、製品インベントリが注文に示されているバージョンと異なる場合の注文の処理方法を決定します。 * このシステムプロパティが true (デフォルト) に設定されている場合、製品インベントリは、参照されている製品仕様を変更することによって注文のバージョンに自動的にアップグレードされます。これにより、注文を正常に処理できます。 * このシステムプロパティが false に設定されている場合、製品インベントリが注文に示されているバージョンと異なる場合、バージョンの不一致により注文は失敗します。 {#tmf_prod_order-POST-productOrder__ul_zbw_sdz_dbc} データタイプ: オブジェクト "productSpecification": { "id": "String", "internalVersion": "String", "name": "String", "version": "String", "@type": "String" } 格納場所:sn_ind_tmt_orm_order_line_item | | productOrderItem.product.productSpecification.@type | TMF Open API 標準の一部です。この値は常に ProductSpecificationRef です。この情報は保存されません。 データタイプ：文字列 | | productOrderItem.product.productSpecification.id | 必須です。製品仕様の初期バージョンまたは外部 ID。初期バージョンは、仕様の最初のバージョンのsys_idです。 データタイプ：文字列 表:製品仕様 \[sn_prd_pm_product_specification\] | | productOrderItem.product.productSpecification.internalVersion | 製品仕様のバージョン。 データタイプ：文字列 テーブル:製品仕様 \[sn_prd_pm_product_specification\] テーブルのバージョンフィールド。 | | productOrderItem.product.productSpecification.internalVersion | サービス仕様の内部バージョン。version の値と一致する必要があります。一致しない場合、エラーがスローされます。 データタイプ:文字列 | | productOrderItem.product.productSpecification.name | 製品仕様の名前。 データタイプ：文字列 表:製品仕様 \[sn_prd_pm_product_specification\] | | productOrderItem.product.productSpecification.version | 製品仕様の外部バージョン。 データタイプ：文字列 テーブル:製品仕様 \[sn_prd_pm_product_specification\] テーブルの external_version フィールド。 | | productOrderItem.product.productSpecification.version | サービス仕様の外部バージョン。internalVersion の値と一致する必要があります。一致しない場合、エラーがスローされます。 データタイプ:文字列 | | 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.@referredType | 必須です。顧客のタイプ。 可能な値:OrderLineItemContact データタイプ：文字列 | | productOrderItem.product.relatedParty.@type | TMF Open API 標準の一部です。注文明細品目の連絡先の注釈。この値は常に RelatedParty です。この情報は保存されません。 データタイプ：文字列 | | productOrderItem.product.relatedParty.email | 連絡先のメールアドレス。 データタイプ：文字列 格納場所:sn_ind_tmt_orm_order_line_item_contactテーブルのメールフィールド。 デフォルト：空白の文字列 | | productOrderItem.product.relatedParty.firstName | 連絡先の名。 データタイプ：文字列 格納場所:sn_ind_tmt_orm_order_line_item_contactテーブルのfirst_nameフィールド。 デフォルト：空白の文字列 | | productOrderItem.product.relatedParty.lastName | 連絡先の名前 (姓)。 データタイプ：文字列 格納場所:sn_ind_tmt_orm_order_line_item_contactテーブルの lastName フィールド。 デフォルト：空白の文字列 | | productOrderItem.product.relatedParty.phone | 連絡先の勤務先電話番号。 データタイプ：文字列 格納場所:sn_ind_tmt_orm_order_line_item_contactテーブルのbusiness_phoneフィールド。 デフォルト：空白の文字列 | | productOrderItem.productOffering | 必須です。製品に関連付けられた製品オファリングの説明。 データタイプ: オブジェクト "productOffering": { "id": "String", "internalVersion": "String", "name": "String", "version": "String" } 格納場所:sn_ind_tmt_orm_order_line_item | | productOrderItem.productOffering.id | 必須です。製品オファリングの初期バージョンまたは外部 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 * 親がある {#tmf_prod_order-POST-productOrder__ul_rmq_vrk_5rb} データタイプ：文字列 | | productOrderItem.quantity | 注文されたアイテムの数。 データタイプ：数値 格納場所:sn_ind_tmt_orm_orderテーブルの数量フィールド。 デフォルト：空白の文字列 | | 関連パーティー | 注文の連絡先のリスト。各連絡先はアレイ内のオブジェクトです。顧客アカウントまたはコンシューマーアカウント情報を含むアイテムを少なくとも 1 つリストする必要があります。 データタイプ：オブジェクトのアレイ "relatedParty": [ { "id": "String", "name": "String", "@referredType": "String", "@type": "String" } ] | | relatedParty.@referredType | 必須です。顧客のタイプ。 可能な値： * コンシューマー * 顧客 * 顧客連絡先 {#tmf_prod_order-POST-productOrder__ul_smq_vrk_5rb} データタイプ：文字列 | | relatedParty.@type | TMF Open API 標準の一部です。製品の注釈。この値は常に RelatedParty です。この情報は保存されません。 データタイプ：文字列 | | relatedParty.id | 注文に関連付けられたアカウントまたは顧客の連絡先のSys_idまたはexternal_id。 データタイプ：文字列 テーブル:アカウント \[customer_account\]、連絡先 \[customer_contact\] テーブル、またはコンシューマー \[csm_consumer\] | | relatedParty.name | アカウント、顧客、またはコンシューマーの名前。 データタイプ：文字列 | | requestedCompletionDate | 顧客が要求した配送日。 データタイプ：文字列 格納場所:sn_ind_tmt_orm_orderテーブルのexpected_end_dateフィールド。 デフォルト：空白の文字列 | | requestedStartDate | 顧客が要求した注文開始日。 データタイプ：文字列 格納場所:sn_ind_tmt_orm_orderテーブルのexpected_start_dateフィールド。 デフォルト：空白の文字列 | [表 : 51. 要求本文パラメーター (JSON)] {#tmf_prod_order-POST-productOrder__id_vk2_p5n_t4b} ### ヘッダー 次の要求ヘッダーと応答ヘッダーは、この HTTP アクションにのみ適用されるか、別の方法でこのアクションに適用されます。REST API で使用される一般的なヘッダーのリストについては、「 [サポートされている REST API ヘッダー」](https://servicenow-prod.fluidtopics.net/lLW_uT5I5_l1aD8yR4Jt9A "REST (REpresentational State Transfer) は、Web 上のコンピューター システム間の標準を提供するシンプルなステートレス アーキテクチャであり、コンピューター システム間の通信を容易にします。")を参照してください。 {#tmf_prod_order-POST-productOrder__table_omb_dvk_5rb__entry__2}{#tmf_prod_order-POST-productOrder__accept-JSON-only-entry-RESTAPI}{#tmf_prod_order-POST-productOrder__content_type-JSON-only-entry-RESTAPI} | ヘッダー | 説明 | |-|-| | 承認 | 応答本文のデータフォーマット。application/json のみをサポートします。 | | Content-Type | 要求本文のデータ形式。application/json のみをサポートします。 | [表 : 52. 要求ヘッダー] {#tmf_prod_order-POST-productOrder__table_omb_dvk_5rb} {#tmf_prod_order-POST-productOrder__table_tzy_thy_ksb__entry__2} | ヘッダー | 説明 | |-|-| | Content-Type | 応答本文のデータフォーマット。application/json のみをサポートします。 | [表 : 53. 応答ヘッダー] {#tmf_prod_order-POST-productOrder__table_tzy_thy_ksb} ### ステータスコード この HTTP アクションには、次のステータスコードが適用されます。REST API で使用される可能性のあるステータスコードのリストについては、「 [REST API HTTP 応答コード](https://servicenow-prod.fluidtopics.net/lLW_uT5I5_l1aD8yR4Jt9A "REST (REpresentational State Transfer) は、Web 上のコンピューター システム間の標準を提供するシンプルなステートレス アーキテクチャであり、コンピューター システム間の通信を容易にします。")」を参照してください。 {#tmf_prod_order-POST-productOrder__entry__160} | ステータスコード | 説明 | |-|-| | 201 | 成功。 特性または特性オプション情報に問題がある場合、エンドポイントは関連する顧客発注書明細レコードの作業メモフィールドに次のコメントを保存します。 * 次の注文品目特性が存在しません。注文を承認する前に、仕様\を確認し、注文明細品目の特性と特性オプションを修正してください。 * 注文アイテム特性:特性値\を持つ\は無効です。注文を承認する前に特性値を修正してください。 {#tmf_prod_order-POST-productOrder__ul_xtx_xym_t4b} | | 400 | 要求が正しくありません。以下のいずれかの理由が考えられます。 * 無効なペイロード:要求本文がありません:ペ イロードが要求本文で渡されませんでした。 * 無効なペイロード:productOrderItem がありません :製品の注文明細品目オブジェクトまたは JSON がありません。 * 無効なペイロード:productOrderItem id がありません :ペイロードの製品注文明細品目に id パラメーターがありません。 * 無効なペイロード:productOrderItem アクションがありません: ペイロードの製品注文明細品目に action パラメーターがありません。 * 無効なペイロード:productOrderItem productOffering がありません :ペイロードの製品注文明細品目に製品オファリングオブジェクトまたは JSON がありません。 * 無効なペイロード:productOffering id がありません :ペイロード内の製品オファリングオブジェクトの製品注文明細品目に id パラメーターがありません。 * 無効なペイロード:製品オファリングが存在しません :製品注文明細品目の製品オファリングが無効です。 * 無効なペイロード:productOrderItem 製品がありません: 製品注文明細品目の製品オブジェクトまたは JSON がペイロードにありません。 * 無効なペイロード:製品 productSpecification がありません :製品注文明細品目の製品仕様オブジェクトまたは JSON がペイロードにありません。 * 無効なペイロード:productSpecification id がありません :製品仕様オブジェクトの製品注文明細品目の id パラメーターがペイロードにありません。 * 無効なペイロード:製品仕様が存在しません :製品注文明細品目の製品仕様が無効です。 * 無効なペイロード:プロダクトインベントリが存在しません : 変更指示 (アクション = 変更) で、アイテムの数量が在庫数量を上回っています。 * 無効なペイロード:製品インベントリ ID がありません :注文変更では、ペイロードに product.id がありません。 * 無効なペイロード:販売済み製品は非アクティブです :変更指示で、ペイロードに指定された製品が非アクティブです。 * 無効なペイロード:relatedParty がありません :関係者オブジェクトがペイロードにありません。 * 無効なペイロード:顧客アカウントまたはコンシューマーがありません :関係者顧客またはコンシューマーオブジェクトがペイロードにありません。 * 無効なペイロード:コンシューマーが存在しません :指定された関係者コンシューマーが ServiceNow インスタンスに存在しません。 * 無効なペイロード:顧客アカウントが存在しません :指定された関係者顧客が ServiceNow インスタンスに存在しません。 * 無効なペイロード:注文の作成に失敗しました。 要求された注文を作成できません。 {#tmf_prod_order-POST-productOrder__ul_g2v_rzm_t4b} | [表 : 54. ステータスコード] ### 応答本文のパラメーター (JSON) {#tmf_prod_order-POST-productOrder__entry__166} | 名前 | 説明 | |-|-| | @type | TMF Open API 標準の一部です。製品の注釈。この値は常に ProductOrder です。この情報は保存されません。 データタイプ：文字列 | | チャネル | 製品の販売に使用するチャネルのリスト。 データタイプ：オブジェクトのアレイ "channel": [ { "id": "String", "name": "String" } ] | | channel.id | 関連製品の販売に使用するチャネルの一意の識別子。 データタイプ：文字列 | | channel.name | 関連製品の販売に使用するチャネルの名前。 データタイプ：文字列 | | externalId | 発注書番号などの顧客注文の外部識別子。 データタイプ：文字列 | | 外部システム | `TMF622` が追加された製品注文の外部システム。 たとえば、外部システムが ABC の場合、 externalSystem に `ABC-TMF622` と入力します。 データタイプ:文字列 | | ID | この要求に対して作成された顧客注文のSys_id。 データタイプ：文字列 | | 注意 | 注文時に顧客が行った追加のメモのリスト。 データタイプ：オブジェクトのアレイ "note": [ { "text": "String" } ] | | note.text | 注文時に顧客が行った追加のメモ/コメント。 データタイプ：文字列 | | productOderItem.actionReason | 注文明細品目を追加する理由。 データタイプ：文字列 格納場所:sn_ind_tmt_orm_order_line_itemテーブルのaction_reasonフィールド。 | | 製品注文アイテム | 製品注文とそれに関連するアクションに関連付けられたアイテムを説明するリスト。 データタイプ：オブジェクトのアレイ "productOrderItem:" [ { "action": "String", "id": "String", "itemPrice": [Array], "product": {Object}, "productOffering": {Object}, "productOrderItemReleationship": [Array], "quantity": Number, "state": "String", "@type": "String" } ] | | productOrderItem.@type | TMF Open API 標準の一部です。製品の注釈。この値は常に ProductOrderItem です。この情報は保存されません。 データタイプ：文字列 | | productOrderItem.action | 製品に対して実行するアクション。可能なアクションは、sn_ind_tmt_orm_order_line_itemテーブルのアクション辞書エントリの \[選択リスト\] タブで定義されます。 データタイプ：文字列 | | productOrderItem.id | 品目の一意の識別子。注文明細品目 \[sn_ind_tmt_orm_order_line_item\] テーブルの sn_ind_tmt_orm_external_id フィールドにあります。 データタイプ：文字列 | | productOrderItem.itemPrice | 製品に関連付けられた価格を説明するリスト。 データタイプ：オブジェクトのアレイ "itemPrice": [ { "price": {Object}, "priceType": "String", "recurringChargePeriod": "String" } ] | | productOrderItem.itemPrice.price | 関連製品の価格の説明。 データタイプ: オブジェクト "price": { "taxIncludedAmount": {Object} } | | productOrderItem.itemPrice.price.taxIncludeAmount | 税を含む関連製品の価格の説明。 データタイプ: オブジェクト "taxIncludedAmount": { "unit": "String", "value": Number } | | productOrderItem.itemPrice.price.taxIncludeAmount.unit | 価格を表す通貨コード。 データタイプ：文字列 | | productOrderItem.itemPrice.price.taxIncludeAmount.value | 製品の価格 (税込み)。 データタイプ：数値 | | productOrderItem.itemPrice.priceType | アイテム価格のタイプ (繰り返しまたは非繰り返し)。 データタイプ：文字列 | | productOrderItem.itemPrice.recurringChargePeriod | 価格が繰り返し発生する場合は、 月などの繰り返し期間。 データタイプ：文字列 | | productOrderItem.product | 顧客が購入した製品のインスタンス詳細の説明。 データタイプ: オブジェクト "product": { "id": "String", "place": {Object}, "productCharacteristic": [Array], "productSpecification": {Object}, "relatedParty": {Object}, "@type": "String" } | | productOrderItem.product.@type | TMF Open API 標準の一部です。製品の注釈。この値は常に Product です。この情報は保存されません。 データタイプ：文字列 | | 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.action パラメーターを使用して) 変更アクションを使用する場合、要求を新しい場所sys_id更新すると、注文は変更されず、新しい場所で履行される移動オーダーが作成されます。 データタイプ：文字列 | | productOrderItem.product.productCharacteristic | 関連製品の特性のリスト。 データタイプ：オブジェクトのアレイ "productCharacteristic": [ { "name": "String", "previousValue": "String", "value": "String", "valueType": "String" } ] | | productOrderItem.product.productCharacteristic.name | 製品に関連付ける特性レコードの名前。特性 \[sn_prd_pm_characteristic\] テーブルにあります。 データタイプ：文字列 | | productOrderItem.product.productCharacteristic.previousValue | 更新が変更指示用である場合の以前の特性オプションの値。productOrderItem.actionパラメーターが add 以外の場合、要求は変更指示です。特性オプション値の詳細については、「 [Create product characteristics and characteristic options](https://www.servicenow.com/docs/access?context=som-product-config-add-characteristics&version=australia&pubname=australia-order-management&ft:locale=en-US)」を参照してください。 データタイプ：文字列 | | productOrderItem.product.productCharacteristic.value | 製品に関連付けられた特性オプション値。特性オプション値の詳細については、「 [Create product characteristics and characteristic options](https://www.servicenow.com/docs/access?context=som-product-config-add-characteristics&version=australia&pubname=australia-order-management&ft:locale=en-US)」を参照してください。 データタイプ：文字列 | | productOrderItem.product.productCharacteristic.valueType | 特性値のタイプ。 可能な値： * Array.Date * Array.Datetime * Array.Decimal * Array.Integer * Array.Object * Array.Single Line Test * チェックボックス * 選択肢 * 日付、住所 * メール * 整数、日付/時刻 * オブジェクト * 1 行テキスト * はい/いいえ {#tmf_prod_order-POST-productOrder__d3728e877} データタイプ：文字列 | | productOrderItem.product.productSpecification | 製品に関連付けられた製品仕様の説明。 データタイプ: オブジェクト "productSpecification": { "id": "String", "internalVersion": "String", "name": "String", "version": "String", "@type": "String" } | | productOrderItem.product.productSpecification.@type | TMF Open API 標準の一部です。この値は常に ProductSpecificationRef です。この情報は保存されません。 データタイプ：文字列 | | 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.internalVersion | 製品仕様の内部バージョン。version の値と一致する必要があります。一致しない場合、エラーがスローされます。 データタイプ:文字列 表:製品仕様 \[sn_prd_pm_product_specification\] | | productOrderItem.product.productSpecification.name | 製品仕様の名前。製品仕様 \[sn_prd_pm_product_specification\] テーブルにあります。 データタイプ：文字列 | | productOrderItem.product.productSpecification.version | 製品仕様の外部バージョン。internalVersion の値と一致する必要があります。一致しない場合、エラーがスローされます。 データタイプ:文字列 表:製品仕様 \[sn_prd_pm_product_specification\] | | productOrderItem.product.relatedParty | 品目の連絡先のリスト。 データタイプ：オブジェクトのアレイ "relatedParty:" [ { "email": "String", "firstName": "String", "lastName": "String", "phone": "String", "@referredType": "String", "@type": "String" } ] | | productOrderItem.product.relatedParty.@referredType | 顧客のタイプ。 可能な値:OrderLineItemContact データタイプ：文字列 | | productOrderItem.product.relatedParty.@type | TMF Open API 標準の一部です。注文明細品目の連絡先の注釈。この値は常に RelatedParty です。この情報は保存されません。 データタイプ：文字列 | | productOrderItem.product.relatedParty.email | 連絡先のメールアドレス。 データタイプ：文字列 | | productOrderItem.product.relatedParty.firstName | 連絡先の名。 データタイプ：文字列 | | productOrderItem.product.relatedParty.lastName | 連絡先の名前 (姓)。 データタイプ：文字列 データタイプ：文字列 | | productOrderItem.product.relatedParty.phone | 連絡先の勤務先電話番号。 データタイプ：文字列 | | 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 | 製品注文アイテムの現在のステータス。この値は常に 新規です。 データタイプ：文字列 | | 関連パーティー | 注文の連絡先のリスト。各連絡先はアレイ内のオブジェクトです。顧客アカウントまたはコンシューマーアカウント情報を含むアイテムを少なくとも 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 | 顧客のタイプ。 可能な値： * コンシューマー * 顧客 * 顧客連絡先 {#tmf_prod_order-POST-productOrder__ul_lcq_jwm_t4b} データタイプ：文字列 | | requestedCompletionDate | 顧客が要求した配送日。 データタイプ：文字列 | | requestedStartDate | 顧客が要求した注文開始日。 データタイプ：文字列 | | serviceOrderItem.service.serviceSpecification.internalVersion | サービス仕様の内部バージョン。version の値と一致する必要があります。一致しない場合、エラーがスローされます。 データタイプ:文字列 | | serviceOrderItem.service.serviceSpecification.version | サービス仕様の外部バージョン。internalVersion の値と一致する必要があります。一致しない場合、エラーがスローされます。 データタイプ:文字列 | | 状況 | 注文の現在のステータス。このエンドポイントの場合、この値は常に 新規です。 データタイプ：文字列 | [ ] ### 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", "externalSystem": "Salesforce -- TMF 622", "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", "externalVersion": "1", "@version": "v1" }, "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", "externalSystem": "Salesforce -- TMF 622", "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", "externalVersion": "1", "@version": "v1" "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" }