この文章は 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 で使用できます。

可能な値は次のとおりです。
  • Annual (毎年)
  • 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
説明
ListPriceQuantity を乗算したもの。この項目は計算項目です。

この項目は、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
説明
親注文の isReductionOrdertrue の場合は必須。
削減される元の注文商品の ID。
この項目はリレーション項目です。
リレーション名
OriginalOrderItem
リレーション種別
Lookup
参照先
OrderItem
PeriodBoundary
picklist
プロパティ
Create、Filter、Group、Nillable、Restricted picklist、Sort、Update
説明
請求期間の開始日と終了日を決定するための期間境界。

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

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

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

PeriodBoundaryStartMonth
picklist
プロパティ
Create、Filter、Group、Restricted picklist、Nillable、Sort、Update
説明
この項目は、BillingFrequency2 が Annual の場合、StartDate、PeriodBoundary、PeriodBoundaryDay の入力に基づいて入力されます。またユーザーの手入力により入力可能です。可能な値は次のとおりです。
  • 1-January
  • 2-February
  • 3-March
  • 4-April
  • 5-May
  • 6-June
  • 7-July
  • 8-August
  • 9-September
  • 10-October
  • 11-November
  • 12-December
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
プロパティ
Filter、Group、Nillable、Sort
説明
関連する商品販売モデルの ID。商品販売モデルは、商品の販売方法の 1 つを定義します。たとえば、1 回限りの販売、エバーグリーンサブスクリプション、期限付きサブスクリプションなどがあります。

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

この項目はリレーション項目です。
リレーション名
ProductSellingModel
リレーション種別
Lookup
参照先
ProductSellingModel
ProrationPolicyId
reference
プロパティ
Filter、Group、Nillable、Sort
説明
関連する按分ポリシーの 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 に送られます。上記以外の場合、TotalLineAmountRoundedLineAmount に送られて丸められてから、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
オブジェクトの追跡項目について履歴を利用できます。