注文 API

リリースバージョン: Australia

更新日 2026年03月12日

所要時間：54分

Order API は、カスタマーサービス管理 (CSM) アプリケーションの注文明細品目を含む注文を取得および作成するためのエンドポイントを提供します。

この API は注文管理 (app-csm-order-mgmt) ストアアプリケーションを必要とし、 sn_ind_tmt_orm 名前空間内で提供されます。詳細については、「Sales Customer Relationship Management」を参照してください。

この API には、アクセスするために sn_csm_om.order_integrator が必要であり、次のいずれかが必要です。

sn_csm_om.consumer_agent:B2C 注文に制限された API 書き込みアクセス。
sn_csm_om.customer_agent:B2B 注文に制限された API 書き込みアクセス。
sn_csm_om.order_admin:B2B または B2C 注文の API 書き込みアクセス。

B2B および B2C 注文の詳細については、「 B2B2C の顧客データモデル」を参照してください。

注文 API – GET /sn_ind_tmt_orm/order/{id}

sys_idまたは注文番号を指定して、完全な注文の詳細を取得します。

URL 形式

バージョニングされた URL: /api/sn_ind_tmt_orm/{api_version}/order/{id}

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

注:

使用可能なバージョンは、REST API エクスプローラーで指定されます。スクリプト済み REST API の場合、[ スクリプト済み REST サービス] フォームに追加のバージョン情報があります。

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

表 : 1. パスパラメーター
名前	説明
api_version	オプション。アクセスするエンドポイントのバージョン。たとえば、 `v1` や `v2` などです。最新以外のエンドポイントバージョンを使用する場合にのみ、この値を指定してください。データタイプ：文字列
ID	取得するレコードのSys_idまたは順序番号 (order_id)。データタイプ：文字列テーブル:注文 [sn_csm_om_order]

表 : 2. クエリパラメーター
名前	説明
sysparm_display_value	参照フィールドの表示値を表示するかどうかを示すフラグ。有効な値： true:応答の参照フィールド、選択フィールド、および日付フィールドの表示値を表示します。 false:応答の参照フィールド、選択フィールド、および日付フィールドの実際の値を表示します。デフォルト値：false

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

ヘッダー

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

表 : 4. 要求ヘッダー
ヘッダー	説明
承認	応答本文のデータフォーマット。サポートされるタイプ：application/json または application/xml。デフォルト： application/json

表 : 5. 応答ヘッダー
ヘッダー	説明
なし

ステータスコード

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

表 : 6. ステータスコード
ステータスコード	説明
200	成功。要求が正常に処理されました。
401	ユーザーは認証されていません。
403	ユーザーには権限がありません。ユーザーには、API にアクセスするために必要なロールがありません。ユーザーには注文を読み取る権限がありません。この API には、アクセスするために sn_csm_om.order_integrator が必要であり、次のいずれかが必要です。 sn_csm_om.consumer_agent:B2C 注文に制限された API 書き込みアクセス。 sn_csm_om.customer_agent:B2B 注文に制限された API 書き込みアクセス。 sn_csm_om.order_admin:B2B または B2C 注文の API 書き込みアクセス。

応答本文のパラメーター (JSON または XML)


名前	説明
アカウント	アカウント [customer_account] テーブルにあるレコードのSys_id。 B2B 注文のアカウントを識別します。データタイプ：文字列
actual_end_date	注文の終了日。形式:UTC 形式、yyyy-MM-dd HH:mm:ss データタイプ：文字列
actual_start_date	注文の開始日。形式:UTC 形式、yyyy-MM-dd HH:mm:ss データタイプ：文字列
billing_city	市区町村 (請求先) の名前。データタイプ：文字列
billing_country	請求先の国の略称。データタイプ：文字列
billing_state	請求先の都道府県の略称。データタイプ：文字列
billing_street	番地 (請求先) データタイプ：文字列
billing_zip	郵便番号 (請求先) データタイプ：文字列
コメント	注文の追加情報。データタイプ：文字列
consumer	コンシューマーレコードのSys_id。 B2C 注文のコンシューマーを識別します。データタイプ：文字列
連絡先	アカウントに関連する顧客連絡先のSys_id。データタイプ：文字列テーブル:連絡先 [customer_contact]
contract	カスタマーサービス契約レコードのSys_id。データタイプ：文字列テーブル:契約 [ast_contract]
エラー	要求プロセス中に発生したエラーを説明する詳細。データタイプ: オブジェクト `"error": { "detail": "String", "message": "String" }`
error.detail	要求プロセス中に発生したエラーの詳細。データタイプ：文字列
error.message	要求プロセス中に発生したエラーのメッセージ。各エラーメッセージには、 detail プロパティに対応する説明があります。データタイプ：文字列
expected_end_date	注文の予定終了日。形式:UTC 形式、yyyy-MM-dd HH:mm:ss データタイプ：文字列
expected_start_date	注文の予定開始日。形式:UTC 形式、yyyy-MM-dd HH:mm:ss データタイプ：文字列
external_id	サードパーティのシステム上の関連レコードを表す外部 ID。データタイプ：文字列
external_system	顧客のシステムの名前。データタイプ：文字列
order_category	顧客の注文タイプ。可能な値： product service データタイプ：文字列
order_currency	注文が購入された通貨を表す通貨コード。たとえば、米ドルは `USD` です。この通貨は、注文注文と明細行注文のすべての金額フィールドで使用されます。通貨コードは通貨 [fx_currency] テーブルに一覧表示されます。注: このプロパティは、以前のバージョンの注文管理では使用できない場合があります。データタイプ：文字列
order_date	注文が作成された日時。形式:UTC 形式、yyyy-MM-dd HH:mm:ss データタイプ：文字列
order_id	注文の注文番号。データタイプ：文字列テーブル:注文 [sn_csm_om_order]
order_line_items	必須です。注文の各注文品目を定義するオブジェクトのリスト。データタイプ：アレイ各注文品目オブジェクトの必須プロパティ: account B2B 注文の場合は、B2C 注文の場合は consumer 。 product_offering – quantity unit_of_measurements order_line_characteristics "order_line_items": [ { "account": "String", "action": "String", "comments": "String", "consumer": "String", "contact": "String", "delivered_quantity": "String", "effective_date": "String", "expiration_date": "String", "external_id": "String", "external_system": "String", "list_price": "String", "location": "String", "order_line_characteristics": [Array], "order_line_id": "String", "order": "String", "parent_line_item": "String", "previous_product_model": "String", "price_list": "String", "product_offering": "String", "product_specification": "String", "product": "String", "quantity": "String", "shipping_city": "String", "shipping_country": "String", "shipping_state": "String", "shipping_street": "String", "shipping_zip": "String", "short_description": "String", "sku": "String", "sold_product": "String", "specification": "String", "state": "String", "status": "String", "sys_class_name": "String", "sys_created_by": "String", "sys_created_on": "String", "sys_id": "String", "sys_mod_count": "String", "sys_tags": "String", "sys_updated_by": "String", "sys_updated_on": "String", "top_line_item": "String", "total_price": "String", "unit_of_measurement": "String", "unit_price": "String", "work_notes": "String" } ] テーブル:注文明細品目 [sn_csm_om_order_line_item]
order_line_items	注文の各注文品目を定義するオブジェクトのリスト。データタイプ：オブジェクトのアレイ "order_line_items": [ { "account": "String", "action": "String", "comments": "String", "consumer": "String", "contact": "String", "delivered_quantity": "String", "effective_date": "String", "expiration_date": "String", "external_id": "String", "external_system": "String", "list_price": "String", "location": "String", "order_line_characteristics": [Array], "order_line_id": "String", "order": "String", "parent_line_item": "String", "previous_product_model": "String", "price_list": "String", "product_offering": "String", "product_specification": "String", "product": "String", "quantity": "String", "shipping_city": "String", "shipping_country": "String", "shipping_state": "String", "shipping_street": "String", "shipping_zip": "String", "short_description": "String", "sku": "String", "sold_product": "String", "specification": "String", "state": "String", "status": "String", "sys_class_name": "String", "sys_created_by": "String", "sys_created_on": "String", "sys_id": "String", "sys_mod_count": "String", "sys_tags": "String", "sys_updated_by": "String", "sys_updated_on": "String", "top_line_item": "String", "total_price": "String", "unit_of_measurement": "String", "unit_price": "String", "work_notes": "String" } ]
order_line_items.account	B2B 注文に必要です。この注文明細品目に割り当てられたビジネスアカウントのSys_id。アカウント [customer_account] テーブルにあります。コンシューマープロパティは、B2C 注文に必要です。データタイプ：文字列
order_line_items.account	この注文明細品目に割り当てられたビジネスアカウントのSys_id。アカウント [customer_account] テーブルにあります。データタイプ：文字列
order_line_items.action	注文明細行を注文に追加する方法を決定するアクション。可能な値：追加変更データタイプ：文字列
order_line_items.comments	注文品目の追加情報。データタイプ：文字列
order_line_items.consumer	この注文品目にアサインされているコンシューマーのSys_id。コンシューマー [csm_consumer] テーブルにあります。データタイプ：文字列
order_line_items.contact	アカウントに関連する連絡先sys_id。データタイプ：文字列
order_line_items.delivered_quantity	配送された注文のアイテムの数。データタイプ：文字列
order_line_items.effective_date	注文明細行の有効日。形式:yyyy-MM-dd HH:mm:ss (UTC タイムゾーン) データタイプ：文字列
order_line_items.expiration_date	注文明細行の有効期限。形式:yyyy-MM-dd HH:mm:ss (UTC タイムゾーン) データタイプ：文字列
order_line_items.external_id	注文品目の外部 ID。データタイプ：文字列
order_line_items.external_system	注文品目の外部sys_id。データタイプ：文字列
order_line_items.list_price	単位あたりの製品オファリングの表示価格。注: このプロパティは、以前のバージョンの注文管理では使用できない場合があります。データタイプ：文字列
order_line_items.location	出荷場所レコードのSys_id。データタイプ：文字列テーブル:場所 [cmn_location]
order_line_items.order	注文 [sn_csm_om_order] テーブルにリストされているこの品目の注文番号。データタイプ：文字列
order_line_items。order_line_characteristics	関連する注文明細特性を定義するオブジェクトのリスト。注文明細特性は、注文明細特性 [sn_csm_om_order_characteristic_value] テーブルにあります。データタイプ：オブジェクトのアレイ `"order_line_characteristics": [ { "characteristic": "String", "characteristic_option": "String" } ]`
order_line_items。order_line_characteristics。characteristic_option	除外ルールをトリガーする製品特性の一意のオプション。たとえば、製品のサイズや色などです。データタイプ：文字列
order_line_items。order_line_characteristics。characteristic_option_value	特性オプションの値。データタイプ：文字列
order_line_items。order_line_characteristics。external_id	注文明細特性の外部 ID。データタイプ: オブジェクト
order_line_items。order_line_characteristics.number	注文明細特性番号。データタイプ：文字列テーブル:発注明細特性 [sn_csm_om_order_characteristic_value]
order_line_items。order_line_characteristics。order_line_item	この特性の注文明細品目のSys_id。データタイプ：文字列テーブル:注文明細品目 [sn_csm_om_order_line_item]
order_line_items。order_line_characteristics。previous_characteristic_option_value	注文明細行の製品モデルに関連付けられた以前の特性オプションの名前。データタイプ: オブジェクト
order_line_items。order_line_characteristics.specification	サービス注文特性に関連付けられているサービス仕様。データタイプ：文字列
order_line_items。order_line_characteristics。sys_class_name	この注文明細特性レコードが配置されているテーブルのシステム名。データタイプ：文字列
order_line_characteristics。sys_created_by	このレコードを作成したユーザーのシステム名。データタイプ：文字列
order_line_items。order_line_characteristics。sys_created_on	レコードが最初に作成された日時。データタイプ：文字列
order_line_items。order_line_characteristics。sys_domain	注文レコードにアクセスできるドメインスコープ。たとえば、 global です。データタイプ：文字列
order_line_items。order_line_characteristics。sys_domain_path	レコードのドメインパス。データタイプ：文字列デフォルト:/ (グローバル)
order_line_items。order_line_characteristics。sys_id	注文レコードのSys_id データタイプ：文字列テーブル:発注明細特性 [sn_csm_om_order_characteristic_value]
order_line_items。order_line_characteristics。sys_mod_count	このレコードが変更された回数。データタイプ：文字列
order_line_items。order_line_characteristics。sys_tags	コンテンツのシステムタグ。データタイプ：文字列
order_line_items。order_line_characteristics。sys_updated_by	このレコードを最後に更新したユーザーのシステム名。データタイプ：文字列
order_line_items。order_line_characteristics。sys_updated_on	レコードが最後に更新された日時。データタイプ：文字列
order_line_items。order_line_characteristics.type	注文明細特性のタイプ。可能な値： product service データタイプ：文字列
order_line_items.order_line_id	この注文品目に関連付けられた注文の注文番号。データタイプ：文字列
order_line_items.parent_line_item	該当する場合、この品目の親品目を示します。データタイプ：文字列
order_line_items.previous_product_model	注文明細行のこのアイテムの前にリストされている製品の製品モデルのSys_id。データタイプ：文字列テーブル:製品モデル [cmdb_model]
order_line_items.price_list	価格リスト [sn_csm_pricing_price_list] テーブルの価格リストレコードのSys_id。注: このプロパティは、以前のバージョンの注文管理では使用できない場合があります。データタイプ：文字列
order_line_items.product	製品のSys_id データタイプ：文字列テーブル:製品モデル [cmdb_model]
order_line_items.product_offering	製品オファリング [sn_prd_pm_product_offering] テーブルにリストされている製品のSys_id。データタイプ：文字列
order_line_items.product	製品モデル [cmdb_model] テーブルにリストされている製品モデルのSys_id。一致する注文明細品目とともに指定する必要がありますデータタイプ：文字列
order_line_items.product_specification	注文品目に関連付けられた製品仕様のSys_id。製品仕様 [sn_prd_pm_product_specification] テーブルに記載されています。データタイプ：文字列
order_line_items.quantity	注文した製品モデルの数。データタイプ：文字列
order_line_items.shipping_city	移動先の市区町村の名前。データタイプ：文字列
order_line_items.shipping_country	移動先の国の略称。データタイプ：文字列
order_line_items.shipping_state	移動先の都道府県の略称。データタイプ：文字列
order_line_items.shipping_street	宛先の番地。データタイプ：文字列
order_line_items.shipping_zip	宛先の郵便番号。データタイプ：文字列
order_line_items.short_description	注文品目の簡単な説明。データタイプ：文字列
order_line_items.sku	サプライヤーによって販売される製品を一意に識別するためにサプライヤーによって生成された番号。データタイプ：文字列
order_line_items.sold_product	インストールベースの販売済み製品レコードのSys_id。データタイプ：文字列テーブル:販売済み製品 [sn_install_base_sold_product]
order_line_items.specification	注文品目の仕様。データタイプ：文字列
order_line_items.state	注文明細のステータス。たとえば、ドラフト、新規、in_progress、完了などです。データタイプ：文字列
order_line_items.status	注文品目のステータス。可能な値：失敗成功データタイプ：文字列
order_line_items.sys_class_name	この注文品目レコードが配置されているテーブルのシステム名。データタイプ：文字列
order_line_items.sys_created_by	このレコードを作成したユーザーのシステム名。データタイプ：文字列
order_line_items.sys_created_on	レコードが最初に作成された日時。データタイプ：文字列
order_line_items.sys_domain	注文レコードにアクセスできるドメインスコープ。たとえば、 global です。データタイプ：文字列
order_line_items.sys_domain_path	レコードのドメインパス。データタイプ：文字列デフォルト:/ (グローバル)
order_line_items.sys_id	品目レコードのSys_id データタイプ：文字列テーブル:注文明細品目 [sn_csm_om_order_line_item]
order_line_items.sys_mod_count	このレコードが変更された回数。データタイプ：文字列
order_line_items.sys_tags	コンテンツのシステムタグ。データタイプ：文字列
order_line_items.sys_updated_by	このレコードを最後に更新したユーザーのシステム名。データタイプ：文字列
order_line_items.sys_updated_on	レコードが最後に更新された日時。データタイプ：文字列
order_line_items.top_line_item	この注文に累積されたすべての注文品目の合計価格。データタイプ：文字列
order_line_items.total_price	注文明細行の合計価格。API は正味価格と数量に基づいて合計を計算しません。データタイプ：文字列
order_line_items.unit_of_measurement	測定単位 [sn_prd_pm_uom] テーブルにリストされている順序付けされた測定単位のSys_id。注: このプロパティは、以前のバージョンの注文管理では使用できない場合があります。データタイプ：文字列
order_line_items。unit_of_measurement	必須です。測定単位 [sn_prd_pm_uom] テーブルにリストされている順序付けされた測定単位のSys_id。注: このプロパティは、以前のバージョンの注文管理では使用できない場合があります。データタイプ：文字列
order_line_items.unit_price	1 台あたりの製品オファリングの正味価格。データタイプ：文字列テーブル:通貨インスタンス [fx_currency_instance]
order_line_items.work_notes	注文品目の自由形式の内部作業メモ。データタイプ：文字列
order_type	注文を追加する方法を決定する注文アクション。可能な値：追加変更データタイプ：文字列
パートナー	B2B 注文の場合は、アカウントに関連付けられたパートナーレコードのsys_id。データタイプ：文字列テーブル:アカウント [customer_account]
partner_contact	B2B 注文の場合、パートナーアカウントに対するパートナーの主要連絡先のsys_id。データタイプ：文字列テーブル:連絡先 [customer_contact]
payment_ref_id	支払の一意の識別子。たとえば、小切手番号などです。データタイプ：文字列
price_list	関連する価格リストレコードのSys_id。価格は、この API によって正味価格と数量に基づいて計算されるものではありません。注: このプロパティは、以前のバージョンの注文管理では使用できない場合があります。データタイプ：文字列テーブル:価格リスト [sn_csm_pricing_price_list]
quote_id	注文価格見積の一意の ID。データタイプ：文字列
same_as_shipping_address	購入者の住所が出荷先と同じかどうかを示すフラグ。有効な値： true:購入者の住所は出荷先と同じです。 false:購入者の住所が出荷先と異なります。データタイプ：ブーリアン
shipping_city	移動先の市区町村の名前。データタイプ：文字列
shipping_country	移動先の国の略称。データタイプ：文字列
shipping_location	出荷場所レコードのSys_id。データタイプ：文字列テーブル:場所 [cmn_location]
shipping_state	移動先の都道府県の略称。データタイプ：文字列
shipping_street	宛先の番地。データタイプ：文字列
shipping_zip	宛先の郵便番号。データタイプ：文字列
short_description	注文の簡単な説明。データタイプ：文字列
special_instructions	注文に関する特別な指示。データタイプ：文字列
状況	注文のステータス。たとえば、新規、in_progress、完了などです。データタイプ：文字列
status	注文のステータス。可能な値：成功失敗データタイプ：文字列
sys_class_name	この注文レコードが配置されているテーブルのシステム名。データタイプ：文字列
sys_created_by	このレコードを作成したユーザーのシステム名。データタイプ：文字列
sys_created_on	レコードが最初に作成された日時。データタイプ：文字列
sys_domain	注文レコードにアクセスできるドメインスコープ。たとえば、 global です。データタイプ：文字列
sys_domain_path	レコードのドメインパス。データタイプ：文字列デフォルト:/ (グローバル)
sys_id	注文レコードのSys_id。データタイプ：文字列テーブル:注文 [sn_csm_om_order]
sys_mod_count	このレコードが変更された回数。データタイプ：文字列
sys_tags	コンテンツのシステムタグ。データタイプ：文字列
sys_updated_by	このレコードを最後に更新したユーザーのシステム名。データタイプ：文字列
sys_updated_on	レコードが最後に更新された日時。データタイプ：文字列
total_amount	注文全体の総費用。データタイプ：文字列

cURL 要求

次の例は、注文番号で注文を取得する方法を示しています。

curl "https://instance.service-now.com/api/sn_ind_tmt_orm/order/ORD0001034" \
--request GET \
--header "Accept:application/json" \
--user 'username':'password'

応答：

{
  "result": {
    "actual_start_date": "",
    "payment_ref_id": null,
    "shipping_city": null,
    "channel": "api",
    "expected_end_date": "",
    "sys_updated_on": "2022-03-30 21:59:41",
    "price_list": null,
    "sys_updated_by": "username",
    "sys_created_on": "2022-03-30 21:59:41",
    "contact": "96d0461553ab70101aaeddeeff7b120b",
    "sys_domain": "global",
    "state": "draft",
    "order_type": "add",
    "sys_created_by": "eseruser",
    "shipping_street": null,
    "special_instructions": null,
    "contract": null,
    "quote_id": null,
    "expected_start_date": "",
    "sys_domain_path": "/",
    "billing_street": null,
    "billing_city": null,
    "total_amount": "2000",
    "order_id": "ORD0001034",
    "shipping_country": "USA",
    "status": "new",
    "short_description": null,
    "shipping_state": null,
    "external_id": null,
    "sys_class_name": "sn_csm_om_order",
    "sys_id": "24fdf5bd75eec510f877f30c01a15aa0",
    "shipping_zip": null,
    "billing_state": null,
    "billing_zip": null,
    "same_as_shipping_address": "0",
    "consumer": null,
    "comments": "",
    "order_currency": "USD",
    "billing_country": "USA",
    "sys_mod_count": "1",
    "billing_location": null,
    "shipping_location": null,
    "sys_tags": "",
    "order_date": "2022-03-30 21:59:41",
    "order_category": "product",
    "actual_end_date": "",
    "partner": null,
    "partner_contact": null,
    "account": "c480021553ab70101aaeddeeff7b120f",
    "external_system": null,
    "order_line_items": [
      {
        "short_description": null,
        "shipping_state": "CA",
        "shipping_city": "Santa Clara",
        "product_offering": "2d4376760f740110603bf634a7767e46",
        "external_id": null,
        "sys_updated_on": "2022-03-30 21:59:41",
        "expiration_date": "",
        "sys_class_name": "sn_csm_om_order_line_item",
        "sold_product": null,
        "sys_id": "ecfdf5bd75eec510f877f30c01a15aa3",
        "unit_of_measurement": "cb2795d553020110286eddeeff7b12ff",
        "price_list": null,
        "sys_updated_by": "username",
        "shipping_zip": "94560",
        "sys_created_on": "2022-03-30 21:59:41",
        "contact": "96d0461553ab70101aaeddeeff7b120b",
        "sys_domain": "global",
        "effective_date": "",
        "action": "add",
        "order_line_id": "ORDL0001060",
        "state": "draft",
        "sku": null,
        "consumer": null,
        "sys_created_by": "username",
        "order": "24fdf5bd75eec510f877f30c01a15aa0",
        "previous_product_model": null,
        "shipping_street": "222 Star St",
        "product": "561dba7e0f740110603bf634a7767ebe",
        "quantity": "1",
        "comments": "",
        "total_price": "2000",
        "parent_line_item": null,
        "sys_mod_count": "1",
        "specification": "104f66720f740110603bf634a7767e7d",
        "list_price": "2000",
        "unit_price": "2000",
        "sys_domain_path": "/",
        "sys_tags": "",
        "delivered_quantity": null,
        "top_line_item": null,
        "product_specification": "104f66720f740110603bf634a7767e7d",
        "location": null,
        "work_notes": "",
        "shipping_country": "USA",
        "account": "c480021553ab70101aaeddeeff7b120f",
        "external_system": null,
        "status": "new",
        "order_line_characteristics": [
          {
            "characteristic_option": "1c6ceabe0f340110603bf634a7767e97",
            "sys_mod_count": "0",
            "specification": "104f66720f740110603bf634a7767e7d",
            "external_id": null,
            "sys_updated_on": "2022-03-30 21:59:41",
            "type": "1",
            "sys_domain_path": "/",
            "sys_tags": "",
            "characteristic": "4e76f1b20fb00110603bf634a7767ee3",
            "sys_class_name": "sn_csm_om_order_characteristic_value",
            "previous_characteristic_option_value": null,
            "number": "ORC000001041",
            "sys_id": "acfd79bd75eec510f877f30c01a15a94",
            "sys_updated_by": "username",
            "sys_created_on": "2022-03-30 21:59:41",
            "sys_domain": "global",
            "characteristic_option_value": "1.2 cu",
            "order_line_item": "ecfdf5bd75eec510f877f30c01a15aa3",
            "sys_created_by": "user"
          },
          {
            "characteristic_option": "2d0d66fe0f340110603bf634a7767ef6",
            "sys_mod_count": "0",
            "specification": "104f66720f740110603bf634a7767e7d",
            "external_id": null,
            "sys_updated_on": "2022-03-30 21:59:41",
            "type": "1",
            "sys_domain_path": "/",
            "sys_tags": "",
            "characteristic": "11e639b20fb00110603bf634a7767e17",
            "sys_class_name": "sn_csm_om_order_characteristic_value",
            "previous_characteristic_option_value": null,
            "number": "ORC000001042",
            "sys_id": "e0fd79bd75eec510f877f30c01a15a95",
            "sys_updated_by": "username",
            "sys_created_on": "2022-03-30 21:59:41",
            "sys_domain": "global",
            "characteristic_option_value": "Stainless steel",
            "order_line_item": "ecfdf5bd75eec510f877f30c01a15aa3",
            "sys_created_by": "user"
          }
        ]
      }
    ]
  }
}

注文 API – POST /sn_ind_tmt_orm/order

品目と特性を使用して新しい注文を作成します。

品目のある注文は、要求本文のパラメーターを使用して定義されます。ほとんどのバージョンの注文管理で、次のプロパティが必要です。

account B2B 注文の場合は、B2C 注文の場合は consumer 。
- account – アカウント [customer_account] テーブルにあるレコードのSys_id。
- consumer – コンシューマーレコードのSys_id。
order_currency – 注文が購入された通貨を表す通貨コード。たとえば、米ドルは USD です。この通貨は、注文注文と明細行注文のすべての金額フィールドで使用されます。通貨コードは通貨 [fx_currency] テーブルに一覧表示されます。
order_line_items – 注文の各注文品目を定義するオブジェクトのリスト。各注文品目オブジェクトの必須プロパティ:
- account B2B 注文の場合は、B2C 注文の場合は consumer 。
  - account – この注文明細品目に割り当てられたビジネスアカウントのSys_id。アカウント [customer_account] テーブルにあります。
  - consumer – この注文品目にアサインされているコンシューマーのSys_id。コンシューマー [csm_consumer] テーブルにあります。
- order_line_characteristics – 関連する注文明細特性を定義するオブジェクトのリスト。注文明細特性は、注文明細特性 [sn_csm_om_order_characteristic_value] テーブルにあります。
- product_offering – 製品オファリング [sn_prd_pm_product_offering] テーブルにリストされている製品のSys_id。
- quantity – 注文した製品モデルの数。
- unit_of_measurements – 測定単位 [sn_prd_pm_uom] テーブルにリストされている順序付けされた測定単位のSys_id。

[要求本文パラメーター] テーブルには、詳細が含まれています。

URL 形式

バージョニングされた URL: /api/sn_ind_tmt_orm/{api_version}/order

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

注:

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

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

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

表 : 9. 要求本文パラメーター (XML または JSON)
名前	説明
アカウント	B2B 注文に必要です。アカウント [customer_account] テーブルにあるレコードのSys_id。コンシューマープロパティは、B2C 注文に必要です。データタイプ：文字列
actual_end_date	注文の終了日。形式:UTC 形式、yyyy-MM-dd HH:mm:ss データタイプ：文字列
actual_start_date	注文の開始日。形式:UTC 形式、yyyy-MM-dd HH:mm:ss データタイプ：文字列
billing_city	市区町村 (請求先) の名前。データタイプ：文字列
billing_country	請求先の国の略称。データタイプ：文字列
billing_state	請求先の都道府県の略称。データタイプ：文字列
billing_street	番地 (請求先) データタイプ：文字列
billing_zip	郵便番号 (請求先) データタイプ：文字列
コメント	注文の追加情報。データタイプ：文字列
consumer	B2C 注文に必要です。コンシューマーレコードのSys_id。B2B 注文にはアカウントプロパティが必要です。データタイプ：文字列テーブル:コンシューマー [csm_consumer]
連絡先	アカウントに関連する顧客連絡先のSys_id。データタイプ：文字列テーブル:連絡先 [customer_contact]
contract	カスタマーサービス契約レコードのSys_id。データタイプ：文字列テーブル:契約 [ast_contract]
expected_end_date	注文の予定終了日。形式:UTC 形式、yyyy-MM-dd HH:mm:ss データタイプ：文字列
expected_start_date	注文の予定開始日。形式:UTC 形式、yyyy-MM-dd HH:mm:ss データタイプ：文字列
external_id	サードパーティのシステム上の関連レコードを表す外部 ID。データタイプ：文字列
external_system	顧客のシステムの名前。データタイプ：文字列
order_category	顧客の注文タイプ。可能な値： product service データタイプ：文字列
order_currency	必須です。注文が購入された通貨を表す通貨コード。たとえば、米ドルは `USD` です。この通貨は、注文注文と明細行注文のすべての金額フィールドで使用されます。通貨コードは通貨 [fx_currency] テーブルに一覧表示されます。注: このプロパティは、以前のバージョンの注文管理では使用できない場合があります。データタイプ：文字列
order_date	注文が作成された日時。形式:UTC 形式、yyyy-MM-dd HH:mm:ss データタイプ：文字列
order_line_items	必須です。注文の各注文品目を定義するオブジェクトのリスト。データタイプ：アレイ各注文品目オブジェクトの必須プロパティ: account B2B 注文の場合は、B2C 注文の場合は consumer 。 product_offering – quantity unit_of_measurements order_line_characteristics "order_line_items": [ { "account": "String", "action": "String", "comments": "String", "consumer": "String", "contact": "String", "delivered_quantity": "String", "effective_date": "String", "expiration_date": "String", "external_id": "String", "external_system": "String", "list_price": "String", "location": "String", "order_line_characteristics": [Array], "order_line_id": "String", "order": "String", "parent_line_item": "String", "previous_product_model": "String", "price_list": "String", "product_offering": "String", "product_specification": "String", "product": "String", "quantity": "String", "shipping_city": "String", "shipping_country": "String", "shipping_state": "String", "shipping_street": "String", "shipping_zip": "String", "short_description": "String", "sku": "String", "sold_product": "String", "specification": "String", "state": "String", "status": "String", "sys_class_name": "String", "sys_created_by": "String", "sys_created_on": "String", "sys_id": "String", "sys_mod_count": "String", "sys_tags": "String", "sys_updated_by": "String", "sys_updated_on": "String", "top_line_item": "String", "total_price": "String", "unit_of_measurement": "String", "unit_price": "String", "work_notes": "String" } ] テーブル:注文明細品目 [sn_csm_om_order_line_item]
order_line_items.account	B2B 注文に必要です。この注文明細品目に割り当てられたビジネスアカウントのSys_id。アカウント [customer_account] テーブルにあります。コンシューマープロパティは、B2C 注文に必要です。データタイプ：文字列
order_line_items.action	注文明細行を注文に追加する方法を決定するアクション。可能な値：追加変更データタイプ：文字列
order_line_items.comments	注文品目の追加情報。データタイプ：文字列
order_line_items.consumer	B2C 注文に必要です。この注文品目にアサインされているコンシューマーのSys_id。コンシューマー [csm_consumer] テーブルにあります。B2B 注文にはアカウントプロパティが必要です。データタイプ：文字列
order_line_items.contact	アカウントに関連する連絡先sys_id。データタイプ：文字列
order_line_items.delivered_quantity	配送された注文のアイテムの数。データタイプ：文字列
order_line_items.effective_date	注文明細行の有効日。形式:yyyy-MM-dd HH:mm:ss (UTC タイムゾーン) データタイプ：文字列
order_line_items.expiration_date	注文明細行の有効期限。形式:yyyy-MM-dd HH:mm:ss (UTC タイムゾーン) データタイプ：文字列
order_line_items.external_id	注文品目の外部 ID。データタイプ：文字列
order_line_items.external_system	注文品目の外部sys_id。データタイプ：文字列
order_line_items.list_price	単位あたりの製品オファリングの表示価格。注: このプロパティは、以前のバージョンの注文管理では使用できない場合があります。データタイプ：文字列
order_line_items。order_line_characteristics	必須です。関連する注文明細特性を定義するオブジェクトのリスト。注文明細特性は、注文明細特性 [sn_csm_om_order_characteristic_value] テーブルにあります。最新のリリースでは、オファリングが製品仕様に関連付けられている場合、製品モデルを決定するために発注特性を含める必要があります。以前のリリースでは、このプロパティは order_line_items.product_specification プロパティが設定された単純な注文にのみ必要でした。データタイプ：オブジェクトのアレイ `"order_line_characteristics": [ { "characteristic": "String", "characteristic_option": "String" } ]`
order_line_items。order_line_characteristics。特性	製品モデルに関連付けられた特性の名前。例:食洗機サイズ。データタイプ：文字列
order_line_items。order_line_characteristics。characteristic_option	除外ルールをトリガーする製品特性の一意のオプション。たとえば、製品のサイズや色などです。データタイプ：文字列
order_line_items.price_list	価格リスト [sn_csm_pricing_price_list] テーブルの価格リストレコードのSys_id。注: このプロパティは、以前のバージョンの注文管理では使用できない場合があります。データタイプ：文字列
order_line_items.product	製品モデル [cmdb_model] テーブルにリストされている製品モデルのSys_id。要求本文に含める場合、関連付けられた注文明細特性が一致している必要があります。データタイプ：文字列
order_line_items.product_offering	必須です。製品オファリング [sn_prd_pm_product_offering] テーブルにリストされている製品のSys_id。オファリングが製品モデルに関連付けられている場合、製品モデルは注文によって決定されます。オファリングが製品仕様に関連付けられている場合は、製品モデルを決定するために注文特性を含める必要があります。データタイプ：文字列
order_line_items。product_specification	必須です。注文品目に関連付けられた製品仕様のSys_id。製品仕様 [sn_prd_pm_product_specification] テーブルに記載されています。注: このプロパティは、以前のバージョンの注文管理では必須ではありませんでした。データタイプ：文字列
order_line_items.quantity	必須です。注文した製品モデルの数。注: このプロパティは、以前のバージョンの注文管理では必須でした。データタイプ：文字列
order_line_items.shipping_city	移動先の市区町村の名前。データタイプ：文字列
order_line_items.shipping_country	移動先の国の略称。データタイプ：文字列
order_line_items.shipping_state	移動先の都道府県の略称。データタイプ：文字列
order_line_items.shipping_street	宛先の番地。データタイプ：文字列
order_line_items.shipping_zip	宛先の郵便番号。データタイプ：文字列
order_line_items.short_description	注文品目の簡単な説明。データタイプ：文字列
order_line_items.sku	サプライヤーによって販売される製品を一意に識別するためにサプライヤーによって生成された番号。データタイプ：文字列
order_line_items.sold_product	インストールベースの販売済み製品レコードのSys_id。データタイプ：文字列テーブル:販売済み製品 [sn_install_base_sold_product]
order_line_items.specification	注文品目の仕様。データタイプ：文字列
order_line_items.state	注文明細のステータス。たとえば、ドラフト、新規、in_progress、完了などです。データタイプ：文字列
order_line_items.total_price	注文明細行の合計価格。合計価格は、この API によって正味価格と数量に基づいて計算されません。データタイプ：文字列
order_line_items。unit_of_measurement	必須です。測定単位 [sn_prd_pm_uom] テーブルにリストされている順序付けされた測定単位のSys_id。注: このプロパティは、以前のバージョンの注文管理では使用できない場合があります。データタイプ：文字列
order_line_items.unit_price	1 台あたりの製品オファリングの正味価格。データタイプ：文字列テーブル:通貨インスタンス [fx_currency_instance]
order_line_items.work_notes	注文品目の自由形式の内部作業メモ。データタイプ：文字列
order_type	注文を追加する方法を決定する注文アクション。可能な値：追加変更データタイプ：文字列
パートナー	B2B 注文の場合は、アカウントに関連付けられたパートナーレコードのsys_id。データタイプ：文字列テーブル:アカウント [customer_account]
partner_contact	B2B 注文の場合、パートナーアカウントに対するパートナーの主要連絡先のsys_id。データタイプ：文字列テーブル:連絡先 [customer_contact]
price_list	関連する価格リストレコードのSys_id。価格は、この API によって正味価格と数量に基づいて計算されるものではありません。注: このプロパティは、以前のバージョンの注文管理では使用できない場合があります。データタイプ：文字列テーブル:価格リスト [sn_csm_pricing_price_list]
quote_id	注文価格見積の一意の ID。データタイプ：文字列
shipping_city	移動先の市区町村の名前。データタイプ：文字列
shipping_country	移動先の国の略称。データタイプ：文字列
shipping_state	移動先の都道府県の略称。データタイプ：文字列
shipping_street	宛先の番地。データタイプ：文字列
shipping_zip	宛先の郵便番号。データタイプ：文字列
short_description	注文の簡単な説明。データタイプ：文字列
special_instructions	注文に関する特別な指示。データタイプ：文字列
状況	注文のステータス。たとえば、新規、in_progress、完了などです。データタイプ：文字列
total_amount	注文全体の総費用。データタイプ：文字列

ヘッダー

表 : 10. 要求ヘッダー
ヘッダー	説明
承認	応答本文のデータフォーマット。サポートされるタイプ：application/json または application/xml。デフォルト： application/json

表 : 11. 応答ヘッダー
ヘッダー	説明
なし

ステータスコード

表 : 12. ステータスコード
ステータスコード	説明
200	成功。要求が正常に処理されました。
400	要求が正しくありません。ペイロードが想定される形式ではありません。
401	ユーザーは認証されていません。
403	ユーザーには権限がありません。ユーザーには、API にアクセスするために必要なロールがありません。ユーザーには注文を読み取る権限がありません。この API には、アクセスするために sn_csm_om.order_integrator が必要であり、次のいずれかが必要です。 sn_csm_om.consumer_agent:B2C 注文に制限された API 書き込みアクセス。 sn_csm_om.customer_agent:B2B 注文に制限された API 書き込みアクセス。 sn_csm_om.order_admin:B2B または B2C 注文の API 書き込みアクセス。
500	内部サーバーエラー1 つ以上の検証に失敗しました。考えられる問題: Account または consumer パラメーターがありません。これらのフィールドは、ヘッダーとアイテムで必須です。 Account/contact と consumer パラメーターが渡されました。これらのパラメーターを一緒に渡すことはできません。選択パラメーター:無効な選択値が渡されました。数量パラメーター:無効な値です。参照フィールドが無効です。必須フィールドがありません。無効な日付と時刻の形式。開始日が終了日より後になっています。無効な特性です。無効な特性オプション。指定された特性に対して複数の製品モデルが見つかりました。指定された特性の製品モデルが見つかりません。ユーザーには注文を作成するためのアクセス権がありません。 B2B 注文にはコンシューマー注文明細行が含まれています。 B2C 注文には、アカウント、連絡先、パートナー、またはパートナー連絡先のパラメーターが含まれます。金額フィールドの通貨が注文通貨と一致しません。 Order_line_characteristics が製品モデルに関連付けられた product_offering を持つ注文明細行に対して渡されました。オファータイプ = 構成に指定された測定単位が、製品オファリングで定義されている許容測定単位に属していません。製品オファリングが構成を予期している場合、構成のオファータイプの特性は渡されませんでした。注文明細行にバンドルアイテムと簡単な構成がある注文を作成することはできません。渡されたパラメーターには、バンドルオファリングの特性が含まれています。親注文品目や子注文品目を作成できません。バンドルオファリング呼び出しでは、親バンドルアイテムのみが有効です。バンドルオファリングの指定されたunit_of_measurementレコードに「EACH」以外の値が含まれています。

応答本文のパラメーター (JSON または XML)


名前	説明
エラー	要求プロセス中に発生したエラーを説明する詳細。データタイプ: オブジェクト `"error": { "detail": "String", "message": "String" }`
error.detail	要求プロセス中に発生したエラーの詳細。データタイプ：文字列
error.message	要求プロセス中に発生したエラーのメッセージ。各エラーメッセージには、 detail プロパティに対応する説明があります。データタイプ：文字列
order_id	注文の注文番号。データタイプ：文字列テーブル:注文 [sn_csm_om_order]
status	エラーオブジェクトに加えて含まれる失敗メッセージ。データタイプ：文字列
sys_id	注文レコードのSys_id。データタイプ：文字列テーブル:注文 [sn_csm_om_order]

cURL 要求

次の例は、ステンレス製電子レンジの単品注文を作成する方法を示しています。

curl "https://instance.service-now.com/api/sn_ind_tmt_orm/order" \
--request POST \
--header "Accept:application/json" \
--header "Content-Type:application/json" \
--data "{
\"account\": \"c480021553ab70101aaeddeeff7b120f\",
\"contact\":\"96d0461553ab70101aaeddeeff7b120b\",
\"order_currency\": \"USD\",
\"order_line_items\": [
{
\"account\": \"c480021553ab70101aaeddeeff7b120f\",
\"action\": \"add\",
\"contact\": \"96d0461553ab70101aaeddeeff7b120b\",
\"list_price\": \"2000\",
\"order_line_characteristics\": [
{
\"characteristic\" : \"Solana color\",
\"characteristic_option\" : \"Stainless steel\"
},
{
\"characteristic\" :\"Microvawe Capacity\",
\"characteristic_option\" : \"1.2 cu\"
}
],
\"product_offering\": \"2d4376760f740110603bf634a7767e46\",
\"quantity\": \"1\",
\"shipping_city\": \"Santa Clara\",
\"shipping_country\": \"USA\",
\"shipping_state\": \"CA\",
\"shipping_street\": \"222 Star St\",
\"shipping_zip\": \"94560\",
\"state\": \"draft\",
\"status\": \"new\",
\"total_price\": \"2000\",
\"unit_of_measurement\": \"cb2795d553020110286eddeeff7b12ff\",
\"unit_price\": \"2000\"
}
]
}" \
--user 'user':'password'

応答：

{
  "result": {
    "sys_id": "24fdf5bd75eec510f877f30c01a15aa0",
    "order_id": "ORD0001034"
  }
}