すべての販売オーダー明細を取得
get
/crmRestApi/resources/11.13.18.05/salesOrderLines
リクエスト
問合せパラメータ
- expand: string
このパラメータを指定すると、指定した子がリソース・ペイロードに含まれます(リンクのみでなく)。 この問合せパラメータの値は"all"または""です。 カンマをセパレータとして使用して、複数の子を指定できます。 例: ?expand=Employees,Localizations. ネストされた子は、"Child.NestedChild"の書式に従って指定することもできます(例): ?expand=Employees.Managers). ネストされた子が指定されている場合(例): Employees.Managers)。欠落している子は暗黙的に処理されます。 たとえば、"?expand=Employees.Managers"は"?expand=Employees,Employees.Managers"と同じです(これにより、従業員とマネージャが展開されます)。
- fields: string
このパラメータは、リソース・フィールドをフィルタします。 指定されたフィールドのみが返されます。つまり、フィールドが指定されていない場合、フィールドは返されません(リンクのみを取得する場合に便利です)。 間接子リソースが指定されている場合(例): Employees.Managers)。欠落している子は暗黙的に処理されます。 たとえば、"?fields=Employees.Managers:Empname"は"?fields=;Employees:;Employees.Managers:Empname" (これはマネージャの"Empname"フィールドのみを返す)と同じです。この問合せパラメータの値は、リソース・フィールドのリストです。 属性は直接にすることができます(例): 従業員または間接(例): Employees.Managers) child. 拡張問合せパラメータと組み合せることはできません。 両方を指定した場合、フィールドのみが考慮されます。
フォーマット : ?fields=Attribute1,Attribute2
子リソースのフィールドの書式 : ?fields=Accessor1:Attribute1,Attribute2 - finder: string
コレクションを検索するための事前定義済ファインダとして使用されます。
Format ?finder=<finderName>;<variableName>=<variableValue>,<variableName2>=<variableValue2>
使用可能なファインダ名および対応するファインダ変数を次に示します- PrimaryKey指定したOrderLineId; integer; .で販売オーダー明細を検索します。
ファインダ変数- OrderLineId; integer;販売オーダー明細の一意の識別子。
- SalesOrderLineAltKey OrderLineNumber; string;で販売オーダー明細を検索します。
ファインダ変数- OrderLineNumber; string;販売オーダー明細の代替一意識別子。
- PrimaryKey指定したOrderLineId; integer; .で販売オーダー明細を検索します。
- limit: integer
このパラメータは、リソース・コレクション内で返されるリソースの数を制限します。 制限がリソース数を超えると、フレームワークは使用可能なリソースのみを返します。
- links: string
このパラメータは、単一のリソースまたはリソース・コレクションへのアクセス中に特定のリンクのみを表示するために使用できます。 パラメータ値書式は、次のカンマ区切りリストです : <link_relation>
例:
self,canonical
- offset: integer
リソース・コレクションの開始位置を定義するために使用します。 オフセットがリソース数を超えると、リソースは返されません。 デフォルト値は0です。
- onlyData: boolean
リソース・アイテム・ペイロードは、データのみを含めるようにフィルタされます(リンク・セクションなどは含まれません)。
- orderBy: string
このパラメータは、指定されたフィールドに基づいてリソース・コレクションを順序付けます。 パラメータ値は、属性名のカンマ区切りの文字列で、それぞれオプションでコロンと「asc」または「desc」が続きます。 昇順の場合は「asc」、降順の場合は「desc」を指定します。 デフォルト値は「asc」です。 たとえば、?orderBy=field1:asc,field2:descです
- q: string
この問合せパラメータは、where句を定義します。 リソース・コレクションは、指定された式を使用して問い合せられます。 この問合せパラメータの値は、1つ以上の式です。 例 : ?q=部門番号>=10および<= 30;Loc!=NY
フォーマット : ?q=expression1;expression2
次の問合せ可能属性を使用して、q問合せパラメータを使用してこの収集リソースをフィルタできます:
- ExternalOrderLineId; string;外部オーダー明細の一意の識別子。
- ExternalOrderLineNumber; string; レコードを作成したソース・システムの代替識別子。
- InventoryItemId; integer; 在庫アイテムの一意の識別子。
- InventoryOrgId; integer;在庫組織の一意の識別子。
- LastUpdateDate; string; レコードが最後に更新された日時。
- LineStatusCode; string;販売オーダー明細レコードのステータス。
- OrderHeaderId; integer;販売オーダー・レコードの一意の識別子。
- OrderLineId; integer;販売オーダー明細の一意の識別子。
- OrderLineNumber; string;販売オーダー明細番号。
- OrderNumber; string;履行オーダーの参照番号。
- RootLine; string;見積明細のタイプがrootかどうかを示します。
- WinLossStatusCode; string;オーダー明細の現在の受注または失注ステータスを示します。
- totalResults: boolean
"?totalResults=true"の場合、リソース・コレクション表現には"推定行数"が含まれます。それ以外の場合、カウントは含まれません。 デフォルト値はfalseです。
ヘッダー・パラメータ
- Metadata-Context:
REST APIがランタイム・カスタマイズをサポートしている場合、サービスのシェイプはランタイム中に変更される可能性があります。 RESTクライアントは、これらの変更から自身を分離したり、このヘッダーを指定して最新バージョンのAPIと対話することを選択できます。 次に例を示します : Metadata-Context:sandbox="TrackEmployeeFeature".
- REST-Framework-Version:
RESTクライアントとサービスの間のプロトコル・バージョン。 クライアントがリクエストでこのヘッダーを指定しない場合、サーバーはAPIのデフォルト・バージョンを選択します。
この操作にはリクエスト本文がありません。
トップに戻る応答
サポートされるメディア・タイプ
- application/json
デフォルトのレスポンス
次の表では、このタスクに対するデフォルトのレスポンスについて説明します。
ヘッダー
- Metadata-Context(required):
REST APIがランタイム・カスタマイズをサポートしている場合、サービスのシェイプはランタイム中に変更される可能性があります。 RESTクライアントは、これらの変更から自身を分離したり、このヘッダーを指定して最新バージョンのAPIと対話することを選択できます。 次に例を示します : Metadata-Context:sandbox="TrackEmployeeFeature".
- REST-Framework-Version(required):
RESTクライアントとサービスの間のプロトコル・バージョン。 クライアントがリクエストでこのヘッダーを指定しない場合、サーバーはAPIのデフォルト・バージョンを選択します。
ルート・スキーマ : salesOrderLines
タイプ:
ソースを表示
object
-
count(required): integer
現在の範囲で返されたリソース・インスタンスの数。
-
hasMore(required): boolean
サーバーで使用可能なリソースが、レスポンスで返されたサブセットより多いかどうかを示します。 値がtrueの場合、サーバーから取得するリソースがさらにあります。 デフォルト値はfalseです。
-
items: array Items
タイトル:
Items
コレクション内のアイテム。 -
limit(required): integer
サーバーで使用される実際のページング・サイズ。
-
links(required): array Links
タイトル:
Links
リソース・インスタンスに関連付けられたリンク関係。 -
offset(required): integer
現在のページで使用されるオフセット値。
-
totalResults: integer
"?totalResults=true"の場合の推定行数。それ以外の場合、カウントは含まれません。
ネストされたスキーマ : salesOrderLines-item-response
タイプ:
ソースを表示
object
-
金額: number
タイトル:
Net Amount
販売オーダー明細品目に関連付けられている収益金額。 -
ContractEndDate: string (date-time)
タイトル:
Line Contract End Date
販売オーダーの販売オーダー明細に関連付けられている契約の終了日。 -
ContractPeriods: integer (int64)
タイトル:
Line Contract Periods
販売オーダー明細に関連付けられた契約期間の数。 -
ContractStartDate: string (date-time)
タイトル:
Line Contract Start Date
販売オーダーの販売オーダー明細に関連付けられている契約の開始日。 -
ContractValue: number
タイトル:
Line Contract Value
販売オーダー明細品目に関連付けられている合計金額。 -
CreatedBy: string
タイトル:
Created By
読取り専用:true
最大長:64
ラベルは、オーダー明細の現在の受注または失注ステータスを示します。 -
CreationDate: string (date-time)
タイトル:
Creation Date
読取り専用:true
レコードが作成された日時。 -
CurrencyCode: string
タイトル:
Line Currency
最大長:15
販売オーダー明細に関連付けられた通貨コード。 -
DeleteFlag: boolean
読取り専用:
true
レコードを削除するためのアクセス権がユーザーに付与されているかどうかを示します。 -
Description: string
タイトル:
Product Name
読取り専用:true
最大長:240
オーダー明細に関連付けられた製品の名前。 -
DiscountPercentage: number
タイトル:
Line Discount
特定の販売オーダー明細に適用される割引(パーセント)。 -
ExternalAssetKey: string
タイトル:
External Asset Key
最大長:255
外部システムからのアセット・キー。 -
ExternalOrderLineId: string
タイトル:
External Order Line ID
最大長:64
外部オーダー明細の一意の識別子。 -
ExternalOrderLineNumber: string
タイトル:
External Line Number
最大長:64
レコードを作成したソース・システムの代替識別子。 -
ExternalParentAssetKey: string
タイトル:
External Parent Asset Key
最大長:255
外部システムの親のルート・アセット・キー。 -
ExternalQuoteNumber: string
タイトル:
Quote ID
読取り専用:true
最大長:30
見積を作成したソース・システムの識別子。 -
ExternalRootAssetKey: string
タイトル:
External Root Asset Key
最大長:255
外部システムから取得したルート・アセット・キー。 -
ExtReferenceNumber: string
タイトル:
Reference Number
読取り専用:true
最大長:64
外部見積またはオーダーの識別子。 -
InventoryItemId: integer (int64)
タイトル:
Inventory Item ID
在庫品目の一意の識別子。 -
InventoryOrgId: integer (int64)
タイトル:
Inventory Organization ID
在庫組織の一意の識別子。 -
ItemNumber: string
タイトル:
Item Number
読取り専用:true
最大長:300
販売オーダー明細に関連付けられている製品のアイテム番号。 -
ItemTypeCode: string
タイトル:
Item Type
最大長:30
販売オーダー明細品目のタイプ。 -
LastUpdateDate: string (date-time)
タイトル:
Last Updated
読取り専用:true
レコードが最後に更新された日時。 -
LastUpdatedBy: string
タイトル:
Last Updated By
読取り専用:true
最大長:64
オーダー明細レコードを最後に更新したユーザー。 -
LastUpdateLogin: string
タイトル:
Last Update Login
読取り専用:true
最大長:32
オーダー明細レコードを最後に更新したユーザーのログイン。 -
LineStatusCode: string
タイトル:
Line Status
最大長:30
販売オーダー明細レコードのステータス。 -
links: array Links
タイトル:
Links
リソース・インスタンスに関連付けられたリンク関係。 -
MonthlyRecurringRevenue: number
タイトル:
Monthly Recurring Revenue
見積明細の月次経常収益。 -
MonthlyUsageRevenue: number
タイトル:
Monthly Usage Revenue
見積明細の月次使用収益。 -
NonRecurringRevenue: number
タイトル:
Nonrecurring Revenue
見積明細の変動収益または単発収益。 -
OrderDate: string (date-time)
タイトル:
Line Order Date
オーダー明細のオーダー日。 -
OrderHeaderId: integer (int64)
タイトル:
Order Header ID
販売オーダー・レコードの一意の識別子。 -
OrderHeaderName: string
タイトル:
Order Header Name
読取り専用:true
最大長:275
オーダー明細に関連付けられているオーダーの名前。 -
OrderHeaderNumber: string
タイトル:
Quote or Order Number
読取り専用:true
最大長:30
オーダー明細に関連付けられたオーダーの公開一意識別子。 -
OrderLineId: integer (int64)
タイトル:
Order Line ID
販売オーダー明細の一意の識別子。 -
OrderLineNumber: string
タイトル:
Order Line Number
最大長:30
販売オーダー明細番号。 -
OrderNumber: string
タイトル:
Order Number
最大長:64
履行オーダーの参照番号。 -
ParentExternalOrderLineNumber: string
タイトル:
Parent External Line Number
最大長:64
外部アプリケーションからの親販売オーダー明細の公開一意識別子。 -
価格: number
タイトル:
Net Price
単位当たりの販売オーダー明細品目の価格。 -
PricePeriodCode: string
タイトル:
Line Price Period
最大長:30
販売オーダー明細品目に関連付けられた価格が指定されている期間。 -
PriceTypeCode: string
タイトル:
Line Price Type
最大長:30
販売オーダー明細アイテムに関連付けられた価格設定のタイプです。 -
数量: number
タイトル:
Quantity
販売オーダー明細品目に関連付けられている数量。 -
RecurRevenue: number
タイトル:
Recurring Revenue
見積明細の経常収益。 -
RequestDate: string (date-time)
タイトル:
Line Request Date
販売オーダー明細の製品のリクエスト日。 -
RevenueTypeCategory: string
タイトル:
Revenue Type Category
最大長:30
商談売上明細に関連付けられている売上カテゴリ・タイプ。 -
RevnId: integer (int64)
タイトル:
Revenue ID
オーダー明細に関連付けられた収益の一意の識別子。 -
RootLine: string
タイトル:
Root Line
最大長:1
見積明細のタイプがルートかどうかを示します。 -
SalesAccountId: integer (int64)
タイトル:
Account ID
読取り専用:true
オーダー明細に関連付けられたオーダーの販売アカウントの一意の識別子。 -
SoldContactPartyId: integer (int64)
タイトル:
Contact ID
読取り専用:true
オーダー明細に関連付けられたオーダーの担当者の一意の識別子。 -
SoldCustPartyId: integer (int64)
タイトル:
Customer ID
読取り専用:true
オーダー明細に関連付けられたオーダーのアカウントの一意の識別子。 -
SoldPartySiteId: integer (int64)
タイトル:
Customer ID
読取り専用:true
オーダー明細に関連付けられたオーダーの顧客住所の一意の識別子です。 -
SubscriptionId: integer (int64)
タイトル:
Subscription Id
サブスクリプションの一意の識別子。 -
SubscriptionLineId: integer (int64)
タイトル:
Subscription Line Id
サブスクリプション内のサブスクリプション明細の一意の識別子。 -
小計: number
タイトル:
Line Subtotal
販売オーダー明細品目に関連付けられている金額(価格タイプによる)。 -
SummableContractAmount: number
タイトル:
Contract Value Detail
レポートのニーズに使用できる見積明細の契約値。 -
SummableNonRecurringRevenue: number
タイトル:
Nonrecurring Revenue Detail
レポートのニーズに使用できる、見積明細の経常外収益です。 -
SummableRecurringRevenue: number
タイトル:
Recurring Revenue Detail
レポートのニーズに使用できる、見積明細の経常収益。 -
SummableUsageRevenue: number
タイトル:
Usage Revenue Detail
レポートのニーズに使用できる見積明細の使用収益です。 -
UnitListPrice: number
タイトル:
Unit List Price
見積明細品目のユニット定価。 -
UOMCode: string
タイトル:
UOM
最大長:3
製品の販売に使用される単位。 -
UpdateFlag: boolean
読取り専用:
true
レコードを更新するためのアクセス権がユーザーに付与されているかどうかを示します。 -
UsageRevenue: number
タイトル:
Usage Revenue
見積明細の使用収益。 -
WinLossStatusCode: string
タイトル:
Line Win Loss Status
最大長:30
オーダー明細の現在の受注または失注ステータスを示します。
ネストされたスキーマ : リンク
タイプ:
ソースを表示
object
-
href: string
タイトル:
hyperlink reference
関連リソースへのURI。 -
kind: string
タイトル:
kind
許可された値:[ "collection", "item", "describe", "other" ]
関連リソースの種類。 -
name: string
タイトル:
name
関連リソースへのリンクの名前。 -
properties: object properties
-
rel: string
タイトル:
relation
許可された値:[ "self", "lov", "parent", "canonical", "child", "enclosure", "action", "custom" ]
リソース・インスタンスとの関係の名前。 例: self.
ネストされたスキーマ : properties
タイプ:
ソースを表示
object
-
changeIndicator: string
リソース・インスタンスのインジケータまたはETag値を変更します。
リンク
- getIdValues
-
オーダー・ヘッダーに関連付けられたすべての明細のすべての外部および内部IDを取得します。