機械翻訳について
  1. Oracle Fusion Cloud Customer ExperienceのSales and Fusion ServiceのREST API
  2. タスク
  3. 販売オーダー

見積りを取得

get

/crmRestApi/resources/11.13.18.05/salesOrders/{OrderHeaderId}

リクエスト

パス・パラメータ
問合せパラメータ
  • このパラメータは、レスポンスの生成後に設定およびロールバックされるフィールドである依存関係を指定します。 通常、これらは属性変更の影響をプレビューするために使用されます。 このパラメータで指定されたフィールドは、常に問題のリソース・インスタンスで設定されます。 子リソース・コレクションがリクエストされ、パラメータが設定されると、リソース・コレクション・ペイロードを生成する前にフィールドが親リソース・インスタンスに設定されます。 この問合せパラメータの値は、依存性フィールドのセットです。 例: dependency=ProductId=2

    フォーマット: <attr1>=<val1>,<attr2>=<value2>
  • このパラメータを指定すると、指定した子がリソース・ペイロードに含まれます(リンクのみでなく)。 この問合せパラメータの値は"all"または""です。 カンマをセパレータとして使用して、複数の子を指定できます。 例: ?expand=Employees,Localizations. ネストされた子は、"Child.NestedChild"の書式に従って指定することもできます(例): ?expand=Employees.Managers). ネストされた子が指定されている場合(例): Employees.Managers)。欠落している子は暗黙的に処理されます。 たとえば、"?expand=Employees.Managers"は"?expand=Employees,Employees.Managers"と同じです(これにより、従業員とマネージャが展開されます)。
  • このパラメータは、リソース・フィールドをフィルタします。 指定されたフィールドのみが返されます。つまり、フィールドが指定されていない場合、フィールドは返されません(リンクのみを取得する場合に便利です)。 間接子リソースが指定されている場合(例): Employees.Managers)。欠落している子は暗黙的に処理されます。 たとえば、"?fields=Employees.Managers:Empname"は"?fields=;Employees:;Employees.Managers:Empname" (これはマネージャの"Empname"フィールドのみを返す)と同じです。この問合せパラメータの値は、リソース・フィールドのリストです。 属性は直接にすることができます(例): 従業員または間接(例): Employees.Managers) child. 拡張問合せパラメータと組み合せることはできません。 両方を指定した場合、フィールドのみが考慮されます。

    フォーマット : ?fields=Attribute1,Attribute2

    子リソースのフィールドの書式 : ?fields=Accessor1:Attribute1,Attribute2
  • このパラメータは、単一のリソースまたはリソース・コレクションへのアクセス中に特定のリンクのみを表示するために使用できます。 パラメータ値書式は、次のカンマ区切りリストです : <link_relation>

    例:
    self,canonical
  • リソース・アイテム・ペイロードは、データのみを含めるようにフィルタされます(リンク・セクションなどは含まれません)。
ヘッダー・パラメータ
  • REST APIがランタイム・カスタマイズをサポートしている場合、サービスのシェイプはランタイム中に変更される可能性があります。 RESTクライアントは、これらの変更から自身を分離したり、このヘッダーを指定して最新バージョンのAPIと対話することを選択できます。 次に例を示します : Metadata-Context:sandbox="TrackEmployeeFeature".
  • RESTクライアントとサービスの間のプロトコル・バージョン。 クライアントがリクエストでこのヘッダーを指定しない場合、サーバーはAPIのデフォルト・バージョンを選択します。

この操作にはリクエスト本文がありません。

トップに戻る

応答

サポートされるメディア・タイプ

デフォルトのレスポンス

次の表では、このタスクに対するデフォルトのレスポンスについて説明します。
ヘッダー
  • REST APIがランタイム・カスタマイズをサポートしている場合、サービスのシェイプはランタイム中に変更される可能性があります。 RESTクライアントは、これらの変更から自身を分離したり、このヘッダーを指定して最新バージョンのAPIと対話することを選択できます。 次に例を示します : Metadata-Context:sandbox="TrackEmployeeFeature".
  • RESTクライアントとサービスの間のプロトコル・バージョン。 クライアントがリクエストでこのヘッダーを指定しない場合、サーバーはAPIのデフォルト・バージョンを選択します。
本文( )
ルート・スキーマ : salesOrders-item-response
タイプ: object
ソースを表示
  • タイトル: Account Based Quote
    最大長: 1
    この見積レコードがアカウント・ベースの見積かどうかを示します。
  • タイトル: Active
    最大長: 1
    販売オーダーがアクティブかどうかを示します。 trueまたはfalseの値があります。
  • タイトル: Business Unit ID
    この見積が属するビジネス・ユニットまたは内部組織。
  • タイトル: Contact
    読取り専用: true
    最大長: 360
    見積または販売オーダーのプライマリ担当者の名前。
  • タイトル: Contract End Date
    見積内のすべての明細品目の最新終了日。
  • タイトル: Contract Start Date
    見積内のすべての品目の最早開始日。
  • タイトル: Created By
    読取り専用: true
    最大長: 64
    販売オーダーを作成したユーザー。
  • タイトル: Creation Date
    読取り専用: true
    販売オーダーが作成された日付。
  • タイトル: Currency Conversion Rate
    販売オーダーに関連付けられたトランザクションの通貨換算レート。
  • タイトル: Currency
    最大長: 15
    販売オーダーに関連付けられた通貨コード。 この属性は、CRM拡張フレームワークで使用されます。 有効な値のリストは、参照ZCA_COMMON_CORPORATE_CURRENCYで定義されます。 「設定およびメンテナンス」作業領域の通貨プロファイル・オプションの管理タスクを使用して、プロファイル・オプションをレビューおよび更新します。
  • 読取り専用: true
    レコードを削除するためのアクセス権がユーザーに付与されているかどうかを示します。
  • タイトル: Description
    最大長: 360
    オーダーの摘要。
  • タイトル: Valid to Date
    販売オーダーが失効する日付。
  • タイトル: CPQ Host Name
    最大長: 255
    CPQサイトの名前。
  • タイトル: CPQ Process Name
    最大長: 255
    CPQサイトのプロセスの名前。
  • タイトル: Quote ID
    最大長: 30
    この見積を作成したソース・システムの一意の識別子。
  • タイトル: Reference Number
    最大長: 64
    外部ソース・システムからの見積の外部参照番号。
  • タイトル: Reference Code
    最大長: 30
    見積またはオーダーの外部参照(サード・パーティ)タイプ。ビッグ・マシンはBMQUOTEを渡します。
  • タイトル: Last Synchronized
    商談の見積りの有効なバージョンを識別するために、見積りに対して商談を同期できる最終日。
  • タイトル: Last Updated
    読取り専用: true
    レコードが最後に更新された日付。
  • タイトル: Last Updated By
    読取り専用: true
    最大長: 64
    レコードを最後に更新したユーザー。
  • タイトル: Last Update Login
    読取り専用: true
    最大長: 32
    販売オーダーを最後に更新したユーザーのログイン。
  • Links
  • タイトル: Name
    最大長: 275
    見積りまたはオーダーの名前。
  • タイトル: Opportunity
    読取り専用: true
    最大長: 275
    見積または販売オーダーに関連付けられた商談の名前。
  • タイトル: Opportunity ID
    商談の一意の識別子。
  • タイトル: Opportunity Number
    読取り専用: true
    最大長: 30
    販売オーダーに関連付けられている商談番号。
  • タイトル: Opportunity Status
    読取り専用: true
    最大長: 30
    販売オーダーに関連付けられている商談のステータス。 有効な値は、MOO_OPTY_STATUS参照タイプにリストされます。
  • タイトル: ID
    見積またはオーダーの一意の識別子。
  • タイトル: Quote or Order Number
    最大長: 30
    販売オーダーの代替キー識別子です。
  • タイトル: Total Contract Value
    見積またはオーダーの合計金額。
  • タイトル: Quote Descriptor
    最大長: 360
    オーダーの所有者。
  • タイトル: Owner Resource Party Id
    所有者パーティのリソース識別子。
  • タイトル: Owner Party Name
    読取り専用: true
    最大長: 360
    所有者のパーティ名。
  • タイトル: Placed On
    オーダーが行われた日付。
  • タイトル: Proposal
    最大長: 1
    見積に対して提案文書が生成されているかどうかを示します(Y、Nなど)。 デフォルト値はありません。
  • タイトル: Proposal URL
    読取り専用: true
    見積提案文書をフェッチするURL。
  • タイトル: Quote Type Category
    最大長: 30
    見積が新規、更改または拡張のいずれであるかを示します。
  • タイトル: Renewal Process
    最大長: 30
    見積の更改に使用される更改プロセス。
  • タイトル: Account ID
    販売オーダーに関連付けられた顧客アカウントの一意の識別子。
  • タイトル: Customer
    読取り専用: true
    最大長: 900
    顧客アカウントの名前。
  • Sales Orders Active Version
    タイトル: Sales Orders Active Version
    販売オーダー・アクティブ・バージョン・リソースには、アクティブなすべての販売オーダー・バージョンがリストされます。
  • Quote and Order Lines
    タイトル: Quote and Order Lines
    見積およびオーダー明細リソースは、販売オーダー明細の表示、作成、更新および削除に使用されます。 製品、見積名、その他の収益関連データなど、オーダー明細の詳細が含まれています。
  • Quote Rollups
    タイトル: Quote Rollups
    見積積上リソースは、見積積上情報の表示に使用されます。
  • タイトル: Contact ID
    顧客担当者パーティの一意の識別子。
  • タイトル: Contact Party Number
    読取り専用: true
    最大長: 30
    販売オーダーに関連付けられている担当者の一意の識別子。
  • タイトル: Customer ID
    顧客パーティの一意の識別子。
  • タイトル: Account
    読取り専用: true
    最大長: 900
    顧客パーティの一意の名前。
  • タイトル: Account Party Number
    読取り専用: true
    最大長: 30
    販売オーダーに関連付けられたアカウントの一意の識別子。
  • タイトル: Address ID
    顧客サイトの一意の識別子。
  • タイトル: Status
    最大長: 255
    BMによって送信された正確な見積ステータス。
  • タイトル: Total Monthly Recurring Revenue
    見積りの月次経常売上の合計。
  • タイトル: Total Monthly Usage Revenue
    見積りの合計月次使用収益。
  • タイトル: Total Nonrecurring Revenue
    見積りの経常外売上の合計。
  • タイトル: Total Recurring Revenue
    見積りの経常売上合計。
  • タイトル: Total Usage Revenue
    見積の使用収益合計。
  • 読取り専用: true
    レコードを更新するためのアクセス権がユーザーに付与されているかどうかを示します。
  • タイトル: Version
    見積またはオーダーのバージョン番号。
  • タイトル: Win Status
    最大長: 30
    デフォルト値: ZCA_IN_PROGRESS
    受注のステータスを示すコード。 たとえば、ZCA_WIN、ZCA_LOST、ZCA_IN_PROGRESS、ZCA_DELETEDまたはZCA_ALTERNATE_VERSIONです。 有効な値はORA_ZCA_WIN_STATUSにリストされます。 見積または販売オーダーの集計ステータスは、フィルタリングおよび分析のために各見積または販売オーダーの集計ステータスを定義します。
ネストされたスキーマ : 販売オーダー・アクティブ・バージョン
タイプ: array
タイトル: Sales Orders Active Version
販売オーダー・アクティブ・バージョン・リソースには、アクティブなすべての販売オーダー・バージョンがリストされます。
ソースを表示
ネストされたスキーマ : 見積およびオーダー明細
タイプ: array
タイトル: Quote and Order Lines
見積およびオーダー明細リソースは、販売オーダー明細の表示、作成、更新および削除に使用されます。 製品、見積名、その他の収益関連データなど、オーダー明細の詳細が含まれています。
ソースを表示
ネストされたスキーマ : 見積ロールアップ
タイプ: array
タイトル: Quote Rollups
見積積上リソースは、見積積上情報の表示に使用されます。
ソースを表示
ネストされたスキーマ : salesOrders-SalesOrderActiveVersionVA-item-response
タイプ: object
ソースを表示
ネストされたスキーマ : salesOrders-SalesOrderLine-item-response
タイプ: object
ソースを表示
  • タイトル: Net Amount
    販売オーダー明細品目に関連付けられている収益金額。
  • タイトル: Line Contract End Date
    販売オーダーの販売オーダー明細に関連付けられている契約の終了日。
  • タイトル: Line Contract Periods
    販売オーダー明細に関連付けられた契約期間の数。
  • タイトル: Line Contract Start Date
    販売オーダーの販売オーダー明細に関連付けられている契約の開始日。
  • タイトル: Line Contract Value
    販売オーダー明細品目に関連付けられている合計金額。
  • タイトル: Created By
    読取り専用: true
    最大長: 64
    ラベルは、オーダー明細の現在の受注または失注ステータスを示します。
  • タイトル: Creation Date
    読取り専用: true
    レコードが作成された日時。
  • タイトル: Line Currency
    最大長: 15
    販売オーダー明細に関連付けられた通貨コード。
  • 読取り専用: true
    レコードを削除するためのアクセス権がユーザーに付与されているかどうかを示します。
  • タイトル: Product Name
    読取り専用: true
    最大長: 240
    オーダー明細に関連付けられた製品の名前。
  • タイトル: Line Discount
    特定の販売オーダー明細に適用される割引(パーセント)。
  • タイトル: External Asset Key
    最大長: 255
    外部システムからのアセット・キー。
  • タイトル: External Order Line ID
    最大長: 64
    外部オーダー明細の一意の識別子。
  • タイトル: External Line Number
    最大長: 64
    レコードを作成したソース・システムの代替識別子。
  • タイトル: External Parent Asset Key
    最大長: 255
    外部システムの親のルート・アセット・キー。
  • タイトル: Quote ID
    読取り専用: true
    最大長: 30
    見積を作成したソース・システムの識別子。
  • タイトル: External Root Asset Key
    最大長: 255
    外部システムから取得したルート・アセット・キー。
  • タイトル: Reference Number
    読取り専用: true
    最大長: 64
    外部見積またはオーダーの識別子。
  • タイトル: Inventory Item ID
    在庫品目の一意の識別子。
  • タイトル: Inventory Organization ID
    在庫組織の一意の識別子。
  • タイトル: Item Number
    読取り専用: true
    最大長: 300
    販売オーダー明細に関連付けられている製品のアイテム番号。
  • タイトル: Item Type
    最大長: 30
    販売オーダー明細品目のタイプ。
  • タイトル: Last Updated
    読取り専用: true
    レコードが最後に更新された日時。
  • タイトル: Last Updated By
    読取り専用: true
    最大長: 64
    オーダー明細レコードを最後に更新したユーザー。
  • タイトル: Last Update Login
    読取り専用: true
    最大長: 32
    オーダー明細レコードを最後に更新したユーザーのログイン。
  • タイトル: Line Status
    最大長: 30
    販売オーダー明細レコードのステータス。
  • Links
  • タイトル: Monthly Recurring Revenue
    見積明細の月次経常収益。
  • タイトル: Monthly Usage Revenue
    見積明細の月次使用収益。
  • タイトル: Nonrecurring Revenue
    見積明細の経常外収益または単発収益。
  • タイトル: Line Order Date
    オーダー明細のオーダー日。
  • タイトル: Order Header ID
    販売オーダー・レコードの一意の識別子。
  • タイトル: Order Header Name
    読取り専用: true
    最大長: 275
    オーダー明細に関連付けられているオーダーの名前。
  • タイトル: Quote or Order Number
    読取り専用: true
    最大長: 30
    オーダー明細に関連付けられたオーダーの公開一意識別子。
  • タイトル: Order Line ID
    販売オーダー明細の一意の識別子。
  • タイトル: Order Line Number
    最大長: 30
    販売オーダー明細番号。
  • タイトル: Order Number
    最大長: 64
    履行オーダーの参照番号。
  • タイトル: Parent External Line Number
    最大長: 64
    外部アプリケーションからの親販売オーダー明細の公開一意ID。
  • タイトル: Net Price
    単位当たりの販売オーダー明細品目の価格。
  • タイトル: Line Price Period
    最大長: 30
    販売オーダー明細品目に関連付けられた価格が指定されている期間。
  • タイトル: Line Price Type
    最大長: 30
    販売オーダー明細アイテムに関連付けられた価格設定のタイプです。
  • タイトル: Quantity
    販売オーダー明細品目に関連付けられている数量。
  • タイトル: Recurring Revenue
    見積明細の経常収益。
  • タイトル: Line Request Date
    販売オーダー明細の製品のリクエスト日。
  • タイトル: Revenue Type Category
    最大長: 30
    商談売上明細の売上カテゴリ・タイプ。
  • タイトル: Revenue ID
    オーダー明細に関連付けられた収益の一意の識別子。
  • タイトル: Root Line
    最大長: 1
    見積明細のタイプがルートかどうかを示します。
  • タイトル: Account ID
    読取り専用: true
    オーダー明細に関連付けられたオーダーの販売アカウントの一意の識別子。
  • タイトル: Contact ID
    読取り専用: true
    オーダー明細に関連付けられたオーダーの担当者の一意の識別子。
  • タイトル: Customer ID
    読取り専用: true
    オーダー明細に関連付けられたオーダーのアカウントの一意の識別子。
  • タイトル: Customer ID
    読取り専用: true
    オーダー明細に関連付けられたオーダーの顧客住所の一意の識別子です。
  • タイトル: Subscription Id
    サブスクリプションの一意の識別子。
  • タイトル: Subscription Line Id
    サブスクリプション内のサブスクリプション明細の一意の識別子。
  • タイトル: Line Subtotal
    販売オーダー明細品目に関連付けられている金額(価格タイプによる)。
  • タイトル: Contract Value Detail
    見積明細の契約値で、レポート・ニーズに集計して使用できます。
  • タイトル: Nonrecurring Revenue Detail
    見積明細の経常外収益で、集計してレポート・ニーズに使用できます。
  • タイトル: Recurring Revenue Detail
    見積明細の経常収益で、レポート作成のニーズに集計して使用できます。
  • タイトル: Usage Revenue Detail
    見積明細の使用収益で、レポート・ニーズに集計して使用できます。
  • タイトル: Unit List Price
    見積明細品目のユニット定価。
  • タイトル: UOM
    最大長: 3
    製品の販売に使用される単位。
  • 読取り専用: true
    レコードを更新するためのアクセス権がユーザーに付与されているかどうかを示します。
  • タイトル: Usage Revenue
    見積明細の使用収益。
  • タイトル: Line Win Loss Status
    最大長: 30
    オーダー明細の現在の受注または失注ステータスを示します。
ネストされたスキーマ : salesOrders-SalesOrderRollup-item-response
タイプ: object
ソースを表示
  • タイトル: Corporate Currency Code
    読取り専用: true
    最大長: 15
    見積ロールアップの企業通貨コード。
  • タイトル: Created By
    読取り専用: true
    最大長: 64
    行を作成したユーザー。
  • タイトル: Creation Date
    読取り専用: true
    行が作成された日時。
  • タイトル: Last Updated
    読取り専用: true
    行が最後に更新された日時。
  • タイトル: Last Updated By
    読取り専用: true
    最大長: 64
    レコードを最後に更新したユーザー。
  • タイトル: Last Update Login
    読取り専用: true
    最大長: 32
    レコードを最後に更新したユーザーのログイン。
  • Links
  • タイトル: Order Header ID
    読取り専用: true
    オーダー明細に関連付けられた見積積上ヘッダーのIDを示します。
リンク
OptyRenewalProcessPVO
パラメータ:
  • ファインダ: LookupTypeActiveEnabledOrBindCodeFinder%3BBindLookupCode%3D{RenewalProcess}%2CBindLookupType%3DORA_MOO_OPTY_RENEWAL_PROCESS
更改プロセスを示す値リストであり、手動、更改しない、または自動更改が可能です。

LOVリンク関連では、次のプロパティが定義されます:
  • ソース属性: RenewalProcess;ターゲット属性: LookupCode
  • 表示属性: 意味
OptyStatusZbsLookupValuesVA
パラメータ:
  • ファインダ: StatusByBUIdFinder%3BBindEnabledFlag%3DY%2CBindLookupType%3DOPTY_STATUS
LOVリンク関連では、次のプロパティが定義されます:
  • ソース属性: OptyStatusCd;ターゲット属性: LookupCode
  • 表示属性: 意味
QuoteTypeCategoryPVO
パラメータ:
  • ファインダ: LookupTypeActiveEnabledOrBindCodeFinder%3BBindLookupCode%3D{QuoteTypeCategory}%2CBindLookupType%3DORA_MOO_OPPORTUNITY_TYPE
新規、更改および拡張など、様々なタイプの見積を示す値リスト。

LOVリンク関連では、次のプロパティが定義されます:
  • ソース属性: QuoteTypeCategory;ターゲット属性: LookupCode
  • 表示属性: 意味
SalesOrderActiveVersionVA
パラメータ:
  • OrderHeaderId: $request.path.OrderHeaderId
販売オーダー・アクティブ・バージョン・リソースには、アクティブなすべての販売オーダー・バージョンがリストされます。
SalesOrderLine
パラメータ:
  • OrderHeaderId: $request.path.OrderHeaderId
見積およびオーダー明細リソースは、販売オーダー明細の表示、作成、更新および削除に使用されます。 製品、見積名、その他の収益関連データなど、オーダー明細の詳細が含まれています。
SalesOrderRollup
パラメータ:
  • OrderHeaderId: $request.path.OrderHeaderId
見積積上リソースは、見積積上情報の表示に使用されます。
StatusLookupPVO
パラメータ:
  • ファインダ: LookupTypeIsEnabledFinder%3BBindLookupType%3DORA_ZCA_SO_STATUS
作成済、取消済など、販売オーダーのステータスを示す値リスト。

LOVリンク関連では、次のプロパティが定義されます:
  • ソース属性: ステータス;ターゲット属性: LookupCode
  • 表示属性: 意味
WinStatusLOV
パラメータ:
  • ファインダ: LookupTypeFinder%3BBindLookupType%3DORA_ZCA_WIN_STATUS
販売オーダー済や進行中など、見積または販売オーダーの全体的なステータスを示す値リスト。

LOVリンク関連では、次のプロパティが定義されます:
  • ソース属性: WinStatusCode;ターゲット属性: LookupCode
  • 表示属性: 意味
YesNoLookupPVO
パラメータ:
  • ファインダ: LookupTypeFinder%3BBindLookupType%3DYES_NO
販売オーダーがアクティブかどうかを示す値リストであり、値はtrueおよびfalseです。

LOVリンク関連では、次のプロパティが定義されます:
  • ソース属性: ActiveVersionFlag;ターゲット属性: LookupCode
  • 表示属性: 意味
トップに戻る

例:

次の例は、cURLを使用してRESTリソースに対する取得リクエストを発行することによって見積を取得する方法を示しています。

レスポンス本文の例

次に、JSON形式のレスポンス本文の例を示します。

{
  "CurrencyCode": "USD",
  "ExpirationDate": null,
  "ExternalReferenceNumber": "36305529",
  "LastOptySyncDate": null,
  "LastUpdateDate": "2016-03-07T12:03:05-08:00",
  "Name": "03/04 BM88 Test",
  "OptyId": 300000103498006,
  "OrderHeaderId": 300000103503209,
  "OrderTotal": 250,
  "ProposalExistFlag": null,
  "SoldContactPartyId": null,
  "SoldCustomerPartyId": null,
  "SoldPartySiteId": null,
  "VersionNumber": null,
  "Owner": null,
  "Description": null,
  "ExternalSystemReferenceCode": "BMQUOTE",
  "Status": "CREATED",
  "WinStatusCode": "ZCA_IN_PROGRESS",
  "PlacedOnDate": null,
  "links": [
    {
      "rel": "self",
      "href": "http://servername.fa.us2.oraclecloud.com/crmRestApi/resources/11.13.18.05/salesOrders/300000103503209",
      "name": "salesOrders",
      "kind": "item"
    },
    {
      "rel": "canonical",
      "href": "http://servername.fa.us2.oraclecloud.com/crmRestApi/resources/11.13.18.05/salesOrders/300000103503209",
      "name": "salesOrders",
      "kind": "item"
    },
    {
      "rel": "lov",
      "href": "http://servername.fa.us2.oraclecloud.com/crmRestApi/resources/11.13.18.05/salesOrders/300000103503209/lov/WinStatusLOV",
      "name": "WinStatusLOV",
      "kind": "collection"
    },
    {
      "rel": "child",
      "href": "http://servername.fa.us2.oraclecloud.com/crmRestApi/resources/11.13.18.05/salesOrders/300000103503209/child/SalesOrderActiveVersionVA",
      "name": "SalesOrderActiveVersionVA",
      "kind": "collection"
    }
  ]
}
「トップに戻る」