ccrz__E_Order__c

Compatibility

This reference applies to:

API Usage

Class used with: ccrz.ccApiOrder

Fetch sizing: To specify which fields the ccrz.ccApiOrder.fetch method returns for each order record, request a specific data size for the ccrz.ccApiOrder.ENTITYNAME key in your input data:

ccrz.ccApi.SIZING => new Map<String, Object> {
    ccrz.ccApiOrder.ENTITYNAME => new Map<String, Object> {
        ccrz.ccApi.SZ_DATA => ccrz.ccApi.SZ_L
    }
}

The reference for each field indicates which data size the field is returned with.

Fields

Account

The account associated with the user assigned in the User field.

Usage	Field Name	Data Type
Input on object	ccrz__Account__c	Lookup Relationship (Account)
Input or output with API (with SZ_L or larger)	account	ID

Adjustment Amount

Amount to adjust the order price by after the order is placed. This amount is specified on the cart, and passed to the corresponding ccrz__E_Order__c record. You can use your own back-end processing to apply this adjustment without changing the values of other fields.

Usage	Field Name	Data Type
Input on object	ccrz__AdjustmentAmount__c	Currency (16, 2)
Input or output with API (with SZ_L or larger)	adjustmentAmount	Decimal

Adjustment Reason

Text that explains or justifies an adjustment amount. This text is specified on the cart, and passed to the corresponding ccrz__E_Order__c record.

Usage	Field Name	Data Type
Input on object	ccrz__AdjustmentReason__c	Text (255)
Input or output with API (with SZ_L or larger)	adjustmentReason	String

Bill To

The billing address associated with the order. This record is a unique copy of the billing address specified during checkout.

Usage	Field Name	Data Type
Input on object	ccrz__BillTo__c	Lookup Relationship (ccrz__E_ContactAddr__c)
Input or output with API (with SZ_XL)	billTo	ID

Cart Restored

Whether the cart that corresponds to an order that failed to place asynchronously has been reset to Open and made active. You can restore an order only one time. For more information, see ccrz.ccLogicOrderRestore.

This field is available only in B2B Commerce for Visualforce Winter '21 (version 4.13) or later.

Note

Usage	Field Name	Data Type
Input on object	ccrz__IsCartRestored__c	Checkbox
Input or output with API (with SZ_M or larger)	isCartRestored	Boolean

CCEmailAddress

Whitespace-separated list of email addresses for the CC line of the order confirmation email. For usage, see https://help.salesforce.com/articleView?id=b2b_commerce_page_checkout_cc_email.htm.

We recommend that you populate this field only for orders that contain a low volume of cart items.

Tip

Usage	Field Name	Data Type
Input on object	ccrz__CCEmailAddress__c	Text Area (Long) (32768)
Input or output with API (with SZ_XL)	CCEmailAddress	String

CCSubscription

A subscription associated with the order.

Usage	Field Name	Data Type
Input on object	ccrz__CCSubscription__c	Lookup Relationship (ccrz__E_Subscription__c)
Input or output with API (with SZ_M or larger)	CCSubscription	ID

Contact

The contact associated with the user assigned in the User field.

Usage	Field Name	Data Type
Input on object	ccrz__Contact__c	Lookup Relationship (Contact)
Input or output with API (with SZ_M or larger)	contact	ID

Currency ISO Code

The ISO 4217 currency code for the order, such as USD or JPY.

Usage	Field Name	Data Type
Input on object	ccrz__CurrencyISOCode__c	Text (10)
Input or output with API (with SZ_L or larger)	currencyISOCode	String

Effective Account ID

The effective account associated with the order. For usage, see Manage Carts for Effective Accounts.

Usage	Field Name	Data Type
Input on object	ccrz__EffectiveAccountID__c	Text (20)
Input or output with API (with SZ_S or larger)	effectiveAccountID	String

Email

Buyer's email address.

Usage	Field Name	Data Type
Input on object	ccrz__BuyerEmail__c	Email
Input or output with API (with SZ_XL)	buyerEmail	String

Encrypted ID

Semi-random UUID to refer to the order in page URLs.

In an encrypted ID, avoid XML characters—such as <, >, or & characters—which are escaped by the default Visualforce remoting request for fetching order history.

Note

Usage	Field Name	Data Type
Input on object	ccrz__EncryptedId__c	Text (250)
Input or output with API (with SZ_S or larger)	encryptedId	String

First Name

Buyer's first name.

Usage	Field Name	Data Type
Input on object	ccrz__BuyerFirstName__c	Text (40)
Input or output with API (with SZ_XL)	buyerFirstName	String

Is Anonymous

Whether a guest buyer placed the order.

Usage	Field Name	Data Type
Input on object	ccrz__IsAnonymous__c	Checkbox
Input or output with API (with SZ_L or larger)	isAnonymous	Boolean

Last Name

Buyer's last name.

Usage	Field Name	Data Type
Input on object	ccrz__BuyerLastName__c	Text (80)
Input or output with API (with SZ_XL)	buyerLastName	String

Name

A unique, automatically assigned ID for the record.

Usage	Field Name	Data Type
Input on object	Name	Auto Number
Input or output with API (with SZ_S or larger)	sfdcName	String

Note

A shipping note entered during checkout.

Usage	Field Name	Data Type
Input on object	ccrz__Note__c	Text Area (Long) (1000)
Input or output with API (with SZ_XL)	note	String

Number of All Order Items

The total number of items in the order, including both major and minor line items.

This field is available only in B2B Commerce for Visualforce Winter '21 (version 4.13) or later.

Note

Usage	Field Name	Data Type
Input on object	ccrz__NumberofAllOrderItems__c	Roll-Up Summary (COUNT ccrz__E_OrderItem__c)
Input or output with API (with SZ_M or larger)	numberofAllOrderItems	Integer

Number of Major Order Items

The total number of major line items in the order.

This field is available only in B2B Commerce for Visualforce Winter '21 (version 4.13) or later.

Note

Usage	Field Name	Data Type
Input on object	ccrz__NumberofMajorOrderItems__c	Roll-Up Summary (COUNT ccrz__E_OrderItem__c)
Input or output with API (with SZ_M or larger)	numberofMajorOrderItems	Integer

Order

A parent order that for the current order. This field is used when fulfilling subscriptions:

• The parent order describes the upfront order that placed the subscription.
• The child order describes a recurring order for fulfilling the subscription.

Usage	Field Name	Data Type
Input on object	ccrz__Order__c	Lookup Relationship (ccrz__E_Order__c)
Input or output with API (with SZ_M or larger)	order	ID

Order Date

The date when the buyer placed the order.

Usage	Field Name	Data Type
Input on object	ccrz__OrderDate__c	Date
Input or output with API (with SZ_M or larger)	orderDate	Date

Order ID

A unique ID that associates the record with an external system.

Usage	Field Name	Data Type
Input on object	ccrz__OrderId__c	Text (128)
Input or output with API (with SZ_M or larger)	orderId	String

Order Name

The ccrz__CartName__c value copied from the corresponding ccrz__E_Cart__c record.

Usage	Field Name	Data Type
Input on object	ccrz__Name__c	Text (255)
Input or output with API (with SZ_M or larger)	name	String

Order Name (Duplicated)

A copy of the order's Name auto-number value, for use in the order confirmation email template.

Usage	Field Name	Data Type
Input on object	ccrz__OrderName__c	Formula (Text)
Input or output with API (with SZ_M or larger)	orderName	String

Order Number

The digit portion of the order's Name auto-number value, plus 1,000,000. For example, for an order with an auto-numbered Name of O-0000000018, the Order Number is 1,000,018.

Usage	Field Name	Data Type
Input on object	ccrz__OrderNumber__c	Number (18, 0)
Input or output with API (with SZ_M or larger)	orderNumber	Integer

Order Seller

A seller associated with the order.

Usage	Field Name	Data Type
Input on object	ccrz__OrderSeller__c	Lookup Relationship (ccrz__E_Seller__c)
Input or output with API (with any data size)	The API doesn't return data for this field.

Order Status

Status of the order shown in the My Orders section of the My Account page. By default, B2B Commerce for Visualforce sets the following statuses:

Error

The order failed to place.

In Creation

The ccrz.ccApiCart.placeAsync method is placing the order asynchronously.

On Hold

The order indicates a tax exemption during checkout.

Order Submitted

An order created after checkout completes.

The Error and In Creation values are available only in B2B Commerce for Visualforce Winter ’21 (managed package version 4.13 and API version 12).

Note

The managed package also defines the following picklist values, but doesn't define any default behavior that sets or changes these values. To set other status values, extend the appropriate class in the B2B Commerce for Visualforce API.

Bill of Material	In Process	Returned
Cancel Submitted	Partial Shipped	Shipped
Cancelled	Open
Completed	Return Submitted

Usage	Field Name	Data Type
Input on object	ccrz__OrderStatus__c	Picklist
Input or output with API (with SZ_M or larger)	orderStatus	String

Originated Cart

The cart used for placing the order.

Usage	Field Name	Data Type
Input on object	ccrz__OriginatedCart__c	Lookup Relationship (ccrz__E_Cart__c)
Input or output with API (with SZ_M or larger)	originatedCart	ID

Phone

Buyer's phone number.

Usage	Field Name	Data Type
Input on object	ccrz__BuyerPhone__c	Phone
Input or output with API (with SZ_XL)	buyerPhone	String

Request Date

The delivery date that the buyer requested during checkout.

Usage	Field Name	Data Type
Input on object	ccrz__RequestDate__c	Date
Input or output with API (with SZ_L or larger)	requestDate	Date

Ship Amount

Amount calculated for shipping the order during checkout. This value is calculated based on shipping rates and product quantities in the cart, and passed to the corresponding ccrz__E_Order__c record. Specify Shipping Rates for a Product.

Ship Complete

Whether the buyer selected the Ship Complete option during checkout.

Usage	Field Name	Data Type
Input on object	ccrz__ShipComplete__c	Checkbox
Input or output with API (with SZ_M or larger)	shipComplete	Boolean

Ship Discount Amount

Amount to adjust the shipping cost by after the order is placed. This amount is specified on the cart, and passed to the corresponding ccrz__E_Order__c record. You can use your own back-end processing to apply this adjustment without changing the values of other fields.

Usage	Field Name	Data Type
Input on object	ccrz__ShipDiscountAmount__c	Currency (16, 2)
Input or output with API (with SZ_L or larger)	shipDiscountAmount	Decimal

Ship Method

The shipping method selected during checkout.

Usage	Field Name	Data Type
Input on object	ccrz__ShipMethod__c	Text (50)
Input or output with API (with SZ_L or larger)	shipMethod	String

Ship Structure

The checkout experience used for grouping the cart's items for shipment. If your storefront uses line-level independence (LLI), this value is LLI. Otherwise, this value is empty.

Usage	Field Name	Data Type
Input on object	ccrz__ShipStructure__c	Text (128)
Input or output with API (with SZ_S or larger)	shipStructure	String

Ship To

The shipping address associated with the cart. This record is a unique copy of the shipping address specified during checkout.

Usage	Field Name	Data Type
Input on object	ccrz__ShipTo__c	Lookup Relationship (ccrz__E_ContactAddr__c)
Input or output with API (with SZ_L or larger)	shipTo	ID

Skip Tax Calculation

Whether tax was calculated during checkout.

Usage	Field Name	Data Type
Input on object	ccrz__SkipTax__c	Checkbox
Input or output with API (with SZ_L or larger)	skipTax	Boolean

Split Parent Order

The source order that the current order was split from. For more information, see:

• ccrz.ccApiOrder.getOrdersToSplit
• ccrz.ccApiOrder.splitOrder
• ccrz.ccSplitOrderJob

Usage	Field Name	Data Type
Input on object	ccrz__SplitParentOrder__c	Lookup Relationship (ccrz__E_Order__c)
Input or output with API (with any data size)	The API doesn't return data for this field.

Split Processed

Whether the order has been evaluated for splitting. When this field is TRUE, processes that split orders ignore this order because it's already been evaluated. For more information, see:

• ccrz.ccApiOrder.getOrdersToSplit
• ccrz.ccApiOrder.splitOrder
• ccrz.ccSplitOrderJob

Usage	Field Name	Data Type
Input on object	ccrz__SplitProcessed__c	Checkbox
Input or output with API (with any data size)	The API doesn't return data for this field.

Storefront

The storefront where the order was placed.

Usage	Field Name	Data Type
Input on object	ccrz__Storefront__c	Text (255)
Input or output with API (with SZ_S or larger)	storefront	String

Subtotal Amount

The total entitled price of all items in the order.

Usage	Field Name	Data Type
Input on object	ccrz__SubtotalAmount__c	Roll-Up Summary (SUM ccrz__E_OrderItem__c)
Input or output with API (with SZ_L or larger)	subtotalAmount	Decimal

Tax Amount

Tax amount calculated during checkout.

Usage	Field Name	Data Type
Input on object	ccrz__TaxAmount__c	Currency (16, 2)
Input or output with API (with SZ_L or larger)	taxAmount	Decimal

Tax Exempt Flag

Whether the order is exempt from tax. This value is specified on the cart, and passed to the corresponding ccrz__E_Order__c record.

Usage	Field Name	Data Type
Input on object	ccrz__TaxExemptFlag__c	Checkbox
Input or output with API (with SZ_L or larger)	taxExemptFlag	Boolean

Tax Subtotal Amount

The total taxable price of all items in the order.

Usage	Field Name	Data Type
Input on object	ccrz__TaxSubTotalAmount__c	Roll-Up Summary (SUM ccrz__E_OrderItem__c)
Input or output with API (with SZ_L or larger)	taxSubTotalAmount	Decimal

Total Amount

Total cost calculated for the order, including:

• Ship amount
• Ship discount amount
• Subtotal amount
• Tax amount
• Adjustment amount
• Total surcharge

Usage	Field Name	Data Type
Input on object	ccrz__TotalAmount__c	Formula (Currency)
Input or output with API (with SZ_L or larger)	totalAmount	Decimal

Total Discount

Total amount discounted from the order.

Usage	Field Name	Data Type
Input on object	ccrz__TotalDiscount__c	Currency (16, 2)
Input or output with API (with SZ_L or larger)	totalDiscount	Decimal

Total Surcharge

Charges other than taxes or shipping applied to the order.

Usage	Field Name	Data Type
Input on object	ccrz__TotalSurcharge__c	Currency (16, 2)
Input or output with API (with SZ_L or larger)	totalSurcharge	Decimal

User

The user that created the cart used for placing the order.

Usage	Field Name	Data Type
Input on object	ccrz__User__c	Lookup Relationship (User)
Input or output with API (with SZ_XL)	user	ID

Deprecated Fields

The following fields exist on the object but aren't used by the managed package. Don't use these fields in any development or customization.

Related Lists

A record of the ccrz__E_Order__c object can have multiple related lists that relate the order to other types of records, such as order items. The ccrz.ccApiOrder.fetch method can return data from these related records, depending on the requested data size in the input map.

The reference for each related list indicates which data size the list is returned with by default. You can also use the ccrz.ccApi.SZ_REL flag in your input map to request a particular list, regardless of requested data size:

ccrz.ccApi.SIZING => new Map<String, Object> {
    ccrz.ccApiOrder.ENTITYNAME => new Map<String, Object> {
        ccrz.ccApi.SZ_DATA => ccrz.ccApi.SZ_XS,
        ccrz.ccApi.SZ_REL => New List<String>{'E_OrderItems__r'}
    }
}

EOrderItemsS

List<Map<String, Object>> of ccrz__E_OrderItem__c.

Consideration	Value
Default data size returned with	SZ_M or larger
ccrz.ccApi.SZ_REL request value	E_OrderItems__r

EOrderItemsGroupsS

List<Map<String, Object>> of ccrz__E_OrderItemGroup__c.

Consideration	Value
Default data size returned with	SZ_L or larger
ccrz.ccApi.SZ_REL request value	E_OrderItemGroups__r

EOrderShipmentsS

List<Map<String, Object>> of ccrz__E_OrderShipment__c.

Consideration	Value
Default data size returned with	SZ_L or larger
ccrz.ccApi.SZ_REL request value	E_OrderShipments__r

orderTermsS

List<Map<String, Object>> of ccrz__E_OrderTerm__c.

Consideration	Value
Default data size returned with	SZ_L or larger
ccrz.ccApi.SZ_REL request value	OrderTerms__r