この文章は Salesforce 機械翻訳システムを使用して翻訳されました。詳細はこちらをご参照ください。
英語に切り替える

OrderItem

組織で販売している注文商品を表します。

サポートされているコール

create()、delete()、describeLayout()、describeSObjects()、getDeleted()、getUpdated()、query()、retrieve()、update()、upsert()

特別なアクセスルール

注文の注文商品を作成または更新するには、Order レコードの「編集」権限が必要です。また、注文商品を削除するには、Order レコードの「編集」権限が必要です。

項目

項目名 詳細
AdjustedLineAmount
型
currency
プロパティ
Filter、Nillable、Sort
説明
品目調整後の品目金額 (税抜き)。
コマース注文項目にアクセスするには、組織に Salesforce 注文管理ライセンスが必要です。コマース注文項目は、Lightning Experience でのみ使用できます。
この項目は API バージョン 48.0 以降で使用できます。
AdjustedLineAmtWithTax
型
currency
プロパティ
Filter、Nillable、Sort
説明
品目調整後の品目金額 (税込み)。
これは総税額項目です。
コマース注文項目にアクセスするには、組織に Salesforce 注文管理ライセンスが必要です。コマース注文項目は、Lightning Experience でのみ使用できます。
この項目は API v49.0 以降で使用できます。
AvailableQuantity
型
double
プロパティ
Filter、Nillable、Sort
説明
削減に使用できる注文商品量。値は 0 以上である必要があります。AvailableQuantity が 0 以上である場合にのみ、注文商品を削減で��ます。

注文商品の親注文が削減注文の場合、値は常に 0 になります。

BillingFrequency2
型
picklist
プロパティ
Create、Filter、Group、Nillable、Restricted picklist、Sort、Update
説明
注文項目の請求頻度を示す期間。

この項目は、API バージョン 55.0 以降で使用できます。この項目は、Subscription Management で使用できます。

可能な値は次のとおりです。
  • Monthly
CurrencyIsoCode
型
picklist
プロパティ
Defaulted on create、Filter、Group、Restricted picklist、Sort
説明
マルチ通貨機能を有効化している組織にのみ使用できます。OrderItem に関連付けられた元の注文の通貨の ISO コードが含まれます。
可能な値は次のとおりです。
  • DKK — デンマーククローネ
  • EUR — ユーロ
  • GBP — イギリスポンド
  • USD — アメリカドル
デフォルト値は USD です。
この項目は、API バージョン 49.0 以降で使用できます。
Description
型
string
プロパティ
Create、Filter、Group、Nillable、Sort、Update
説明
このオブジェクトのテキストによる説明。Commerce ストアでは、チェックアウト時に、この項目に商品名の値が入力されます。商品名は、OrderItem に対応するカート商品の CartItem.Name 項目からコピーされます。
EndDate
型
date
プロパティ
Create、Filter、Group、Nillable、Sort、Update
説明
省略可能。注文商品を使用できる最後の日。
GrossUnitPrice
型
currency
プロパティ
Create、Filter、Nillable、Sort、Update
説明
単価 (税込み)。
これは税込み VAT 項目です。Order.TaxLocaleType の値が Gross の場合にのみ、注文作成時に自動入力されます。
LineNumber
型
int
プロパティ
Create、Filter、Group、Nillable、Sort
説明
注文の品目を整理するために使用します。
コマース注文項目にアクセスするには、組織に Salesforce 注文管理ライセンスが必要です。コマース注文項目は、Lightning Experience でのみ使用できます。
この項目は API バージョン 48.0 以降で使用できます。
ListPrice
型
currency
プロパティ
Create、Filter、Nillable、Sort
説明
注文商品のリスト価格。注文商品の作成時に、関連付けられた PriceBookEntry から値が継承されます。
ListPriceTotal
型
currency
プロパティ
Create、Filter、Nillable、Sort、Update
説明
ListPrice に Quantity を乗算したもの。これは計算項目です。

この項目は、API バージョン 55.0 以降で使用できます。この項目は、Subscription Management で使用できます。

NetUnitPrice
型
currency
プロパティ
Create、Filter、Nillable、Sort、Update
説明
すべての価格調整が適用された後の単価。

この項目は、API バージョン 55.0 以降で使用できます。この項目は、Subscription Management で使用できます。

OrderActionId
型
reference
プロパティ
Create、Filter、Group、Nillable、Sort、Update
説明
関連する注文アクションの ID。注文アクションは、新規販売やキャンセルなどの注文の種別を示します。

この項目は、API バージョン 55.0 以降で使用できます。この項目は、Subscription Management で使用できます。

これはリレーション項目です。
リレーション名
OrderAction
リレーション種別
Lookup
参照先
OrderAction
OrderDeliveryGroupId
型
reference
プロパティ
Create、Filter、Group、Nillable、Sort、Update
説明
注文商品の配送グループ。
コマース注文項目にアクセスするには、組織に Salesforce 注文管理ライセンスが必要です。コマース注文項目は、Lightning Experience でのみ使用できます。
この項目は API バージョン 48.0 以降で使用できます。
この項目はリレーション項目です。
リレーション名
OrderDeliveryGroup
リレーション種別
Lookup
参照先
OrderDeliveryGroup
OrderId
型
reference
プロパティ
Create、Filter、Group、Sort
説明
この注文商品が子である注文の ID。
これはリレーション項目です。
リレーション名
Order
リレーション種別
Lookup
参照先
Order
OrderItemNumber
型
string
プロパティ
Autonumber、Defaulted on create、Filter、idLookup、Sort
説明
注文商品を識別する自動生成番号。
OriginalOrderItemId
型
reference
プロパティ
Create、Filter、Group、Nillable、Sort
説明
親注文の isReductionOrder が true の場合は必須。
削減される元の注文商品の ID。
これはリレーション項目です。
リレーション名
OriginalOrderItem
リレーション種別
Lookup
参照先
OrderItem
PeriodBoundary
型
picklist
プロパティ
Create、Filter、Group、Nillable、Restricted picklist、Sort、Update
説明
請求期間の開始日と終了日を決定するための期間境界。

この項目は、API バージョン 55.0 以降で使用できます。この項目は、Subscription Management で使用できます。

可能な値は次のとおりです。
  • AlignToCalendar — 期間が、月の最初の日など、期間単位の初日に開始されます。
  • Anniversary — 開始日により境界が決まります。たとえば、9 月 13 日に月間サブスクリプションを開始する場合、サブスクリプションは毎月の 13 日に開始されます。
  • DayOfPeriod — PeriodBoundaryDay で示される日に期間が開始されます。
  • EndOfPeriod — 期間が価格設定期間単位の最終日に開始されます。
PeriodBoundaryDay
型
int
プロパティ
Create、Filter、Group、Nillable、Sort、Update
説明
PeriodBoundary が DayOfPeriod の場合に必須です。期間境界を示す週または月の日付を示します。1 ~ 31 の整数を指定する必要があります。

この項目は、API バージョン 55.0 以降で使用できます。この項目は、Subscription Management で使用できます。

PricebookEntryId
型
reference
プロパティ
Create、Filter、Group、Nillable、Sort
説明
必須。関連付けられた PricebookEntry の ID。この項目は、OrderItem レコードを作成するときに指定する必要があります。update で変更することはできません。
B2B Commerce、B2B Commerce Starter、B2B Commerce Growth、または B2B Commerce Plus のライセンスを所有する Salesforce ユーザは、価格表なしに注文を作成したり、価格表エントリなしに注文品目を作成したりできます。
これはリレーション項目です。
リレーション名
PricebookEntry
リレーション種別
Lookup
参照先
PricebookEntry
PricingTermCount
型
double
プロパティ
Create、Filter、Nillable、Sort、Update
説明
サブスクリプションの価格設定期間の数を示す計算項目です。

この項目は、API バージョン 55.0 以降で使用できます。この項目は、Subscription Management で使用できます。

ProFormaBillingPeriodAmount
型
currency
プロパティ
Create、Filter、Nillable、Sort、Update
説明
請求期間の初回金額。請求期間の最終金額には、それ以降の修正、割引、または料金を含めることができます。

この項目は、API バージョン 55.0 以降で使用できます。この項目は、Subscription Management で使用できます。

Product2Id
型
reference
プロパティ
Create、Filter、Group、Nillable、Sort
説明
この OrderItem に関連付けられた Product2 の ID。
これはリレーション項目です。
リレーション名
Product2
リレーション種別
Lookup
参照先
Product2
ProductSellingModelId
型
reference
プロパティ
Create、Filter、Group、Nillable、Sort、Update
説明
関連する商品販売モデルの ID。商品販売モデルは、商品の販売方法の 1 つを定義します。たとえば、1 回限りの販売、エバーグリーンサブスクリプション、期限付きサブスクリプションなどがあります。

この項目は、API バージョン 55.0 以降で使用できます。この項目は、Subscription Management で使用できます。

これはリレーション項目です。
リレーション名
ProductSellingModel
リレーション種別
Lookup
参照先
ProductSellingModel
ProrationPolicyId
型
reference
プロパティ
Create、Filter、Group、Nillable、Sort、Update
説明
関連する按分ポリシーの ID。按分ポリシーは、契約期間ごとの価格の計算方法を定義します。たとえば、部分期間を許可するかどうかや、残額の処理方法などを定義します。

この項目は、API バージョン 55.0 以降で使用できます。この項目は、Subscription Management で使用できます。

これはリレーション項目です。
リレーション名
ProrationPolicy
リレーション種別
Lookup
参照先
ProrationPolicy
Quantity
型
double
プロパティ
Create、Filter、Sort、Update
説明
この注文商品の単位数。
QuoteLineItemId
型
reference
プロパティ
Create、Filter、Group、Sort、Update
説明
関連付けられた見積品目の ID。

この項目が指定されている場合、見積品目の QuoteId は、注文商品の親注文の QuoteId と一致する必要があります。

RelatedOrderItemID
型
reference
プロパティ
Filter、Sort、Group
説明
変更注文の場合、元の注文商品を示します。
コマース注文項目にアクセスするには、組織に Salesforce 注文管理ライセンスが必要です。コマース注文項目は、Lightning Experience でのみ使用できます。
この項目は API バージョン 48.0 以降で使用できます。
RoundedLineAmount
型
currency
プロパティ
Filter、Sort
説明
四捨五入された品目金額 (税抜き、未調整)。通貨の 0.5 以上の小数部は整数に切り上げられます。
コマース注文項目にアクセスするには、組織に Salesforce 注文管理ライセンスが必要です。コマース注文項目は、Lightning Experience でのみ使用できます。
この項目は API バージョン 48.0 以降で使用できます。
RoundedLineAmtWithTax
型
currency
プロパティ
Filter、Nillable、Sort
説明
四捨五入された品目金額 (税込み)。通貨の 0.5 以上の小数部は整数に切り上げられます。
コマース注文項目にアクセスするには、組織に Salesforce 注文管理ライセンスが必要です。コマース注文項目は、Lightning Experience でのみ使用できます。
この項目は API v49.0 以降で使用できます。
ServiceDate
型
date
プロパティ
Create、Filter、Group、Nillable、Sort、Update
説明
注文商品の開始日。
表示ラベルは [開始日] です。
StartingPriceTotal
型
currency
プロパティ
Create、Filter、Nillable、Sort、Update
説明
開始単価に数量を乗じた金額。

この項目は、API バージョン 55.0 以降で使用できます。この項目は、Subscription Management で使用できます。

StartingUnitPriceSource
型
picklist
プロパティ
Create、Filter、Group、Nillable、Restricted picklist、Sort、Update
説明
開始単価が手動入力されたものか、計算されたものかを示します。

この項目は、API バージョン 55.0 以降で使用できます。この項目は、Subscription Management で使用できます。

可能な値は次のとおりです。
  • Manual
  • System
TaxTreatmentId
型
reference
プロパティ
Create、Filter、Group、Nillable、Sort、Update
説明
関連税金処理の ID。

この項目は、API バージョン 55.0 以降で使用できます。この項目は、Subscription Management で使用できます。

これはリレーション項目です。
リレーション名
TaxTreatment
リレーション種別
Lookup
参照先
TaxTreatment
TotalAdjustedLineTaxAmount
型
currency
プロパティ
Filter、Sort
説明
品目税額と品目調整税額の合計。
コマース注文項目にアクセスするには、組織に Salesforce 注文管理ライセンスが必要です。コマース注文項目は、Lightning Experience でのみ使用できます。
この項目は API バージョン 48.0 以降で使用できます。
TotalAdjustmentAmount
型
currency
プロパティ
Filter、Sort
説明
すべての注文商品の価格調整の積み上げ。
コマース注文項目にアクセスするには、組織に Salesforce 注文管理ライセンスが必要です。コマース注文項目は、Lightning Experience でのみ使用できます。
この項目は API バージョン 48.0 以降で使用できます。
TotalAdjustmentAmtWithTax
型
currency
プロパティ
Filter、Sort
説明
すべての注文商品の価格調整の積み上げ (税込み)。
これは総税額項目です。
コマース注文項目にアクセスするには、組織に Salesforce 注文管理ライセンスが必要です。コマース注文項目は、Lightning Experience でのみ使用できます。
この項目は API v49.0 以降で使用できます。
TotalAdjustmentDistAmount
型
currency
プロパティ
Filter、Sort
説明
注文のすべての調整の積み上げ。OrderAdjustmentGroup の Type 値が Header の場合にのみ使用されます。
コマース注文項目にアクセスするには、組織に Salesforce 注文管理ライセンスが必要です。コマース注文項目は、Lightning Experience でのみ使用できます。
この項目は API バージョン 48.0 以降で使用できます。
TotalAdjustmentDistTaxAmount
型
currency
プロパティ
Filter、Sort
説明
注文に対するすべての調整税額の積み上げ。OrderAdjustmentGroup の Type 値が Header の場合にのみ使用されます。
コマース注文項目に���クセスするには、組織に Salesforce 注文管理ライセンスが必要です。コマース注文項目は、Lightning Experience でのみ使用できます。
この項目は API バージョン 48.0 以降で使用できます。
TotalAdjustmentDistAmtWithTax
型
currency
プロパティ
Filter、Sort
説明
注文に対するすべての調整税額の積み上げ (税込み)。OrderAdjustmentGroup の Type 値が Header の場合にのみ使用されます。
これは総税額項目です。
コマース注文項目にアクセスするには、組織に Salesforce 注文管理ライセンスが必要です。コマース注文項目は、Lightning Experience でのみ使用できます。
この項目は API v49.0 以降で使用できます。
TotalAdjustmentTaxAmount
型
currency
プロパティ
Filter、Sort
説明
すべての注文商品の税額調整の積み上げ。
コマース注文項目にアクセスするには、組織に Salesforce 注文管理ライセンスが必要です。コマース注文項目は、Lightning Experience でのみ使用できます。
この項目は API バージョン 48.0 以降で使用できます。
TotalAmtWithTax
型
currency
プロパティ
Filter、Nillable、Sort
説明
注文品目の TotalPrice + TotalTaxAmount と等しくなります。
これは総税額項目です。
コマース注文項目にアクセスするには、組織に Salesforce 注文管理ライセンスが必要です。コマース注文項目は、Lightning Experience でのみ使用できます。
この項目は API v49.0 以降で使用できます。
TotalLineAdjustmentAmount
型
currency
プロパティ
Filter、Sort
説明
注文商品の品目レベルの調整の合計。
コマース注文項目にアクセスするには、組織に Salesforce 注文管理ライセンスが必要です。コマース注文項目は、Lightning Experience でのみ使用できます。
この項目は API バージョン 48.0 以降で使用できます。
TotalLineAdjustmentAmtWithTax
型
currency
プロパティ
Filter、Sort
説明
注文商品の品目レベルの調整の合計 (税込み)。
これは総税額項目です。
コマース注文項目にアクセスするには、組織に Salesforce 注文管理ライセンスが必要です。コマース注文項目は、Lightning Experience でのみ使用できます。
この項目は API v49.0 以降で使用できます。
TotalLineAdjustmentTaxAmount
型
currency
プロパティ
Filter、Sort
説明
注文商品に対して行われた調整の税額合計。
コマース注文項目にアクセスするには、組織に Salesforce 注文管理ライセンスが必要です。コマース注文項目は、Lightning Experience でのみ使用できます。
この項目は API バージョン 48.0 以降で使用できます。
TotalLineAmount
型
currency
プロパティ
Create、Filter、Nillable、Sort、Update
説明
注文商品の総額 (価格調整前、数量を含む)。
コマース注文項目にアクセスするには、組織に Salesforce 注文管理ライセンスが必要です。コマース注文項目は、Lightning Experience でのみ使用できます。
この項目は API バージョン 48.0 以降で使用できます。
TotalLineTaxAmount
型
currency
プロパティ
Filter、Sort
説明
この注文商品の税額合計 (調整に対する税額を含まない)。
コマース注文項目にアクセスするには、組織に Salesforce 注文管理ライセンスが必要です。コマース注文項目は、Lightning Experience でのみ使用できます。
この項目は API バージョン 48.0 以降で使用できます。
TotalPrice
型
currency
プロパティ
Filter、Nillable、Sort
説明
この注文商品の総額。コマース注文が有効化されている場合、この項目の値の計算は異なります。
デフォルト値
TotalPrice = (UnitPrice * Quantity)
コマース注文
TotalLineAmount が null の場合は、(UnitPrice * Quantity) が RoundedLineAmount に送られて丸められます。その後で Total Price に送られます。上記以外の場合、TotalLineAmount が RoundedLineAmount に送られて丸められてから、TotalPrice に送られます。
コマース注文項目にアクセスするには、組織に Salesforce 注文管理ライセンスが必要です。コマース注文項目は、Lightning Experience でのみ使用できます。
この項目は API バージョン 48.0 以降で使用できます。
TotalTaxAmount
型
currency
プロパティ
Filter、Sort
説明
注文商品の税額と調整の合計。
コマース注文項目にアクセスするには、組織に Salesforce 注文管理ライセンスが必要です。コマース注文項目は、Lightning Experience でのみ使用できます。
この項目は API バージョン 48.0 以降で使用できます。
Type
型
picklist
プロパティ
Create、Filter、Group、Nillable、Restricted picklist、Sort、Update
説明
注文品目が何を表すかを説明します。各値は、1 つの種別コード (括弧内に表示) に関連付けられています。
可能な値は次のとおりです。
  • Delivery Charge (Charge) — 配送料などの料金。
  • Fee (Charge) — 返品手数料などの料金。この値は API v56.0 以降で使用できます。
  • Order Product (Product) — 注文可能な品目。
コマース注文項目にアクセスするには、組織に Salesforce 注文管理ライセンスが必要です。コマース注文項目は、Lightning Experience でのみ使用できます。
この項目は API バージョン 48.0 以降で使用できます。
TypeCode
型
picklist
プロパティ
Filter、Group、Nillable、Restricted picklist、Sort
説明
種別に関連付けられたカテゴリ。種別コードは 1 つ以上の種別に関連付けることができます。
可能な値は次のとおりです。
  • Charge
  • Product
コマース注文項目にアクセスするには、組織に Salesforce 注文管理ライセンスが必要です。コマース注文項目は、Lightning Experience でのみ使用できます。
この項目は API バージョン 48.0 以降で使用できます。
UnitPrice
型
currency
プロパティ
Create、Filter、Nillable、Sort、Update
説明
注文商品の単価。

使用方法

注文に価格表が関連付けられている場合にのみ、注文を注文商品レコードに関連付けることができます。注文商品は、注文の価格表に示されている商品に対応している必要があります。

関連付けられたオブジェクト

このオブジェクトには次の関連するオブジェクトがあります。API バージョンが指定されていない場合、これらはこのオブジェクトと同じ API バージョンで使用できます。指定されている場合、指定された API バージョン以降で使用できます。

OrderItemChangeEvent (API バージョン 44.0)
このオブジェクトには変更イベントを利用できます。
OrderItemFeed (API バージョン 29.0)
このオブジェクトにはフィード追跡を利用できます。
OrderItemHistory
オブジェクトの追跡項目について履歴を利用できます。