CommerceConstants (The Adobe AEM Quickstart and Web Application.)

@ProviderType
public interface CommerceConstants

Various constants used in the Commerce API.

Field Summary

Fields
Modifier and Type	Field and Description
`static java.lang.String`	`BILLING_ADDRESS_PREDICATE` The predicate (and prefix) of order property keys comprising the billing address.
`static java.lang.String`	`BILLING_PREFIX` Deprecated. since 6.1, use `BILLING_ADDRESS_PREDICATE` + "." or a predicate-based property fetch (`CommerceSession.getOrderDetails(String predicate)`).
`static java.lang.String`	`COMMERCE_COOKIE_NAME`
`static java.lang.String`	`COMMERCE_COOKIE_PREFIX` Deprecated. since 5.6, use `COMMERCE_COOKIE_NAME` instead.
`static java.lang.String`	`OPEN_ORDERS_PREDICATE` Convention used by OOTB order and checkout components.
`static java.lang.String`	`PAYMENT_OPTION` The order property key which stores the path/ID of the chosen payment method.
`static java.lang.String`	`PAYMENT_PREFIX` Deprecated. since 6.1, use `PaymentMethod.getPredicate()` + "." or a predicate-based property fetch (`CommerceSession.getOrderDetails(String predicate)`).
`static java.lang.String`	`PAYMENT_TOKEN` The order property key of the token for a tokenized payment.
`static java.lang.String`	`PN_CART_PAGE_PATH` Defines the location of the cart page for the current site / tree.
`static java.lang.String`	`PN_CHECKOUT_PAGE_PATH` Defines the location of the checkout page for the current site / tree.
`static java.lang.String`	`PN_COMMERCE_PROVIDER` Used to pick a specific implementation behind the Commerce API.
`static java.lang.String`	`PN_COMMERCE_TYPE` Special-case type handling.
`static java.lang.String`	`PN_PRODUCT_DATA` Points back to PIM data for a product.
`static java.lang.String`	`PN_PRODUCT_VARIANT_AXES` Defines which properties of a product produce its variations.
`static java.lang.String`	`PN_PROXY_PAGE_OVERRIDE` A property which overrides the default setting controlling whether or not a proxy page is generated.
`static java.lang.String`	`PROPERTY_COMMERCE_PROVIDER` Deprecated. since 5.6, use `PN_COMMERCE_PROVIDER` instead.
`static java.lang.String`	`REQ_ATTR_CARTOBJECT` Convention used by OOTB order and checkout components.
`static java.lang.String`	`REQ_ATTR_CARTPAGE` Convention used by OOTB order and checkout components.
`static java.lang.String`	`REQ_ATTR_COUNTRYLIST` Convention used by OOTB order and checkout components.
`static java.lang.String`	`REQ_ATTR_PRODNOTFOUNDPAGE` Convention used by OOTB order and checkout components.
`static java.lang.String`	`RT_PRODUCT_PAGE_PROXY` A resource which proxies both a page and a product.
`static java.lang.String`	`SERVICE_COMMERCE` Service name that refers to the generic eCommerce service which provides product information, cart management etc.
`static java.lang.String`	`SHIPPING_ADDR_SAME` The order property key of a flag which indicates that the shipping address should be auto-generated from the billing address.
`static java.lang.String`	`SHIPPING_ADDRESS_PREDICATE` The predicate (and prefix) of order property keys comprising the shipping address.
`static java.lang.String`	`SHIPPING_OPTION` The order property key which stores the path/ID of the chosen shipping method.
`static java.lang.String`	`SHIPPING_PREFIX` Deprecated. since 6.1, use `SHIPPING_ADDRESS_PREDICATE` + "." or a predicate-based property fetch (`CommerceSession.getOrderDetails(String predicate)`).

- Field Detail
  - PN_COMMERCE_PROVIDER
```
static final java.lang.String PN_COMMERCE_PROVIDER
```
    Used to pick a specific implementation behind the Commerce API. See CommerceServiceFactory.
    
    See Also:
    
    Constant Field Values
  - COMMERCE_COOKIE_NAME
```
static final java.lang.String COMMERCE_COOKIE_NAME
```
    See Also:
    
    Constant Field Values
  - SERVICE_COMMERCE
```
static final java.lang.String SERVICE_COMMERCE
```
    Service name that refers to the generic eCommerce service which provides product information, cart management etc.
    
    See Also:
    
    CommerceService.isAvailable(String), Constant Field Values
  - PN_COMMERCE_TYPE
```
static final java.lang.String PN_COMMERCE_TYPE
```
    Special-case type handling.
    1. When "product" or "variant", denotes a subtype of commerce/components/product
    2. When "section", denotes any page which was produced by a blueprint of type commerce/components/section
    See Also:
    
    Constant Field Values
  - PN_PRODUCT_VARIANT_AXES
```
static final java.lang.String PN_PRODUCT_VARIANT_AXES
```
    Defines which properties of a product produce its variations. See Product.
    
    See Also:
    
    Constant Field Values
  - PN_CART_PAGE_PATH
```
static final java.lang.String PN_CART_PAGE_PATH
```
    Defines the location of the cart page for the current site / tree.
    
    See Also:
    
    Constant Field Values
  - PN_CHECKOUT_PAGE_PATH
```
static final java.lang.String PN_CHECKOUT_PAGE_PATH
```
    Defines the location of the checkout page for the current site / tree.
    
    See Also:
    
    Constant Field Values
  - PN_PRODUCT_DATA
```
static final java.lang.String PN_PRODUCT_DATA
```
    Points back to PIM data for a product. See Product.
    
    See Also:
    
    Constant Field Values
  - RT_PRODUCT_PAGE_PROXY
```
static final java.lang.String RT_PRODUCT_PAGE_PROXY
```
    A resource which proxies both a page and a product.
    
    See Also:
    
    Constant Field Values
  - PN_PROXY_PAGE_OVERRIDE
```
static final java.lang.String PN_PROXY_PAGE_OVERRIDE
```
    A property which overrides the default setting controlling whether or not a proxy page is generated.
    
    See Also:
    
    Constant Field Values
  - PAYMENT_OPTION
```
static final java.lang.String PAYMENT_OPTION
```
    The order property key which stores the path/ID of the chosen payment method. NB: convention used by OOTB order and checkout components. NOT REQUIRED by the Commerce API.
    
    See Also:
    
    Constant Field Values
  - PAYMENT_TOKEN
```
static final java.lang.String PAYMENT_TOKEN
```
    The order property key of the token for a tokenized payment. Appears in place of the payment info (not within). NB: convention used by OOTB order and checkout components. NOT REQUIRED by the Commerce API.
    
    See Also:
    
    Constant Field Values
  - SHIPPING_ADDR_SAME
```
static final java.lang.String SHIPPING_ADDR_SAME
```
    The order property key of a flag which indicates that the shipping address should be auto-generated from the billing address. NB: convention used by OOTB order and checkout components. NOT REQUIRED by the Commerce API.
    
    See Also:
    
    Constant Field Values
  - BILLING_ADDRESS_PREDICATE
```
static final java.lang.String BILLING_ADDRESS_PREDICATE
```
    The predicate (and prefix) of order property keys comprising the billing address. NB: convention used by OOTB order and checkout components. NOT REQUIRED by the Commerce API.
    
    See Also:
    
    Constant Field Values
  - SHIPPING_ADDRESS_PREDICATE
```
static final java.lang.String SHIPPING_ADDRESS_PREDICATE
```
    The predicate (and prefix) of order property keys comprising the shipping address. NB: convention used by OOTB order and checkout components. NOT REQUIRED by the Commerce API.
    
    See Also:
    
    Constant Field Values
  - SHIPPING_OPTION
```
static final java.lang.String SHIPPING_OPTION
```
    The order property key which stores the path/ID of the chosen shipping method. NB: convention used by OOTB order and checkout components. NOT REQUIRED by the Commerce API.
    
    See Also:
    
    Constant Field Values
  - REQ_ATTR_COUNTRYLIST
```
static final java.lang.String REQ_ATTR_COUNTRYLIST
```
    Convention used by OOTB order and checkout components. Not required by the Commerce API.
    
    See Also:
    
    Constant Field Values
  - REQ_ATTR_CARTPAGE
```
static final java.lang.String REQ_ATTR_CARTPAGE
```
    Convention used by OOTB order and checkout components. Not required by the Commerce API.
    
    See Also:
    
    Constant Field Values
  - REQ_ATTR_PRODNOTFOUNDPAGE
```
static final java.lang.String REQ_ATTR_PRODNOTFOUNDPAGE
```
    Convention used by OOTB order and checkout components. Not required by the Commerce API.
    
    See Also:
    
    Constant Field Values
  - REQ_ATTR_CARTOBJECT
```
static final java.lang.String REQ_ATTR_CARTOBJECT
```
    Convention used by OOTB order and checkout components. Not required by the Commerce API.
    
    See Also:
    
    Constant Field Values
  - OPEN_ORDERS_PREDICATE
```
static final java.lang.String OPEN_ORDERS_PREDICATE
```
    Convention used by OOTB order and checkout components. Not required by the Commerce API.
    
    See Also:
    
    Constant Field Values
  - PROPERTY_COMMERCE_PROVIDER
```
@Deprecated
static final java.lang.String PROPERTY_COMMERCE_PROVIDER
```
    Deprecated. since 5.6, use PN_COMMERCE_PROVIDER instead.
    
    See Also:
    
    Constant Field Values
  - COMMERCE_COOKIE_PREFIX
```
@Deprecated
static final java.lang.String COMMERCE_COOKIE_PREFIX
```
    Deprecated. since 5.6, use COMMERCE_COOKIE_NAME instead.
    
    See Also:
    
    Constant Field Values
  - BILLING_PREFIX
```
@Deprecated
static final java.lang.String BILLING_PREFIX
```
    Deprecated. since 6.1, use BILLING_ADDRESS_PREDICATE + "." or a predicate-based property fetch (CommerceSession.getOrderDetails(String predicate)).
    
    See Also:
    
    Constant Field Values
  - SHIPPING_PREFIX
```
@Deprecated
static final java.lang.String SHIPPING_PREFIX
```
    Deprecated. since 6.1, use SHIPPING_ADDRESS_PREDICATE + "." or a predicate-based property fetch (CommerceSession.getOrderDetails(String predicate)).
    
    See Also:
    
    Constant Field Values
  - PAYMENT_PREFIX
```
@Deprecated
static final java.lang.String PAYMENT_PREFIX
```
    Deprecated. since 6.1, use PaymentMethod.getPredicate() + "." or a predicate-based property fetch (CommerceSession.getOrderDetails(String predicate)).
    
    See Also:
    
    Constant Field Values

Interface CommerceConstants

Field Summary

Field Detail

PN_COMMERCE_PROVIDER

COMMERCE_COOKIE_NAME

SERVICE_COMMERCE

PN_COMMERCE_TYPE

PN_PRODUCT_VARIANT_AXES

PN_CART_PAGE_PATH

PN_CHECKOUT_PAGE_PATH

PN_PRODUCT_DATA

RT_PRODUCT_PAGE_PROXY

PN_PROXY_PAGE_OVERRIDE

PAYMENT_OPTION

PAYMENT_TOKEN

SHIPPING_ADDR_SAME

BILLING_ADDRESS_PREDICATE

SHIPPING_ADDRESS_PREDICATE

SHIPPING_OPTION

REQ_ATTR_COUNTRYLIST

REQ_ATTR_CARTPAGE

REQ_ATTR_PRODNOTFOUNDPAGE

REQ_ATTR_CARTOBJECT

OPEN_ORDERS_PREDICATE

PROPERTY_COMMERCE_PROVIDER

COMMERCE_COOKIE_PREFIX

BILLING_PREFIX

SHIPPING_PREFIX

PAYMENT_PREFIX