com.ibm.commerce.order.facade

Class OrderFacadeConstants

  • java.lang.Object
    • com.ibm.commerce.order.facade.OrderFacadeConstants


  • public class OrderFacadeConstants
    extends java.lang.Object
    This class defines the constants used to interact with the Order facade.

    Several of the constants defined are used as search parameter names when building the XPath in GetOrderExpressionBuilder. When building the XPath, a Map must be given which includes the desired parameters. Each parameter in the map must be in the form of a String[], unless otherwise indicated. The details of the valid values are described with each parameter below. To find out the valid parameters for a specific builder method, please see the method's documentation in GetOrderExpressionBuilder.

    • Field Summary

      Fields 
      Modifier and Type Field and Description
      static java.lang.String ACCESS_PROFILE_INVENTORY_INFORMATION
      The name of parameter presents access profile of inventory information.
      static java.lang.String ACCESS_PROFILE_ORDER_RECEIPT
      access profile for order receipt
      static java.lang.String ACTION_CODE_PARAMETER_NAME
      Constant representing the action code URL parameter.
      static java.lang.String ADDRESS_ID
      The address id search parameter.
      static java.lang.String ATTRNAME
      The order item attribute name.
      static java.lang.String ATTRVALUE
      The order item attribute value.
      static java.lang.String BILLING_ADDRESS_ID
      The billing address id search parameter.
      static java.lang.String CALCULATION_USAGE
      The name of the XPath parameter which indicates the calculation usage.
      static java.lang.String CALCULATION_USAGE_IDS
      Constant for CalculationUsageId.
      static java.lang.String CATALOG_ENTRY_ID
      The catalog entry Id search parameter.
      static java.lang.String CHANGE_VERB_ACTION_CHANGE
      The action in Verb
      static java.lang.String COMPONENT_CATALOG_ENTRY_ID
      The component catalog entry Id search parameter.
      static java.lang.String COMPONENT_NAME
      The component name for the Order component.
      static java.lang.String COMPONENT_PART_NUMBER
      The component part number search parameter.
      static java.lang.String COMPONENT_QUANTITY
      The component quantity search parameter.
      static java.lang.String CONFIGURATION_XML
      The configuration search parameter.
      static java.lang.String CONTRACT_ID
      The contract id search parameter.
      static java.lang.String CONTROL_PARAMETER_DISPLAY_CURRENCY
      Control parameter indicating the display currency.
      static java.lang.String CONTROL_PARAMETER_USING_PROFILE
      Control parameter for checking out an order using checkout profile.
      static java.lang.String CURRENT_PENDING_ORDER
      The current pending order search parameter.
      static java.lang.String EC_ALLOCATE
      The ATP parameters indicating to allocate order items.
      static java.lang.String EC_BACKORDER
      The ATP parameters indicating to back order order items.
      static java.lang.String EC_CHECK
      The ATP parameters indicating to check order items.
      static java.lang.String EC_MERGE
      The ATP parameters indicating to merge order items.
      static java.lang.String EC_REMERGE
      The ATP parameters indicating to remerge order items.
      static java.lang.String EC_REVERSE
      The ATP parameters indicating to reverse order items.
      static java.lang.String ELEMENT_ORDER
      The name of the element that means the Order noun.
      static java.lang.String ELEMENT_ORDER_ITEM
      The name of the element that means the OrderItem noun part.
      static java.lang.String END_CREATE_DATE
      The end of order item create date search parameter.
      static java.lang.String END_PLACED_DATE
      The end of order placed date search parameter.
      static java.lang.String EXTERNAL_ORDER_ID
      The name of the XPath parameter which indicates the external order id.
      static java.lang.String EXTERNAL_QUOTE_ID
      The name of the XPath parameter which indicates the external quote id.
      static java.lang.String FULFILLMENT_CENTER_ID
      The fulfillment center Id search parameter.
      static java.lang.String GIFT_LIST_EXTERNAL_ID
      The gift list parameter representing external gift list id.
      static java.lang.String GIFT_MESSAGE
      The gift list parameter representing the gift message.
      static java.lang.String IBM_DETAILS
      The Order details access profile.
      static java.lang.String IBM_EXTERNAL_DETAILS
      The external Order details access profile.
      static java.lang.String IBM_EXTERNAL_SUMMARY
      The external Order summary access profile.
      static java.lang.String IBM_ORDER_AMOUNT
      Access profile of order with amount.
      static java.lang.String IBM_ORDER_ITEM_AMOUNT_QUANTITY
      Access profile of order item with amount and quantity.
      static java.lang.String IBM_ORDER_ITEM_CONFIGURATION
      Access profile of order item with configuration.
      static java.lang.String IBM_ORDERITEM_PRODUCT_ID
      Access profile of order item with product ID.
      static java.lang.String IBM_SUMMARY
      The Order summary access profile.
      static java.lang.String IBM_USABLEPAYMENTINFO
      The Order usable payment information access profile.
      static java.lang.String IBM_USABLESHIPPINGINFO
      The Order usable shipping information access profile.
      static java.lang.String INVENTORY_RESERVATION
      The parameter that indicates whether to reserve the inventory.
      static java.lang.String INVENTORY_VALIDATION
      The parameter that indicates if inventory status should be validated.
      static java.lang.String IS_EXPEDITED
      The expedited search parameter.
      static java.lang.String KEY_GENERIC_ERROR
      The generic error
      static java.lang.String KEY_INVALID_PARAMETER_VALUE
      invalid parameter
      static java.lang.String KEY_MISSING_PARAMETER
      missing parameter
      static java.lang.String KEY_PARAMETER_VALUE_NOT_NUMERIC
      parameter value is not numeric
      static java.lang.String MEMBER_DN
      The member id search parameter.
      static java.lang.String MEMBER_ID
      The member id search parameter.
      static java.lang.String MEMBER_UNIQUE_ID_1
      The name of the XPath parameter which indicates the member unique ID.
      static java.lang.String NO
      A value indicating no or false for boolean-style parameters.
      static java.lang.String NOTIFY_ALL_EMAILS
      The e-mail addresses to which all types of mails will be sent.
      static java.lang.String NOTIFY_EMAIL
      The name of XPath parameter which represents the email address recipient for order notification.
      static java.lang.String NOTIFY_MERCHANT
      The name of the parameter which indicates if merchant will be notified.
      static java.lang.String NOTIFY_ORDER_CANCEL_EMAIL
      The e-mail addresses to which order-canceled mail will be sent.
      static java.lang.String NOTIFY_ORDER_CANCEL_FOR_MERCHANT_EMAIL
      The e-mail addresses to which order-canceled-for-merchant mail will be sent.
      static java.lang.String NOTIFY_ORDER_CHANGED_EMAIL
      The e-mail addresses to which order-changed mail will be sent.
      static java.lang.String NOTIFY_ORDER_RECEIVED_EMAIL
      The e-mail addresses to which order-received mail will be sent.
      static java.lang.String NOTIFY_ORDER_SUBMITTED
      The name of the parameter which indicates whether the shopper will be notified when the order is successfully submitted for processing.
      static java.lang.String NOTIFY_RELEASE_SHIP_EMAIL
      The e-mail addresses to which order-release-shipped mail will be sent.
      static java.lang.String NOTIFY_SHOPPER
      The name of the parameter which indicates if shopper will be notified.
      static java.lang.String NOTIFY_SMS
      The name of XPath parameter which represents the short message recipient for order notification.
      static java.lang.String ORDER_CHECKOUT_WITH_PROFILE_ACTION_EXPRESSION
      The action expression for checking out an order using the customer's checkout profile.
      static java.lang.String ORDER_ID
      The order id search parameter.
      static java.lang.String ORDER_ITEM_COMMENT
      The name of the parameter which indicates the comment of the order item.
      static java.lang.String ORDER_ITEM_CREATE_DATE
      The name of the XPath parameter which indicates the order item create date.
      static java.lang.String ORDER_ITEM_STATUS
      The order item status search parameter.
      static java.lang.String ORDER_ITEM_STATUS_1
      The name of the XPath parameter which indicates the order item status.
      static java.lang.String ORDER_PLACED_DATE
      The name of the XPath parameter which indicates the order placed date.
      static java.lang.String ORDER_SCHEDULE_INTERVAL
      The name of the parameter for order schedule interval
      static java.lang.String ORDER_SCHEDULE_START_TIME
      The name of the parameter for the scheduled order start time.
      static java.lang.String ORDER_SCHEDULE_START_TIME_1
      The name of the XPath parameter which indicates the scheduled order start time.
      static java.lang.String ORDER_SCHEDULE_STARTDATE
      The name of the order schedule start date
      static java.lang.String ORDER_STATUS
      The name of the XPath parameter which indicates the order status.
      static java.lang.String ORDER_STATUS_QUICK_CHECKOUT_PROFILE
      Constant for the order status representing the quick checkout profile
      static java.lang.String ORDERITEM_ID
      The order item id search parameter.
      static java.lang.String PAGING_ON
      The paging on parameter.
      static java.lang.String PARAMETER_IS_PERSONAL_ADDRESSES_ALLOWED_FOR_SHIPPING
      Constant for parameter name for the order data bean property isPersonalAddressesAllowedForShipping
      static java.lang.String PARAMETER_IS_PURCHASE_ORDER_NUMBER_REQUIRED
      Constant for parameter name for the order data bean property isPurchaseOrderNumberRequired
      static java.lang.String PART_NUMBER
      The part number search parameter.
      static java.lang.String PAYMENT_INSTRUCTION
      The payment instruction search parameter.
      static java.lang.String PAYMENT_INSTRUCTION_ID
      The payment instruction id search parameter.
      static java.lang.String PAYMENT_METHOD_ID
      The payment method id search parameter.
      static java.lang.String PAYMENT_TERMCOND_ID
      The payment term condition id search parameter.
      static java.lang.String PHYSICAL_STORE_EXTERNAL_IDENTIFIER
      The name of parameter represents external identifier for the physical store.
      static java.lang.String PHYSICAL_STORE_ID
      The identifier constant for physical store ID.
      static java.lang.String PI_AMOUNT
      The payment instruction amount search parameter.
      static java.lang.String POLICY_ATTPAGENAME
      The attribute page name of a policy which is used to display payment method snippet page.
      static java.lang.String POLICY_ID
      The payment policy identifier.
      static java.lang.String POLICY_TYPE_CHAGRGE
      The shipping charge name of policy type.
      static java.lang.String PROCESS_VERB_ACTION_CHECKOUT
      The action code for checking out an order using the customer's checkout profile.
      static java.lang.String PURCHASE_ORDER_ID
      The purchase order id search parameter.
      static java.lang.String QUANTITY
      The quantity search parameter.
      static java.lang.String RECEIPT_ACTION
      The action code which used to decide how to operate receipt information.
      static java.lang.String RECEIPT_ACTION_CHANGE
      The code for action 'change'.
      static java.lang.String RECEIPT_ACTION_DISCARD
      The code for action 'discard'.
      static java.lang.String RECEIPT_ACTION_EXPRESSION
      The receipt action expression in BOD
      static java.lang.String RECEIPT_ADDRESS_ID
      The receipt address
      static java.lang.String RECEIPT_CONTENT
      The receipt content
      static java.lang.String RECEIPT_FIELD1
      The extra receipt field1
      static java.lang.String RECEIPT_FIELD2
      The extra receipt field2
      static java.lang.String RECEIPT_FIELD3
      The extra receipt field3
      static java.lang.String RECEIPT_ID
      The receipt id
      static java.lang.String RECEIPT_INSTRUCTION
      The receipt instruction
      static java.lang.String RECEIPT_TITLE
      The receipt title
      static java.lang.String RECEIPT_TYPE
      The receipt type
      static java.lang.String REQUESTED_SHIP_DATE
      The requested ship date search parameter.
      static java.lang.String REWARD_OPTION_ID
      The reward option ID.
      static java.lang.String SHIP_AS_COMPLETE
      The ship as complete search parameter.
      static java.lang.String SHIP_INSTRUCTIONS
      The ship instruction search parameter.
      static java.lang.String SHIP_TO_REGISTRANT
      The gift list parameter indicating to ship the gift item to the registrant directly or not.
      static java.lang.Integer SHIP_TO_REGISTRANT_CONSTANT
      A possible value for parameter shipToRegistrant.
      static java.lang.Integer SHIP_TO_SHOPER_CONSTANT
      A possible value for parameter shipToRegistrant.
      static java.lang.String SHIPMODE_ID
      The ship mode id search parameter.
      static java.lang.String SHIPPING_CHARGE_ACCOUNT
      The name of XPath parameter which indicates shipping charge account number.
      static java.lang.String SHIPPING_CHARGE_TYPE
      The name of XPath parameter which indicates shipping charge type ID.
      static java.lang.String START_CREATE_DATE
      The start of order item create date search parameter.
      static java.lang.String START_PLACED_DATE
      The start of order placed date search parameter.
      static java.lang.String STORE_ID
      The store id search parameter.
      static java.lang.String STORE_NAME
      The store name search parameter.
      static java.lang.String STORE_UNIQUE_ID_2
      The name of the XPath parameter which indicates the store unique ID.
      static java.lang.String STR_ACCESS_PROFILE
      The access profile search parameter.
      static java.lang.String STR_COUPON_ID
      The string of coupon id.
      static java.lang.String STR_DATA_LANG_IDS
      The data language ids search parameter.
      static java.lang.String STR_EXT_ORD_ID
      The string of external order ID.
      static java.lang.String STR_EXT_QOT_ID
      The string of external quote ID.
      static java.lang.String STR_FIELD1
      The string of field1.
      static java.lang.String STR_FIELD2
      The string of field2.
      static java.lang.String STR_FIELD3
      The string of field3.
      static java.lang.String STR_ORD_ID
      The order Id parameter.
      static java.lang.String STR_ORD_STATUS
      The order status search parameter.
      static java.lang.String STR_PHYSICAL_STORE_ID
      The physical store ID.
      static java.lang.String STR_PROMO_CODE
      This string of promotion code.
      static java.lang.String STR_QOT_ID
      The string of quoteId.
      static java.lang.String STR_SORT_ORDER_ITEM_BY
      Control parameter for how to sort the order items.
      static java.lang.String STR_SORT_ORDER_ITEM_BY_ID
      The value for the control parameter "_ord.sortOrderItemBy" that indicates the order items will be sorted by the order item identifier.
      static java.lang.String TCSUB_TYPE_CHAGRGE
      The shipping charge name of terms and conditions sub-type.
      static java.lang.String TIE_SHIP_CODE
      The tie ship code search parameter.
      static java.lang.String TOTAL_PRODUCT_AFTER_DISCOUNT
      total product after discount
      static java.lang.String UNIQUE_ID
      The name of the XPath parameter which indicates the unique ID.
      static java.lang.String UOM
      The unit of measure search parameter.
      static java.lang.String UOM_C62
      The Unit of measure to specify the quantity unit of one.
      static java.lang.String UPDATE_ORDER_CHANNEL_ID
      The update order channel id parameter.
      static java.lang.String YES
      A value indicating yes or true for boolean-style parameters.
    • Method Summary

      • Methods inherited from class java.lang.Object

        equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
    • Field Detail

      • COMPONENT_NAME

        public static final java.lang.String COMPONENT_NAME
        The component name for the Order component.
        See Also:
        Constant Field Values
      • PROCESS_VERB_ACTION_CHECKOUT

        public static final java.lang.String PROCESS_VERB_ACTION_CHECKOUT
        The action code for checking out an order using the customer's checkout profile.
        See Also:
        Constant Field Values
      • ORDER_CHECKOUT_WITH_PROFILE_ACTION_EXPRESSION

        public static final java.lang.String ORDER_CHECKOUT_WITH_PROFILE_ACTION_EXPRESSION
        The action expression for checking out an order using the customer's checkout profile.
        See Also:
        Constant Field Values
      • STR_ORD_ID

        public static final java.lang.String STR_ORD_ID
        The order Id parameter. Each value in the array must be a valid order ID.
        See Also:
        Constant Field Values
      • STR_QOT_ID

        public static final java.lang.String STR_QOT_ID
        The string of quoteId. Used as key in the Map.
        See Also:
        Constant Field Values
      • STR_EXT_ORD_ID

        public static final java.lang.String STR_EXT_ORD_ID
        The string of external order ID.
        See Also:
        Constant Field Values
      • STR_EXT_QOT_ID

        public static final java.lang.String STR_EXT_QOT_ID
        The string of external quote ID.
        See Also:
        Constant Field Values
      • STR_COUPON_ID

        public static final java.lang.String STR_COUPON_ID
        The string of coupon id.
        See Also:
        Constant Field Values
      • STR_PROMO_CODE

        public static final java.lang.String STR_PROMO_CODE
        This string of promotion code.
        See Also:
        Constant Field Values
      • STR_FIELD1

        public static final java.lang.String STR_FIELD1
        The string of field1.
        See Also:
        Constant Field Values
      • STR_FIELD2

        public static final java.lang.String STR_FIELD2
        The string of field2.
        See Also:
        Constant Field Values
      • STR_FIELD3

        public static final java.lang.String STR_FIELD3
        The string of field3.
        See Also:
        Constant Field Values
      • STR_ORD_STATUS

        public static final java.lang.String STR_ORD_STATUS
        The order status search parameter. Each value in the array must be a valid state code, which is a single letter. Please see the article entitled, "WebSphere Commerce Accelerator: Order and order item states" in the WebSphere Commerce Information Center for a complete list of valid order states.
        See Also:
        Constant Field Values
      • STR_ACCESS_PROFILE

        public static final java.lang.String STR_ACCESS_PROFILE
        The access profile search parameter. Each value in the array can be one of the IBM_* constants defined in this interface, or a custom access profile.
        See Also:
        Constant Field Values
      • STR_DATA_LANG_IDS

        public static final java.lang.String STR_DATA_LANG_IDS
        The data language ids search parameter.
        See Also:
        Constant Field Values
      • IBM_ORDER_ITEM_AMOUNT_QUANTITY

        public static final java.lang.String IBM_ORDER_ITEM_AMOUNT_QUANTITY
        Access profile of order item with amount and quantity.
        See Also:
        STR_ACCESS_PROFILE, Constant Field Values
      • IBM_ORDER_ITEM_CONFIGURATION

        public static final java.lang.String IBM_ORDER_ITEM_CONFIGURATION
        Access profile of order item with configuration.
        See Also:
        STR_ACCESS_PROFILE, Constant Field Values
      • STORE_ID

        public static final java.lang.String STORE_ID
        The store id search parameter. The value for this must be a simple String (not an array) and be a valid store ID.
        See Also:
        Constant Field Values
      • STORE_NAME

        public static final java.lang.String STORE_NAME
        The store name search parameter. The value for this must be a simple String (not an array) and be a valid store name.
        See Also:
        Constant Field Values
      • MEMBER_ID

        public static final java.lang.String MEMBER_ID
        The member id search parameter. Each value in the array must be a valid member ID.
        See Also:
        Constant Field Values
      • MEMBER_DN

        public static final java.lang.String MEMBER_DN
        The member id search parameter. Each value in the array must be a valid member distinguished name .
        See Also:
        Constant Field Values
      • ORDER_ITEM_STATUS

        public static final java.lang.String ORDER_ITEM_STATUS
        The order item status search parameter. The meaning is the same as STR_ORD_STATUS but is applied to order items instead of orders.
        See Also:
        Constant Field Values
      • QUANTITY

        public static final java.lang.String QUANTITY
        The quantity search parameter. Each value in the array must be a number >= 0.
        See Also:
        Constant Field Values
      • ORDERITEM_ID

        public static final java.lang.String ORDERITEM_ID
        The order item id search parameter. Each value in the array must be a valid order item ID.
        See Also:
        Constant Field Values
      • CONTRACT_ID

        public static final java.lang.String CONTRACT_ID
        The contract id search parameter. Each value in the array must be a valid contract ID.
        See Also:
        Constant Field Values
      • CATALOG_ENTRY_ID

        public static final java.lang.String CATALOG_ENTRY_ID
        The catalog entry Id search parameter. Each value in the array must be a valid catalog entry ID.
        See Also:
        Constant Field Values
      • PART_NUMBER

        public static final java.lang.String PART_NUMBER
        The part number search parameter. Each value in the array must be a valid part number associated with a catalog entry.
        See Also:
        Constant Field Values
      • COMPONENT_CATALOG_ENTRY_ID

        public static final java.lang.String COMPONENT_CATALOG_ENTRY_ID
        The component catalog entry Id search parameter. Each value in the array must be a valid catalog entry ID.
        See Also:
        Constant Field Values
      • COMPONENT_PART_NUMBER

        public static final java.lang.String COMPONENT_PART_NUMBER
        The component part number search parameter. Each value in the array must be a valid part number associated with a catalog entry.
        See Also:
        Constant Field Values
      • COMPONENT_QUANTITY

        public static final java.lang.String COMPONENT_QUANTITY
        The component quantity search parameter. Each value in the array must be a number >= 0.
        See Also:
        Constant Field Values
      • CONFIGURATION_XML

        public static final java.lang.String CONFIGURATION_XML
        The configuration search parameter. Each value in the array must be a valid configuration XML.
        See Also:
        Constant Field Values
      • UOM

        public static final java.lang.String UOM
        The unit of measure search parameter. Each value in the array must be a valid unit of measure associated with a catalog entry.
        See Also:
        Constant Field Values
      • FULFILLMENT_CENTER_ID

        public static final java.lang.String FULFILLMENT_CENTER_ID
        The fulfillment center Id search parameter. Each value must be a valid fulfillment center ID.
        See Also:
        Constant Field Values
      • CURRENT_PENDING_ORDER

        public static final java.lang.String CURRENT_PENDING_ORDER
        The current pending order search parameter.
        See Also:
        Constant Field Values
      • REQUESTED_SHIP_DATE

        public static final java.lang.String REQUESTED_SHIP_DATE
        The requested ship date search parameter. Each value must be in the form "yyyy-MM-dd'T'HH:mm:ss.SSS'Z'" as defined in SimpleDateFormat.
        See Also:
        Constant Field Values
      • START_CREATE_DATE

        public static final java.lang.String START_CREATE_DATE
        The start of order item create date search parameter. The value for this must be a simple String (not an array) and be in the form "yyyy-MM-dd'T'HH:mm:ss.SSS'Z'" as defined in SimpleDateFormat.
        See Also:
        Constant Field Values
      • END_CREATE_DATE

        public static final java.lang.String END_CREATE_DATE
        The end of order item create date search parameter. The value for this must be a simple String (not an array) and be in the form "yyyy-MM-dd'T'HH:mm:ss.SSS'Z'" as defined in SimpleDateFormat.
        See Also:
        Constant Field Values
      • START_PLACED_DATE

        public static final java.lang.String START_PLACED_DATE
        The start of order placed date search parameter. The value for this must be a simple String (not an array) and be in the form "yyyy-MM-dd'T'HH:mm:ss.SSS'Z'" as defined in SimpleDateFormat.
        See Also:
        Constant Field Values
      • END_PLACED_DATE

        public static final java.lang.String END_PLACED_DATE
        The end of order placed date search parameter. The value for this must be a simple String (not an array) and be in the form "yyyy-MM-dd'T'HH:mm:ss.SSS'Z'" as defined in SimpleDateFormat.
        See Also:
        Constant Field Values
      • SHIPMODE_ID

        public static final java.lang.String SHIPMODE_ID
        The ship mode id search parameter. Each value in the array must be a valid ship mode ID.
        See Also:
        Constant Field Values
      • TIE_SHIP_CODE

        public static final java.lang.String TIE_SHIP_CODE
        The tie ship code search parameter. Each value in the array must be a shipping code.
        See Also:
        Constant Field Values
      • SHIP_INSTRUCTIONS

        public static final java.lang.String SHIP_INSTRUCTIONS
        The ship instruction search parameter. Each value in the array is a String with special instructions for shipping.
        See Also:
        Constant Field Values
      • ADDRESS_ID

        public static final java.lang.String ADDRESS_ID
        The address id search parameter. Each value in the array must be a valid address ID.
        See Also:
        Constant Field Values
      • SHIP_AS_COMPLETE

        public static final java.lang.String SHIP_AS_COMPLETE
        The ship as complete search parameter. Each value in the array must be either YES or NO.
        See Also:
        Constant Field Values
      • IS_EXPEDITED

        public static final java.lang.String IS_EXPEDITED
        The expedited search parameter. Each value in the array must be either YES or NO.
        See Also:
        Constant Field Values
      • YES

        public static final java.lang.String YES
        A value indicating yes or true for boolean-style parameters.
        See Also:
        Constant Field Values
      • NO

        public static final java.lang.String NO
        A value indicating no or false for boolean-style parameters.
        See Also:
        Constant Field Values
      • PAYMENT_METHOD_ID

        public static final java.lang.String PAYMENT_METHOD_ID
        The payment method id search parameter. Each value in the array must be a valid payment method id.
        See Also:
        Constant Field Values
      • PI_AMOUNT

        public static final java.lang.String PI_AMOUNT
        The payment instruction amount search parameter. Each value in the array must be a number (decimals allowed) that represent the amount.
        See Also:
        Constant Field Values
      • PAYMENT_TERMCOND_ID

        public static final java.lang.String PAYMENT_TERMCOND_ID
        The payment term condition id search parameter. Each value in the array must be a valid payment term condition ID.
        See Also:
        Constant Field Values
      • BILLING_ADDRESS_ID

        public static final java.lang.String BILLING_ADDRESS_ID
        The billing address id search parameter. Each value in the array must be a valid billing address ID.
        See Also:
        Constant Field Values
      • PAYMENT_INSTRUCTION

        public static final java.lang.String PAYMENT_INSTRUCTION
        The payment instruction search parameter. Each value in the array is the instructions to follow.
        See Also:
        Constant Field Values
      • PAYMENT_INSTRUCTION_ID

        public static final java.lang.String PAYMENT_INSTRUCTION_ID
        The payment instruction id search parameter. Each value in the array must be a valid payment instruction id.
        See Also:
        Constant Field Values
      • PURCHASE_ORDER_ID

        public static final java.lang.String PURCHASE_ORDER_ID
        The purchase order id search parameter. Each value in the array must be a valid purchase order id.
        See Also:
        Constant Field Values
      • UPDATE_ORDER_CHANNEL_ID

        public static final java.lang.String UPDATE_ORDER_CHANNEL_ID
        The update order channel id parameter. The value can be "Y" or "N". "Y" indicates that business channel id need to be updated. "N" indicates that business channel id does not need to be updated.
        See Also:
        Constant Field Values
      • PAGING_ON

        public static final java.lang.String PAGING_ON
        The paging on parameter. The value for this must be a simple String (not an array) and must be a valid noun-part. This value is not a search parameter, but is represented in the XPath as a final "/" (slash) with the noun-part added. Currently only ELEMENT_ORDER_ITEM is supported for this value.
        See Also:
        Constant Field Values
      • ELEMENT_ORDER_ITEM

        public static final java.lang.String ELEMENT_ORDER_ITEM
        The name of the element that means the OrderItem noun part. This is used to build and parse the XPath.
        See Also:
        Constant Field Values
      • ELEMENT_ORDER

        public static final java.lang.String ELEMENT_ORDER
        The name of the element that means the Order noun. This is used to build and parse the XPath.
        See Also:
        Constant Field Values
      • KEY_GENERIC_ERROR

        public static final java.lang.String KEY_GENERIC_ERROR
        The generic error
        See Also:
        Constant Field Values
      • KEY_MISSING_PARAMETER

        public static final java.lang.String KEY_MISSING_PARAMETER
        missing parameter
        See Also:
        Constant Field Values
      • KEY_INVALID_PARAMETER_VALUE

        public static final java.lang.String KEY_INVALID_PARAMETER_VALUE
        invalid parameter
        See Also:
        Constant Field Values
      • KEY_PARAMETER_VALUE_NOT_NUMERIC

        public static final java.lang.String KEY_PARAMETER_VALUE_NOT_NUMERIC
        parameter value is not numeric
        See Also:
        Constant Field Values
      • TOTAL_PRODUCT_AFTER_DISCOUNT

        public static final java.lang.String TOTAL_PRODUCT_AFTER_DISCOUNT
        total product after discount
        See Also:
        Constant Field Values
      • CONTROL_PARAMETER_DISPLAY_CURRENCY

        public static final java.lang.String CONTROL_PARAMETER_DISPLAY_CURRENCY
        Control parameter indicating the display currency.
        See Also:
        Constant Field Values
      • CONTROL_PARAMETER_USING_PROFILE

        public static final java.lang.String CONTROL_PARAMETER_USING_PROFILE
        Control parameter for checking out an order using checkout profile.
        See Also:
        Constant Field Values
      • STR_SORT_ORDER_ITEM_BY

        public static final java.lang.String STR_SORT_ORDER_ITEM_BY
        Control parameter for how to sort the order items.
        See Also:
        Constant Field Values
      • STR_SORT_ORDER_ITEM_BY_ID

        public static final java.lang.String STR_SORT_ORDER_ITEM_BY_ID
        The value for the control parameter "_ord.sortOrderItemBy" that indicates the order items will be sorted by the order item identifier. Currently, only value "orderItemID" is supported. If null or an invalid value, order items will be sorted by the shipping address id.
        See Also:
        Constant Field Values
      • NOTIFY_ALL_EMAILS

        public static final java.lang.String NOTIFY_ALL_EMAILS
        The e-mail addresses to which all types of mails will be sent.
        See Also:
        Constant Field Values
      • NOTIFY_ORDER_RECEIVED_EMAIL

        public static final java.lang.String NOTIFY_ORDER_RECEIVED_EMAIL
        The e-mail addresses to which order-received mail will be sent.
        See Also:
        Constant Field Values
      • NOTIFY_ORDER_CANCEL_EMAIL

        public static final java.lang.String NOTIFY_ORDER_CANCEL_EMAIL
        The e-mail addresses to which order-canceled mail will be sent.
        See Also:
        Constant Field Values
      • NOTIFY_ORDER_CANCEL_FOR_MERCHANT_EMAIL

        public static final java.lang.String NOTIFY_ORDER_CANCEL_FOR_MERCHANT_EMAIL
        The e-mail addresses to which order-canceled-for-merchant mail will be sent.
        See Also:
        Constant Field Values
      • NOTIFY_ORDER_CHANGED_EMAIL

        public static final java.lang.String NOTIFY_ORDER_CHANGED_EMAIL
        The e-mail addresses to which order-changed mail will be sent.
        See Also:
        Constant Field Values
      • NOTIFY_RELEASE_SHIP_EMAIL

        public static final java.lang.String NOTIFY_RELEASE_SHIP_EMAIL
        The e-mail addresses to which order-release-shipped mail will be sent.
        See Also:
        Constant Field Values
      • NOTIFY_MERCHANT

        public static final java.lang.String NOTIFY_MERCHANT
        The name of the parameter which indicates if merchant will be notified.
        See Also:
        Constant Field Values
      • NOTIFY_SHOPPER

        public static final java.lang.String NOTIFY_SHOPPER
        The name of the parameter which indicates if shopper will be notified.
        See Also:
        Constant Field Values
      • NOTIFY_ORDER_SUBMITTED

        public static final java.lang.String NOTIFY_ORDER_SUBMITTED
        The name of the parameter which indicates whether the shopper will be notified when the order is successfully submitted for processing.
        See Also:
        Constant Field Values
      • ORDER_ITEM_COMMENT

        public static final java.lang.String ORDER_ITEM_COMMENT
        The name of the parameter which indicates the comment of the order item.
        See Also:
        Constant Field Values
      • UNIQUE_ID

        public static final java.lang.String UNIQUE_ID
        The name of the XPath parameter which indicates the unique ID.
        See Also:
        Constant Field Values
      • MEMBER_UNIQUE_ID_1

        public static final java.lang.String MEMBER_UNIQUE_ID_1
        The name of the XPath parameter which indicates the member unique ID.
        See Also:
        Constant Field Values
      • STORE_UNIQUE_ID_2

        public static final java.lang.String STORE_UNIQUE_ID_2
        The name of the XPath parameter which indicates the store unique ID.
        See Also:
        Constant Field Values
      • ORDER_ITEM_STATUS_1

        public static final java.lang.String ORDER_ITEM_STATUS_1
        The name of the XPath parameter which indicates the order item status.
        See Also:
        Constant Field Values
      • ORDER_ITEM_CREATE_DATE

        public static final java.lang.String ORDER_ITEM_CREATE_DATE
        The name of the XPath parameter which indicates the order item create date.
        See Also:
        Constant Field Values
      • ORDER_PLACED_DATE

        public static final java.lang.String ORDER_PLACED_DATE
        The name of the XPath parameter which indicates the order placed date.
        See Also:
        Constant Field Values
      • ORDER_STATUS

        public static final java.lang.String ORDER_STATUS
        The name of the XPath parameter which indicates the order status.
        See Also:
        Constant Field Values
      • EXTERNAL_ORDER_ID

        public static final java.lang.String EXTERNAL_ORDER_ID
        The name of the XPath parameter which indicates the external order id.
        See Also:
        Constant Field Values
      • EXTERNAL_QUOTE_ID

        public static final java.lang.String EXTERNAL_QUOTE_ID
        The name of the XPath parameter which indicates the external quote id.
        See Also:
        Constant Field Values
      • PHYSICAL_STORE_ID

        public static final java.lang.String PHYSICAL_STORE_ID
        The identifier constant for physical store ID.
        See Also:
        Constant Field Values
      • STR_PHYSICAL_STORE_ID

        public static final java.lang.String STR_PHYSICAL_STORE_ID
        The physical store ID.
        See Also:
        Constant Field Values
      • SHIPPING_CHARGE_TYPE

        public static final java.lang.String SHIPPING_CHARGE_TYPE
        The name of XPath parameter which indicates shipping charge type ID.
        See Also:
        Constant Field Values
      • SHIPPING_CHARGE_ACCOUNT

        public static final java.lang.String SHIPPING_CHARGE_ACCOUNT
        The name of XPath parameter which indicates shipping charge account number.
        See Also:
        Constant Field Values
      • TCSUB_TYPE_CHAGRGE

        public static final java.lang.String TCSUB_TYPE_CHAGRGE
        The shipping charge name of terms and conditions sub-type.
        See Also:
        Constant Field Values
      • POLICY_TYPE_CHAGRGE

        public static final java.lang.String POLICY_TYPE_CHAGRGE
        The shipping charge name of policy type.
        See Also:
        Constant Field Values
      • NOTIFY_EMAIL

        public static final java.lang.String NOTIFY_EMAIL
        The name of XPath parameter which represents the email address recipient for order notification.
        See Also:
        Constant Field Values
      • NOTIFY_SMS

        public static final java.lang.String NOTIFY_SMS
        The name of XPath parameter which represents the short message recipient for order notification.
        See Also:
        Constant Field Values
      • POLICY_ATTPAGENAME

        public static final java.lang.String POLICY_ATTPAGENAME
        The attribute page name of a policy which is used to display payment method snippet page.
        See Also:
        Constant Field Values
      • POLICY_ID

        public static final java.lang.String POLICY_ID
        The payment policy identifier.
        See Also:
        Constant Field Values
      • ACCESS_PROFILE_INVENTORY_INFORMATION

        public static final java.lang.String ACCESS_PROFILE_INVENTORY_INFORMATION
        The name of parameter presents access profile of inventory information.
        See Also:
        Constant Field Values
      • PHYSICAL_STORE_EXTERNAL_IDENTIFIER

        public static final java.lang.String PHYSICAL_STORE_EXTERNAL_IDENTIFIER
        The name of parameter represents external identifier for the physical store.
        See Also:
        Constant Field Values
      • ORDER_SCHEDULE_STARTDATE

        public static final java.lang.String ORDER_SCHEDULE_STARTDATE
        The name of the order schedule start date
        See Also:
        Constant Field Values
      • ORDER_SCHEDULE_INTERVAL

        public static final java.lang.String ORDER_SCHEDULE_INTERVAL
        The name of the parameter for order schedule interval
        See Also:
        Constant Field Values
      • ORDER_SCHEDULE_START_TIME

        public static final java.lang.String ORDER_SCHEDULE_START_TIME
        The name of the parameter for the scheduled order start time.
        See Also:
        Constant Field Values
      • ORDER_SCHEDULE_START_TIME_1

        public static final java.lang.String ORDER_SCHEDULE_START_TIME_1
        The name of the XPath parameter which indicates the scheduled order start time.
        See Also:
        Constant Field Values
      • REWARD_OPTION_ID

        public static final java.lang.String REWARD_OPTION_ID
        The reward option ID.
        See Also:
        Constant Field Values
      • UOM_C62

        public static final java.lang.String UOM_C62
        The Unit of measure to specify the quantity unit of one.
        See Also:
        Constant Field Values
      • CALCULATION_USAGE

        public static final java.lang.String CALCULATION_USAGE
        The name of the XPath parameter which indicates the calculation usage.
        See Also:
        Constant Field Values
      • INVENTORY_VALIDATION

        public static final java.lang.String INVENTORY_VALIDATION
        The parameter that indicates if inventory status should be validated.
        See Also:
        Constant Field Values
      • INVENTORY_RESERVATION

        public static final java.lang.String INVENTORY_RESERVATION
        The parameter that indicates whether to reserve the inventory.
        See Also:
        Constant Field Values
      • ATTRNAME

        public static final java.lang.String ATTRNAME
        The order item attribute name.
        See Also:
        Constant Field Values
      • ATTRVALUE

        public static final java.lang.String ATTRVALUE
        The order item attribute value.
        See Also:
        Constant Field Values
      • EC_MERGE

        public static final java.lang.String EC_MERGE
        The ATP parameters indicating to merge order items.
        See Also:
        Constant Field Values
      • EC_REMERGE

        public static final java.lang.String EC_REMERGE
        The ATP parameters indicating to remerge order items.
        See Also:
        Constant Field Values
      • EC_CHECK

        public static final java.lang.String EC_CHECK
        The ATP parameters indicating to check order items.
        See Also:
        Constant Field Values
      • EC_ALLOCATE

        public static final java.lang.String EC_ALLOCATE
        The ATP parameters indicating to allocate order items.
        See Also:
        Constant Field Values
      • EC_BACKORDER

        public static final java.lang.String EC_BACKORDER
        The ATP parameters indicating to back order order items.
        See Also:
        Constant Field Values
      • EC_REVERSE

        public static final java.lang.String EC_REVERSE
        The ATP parameters indicating to reverse order items.
        See Also:
        Constant Field Values
      • RECEIPT_ID

        public static final java.lang.String RECEIPT_ID
        The receipt id
        See Also:
        Constant Field Values
      • RECEIPT_TITLE

        public static final java.lang.String RECEIPT_TITLE
        The receipt title
        See Also:
        Constant Field Values
      • RECEIPT_TYPE

        public static final java.lang.String RECEIPT_TYPE
        The receipt type
        See Also:
        Constant Field Values
      • RECEIPT_CONTENT

        public static final java.lang.String RECEIPT_CONTENT
        The receipt content
        See Also:
        Constant Field Values
      • RECEIPT_INSTRUCTION

        public static final java.lang.String RECEIPT_INSTRUCTION
        The receipt instruction
        See Also:
        Constant Field Values
      • RECEIPT_ACTION

        public static final java.lang.String RECEIPT_ACTION
        The action code which used to decide how to operate receipt information.
        See Also:
        Constant Field Values
      • RECEIPT_ADDRESS_ID

        public static final java.lang.String RECEIPT_ADDRESS_ID
        The receipt address
        See Also:
        Constant Field Values
      • RECEIPT_FIELD1

        public static final java.lang.String RECEIPT_FIELD1
        The extra receipt field1
        See Also:
        Constant Field Values
      • RECEIPT_FIELD2

        public static final java.lang.String RECEIPT_FIELD2
        The extra receipt field2
        See Also:
        Constant Field Values
      • RECEIPT_FIELD3

        public static final java.lang.String RECEIPT_FIELD3
        The extra receipt field3
        See Also:
        Constant Field Values
      • RECEIPT_ACTION_CHANGE

        public static final java.lang.String RECEIPT_ACTION_CHANGE
        The code for action 'change'.
        See Also:
        Constant Field Values
      • RECEIPT_ACTION_DISCARD

        public static final java.lang.String RECEIPT_ACTION_DISCARD
        The code for action 'discard'.
        See Also:
        Constant Field Values
      • RECEIPT_ACTION_EXPRESSION

        public static final java.lang.String RECEIPT_ACTION_EXPRESSION
        The receipt action expression in BOD
        See Also:
        Constant Field Values
      • CHANGE_VERB_ACTION_CHANGE

        public static final java.lang.String CHANGE_VERB_ACTION_CHANGE
        The action in Verb
        See Also:
        Constant Field Values
      • ACCESS_PROFILE_ORDER_RECEIPT

        public static final java.lang.String ACCESS_PROFILE_ORDER_RECEIPT
        access profile for order receipt
        See Also:
        Constant Field Values
      • GIFT_LIST_EXTERNAL_ID

        public static final java.lang.String GIFT_LIST_EXTERNAL_ID
        The gift list parameter representing external gift list id.
        See Also:
        Constant Field Values
      • GIFT_MESSAGE

        public static final java.lang.String GIFT_MESSAGE
        The gift list parameter representing the gift message.
        See Also:
        Constant Field Values
      • SHIP_TO_REGISTRANT

        public static final java.lang.String SHIP_TO_REGISTRANT
        The gift list parameter indicating to ship the gift item to the registrant directly or not.
        See Also:
        Constant Field Values
      • SHIP_TO_REGISTRANT_CONSTANT

        public static final java.lang.Integer SHIP_TO_REGISTRANT_CONSTANT
        A possible value for parameter shipToRegistrant.
      • SHIP_TO_SHOPER_CONSTANT

        public static final java.lang.Integer SHIP_TO_SHOPER_CONSTANT
        A possible value for parameter shipToRegistrant.
      • CALCULATION_USAGE_IDS

        public static final java.lang.String CALCULATION_USAGE_IDS
        Constant for CalculationUsageId.
        See Also:
        Constant Field Values
      • ACTION_CODE_PARAMETER_NAME

        public static final java.lang.String ACTION_CODE_PARAMETER_NAME
        Constant representing the action code URL parameter. The value of this parameter is used as the action code while invoking the Change service for adding an order item.
        See Also:
        Constant Field Values
      • ORDER_STATUS_QUICK_CHECKOUT_PROFILE

        public static final java.lang.String ORDER_STATUS_QUICK_CHECKOUT_PROFILE
        Constant for the order status representing the quick checkout profile
        See Also:
        Constant Field Values
      • PARAMETER_IS_PERSONAL_ADDRESSES_ALLOWED_FOR_SHIPPING

        public static final java.lang.String PARAMETER_IS_PERSONAL_ADDRESSES_ALLOWED_FOR_SHIPPING
        Constant for parameter name for the order data bean property isPersonalAddressesAllowedForShipping
        See Also:
        Constant Field Values
      • PARAMETER_IS_PURCHASE_ORDER_NUMBER_REQUIRED

        public static final java.lang.String PARAMETER_IS_PURCHASE_ORDER_NUMBER_REQUIRED
        Constant for parameter name for the order data bean property isPurchaseOrderNumberRequired
        See Also:
        Constant Field Values
    • Constructor Detail

      • OrderFacadeConstants

        public OrderFacadeConstants()