Salesforce Order Management Winter ’23 References

New Objects & Fields

PendingOrderSummary
Object representing a B2C Commerce order ingested via High Scale Orders before an OrderSummary is created for it. Optimized for online transaction processing (OLTP).
This object is only available in Salesforce Order Management orgs where the High Scale Orders feature is enabled.

Pricebook2History
Represents historical information about changes that have been made to the standard fields of the associated Pricebook2, or to any custom fields with history tracking enabled.
This object is always read-only.
ObjectFieldTypeDescription
PendingOrderSummaryAccountIdReferenceID of the account or person account associated with the PendingOrderSummary. It represents the shopper in the storefront.
PendingOrderSummaryBillToContactIdReferenceID of the Contact associated with the PendingOrderSummary. It represents the shopper in the storefront when not using person accounts.
PendingOrderSummaryBillingEmailAddressEmailEmail address on the billing address.
PendingOrderSummaryBillingPhoneNumberPhonePhone number of the billing address.
PendingOrderSummaryCurrencyIsoCodePicklistAvailable only for orgs with the multicurrency feature enabled. Contains the ISO code for the currency of the original Order associated with the PendingOrderSummary.
Possible values are:
DKK — Danish Krone
EUR — Euro
GBP — British Pound
USD — U.S. Dollar
The default value is USD.
PendingOrderSummaryDescriptionStringDescription of the PendingOrderSummary.
PendingOrderSummaryExternalIdStringThis field is used internally.
This field isn’t synced with ZOS, so you can’t use it in a query or insert operation.
PendingOrderSummaryExternalReferenceIdentifierStringUsed internally to prevent duplicate records. This value is case-sensitive. On creation, this value is set to B2C realm ID + “_” + B2C instance ID + “@” + B2C Commerce catalog/domain ID + “@” + B2C Commerce order number.
When the OrderSummary is created, this value is copied to its ExternalReferenceIdentifier field. If you ingest orders from multiple sources, you can maintain uniqueness by including a prefix based on the source.
PendingOrderSummaryGrandTotalAmountCurrencyTotal amount, including adjustments and tax, of the PendingOrderSummary.
PendingOrderSummaryOrderNumberStringName of the PendingOrderSummary.
PendingOrderSummaryOrderedDateDateTimeDate of the original order associated with this PendingOrderSummary.
PendingOrderSummaryPayloadTextareaThe order data payload.
PendingOrderSummaryPayloadTypePicklistThe datatype of the Payload.
Possible values are:
– JSON_GZIP
– JSON_RAW
PendingOrderSummarySalesChannelIdReferenceID of the SalesChannel associated with this PendingOrderSummary. The SalesChannel Name matches the B2C Commerce catalog/domain ID.
PendingOrderSummarySalesStoreIdReferenceID of the RetailStore or WebStore associated with this PendingOrderSummary.
PendingOrderSummaryShopperNameStringThe first name and last name of the shopper that placed the original order.
Pricebook2HistoryPricebook2IdReferenceID of the Pricebook2 associated with this record.
Pricebook2HistoryDataTypePicklistData type of the field that was changed.
Pricebook2HistoryFieldPicklistName of the price book field that was modified, or a special value to indicate some other modification to the price book.
Pricebook2HistoryIsDeletedBooleanIndicates whether the object has been moved to the Recycle Bin (true) or not (false). This is a standard system field. Label is Deleted.
Pricebook2HistoryNewValueAnytypeNew value of the modified price book field. Maximum of 255 characters.
Pricebook2HistoryOldValueAnytypePrevious value of the modified price book field. Maximum of 255 characters.
FulfillmentOrderTotalFeeAdjustAmountCurrencyTotal amount of the price adjustments applied to the fees on the FulfillmentOrder. This value only includes adjustments to FulfillmentOrderLineItems of type Fee.
FulfillmentOrderTotalFeeAdjustAmtWithTaxCurrencyTotal amount of the price adjustments applied to the fees on the FulfillmentOrder, inclusive of tax. This value only includes adjustments to FulfillmentOrderLineItems of type Fee. This amount is equal to TotalFeeAdjustAmount + TotalFeeAdjustTaxAmount.
FulfillmentOrderTotalFeeAdjustTaxAmountCurrencyTax on the TotalFeeAdjustAmount.
FulfillmentOrderTotalFeeAmountCurrencyTotal amount of the fees on the FulfillmentOrder, excluding adjustments and tax. This value only includes FulfillmentOrderLineItems of type Fee.
FulfillmentOrderTotalFeeAmtWithTaxCurrencyTotal price of the fees on the FulfillmentOrder, inclusive of tax. This value only includes FulfillmentOrderLineItems of type Fee. This amount is equal to TotalFeeAmount + TotalFeeTaxAmount.
FulfillmentOrderTotalFeeTaxAmountCurrencyTax on the TotalFeeAmount.
FulfillmentOrderLineItemRejectReasonPicklistIf the FulfillmentOrderLineItem was rejected by a fulfillment location, the reason for the rejection. Default values are:
– Damaged
– Just Sold
– Other
– Out of Packing Supplies
– Out of Stock
InvoiceTaxLocaleTypePicklistThe system used to handle tax on the original Order associated with the Invoice. Gross usually applies to taxes like value-added tax (VAT), and Net usually applies to taxes like sales tax. This field is available when Order Management or B2B Commerce is enabled.
Possible values are:
– Gross: Displays most prices and taxes as combined values
– Net: Displays most prices and taxes as separate values
InvoiceLineConvertedNegAmountCurrencyThe amount from an invoice line that is converted to credit.
InvoiceLineReferenceEntityItemTypePicklistThe type of transaction that created the invoice line.
Possible values are:
– DeliveryCharge — Charge
– Fee — Charge
– OrderProduct — Product
OrderOrderManagementReferenceIdentifierStringThis field is used by Order Management to store the external reference Identifier for B2C Commerce orders. On creation, the B2C Integration sets this value to B2C realm ID + “_” + B2C instance ID + “@” + B2C Commerce catalog/domain ID + “@” + B2C Commerce order number. Otherwise, it isn’t set.
When you create an OrderSummary, if you don’t specify an ExternalReferenceIdentifier value, it’s set to this value. If this value is null, then the system generates a value for ExternalReferenceIdentifier. This value isn’t required to be unique in an organization, but the OrderSummary ExternalReferenceIdentifier is.
OrderSummaryExternalReferenceIdentifierStringUsed internally to prevent duplicate records. This value is case-sensitive. On creation, this value is set to B2C realm ID + “_” + B2C instance ID + “@” + B2C Commerce catalog/domain ID + “@” + B2C Commerce order number.
When the OrderSummary is created, this value is copied to its ExternalReferenceIdentifier field. If you ingest orders from multiple sources, you can maintain uniqueness by including a prefix based on the source.
OrderSummaryTotalAdjFee​AmtWithTaxCurrencyTotal amount of all OrderItemSummaries of type Fee belonging to this OrderSummary, inclusive of item-level adjustments and tax. This amount is equal to TotalAdjustedFeeAmount + TotalAdjustedFeeTaxAmount.
OrderSummaryTotalAdjusted​FeeAmountCurrencyTotal, including item-level adjustments but not order-level adjustments or tax, of all OrderItemSummaries of type Fee belonging to this OrderSummary.
OrderSummaryTotalAdjusted​FeeTaxAmountCurrencyTax on the TotalAdjustedFeeAmount.
OrderSummaryTotalFeeAdj​DistAmountCurrencyTotal of all order-level price adjustments applied to OrderItemSummaries of type Fee belonging to this OrderSummary. This value includes OrderItemAdjustmentLineSummaries that belong to OrderAdjustmentGroupSummaries of type Header.
OrderSummaryTotalFeeAdj​DistAmtWithTaxCurrencyTotal of all order-level price adjustments applied to OrderItemSummaries of type Fee belonging to this OrderSummary, inclusive of tax. This value includes OrderItemAdjustmentLineSummaries that belong to OrderAdjustmentGroupSummaries of type Header. It is equal to TotalFeeAdjDistAmount + TotalFeeAdjDistTaxAmount.
OrderSummaryTotalFeeAdj​DistTaxAmountCurrencyTax on the TotalFeeAdjDistAmount.
OrderSummaryTotalFeeAmountCurrencySum of the Total Line Amounts of all OrderItemSummaries of type Fee belonging to this OrderSummary, not including adjustments or tax.
OrderSummaryTotalFeeAmount​WithTaxCurrencyTotal of all OrderItemSummaries of type Fee belonging to this OrderSummary, including tax but not including adjustments. It is equal to TotalFeeAmount + TotalFeeTaxAmount.
OrderSummaryTotalFeeTaxAmountCurrencyTax on the TotalFeeAmount.
ReturnOrderTotalFeeAdjustAmountCurrencyTotal amount of the price adjustments applied to the fees on the return order. This value only includes adjustments to return order line items of type Fee.
This is a calculated field.
ReturnOrderTotalFeeAdjustAmtWithTaxCurrencyTotal amount of the price adjustments applied to the fees on the return order, inclusive of tax. This value only includes adjustments to return order line items of type Fee. This amount is equal to TotalFeeAdjustAmount + TotalFeeAdjustTaxAmount.
This is a calculated field.
ReturnOrderTotalFeeAdjustTaxAmountCurrencyTax on the TotalFeeAdjustAmount.
This is a calculated field.
ReturnOrderTotalFeeAmountCurrencyTotal of the fees on the return order. This value only includes return order line items of type Fee.
This is a calculated field.
ReturnOrderTotalFeeAmtWithTaxCurrencyTotal amount of the fees on the return order, inclusive of tax. This value only includes return order line items of type Fee. This amount is equal to TotalFeeAmount + TotalFeeTaxAmount.
This is a calculated field.
ReturnOrderTotalFeeTaxAmountCurrencyTax on the TotalFeeAmount.
This is a calculated field.

New Picklist Values

FieldValue
FulfillmentOrder.StatusPick Complete (Fulfilling)
FulfillmentOrder.StatusPrinted (Fulfilling)
FulfillmentOrder.StatusRejected (Rejected)
FulfillmentOrder.StatusCategoryREJECTED
FulfillmentOrderLineItem.TypeFee (Charge)
OrderItem.TypeFee (Charge)
OrderItemSummary.TypeFee (Charge)
ReturnOrderLineItem.TypeFee (Charge)

New Platform Events

NameDescription
PendingOrdSumProcEventNotifies subscribers that a PendingOrderSummary record was processed. If the process succeeded, an OrderSummary was created and the PendingOrderSummary can be deleted. Use this event to trigger subscribers such as flows in your order workflow.

New ConnectApi Methods

NameDescription
createMultipleInvoicesCreate Invoices to represent the charges for one or more change orders. Create Invoices for change orders that increase order amounts, such as for return fees. When you ensure the refund for a return, include the invoices for any associated return fees in the request.
multipleEnsureFundsAsyncEnsure and apply funds for one or more invoices. If needed, capture authorized funds by sending a request to a payment provider. This method inserts a background operation into an asynchronous job queue and returns the ID of that operation so you can track its status. Payment gateway responses appear in the payment gateway log and do not affect the background operation status.

New ConnectApi Classes & Properties

ClassPropertyTypeDescription
CreateInvoiceFromChangeOrdersInputRepresentationchangeOrderIdsList<String>List of IDs of change orders to create Invoices for.
CreateInvoiceFromChangeOrdersInputRepresentationorderSummaryIdStringID of the associated Order Summary
CreateMultipleInvoicesFromChangeOrdersInputRepresentationinvoicesFromChangeOrdersList<CreateInvoiceFromChangeOrdersInputRepresentation>List of OrderSummary IDs with the IDs of the associated change orders to create Invoices for. Each entry in the list generates one invoice, which combines the change orders in that entry.
EnsureRefundsAsyncInputRepresentationinvoicesToPayList<InvoiceToPayInputRepresentation>List of invoices for any fees that reduce the refund, such as return fees.
EnsureRefundsAsyncInputRepresentationisAllowPartialBooleanThis value controls the behavior when the amounts included in the sequences list don’t cover the entire refund amount. If this value is false, then the default refund logic is applied to ensure the remaining refund amount. If this value is true, then the unrefunded balance remains on the credit memo. If you don’t specify a sequences list, this value is ignored, and the default refund logic is applied. The default value is false.
EnsureRefundsAsyncInputRepresentationsequencesList<SequenceOrderPaymentSummaryInputRepresentation>Ordered list of refund amounts and OrderPaymentSummaries to apply them to. The process traverses this list in order and stops when it’s refunded the full amount.
InnerEnsureFundsAsyncInputRepresentationinvoiceIdStringID of the Invoice to ensure funds for.
InnerEnsureFundsAsyncInputRepresentationorderSummaryIdStringID of the OrderSummary associated with the Invoice.
InvoiceToPayInputRepresentationinvoiceIdList<InnerEnsureFundsAsyncInputRepresentation>List of Invoices to ensure funds for and the associated OrderSummaries.
OrderSummaryInputRepresentationexternalReferenceIdentifierStringUsed internally to prevent duplicate records. This value is case-sensitive.
SequenceOrderPaymentSummaryInputRepresentationamountDoubleAmount to apply to the OrderPaymentSummary.
SequenceOrderPaymentSummaryInputRepresentationorderPayment​SummaryIdStringID of the OrderPaymentSummary to apply the Amount to.
ReturnItemsInputRepresentationreturnOrderItemFeesList<ReturnOrderItemFeeInputRepresentation>List of ReturnOrderLineItems to process that represent return fees.
ReturnOrderItemFeeInputRepresentationquantityReturnedDoubleQuantity of the ReturnOrderLineItem to process. When the fee is a fixed amount, the charge is determined by multiplying the total fee amount by this value divided by the expected quantity. For example, if the fee amount is $10 and the expected quantity is 2, then if the quantityReturned is 1, $5 is charged. This value normally equals the quantity returned of the ReturnOrderLineItem for the returned item that the fee applies to. The value must be greater than zero. If this value plus quantityToCancel is less than the expected quantity, then the remaining quantity to be returned is added to a new ReturnOrderLineItem.
ReturnOrderItemFeeInputRepresentationquantityToCancelDoubleQuantity of the ReturnOrderLineItem to remove. This value normally equals the quantity canceled of the ReturnOrderLineItem for the returned item that the fee applies to. This value can also be used to cancel a portion of the fee. The value must be zero or greater. If this value plus quantityReturned is less than the expected quantity, then the remaining quantity to be returned is added to a new ReturnOrderLineItem.
ReturnOrderItemFeeInputRepresentationreturnOrder​LineItemIdStringID of the ReturnOrderLineItem representing the return fee.
ReturnOrderLineItemInputRepresentationreturnOrder​LineItemFeesList<ReturnOrderLineItemFeeInputRepresentation>List of input data for return fees associated with the order item being returned. A ReturnOrderLineItem of Type Fee is created to represent each fee.
ReturnOrderLineItemFeeInputRepresentationamountDoubleValue used to calculate the fee amount, as described by the amountType. It must be a positive value.
ReturnOrderLineItemFeeInputRepresentationamountTypeStringDescribes how the fee amount is calculated. It can have one of these values:
AmountWithTax ——— Value of amount is the fee amount, including tax.
AmountWithoutTax ——— Value of amount is the fee amount, not including tax. Tax is calculated on the value and added.
Percentage ——— Value of amount is a percentage. To determine the fee amount, amount is divided by 100, and then multiplied by the TotalPrice and TotalTaxAmount of the associated OrderItemSummary, prorated for the quantity being returned.
PercentageGross ——— Value of amount is a percentage. To determine the fee amount, amount is divided by 100, and then multiplied by the TotalLineAmountWithTax of the associated OrderItemSummary, prorated for the quantity being returned.
ReturnOrderLineItemFeeInputRepresentationdescriptionStringDescription of the fee.
ReturnOrderLineItemFeeInputRepresentationproduct2IdStringID of the product representing the fee.
ReturnOrderLineItemFeeInputRepresentationreasonStringReason for the fee. The value must match an entry in the ReturnOrderLineItem object’s ReasonForReturn picklist.
BaseInvoiceOutputRepresentationinvoiceIdStringID of the created invoice.
CreateMultipleInvoicesFromChangeOrdersOutputRepresentationinvoicesList<ChangeOrdersInvoiceOutputRepresentation>List of IDs of invoices created from change orders for fees. Include these invoice IDs when calling Ensure Refunds for the return that the fees applied to.
MultipleAsyncOutputRepresentationasyncOutputsList<AsyncOutputRepresentation>List of IDs of background operations.
OrderSummaryAdjustmenttargetTypeOrderSummary​Adjustment​Target​TypeType of price adjustment in promotions. Values are:
SplitLine — Price adjustment on an order item.
Header — Price adjustment on the entire order.
ReturnItemsOutputRepresentationfeeChangeOrderIdStringID of the change order created by processing the ReturnOrderLineItems representing return fees. Use this change order to create an invoice.

Leave a Comment

Your email address will not be published. Required fields are marked *