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

OrderSummary

注文の現在のプロパティと状態を表します。元のオブジェクトとそれに適用される変更オブジェクトで構成される、1 つ以上の注文オブジェクトに対応します。このオブジェクトは、API バージョン 48.0 以降で使用できます。

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

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

特別なアクセスルール

このオブジェクトは、Salesforce Order Management 組織でのみ、または B2B Commerce ライセンスが有効になっている場合にのみ使用できます。

項目

項目 詳細
AccountId
reference
プロパティ
Filter、Group、Nillable、Sort
説明
OrderSummary に関連付けられた取引先または個人取引先の ID。ストアフロントの買い物客を表します。
関連付けられた OrderSummary の OrderLifeCycleType 項目が UNMANAGED に設定されている場合、「未管理注文概要を編集」権限または「B2B Commerce インテグレータユーザ」権限を持つユーザはこの項目を変更できます。
この項目はリレーション項目です。
リレーション名
Account
リレーション種別
Lookup
参照先
Account
ActiveProcessExceptionCount
int
プロパティ
Filter、Group、Nillable、Sort
説明
OrderSummary の有効なプロセス例外の総数。
この項目は、API バージョン 50.0 以降で使用できます。
BillingAddress
address
プロパティ
Filter、Nillable
説明
OrderSummary に関連付けられた請求先住所。
関連付けられた OrderSummary の OrderLifeCycleType 項目が UNMANAGED に設定されている場合、「未管理注文概要を編集」権限または「B2B Commerce インテグレータユーザ」権限を持つユーザはこの項目を変更できます。
BillingCity
string
プロパティ
Create、Filter、Group、Nillable、Sort、Update
説明
請求先住所の市区郡。
BillingCountry
string
プロパティ
Create、Filter、Group、Nillable、Sort、Update
説明
請求先住所の国。
BillingEmailAddress
email
プロパティ
Create、Filter、Group、Nillable、Sort、Update
説明
請求先住所のメールアドレス。
BillingGeocodeAccuracy
picklist
プロパティ
Create、Filter、Group、Nillable、Restricted picklist、Sort、Update
説明
請求先住所の地理コードの精度。
可能な値は次のとおりです。
  • Address
  • Block
  • City
  • County
  • ExtendedZip
  • NearAddress
  • Neighborhood
  • State
  • Street
  • Unknown
  • Zip
BillingLatitude
double
プロパティ
Create、Filter、Nillable、Sort、Update
説明
BillingLongitude と一緒に使用して、請求先住所の正確な地理位置情報を指定します。許容値は、–90 ~ 90 (小数点以下 15 桁まで) の数値です。
BillingLongitude
double
プロパティ
Create、Filter、Nillable、Sort、Update
説明
BillingLatitude と一緒に使用して、請求先住所の正確な地理位置情報を指定します。許容値は、–90 ~ 90 (小数点以下 15 桁まで) の数値です。
BillingPhoneNumber
phone
プロパティ
Create、Filter、Group、Nillable、Sort、Update
説明
請求先住所の電話番号。
BillingPostalCode
string
プロパティ
Create、Filter、Group、Nillable、Sort、Update
説明
請求先住所の郵便番号。
BillingState
string
プロパティ
Create、Filter、Group、Nillable、Sort、Update
説明
請求先住所の都道府県。
BillingStreet
textarea
プロパティ
Create、Filter、Group、Nillable、Sort、Update
説明
請求先住所の町名・番地。
BillToContactId
reference
プロパティ
Create、Filter、Group、Nillable、Sort
説明
OrderSummary に関連付けられた Contact の ID。個人取引先を使用していない場合のストアフロントの買い物客を表します。
OrderLifeCycleType 項目が UNMANAGED に設定されている場合、「未管理注文概要を編集」権限または「B2B Commerce インテグレータユーザ」権限を持つユーザはこの項目を変更できます。
この項目は、API バージョン 49.0 以降で使用できます。
BusinessModel
picklist
プロパティ
Create、Filter、Group、Nillable、Restricted picklist、Sort、Update
説明
OrderSummary のビジネスモデル。
可能な値は次のとおりです。
  • B2B
  • B2C
この項目は、API バージョン 53.0 以降で使用できます。
ChangeOrderId
reference
プロパティ
Filter、Group、Nillable、Sort
説明
将来の使用のために予約されています。
CurrencyIsoCode
picklist
プロパティ
Create、Defaulted on create、Filter、Group、Nillable、Restricted picklist、Sort、Update
説明
マルチ通貨機能を有効化している組織にのみ使用できます。OrderSummary に関連付けられた元の注文の通貨の ISO コードが含まれます。
可能な値は次のとおりです。
  • DKK — デンマーククローネ
  • EUR — ユーロ
  • GBP — イギリスポンド
  • USD — アメリカドル
デフォルト値は USD です。
この項目は、API バージョン 49.0 以降で使用できます。
Description
textarea
プロパティ
Create、Nillable、Update
説明
OrderSummary の説明。
この項目は編集できます。
ExternalReferenceIdentifier
string
プロパティ
Filter、Group、idLookup、Nillable、Sort、Update
説明
レコードの重複を防止するために内部的に使用されます。この値では、大文字と小文字が区別されます。作成時、この項目には、「SFDC」 + System.nanoTime() が返す値 + ランダムな base64 GUID が設定されます。B2C Commerce から取り込まれた注文の場合、この値は B2C レルム ID + "_" + B2C インスタンス ID + "@" + B2C Commerce カテゴリ/ドメイン ID + "@" + B2C Commerce 注文番号に設定されます。
API バージョン 56.0 以降では、この値は組織内で一意である必要があります。複数のソースから注文を取り込む場合、ソースに基づいたプレフィックスを含めることで一意性を維持できます。
この項目は、API バージョン 54.0 以降で使用できます。
GrandTotalAmount
currency
プロパティ
Filter、Nillable、Sort
説明
OrderSummary の合計 (調整後、税込み)。
IsSuspended
boolean
プロパティ
Create、Defaulted on create、Filter、Group、Sort、Update
説明
OrderSummary が一時停止されているかどうかを示します。デフォルト値は、false です。
この項目は、API バージョン 50.0 以降で使用できます。
LastReferencedDate
dateTime
プロパティ
Filter、Nillable、Sort
説明
現在のユーザがこのレコードに関連するレコードを最後に表示したときのタイムスタンプ。
LastViewedDate
dateTime
プロパティ
Filter、Nillable、Sort
説明
現在のユーザがこのレコードを最後に表示したときのタイムスタンプ。null 値の場合、このレコードは参照 (LastReferencedDate) されただけで、表示はされていない可能性があります。
OrderedDate
dateTime
プロパティ
Filter、Nillable、Sort
説明
この OrderSummary に関連付けられた元の注文の日付。
関連付けられた OrderSummary の OrderLifeCycleType 項目が UNMANAGED に設定されている場合、「未管理注文概要を編集」権限または「B2B Commerce インテグレータユーザ」権限を持つユーザはこの項目を変更できます。
OrderLifeCycleType
picklist
プロパティ
Filter、Group、Restricted picklist、Sort
説明
OrderSummary を Salesforce Order Management で管理するのか (MANAGED)、外部システムで管理するのか (UNMANAGED) を指定します。未管理 OrderSummary は、参照目的で Salesforce に保存されます。
  • 一部の Order Management (注文管理) API は、未管理 OrderSummary に関連付けられた入力レコードを拒否します。
  • 注文管理では、未管理 OrderSummary に関連付けられた一部のレコードの金融バケット項目を更新しません。
  • EditUnmanagedOrderSummaries 権限または B2BCommerceIntegrator 権限を持つユーザは、通常は API 経由でしかアクセスできない未管理 OrderSummary に関連するオブジェクトの特定の項目を編集できます。
可能な値は次のとおりです。
  • MANAGED — 管理済み
  • UNMANAGED — 未管理
この項目は、API バージョン 49.0 以降で使用できます。
OrderNumber
string
プロパティ
Create、Filter、Group、idLookup、Sort、Update
説明
OrderSummary の名前。
OrderProductLineCount
int
プロパティ
Filter、Group、Nillable、Sort
説明
この注文概要の一意の注文商品の合計数。
この項目は、API バージョン 52.0 以降で��用できます。
OriginalOrderId
reference
プロパティ
Filter、Group、Sort
説明
この OrderSummary に関連付けられた元の注文の ID。
この項目はリレーション項目です。
リレーション名
OriginalOrder
リレーション種別
Lookup
参照先
Order
OwnerId
reference
プロパティ
Create、Defaulted on create、Filter、Group、Sort、Update
説明
この OrderSummary を現在所有するユーザの ID。デフォルト値は、create を実行するために API にログインするユーザです。
この項目は多態的なリレーション項目です。
リレーション名
Owner
リレーション種別
Lookup
参照先
Group、User
PoDate
dateTime
プロパティ
Create、Filter、Nillable、Sort、Update
説明
この OrderSummary に関連付けられた購入注文の日付。
関連付けられた OrderSummary の OrderLifeCycleType 項目が UNMANAGED に設定されている場合、「未管理注文概要を編集」権限または「B2B Commerce インテグレータユーザ」権限を持つユーザはこの項目を変更できます。
この項目は、API バージョン 52.0 以降で使用できます。
PoNumber
string
プロパティ
Create、Filter、Group、Nillable、Sort、Update
説明
この OrderSummary に関連付けられた注文書番号。
関連付けられた OrderSummary の OrderLifeCycleType 項目が UNMANAGED に設定されている場合、「未管理注文概要を編集」権限または「B2B Commerce インテグレータユーザ」権限を持つユーザはこの項目を変更できます。
Pricebook2Id
reference
プロパティ
Filter、Group、Nillable、Sort
説明
この OrderSummary に関連付けられた価格表の ID。
この項目は、API バージョン 54.0 以降で使用できます。
この項目はリレーション項目です。
リレーション名
Pricebook2
リレーション種別
Lookup
参照先
Pricebook2
RoutingAttempts
int
プロパティ
Create、Defaulted on create、Filter、Group、Nillable、Sort、Update
説明
在庫のロケーションに注文概要を転送するために行われた試行回数。
この項目は、API バージョン 51.0 以降で使用できます。
SalesChannelId
reference
プロパティ
Filter、Group、Nillable、Sort
説明
この OrderSummary に関連付けられた SalesChannel ID。
関連付けられた OrderSummary の OrderLifeCycleType 項目が UNMANAGED に設定されている場合、「未管理注文概要を編集」権限または「B2B Commerce インテグレータユーザ」権限を持つユーザはこの項目を変更できます。
この項目はリレーション項目です。
リレーション名
SalesChannel
リレーション種別
Lookup
参照先
SalesChannel
SalesStoreId
reference
プロパティ
Filter、Group、Nillable、Sort
説明
この OrderSummary に関連付けられた RetailStore または WebStore の ID。
関連付けられた OrderSummary の OrderLifeCycleType 項目が UNMANAGED に設定されている場合、「未管理注文概要を編集」権限または「B2B Commerce インテグレータユーザ」権限を持つユーザはこの項目を変更できます。
この項目はリレーション項目です。
リレーション名
SalesStore
リレーション種別
Lookup
参照先
WebStore
Status
picklist
プロパティ
Create、Defaulted on create、Filter、Group、Nillable、Sort、Update
説明
注文概要の状況。注文オブジェクトおよび FulfillmentOrder オブジェクトの Status および Status Category 項目とは異なり、この項目は省略可能です。
この選択リストには、注文オブジェクトの Status 選択リストと同じ値を使用することをお勧めします。
TaxLocaleType
picklist
プロパティ
Filter、Group、Nillable、Restricted picklist、Sort
説明
OrderSummary に関連付けられた元の Order の税処理に使用するシステム。Gross は通常、付加価値税 (VAT) などの税に適用され、Net は通常、消費税のような税に適用されます。
可能な値は次のとおりです。
  • Gross (ほとんどの価格と税額を合計値として表示する)
  • Net (ほとんどの価格と税額を別々の値として表示する)
関連付けられた OrderSummary の OrderLifeCycleType 項目が UNMANAGED に設定されている場合、「未管理注文概要を編集」権限または「B2B Commerce インテグレータユーザ」権限を持つユーザはこの項目を変更できます。
この項目は、API バージョン 49.0 以降で使用できます。
TotalAdjDelivery​AmtWithTax
currency
プロパティ
Filter、Nillable、Sort
説明
この OrderSummary に属する、種別が Delivery Charge のすべての OrderItemSummary の総額 (品目レベルの調整後、税込み)。この金額は TotalAdjustedDeliveryAmount + TotalAdjustedDeliveryTaxAmount と等しくなります。
この項目は、API バージョン 49.0 以降で使用できます。
TotalAdjDistAmount
currency
プロパティ
Filter、Nillable、Sort
説明
この OrderSummary に属する OrderItemSummary に適用される分配調整の合計。この金額は TotalProductAdjDistAmount + TotalDeliveryAdjDistAmount と等しくなります。
TotalAdjDistAmountWithTax
currency
プロパティ
Filter、Nillable、Sort
説明
この OrderSummary に属する OrderItemSummary に適用される分配調整の合計 (税込み)。この金額は TotalAdjDistAmount + TotalAdjDistTaxAmount と等しくなります。
この項目は、API バージョン 49.0 以降で使用できます。
TotalAdjDistTaxAmount
currency
プロパティ
Filter、Nillable、Sort
説明
TotalAdjDistAmount の税額。
TotalAdjFee​AmtWithTax
currency
プロパティ
Filter、Nillable、Sort
説明
この OrderSummary に属する、種別が Fee のすべての OrderItemSummary の総額 (品目レベルの調整後、税込み)。この金額は TotalAdjustedFeeAmount + TotalAdjustedFeeTaxAmount と等しくなります。
この項目は、API バージョン 56.0 以降で使用できます。
TotalAdjProduct​AmtWithTax
currency
プロパティ
Filter、Nillable、Sort
説明
この OrderSummary に属する、種別コードが Product のすべての OrderItemSummary の総額 (品目レベルの調整後、税込み)。この金額は TotalAdjustedProductAmount + TotalAdjustedProductTaxAmount と等しくなります。
この項目は、API バージョン 49.0 以降で使用できます。
TotalAdjusted​DeliveryAmount
currency
プロパティ
Filter、Nillable、Sort
説明
この OrderSummary に属する、種別が Delivery Charge のすべての OrderItemSummary の合計 (品目レベルの調整後。注文レベルの調整はなし、税抜き)。
TotalAdjusted​DeliveryTaxAmount
currency
プロパティ
Filter、Nillable、Sort
説明
TotalAdjustedDeliveryAmount の税額。
TotalAdjusted​FeeAmount
currency
プロパティ
Filter、Nillable、Sort
説明
この OrderSummary に属する、種別が Fee のすべての OrderItemSummary の合計 (品目レベルの調整後。注文レベルの調整はなし、税抜き)。
この項目は、API バージョン 56.0 以降で使用できます。
TotalAdjusted​FeeTaxAmount
currency
プロパティ
Filter、Nillable、Sort
説明
TotalAdjustedFeeAmount の税額。
この項目は、API バージョン 56.0 以降で使用できます。
TotalAdjustedProduct​Amount
currency
プロパティ
Filter、Nillable、Sort
説明
この OrderSummary に属する、種別コードが Product のすべての OrderItemSummary の合計 (品目レベルの調整後。注文レベルの調整はなし、税抜き)。
TotalAdjustedProduct​TaxAmount
currency
プロパティ
Filter、Nillable、Sort
説明
TotalAdjustedProductAmount の税額。
TotalAmount
currency
プロパティ
Filter、Nillable、Sort
説明
この OrderSummary に属する、すべての OrderItemSummary の合計 (調整後、税抜き)。TotalAdjustedProductAmount + TotalAdjustedFeeAmount + TotalAdjustedDeliveryAmount と等しくなります。
TotalDeliveryAdj​DistAmount
currency
プロパティ
Filter、Nillable、Sort
説明
この OrderSummary に属する、種別が Delivery Charge の OrderItemSummary に適用されるすべての注文レベルの価格調整の合計。この値には、種別が Header の OrderAdjustmentGroupSummary に属する OrderItemAdjustmentLineSummary が含まれます。
TotalDeliveryAdj​DistAmtWithTax
currency
プロパティ
Filter、Nillable、Sort
説明
この OrderSummary に属する、種別が Delivery Charge の OrderItemSummary に適用されるすべての注文レベルの価格調整の合計 (税込み)。この値には、種別が Header の OrderAdjustmentGroupSummary に属する OrderItemAdjustmentLineSummary が含まれます。TotalDeliveryAdjDistAmount + TotalDeliveryAdjDistTaxAmount と等しくなります。
この項目は、API バージョン 49.0 以降で使用できます。
TotalDeliveryAdj​DistTaxAmount
currency
プロパティ
Filter、Nillable、Sort
説明
TotalDeliveryAdjDistAmount の税額。
TotalDeliveryAmount
currency
プロパティ
Filter、Nillable、Sort
説明
この OrderSummary に属する、種別が Delivery Charge のすべての OrderItemSummary の品目金額合計の総額 (調整なし、税抜き)。
この項目は、API バージョン 54.0 以降で使用できます。
TotalDeliveryAmount​WithTax
currency
プロパティ
Filter、Nillable、Sort
説明
この OrderSummary に属する、種別が Delivery Charge のすべての OrderItemSummary の合計 (税込み、調整なし)。TotalDeliveryAmount + TotalDeliveryTaxAmount と等しくなります。
この項目は、API バージョン 54.0 以降で使用できます。
TotalDeliveryTaxAmount
currency
プロパティ
Filter、Nillable、Sort
説明
TotalDeliveryAmount の税額。
この項目は、API バージョン 54.0 以降で使用できます。
TotalFeeAdj​DistAmount
currency
プロパティ
Filter、Nillable、Sort
説明
この OrderSummary に属する、種別が Fee の OrderItemSummary に適用されるすべての注文レベルの価格調整の合計。この値には、種別が Header の OrderAdjustmentGroupSummary に属する OrderItemAdjustmentLineSummary が含まれます。
この項目は、API バージョン 56.0 以降で使用できます。
TotalFeeAdj​DistAmtWithTax
currency
プロパティ
Filter、Nillable、Sort
説明
この OrderSummary に属する、種別が Fee の OrderItemSummary に適用されるすべての注文レベルの価格調整の合計 (税込み)。この値には、種別が Header の OrderAdjustmentGroupSummary に属する OrderItemAdjustmentLineSummary が含まれます。TotalFeeAdjDistAmount + TotalFeeAdjDistTaxAmount と等しくなります。
この項目は、API バージョン 56.0 以降で使用できます。
TotalFeeAdj​DistTaxAmount
currency
プロパティ
Filter、Nillable、Sort
説明
TotalFeeAdjDistAmount の税額。
この項目は、API バージョン 56.0 以降で使用できます。
TotalFeeAmount
currency
プロパティ
Filter、Nillable、Sort
説明
この OrderSummary に属する、種別が Fee のすべての OrderItemSummary の品目金額合計の総額 (調整なし、税抜き)。
この項目は、API バージョン 56.0 以降で使用できます。
TotalFeeAmount​WithTax
currency
プロパティ
Filter、Nillable、Sort
説明
この OrderSummary に属する、種別が Fee のすべての OrderItemSummary の合計 (税込み、調整なし)。TotalFeeAmount + TotalFeeTaxAmount と等しくなります。
この項目は、API バージョン 56.0 以降で使用できます。
TotalFeeTaxAmount
currency
プロパティ
Filter、Nillable、Sort
説明
TotalFeeAmount の税額。
この項目は、API バージョン 56.0 以降で使用できます。
TotalProductAdj​DistAmount
currency
プロパティ
Filter、Nillable、Sort
説明
この OrderSummary に属する、種別コードが Product の OrderItemSummary に適用されるすべての注文レベルの価格調整の合計。この値には、種別が Header の OrderAdjustmentGroupSummary に属する OrderItemAdjustmentLineSummary が含まれます。
TotalProductAdj​DistAmtWithTax
currency
プロパティ
Filter、Nillable、Sort
説明
この OrderSummary に属する、種別コードが Product の OrderItemSummary に適用されるすべての注文レベルの価格調整の合計 (税込み)。この値には、種別が Header の OrderAdjustmentGroupSummary に属する OrderItemAdjustmentLineSummary が含まれます。TotalProductAdjDistAmount + TotalProductAdjDistTaxAmount と等しくなります。
この項目は、API バージョン 49.0 以降で使用できます。
TotalProductAdj​DistTaxAmount
currency
プロパティ
Filter、Nillable、Sort
説明
TotalProductAdjDistAmount の税額。
TotalProductAmount
currency
プロパティ
Filter、Nillable、Sort
説明
この OrderSummary に属する、種別コードが Product のすべての OrderItemSummary の品目金額合計の総額 (調整なし、税抜き)。
この項目は、API バージョン 54.0 以降で使用できます。
TotalProductAmount​WithTax
currency
プロパティ
Filter、Nillable、Sort
説明
この OrderSummary に属する、種別コードが Product のすべての OrderItemSummary の合計 (税込み、調整なし)。TotalProductAmount + TotalProductTaxAmount と等しくなります。
この項目は、API バージョン 54.0 以降で使用できます。
TotalProductTaxAmount
currency
プロパティ
Filter、Nillable、Sort
説明
TotalProductAmount の税額。
この項目は、API バージョン 54.0 以降で使用できます。
TotalTaxAmount
currency
プロパティ
Filter、Nillable、Sort
説明
この OrderSummary に属するすべての OrderItemSummary の税額合計。TotalAdjustedDeliveryTaxAmount + TotalAdjustedFeeTaxAmount + TotalAdjustedProductTaxAmount と等しくなります。

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

このオブジェクトには次の関連するオブジェクトがあります。特に記載がない限り、これらはこのオブジェクトと同じ API バージョンで使用できます。

OrderSummaryFeed
このオブジェクトにはフィード追跡を利用できます。
OrderSummaryOwnerSharingRule
このオブジェクトには共有ルールを利用できます。
OrderSummaryShare
このオブジェクトには共有を利用できます。