---
sourceDocument: Xanadu API リファレンス
sourceDocumentLink: https://servicenow-prod.fluidtopics.net/r/ja-JP/xanadu/api-reference
Release :
- xanadu
ft:locale :
- ja-JP
ft:publication_title :
- Xanadu API リファレンス
ft:clusterId :
- crapiref
bundleId :
- crapiref
workflow :
- Creator
---
# 注文 API
# 注文 API {#ariaid-title1}
* リリースバージョン: Xanadu
*
* 更新日 2024年08月01日
*
*  所要時間：55分
Order API は、カスタマーサービス管理 (CSM) アプリケーションの注文明細品目を含む注文を取得および作成するためのエンドポイントを提供します。
この API には 注文管理 (app-csm-order-mgmt) ストアアプリケーションが必要であり、 `sn_csm_order_mgmt` 名前空間内で提供されます。詳細については、「[Sales Customer Relationship Management](https://www.servicenow.com/docs/access?context=order-mgt-overview&version=xanadu&pubname=xanadu-order-management&ft:locale=en-US)」を参照してください。
この 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 書き込みアクセス。
{#order_csm-api__ul_gfd_tfn_ctb}
B2B および B2C 注文の詳細については、「 [B2B2C の顧客データモデル](https://www.servicenow.com/docs/access?context=customer-data-model-b2b2c&version=xanadu&pubname=xanadu-customer-service-management&ft:locale=en-US)」を参照してください。
## 注文 API -- GET /sn_csm_order_mgmt/order/{id} {#ariaid-title2}
sys_id または注文番号を指定して、完全な注文の詳細を取得します。
### URL 形式
バージョニングされた URL：/api/sn_csm_order_mgmt/{api_version}/order/{id}
デフォルトの URL：/api/sn_csm_order_mgmt/order/{id}
### サポートされている要求パラメーター
{#order_csm-GET__entry__2}{#order_csm-GET__version-RESTAPI}
| 名前 | 説明 |
|-|-|
| api_version | オプションアクセスするエンドポイントのバージョン。たとえば、v1 や v2。最新以外のエンドポイントバージョンを使用する場合にのみ、この値を指定してください。 データタイプ：文字列 |
| id | 注文 \[sn_csm_om_order\] テーブルにある、取得するレコードの sys_id または注文番号 (order_id)。 データタイプ：文字列 |
[表 : 1. パスパラメーター]
{#order_csm-GET__entry__8}
| 名前 | 説明 |
|-|-|
| sysparm_display_value | 参照フィールドの表示値を表示するかどうかを示すフラグ。 有効な値： * true：応答の参照フィールド、選択肢フィールド、および日付フィールドの表示値を表示します。 * false：応答の参照フィールド、選択肢フィールド、および日付フィールドの実際の値を表示します。 {#order_csm-GET__ul_hn1_jdp_1tb} デフォルト値：false |
[表 : 2. クエリパラメーター]
{#order_csm-GET__entry__12}
| 名前 | 説明 |
|-|-|
| なし | |
[表 : 3. 要求本文パラメーター (XML または JSON)]
### ヘッダー
次のリクエストや応答ヘッダーは、この HTTP アクションにのみ適用されるか、またはこのアクションに別個の方法で適用されます。REST API で使用される一般的なヘッダーのリストについては、「 [サポートされている REST API ヘッダー](https://servicenow-prod.fluidtopics.net/ldF_qFEQnejbeXLBxcUhWg "REST (REpresentational State Transfer) は、Web 上のコンピューターシステム間の標準を提供し、相互の通信を容易にするシンプルなステートレスアーキテクチャです。")」を参照してください。
{#order_csm-GET__entry__16}{#order_csm-GET__accept-RESTAPI}
| ヘッダー | 説明 |
|-|-|
| 承認 | 応答本文のデータフォーマット。サポートされるタイプ：application/json または application/xml。 デフォルト： application/json |
[表 : 4. 要求ヘッダー]
{#order_csm-GET__entry__20}
| ヘッダー | 説明 |
|-|-|
| なし | |
[表 : 5. 応答ヘッダー]
### ステータスコード
この HTTP アクションには、次のステータスコードが適用されます。REST API で使用される可能性のあるステータスコードのリストについては、「 [REST API HTTP 応答コード](https://servicenow-prod.fluidtopics.net/ldF_qFEQnejbeXLBxcUhWg "REST (REpresentational State Transfer) は、Web 上のコンピューターシステム間の標準を提供し、相互の通信を容易にするシンプルなステートレスアーキテクチャです。")」を参照してください。
{#order_csm-GET__entry__24}{#order_csm-GET__entry-200-status-code}
| ステータスコード | 説明 |
|-|-|
| 200 | 成功。要求が正常に処理されました。 |
| 401 | ユーザーが認証されていません。 |
| 403 | ユーザーは許可されていません。 * ユーザーが API にアクセスするために必要なロールを持っていません。 * ユーザーに注文を読み込む権限がありません。 {#order_csm-GET__ul_ktg_jfp_1tb} この 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 書き込みアクセス。 {#order_csm-GET__ul_gfd_tfn_ctb} |
[表 : 6. ステータスコード]
### 応答本文のパラメーター (JSON または XML)
{#order_csm-GET__entry__32}{#order_csm-GET__ordr-ph-order_li}{#order_csm-GET__ordr-ph-order_li-account}{#order_csm-GET__ordr-ph-unit_of_meas}
| 名前 | 説明 |
|-|-|
| account | アカウント \[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 | 請求先の郵便番号。 データタイプ：文字列 |
| comments | 注文の追加情報。 データタイプ：文字列 |
| consumer | コンシューマー \[csm_consumer\] テーブルにあるレコードの sys_id。B2C 注文のコンシューマーを識別します。 データタイプ：文字列 |
| contact | アカウントに関連する顧客連絡先の sys_id。連絡先 \[customer_contact\] テーブルにリストされます。 データタイプ：文字列 |
| contract | 契約 \[ast_contract\] テーブルにリストされている カスタマーサービス 契約の sys_id。 データタイプ：文字列 |
| error | 要求プロセス中に発生したエラーを説明する詳細。 データタイプ：オブジェクト "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_csm-GET__d3782e287} データタイプ：文字列 |
| order_currency | 注文が購入された通貨を表す通貨コード。たとえば、米ドルの場合は USD です。この通貨は、注文および明細発注のすべての金額フィールドで使用されます。通貨コードは通貨 \[fx_currency\] テーブルにリストされます。 注: このプロパティは、以前のバージョンの 注文管理 では使用できない場合があります。 データタイプ：文字列 |
| order_date | 注文の作成日時。 形式：UTC 形式、yyyy-MM-dd HH:mm:ss データタイプ：文字列 |
| order_id | 注文 \[sn_csm_om_order\] テーブルにリストされている注文の注文番号。 データタイプ：文字列 |
| order_line_items | 必須です。注文の発注書明細を定義するオブジェクトのリスト。発注書明細 \[sn_csm_om_order_line_item\] テーブルにあります。 データタイプ：アレイ 各発注書明細オブジェクトに必要なプロパティ： * account (B2B 注文の場合)または consumer (B2C 注文の場合)。{#order_csm-GET__ordr-ph-order_li-acct-cons} * product_offering -- * quantity * unit_of_measurements * order_line_characteristics {#order_csm-GET__ordr-ul-order_li} "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_csm-GET__ordr-code-order_li} |
| order_line_items | 注文の発注書明細を定義するオブジェクトのリスト。発注書明細 \[sn_csm_om_order_line_item\] テーブルにあります。 データタイプ：アレイ "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 | 注文明細を注文に追加する方法を決定するアクション。 可能な値： * add * change {#order_csm-GET__ul_sqs_t5h_ctb} データタイプ：文字列 |
| 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 | 注文明細の有効日。 形式：UTC タイムゾーンでの yyyy-MM-dd HH:mm:ss データタイプ：文字列 |
| order_line_items.expiration_date | 注文明細の有効期限。 形式：UTC タイムゾーンでの yyyy-MM-dd HH:mm:ss データタイプ：文字列 |
| order_line_items.external_id | 発注書明細の外部 ID。 データタイプ：文字列 |
| order_line_items.external_system | 発注書明細の外部 sys_id。 データタイプ：文字列 |
| order_line_items.list_price | 製品オファリングの単価。 注: このプロパティは、以前のバージョンの 注文管理 では使用できない場合があります。 データタイプ：文字列 |
| order_line_items.location | 場所 \[cmn_location\] テーブルにリストされている出荷場所の sys_id。 データタイプ：文字列 |
| 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 | オーダー品目 \[sn_csm_om_order_line_item\] テーブル内のこの特性のオーダー品目の sys_id。 データタイプ：文字列 |
| 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 | レコードのドメインパス。 データタイプ：文字列 デフォルト：/ (global) |
| order_line_items. order_line_characteristics. sys_id | 注文明細特性 \[sn_csm_om_order_characteristic_value\] テーブルにある注文レコードの sys_id。 データタイプ：文字列 |
| 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_csm-GET__ul_j3l_4qg_ctb} データタイプ：文字列 |
| order_line_items.order_line_id | このオーダー品目に関連付けられた注文の注文番号。 データタイプ：文字列 |
| order_line_items.parent_line_item | 該当する場合、この品目の親品目を識別します。 データタイプ：文字列 |
| order_line_items.previous_product_model | オーダーラインでこのアイテムの前にリストされている製品の製品モデルを識別します。製品モデル \[cmdb_model\] テーブルにリストされている製品の sys_id。 データタイプ：文字列 |
| 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 | 製品モデル \[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 | 販売済み製品 \[sn_install_base_sold_product\] テーブルにリストされているインストールベースの販売済み製品の sys_id。 データタイプ：文字列 |
| order_line_items.specification | 発注書明細の仕様。 データタイプ：文字列 |
| order_line_items.state | 注文明細のステータス。たとえば、draft、new、in_progress、completed などです。 データタイプ：文字列 |
| order_line_items.status | 発注書明細のステータス。 可能な値： * success * failure {#order_csm-GET__ul_qkt_w2m_ctb} データタイプ：文字列 |
| 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 | レコードのドメインパス。 データタイプ：文字列 デフォルト：/ (global) |
| order_line_items.sys_id | オーダー品目 \[sn_csm_om_order_line_item\] テーブルにある品目レコードの sys_id。 データタイプ：文字列 |
| 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 | 通貨インスタンス \[fx_currency_instance\] テーブルにリストされている製品オファリングの正味単価。 データタイプ：文字列 |
| order_line_items.work_notes | 発注書明細の自由形式の内部作業メモ。 データタイプ：文字列 |
| order_type | 注文の追加方法を決定する注文アクション。 可能な値： * add * change データタイプ：文字列 |
| partner | B2B 注文の場合、アカウント \[customer_account\] テーブルにリストされているアカウントの関連パートナーの sys_id。 データタイプ：文字列 |
| partner_contact | B2B 注文の場合、パートナーアカウントのパートナーのプライマリ連絡先の sys_id。連絡先 \[customer_contact\] テーブルにリストされます。 データタイプ：文字列 |
| payment_ref_id | 支払の一意の識別子。たとえば、小切手番号です。 データタイプ：文字列 |
| price_list | 価格リスト \[sn_csm_pricing_price_list\] テーブルにリストされている関連付けられた価格リストの sys_id。この API では、正味価格と数量に基づいて価格は計算されません。 注: このプロパティは、以前のバージョンの 注文管理 では使用できない場合があります。 データタイプ：文字列 |
| quote_id | 注文価格見積もりの一意の ID。 データタイプ：文字列 |
| same_as_shipping_address | 購入者の住所が出荷先住所と同じかどうかを示すフラグ。 有効な値： * true：購入者の住所が出荷先住所と同じです。 * false：購入者の住所が出荷先住所と異なります。 {#order_csm-GET__ul_ygx_zsq_btb} データタイプ：ブーリアン |
| shipping_city | 宛先の都市の名前。 データタイプ：文字列 |
| shipping_country | 宛先の国の略語。 データタイプ：文字列 |
| shipping_location | 場所 \[cmn_location\] テーブルにリストされている出荷場所の sys_id。 データタイプ：文字列 |
| shipping_state | 宛先の都道府県の略語。 データタイプ：文字列 |
| shipping_street | 宛先の番地。 データタイプ：文字列 |
| shipping_zip | 宛先の郵便番号。 データタイプ：文字列 |
| short_description | 注文の簡単な説明 データタイプ：文字列 |
| special_instructions | 注文に関する特別な指示。 データタイプ：文字列 |
| state | 注文のステータス。たとえば、new、in_progress、completed などです。 データタイプ：文字列 |
| status | 注文のステータス。 可能な値： * success * failure {#order_csm-GET__ul_vmw_prm_ctb} データタイプ：文字列 |
| sys_class_name | この注文レコードがあるテーブルのシステム名。 データタイプ：文字列 |
| sys_created_by | このレコードを作成したユーザーのシステム名。 データタイプ：文字列 |
| sys_created_on | レコードが最初に作成された日時。 データタイプ：文字列 |
| sys_domain | 注文レコードにアクセスできるドメインスコープ。たとえば、 global です。 データタイプ：文字列 |
| sys_domain_path | レコードのドメインパス。 データタイプ：文字列 デフォルト：/ (global) |
| sys_id | 注文 \[sn_csm_om_order\] テーブルにリストされている注文の sys_id。 データタイプ：文字列 |
| sys_mod_count | このレコードが変更された回数。 データタイプ：文字列 |
| sys_tags | コンテンツのシステムタグ。 データタイプ：文字列 |
| sys_updated_by | このレコードを最後に更新したユーザーのシステム名。 データタイプ：文字列 |
| sys_updated_on | レコードが最後に更新された日時。 データタイプ：文字列 |
| total_amount | 注文全体の合計コスト。 データタイプ：文字列 |
[ ]
### cURL 要求
次の例は、注文番号で注文を受ける方法を示しています。
curl "https://instance.service-now.com/api/sn_csm_order_mgmt/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_csm_order_mgmt/order {#ariaid-title3}
品目と特性を使用して新しい注文を作成します。
品目を含む注文は、要求本文パラメーターを使用して定義されます。注文管理 のほとんどのバージョンでは、次のプロパティが必要です。
* account (B2B 注文の場合)または consumer (B2C 注文の場合)。
* account -- アカウント \[customer_account\] テーブルにあるレコードの sys_id。
* consumer -- コンシューマー \[csm_consumer\] テーブルにあるレコードの sys_id。
{#order_csm-POST__ul_h5j_my1_dtb}
* order_currency -- 注文が購入された通貨を表す通貨コード。たとえば、米ドルの場合は USD です。この通貨は、注文および明細発注のすべての金額フィールドで使用されます。通貨コードは通貨 \[fx_currency\] テーブルにリストされます。
* order_line_items -- 注文の発注書明細を定義するオブジェクトのリスト。発注書明細 \[sn_csm_om_order_line_item\] テーブルにあります。 各発注書明細オブジェクトに必要なプロパティ：
* account (B2B 注文の場合)または consumer (B2C 注文の場合)。
* account -- この発注書明細にアサインされたビジネスアカウントの sys_id。アカウント \[customer_account\] テーブルにあります。
* consumer -- この発注書明細にアサインされたコンシューマーの sys_id。コンシューマー \[csm_consumer\] テーブルにあります。
{#order_csm-POST__ul_dqm_qbb_dtb}
* 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_csm_order_mgmt/{api_version}/order
デフォルトの URL：/api/sn_csm_order_mgmt/order
### サポートされている要求パラメーター
{#order_csm-POST__entry__2}
| 名前 | 説明 |
|-|-|
| なし | |
[表 : 7. パスパラメーター]
{#order_csm-POST__entry__6}
| 名前 | 説明 |
|-|-|
| なし | |
[表 : 8. クエリパラメータ]
{#order_csm-POST__entry__10}{#order_csm-POST__order_ph_account}{#order_csm-POST__order_ph_consumer}{#order_csm-POST__ordr-ph-order_currency}{#order_csm-POST__ordr-ph-order_li}{#order_csm-POST__ordr-ph-order_li-account}{#order_csm-POST__ordr-ph-order_li-consumer}{#order_csm-POST__ordr-ph-order_li-char}{#order_csm-POST__ordr-ph-order_li-product}{#order_csm-POST__ordr-ph-order_li-product_offering}{#order_csm-POST__ordr-row-order_li-product_spec}{#order_csm-POST__ordr-ph-order_li-quantity}{#order_csm-POST__ordr-ph-unit_of_meas}
| 名前 | 説明 |
|-|-|
| account | 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 | 請求先の郵便番号。 データタイプ：文字列 |
| comments | 注文の追加情報。 データタイプ：文字列 |
| consumer | B2C 注文に必須です。コンシューマー \[csm_consumer\] テーブルにあるレコードの sys_id。B2B 注文にはアカウントプロパティが必要です。 データタイプ：文字列 |
| contact | アカウントに関連する顧客連絡先の sys_id。連絡先 \[customer_contact\] テーブルにリストされます。 データタイプ：文字列 |
| contract | 契約 \[ast_contract\] テーブルにリストされている カスタマーサービス 契約の sys_id。 データタイプ：文字列 |
| 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_csm-POST__ul_j3l_4qg_ctb} データタイプ：文字列 |
| order_currency | 必須です。注文が購入された通貨を表す通貨コード。たとえば、米ドルの場合は USD です。この通貨は、注文および明細発注のすべての金額フィールドで使用されます。通貨コードは通貨 \[fx_currency\] テーブルにリストされます。 注: このプロパティは、以前のバージョンの 注文管理 では使用できない場合があります。 データタイプ：文字列 |
| order_date | 注文の作成日時。 形式：UTC 形式、yyyy-MM-dd HH:mm:ss データタイプ：文字列 |
| order_line_items | 必須です。注文の発注書明細を定義するオブジェクトのリスト。発注書明細 \[sn_csm_om_order_line_item\] テーブルにあります。 データタイプ：アレイ 各発注書明細オブジェクトに必要なプロパティ： * account (B2B 注文の場合)または consumer (B2C 注文の場合)。{#order_csm-POST__ordr-ph-order_li-acct-cons} * product_offering -- * quantity * unit_of_measurements * order_line_characteristics {#order_csm-POST__ordr-ul-order_li} "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_csm-POST__ordr-code-order_li} |
| order_line_items.account | B2B 注文に必須です。この発注書明細にアサインされたビジネスアカウントの sys_id。アカウント \[customer_account\] テーブルにあります。B2C 注文にはコンシューマープロパティが必要です。 データタイプ：文字列 |
| order_line_items.action | 注文明細を注文に追加する方法を決定するアクション。 可能な値： * add * change {#order_csm-POST__ul_sqs_t5h_ctb} データタイプ：文字列 |
| 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 | 注文明細の有効日。 形式：UTC タイムゾーンでの yyyy-MM-dd HH:mm:ss データタイプ：文字列 |
| order_line_items.expiration_date | 注文明細の有効期限。 形式：UTC タイムゾーンでの yyyy-MM-dd HH:mm:ss データタイプ：文字列 |
| 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_csm-POST__ordr-code-order_li-char} |
| order_line_items.order_line_characteristics.characteristic | 製品モデルに関連付けられた特性の名前。例： Dishwasher Size。 データタイプ：文字列 |
| 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 | 販売済み製品 \[sn_install_base_sold_product\] テーブルにリストされているインストールベースの販売済み製品の sys_id。 データタイプ：文字列 |
| order_line_items.specification | 発注書明細の仕様。 データタイプ：文字列 |
| order_line_items.state | 注文明細のステータス。たとえば、draft、new、in_progress、completed などです。 データタイプ：文字列 |
| order_line_items.total_price | オーダーラインの合計価格。この API では、正味価格と数量に基づいて合計価格は計算されません。 データタイプ：文字列 |
| order_line_items.unit_of_measurement | 必須です。測定単位 \[sn_prd_pm_uom\] テーブルにリストされている注文済み測定単位の sys_id。 注: このプロパティは、以前のバージョンの 注文管理 では使用できない場合があります。 データタイプ：文字列 |
| order_line_items.unit_price | 通貨インスタンス \[fx_currency_instance\] テーブルにリストされている製品オファリングの正味単価。 データタイプ：文字列 |
| order_line_items.work_notes | 発注書明細の自由形式の内部作業メモ。 データタイプ：文字列 |
| order_type | 注文の追加方法を決定する注文アクション。 可能な値： * add * change データタイプ：文字列 |
| partner | B2B 注文の場合、アカウント \[customer_account\] テーブルにリストされているアカウントの関連パートナーの sys_id。 データタイプ：文字列 |
| partner_contact | B2B 注文の場合、パートナーアカウントのパートナーのプライマリ連絡先の sys_id。連絡先 \[customer_contact\] テーブルにリストされます。 データタイプ：文字列 |
| price_list | 価格リスト \[sn_csm_pricing_price_list\] テーブルにリストされている関連付けられた価格リストの sys_id。この API では、正味価格と数量に基づいて価格は計算されません。 注: このプロパティは、以前のバージョンの 注文管理 では使用できない場合があります。 データタイプ：文字列 |
| quote_id | 注文価格見積もりの一意の ID。 データタイプ：文字列 |
| shipping_city | 宛先の都市の名前。 データタイプ：文字列 |
| shipping_country | 宛先の国の略語。 データタイプ：文字列 |
| shipping_state | 宛先の都道府県の略語。 データタイプ：文字列 |
| shipping_street | 宛先の番地。 データタイプ：文字列 |
| shipping_zip | 宛先の郵便番号。 データタイプ：文字列 |
| short_description | 注文の簡単な説明 データタイプ：文字列 |
| special_instructions | 注文に関する特別な指示。 データタイプ：文字列 |
| state | 注文のステータス。たとえば、new、in_progress、completed などです。 データタイプ：文字列 |
| total_amount | 注文全体の合計コスト。 データタイプ：文字列 |
[表 : 9. 要求本文パラメーター (XML または JSON)]
### ヘッダー
次のリクエストや応答ヘッダーは、この HTTP アクションにのみ適用されるか、またはこのアクションに別個の方法で適用されます。REST API で使用される一般的なヘッダーのリストについては、「 [サポートされている REST API ヘッダー](https://servicenow-prod.fluidtopics.net/ldF_qFEQnejbeXLBxcUhWg "REST (REpresentational State Transfer) は、Web 上のコンピューターシステム間の標準を提供し、相互の通信を容易にするシンプルなステートレスアーキテクチャです。")」を参照してください。
{#order_csm-POST__entry__146}{#order_csm-POST__accept-RESTAPI}
| ヘッダー | 説明 |
|-|-|
| 承認 | 応答本文のデータフォーマット。サポートされるタイプ：application/json または application/xml。 デフォルト： application/json |
[表 : 10. 要求ヘッダー]
{#order_csm-POST__entry__150}
| ヘッダー | 説明 |
|-|-|
| なし | |
[表 : 11. 応答ヘッダー]
### ステータスコード
この HTTP アクションには、次のステータスコードが適用されます。REST API で使用される可能性のあるステータスコードのリストについては、「 [REST API HTTP 応答コード](https://servicenow-prod.fluidtopics.net/ldF_qFEQnejbeXLBxcUhWg "REST (REpresentational State Transfer) は、Web 上のコンピューターシステム間の標準を提供し、相互の通信を容易にするシンプルなステートレスアーキテクチャです。")」を参照してください。
{#order_csm-POST__entry__154}{#order_csm-POST__entry-200-status-code}
| ステータスコード | 説明 |
|-|-|
| 200 | 成功。要求が正常に処理されました。 |
| 400 | 要求が正しくありません。 ペイロードが予期された形式ではありません。 |
| 401 | ユーザーが認証されていません。 |
| 403 | ユーザーは許可されていません。 * ユーザーが API にアクセスするために必要なロールを持っていません。 * ユーザーに注文を読み込む権限がありません。 {#order_csm-POST__ul_ktg_jfp_1tb} この 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 書き込みアクセス。 {#order_csm-POST__ul_gfd_tfn_ctb} |
| 500 | 内部サーバーエラー。1 つ以上の検証に失敗しました。 考えられる問題： * Account または consumer パラメーターがありません。これらのフィールドはヘッダーとアイテムで必須です。 * Account/contact および consumer パラメーターが渡されました。これらのパラメーターを一緒に渡すことはできません。 * 選択肢パラメーター：無効な選択値が渡されました。 * 数量パラメーター：無効な値です。 * 無効な参照フィールドです。 * 必須フィールドがありません。 * 無効な日時形式です。 * 開始日が終了日より後の日付になっています。 * 無効な特性です。 * 無効な特性オプションです。 * 指定された特性に対して複数の製品モデルが見つかりました。 * 指定された特性に対する製品モデルが見つかりませんでした。 * ユーザーには注文を作成するためのアクセス権がありません。 * B2B 注文にコンシューマーのオーダーラインが含まれています。 * B2C 注文にアカウント、連絡先、パートナー、またはパートナー連絡先パラメーターが含まれています。 * 金額フィールドの通貨が注文通貨と一致しません。 * product_offering が製品モデルに関連付けられているオーダーラインに Order_line_characteristics が渡されました。 * オファータイプ = 構成に指定された測定単位が、製品オファリングで定義された許容測定単位に属していません。 * 製品オファリングが構成を想定している場合に、構成のオファータイプに特性が渡されませんでした。 * オーダーラインにバンドルアイテムと簡単な構成を含む注文は作成できません。 * 渡されたパラメーターに、バンドルオファリングの特性が含まれています。 * 親オーダーラインまたは子オーダーライン、またはその両方を作成できません。バンドルオファリング呼び出しでは、親バンドルアイテムのみが有効です。 * バンドルオファリングの指定された unit_of_measurement レコードに「EACH」以外の値が含まれています。 |
[表 : 12. ステータスコード]
### 応答本文のパラメーター (JSON または XML)
{#order_csm-POST__entry__166}
| 名前 | 説明 |
|-|-|
| error | 要求プロセス中に発生したエラーを説明する詳細。 データタイプ：オブジェクト "error": { "detail": "String", "message": "String" } |
| error.detail | 要求プロセス中に発生したエラーの詳細。 データタイプ：文字列 |
| error.message | 要求プロセス中に発生したエラーのメッセージ。各エラーメッセージには、detail プロパティに対応する説明があります。 データタイプ：文字列 |
| order_id | 注文 \[sn_csm_om_order\] テーブルにリストされている注文の注文番号。 データタイプ：文字列 |
| status | エラーオブジェクトに加えて含まれる失敗メッセージ。 データタイプ：文字列 |
| sys_id | 注文 \[sn_csm_om_order\] テーブルにリストされている注文の sys_id。 データタイプ：文字列 |
[ ]
### cURL 要求
次の例は、ステンレス鋼電子レンジの単一アイテムの注文を作成する方法を示しています。
curl "https://instance.service-now.com/api/sn_csm_order_mgmt/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"
}
}