public class CommonOrderFacadeClient extends AbstractOrderFacadeClient
Modifier and Type | Field and Description |
---|---|
static java.lang.String | COMPONENT_NAME
The component name for the order component.
|
static java.lang.String | COPYRIGHT
the IBM Copyright notice field.
|
Constructor and Description |
---|
CommonOrderFacadeClient()
The default constructor of the class.
|
CommonOrderFacadeClient(BusinessContextType businessContext, javax.security.auth.callback.CallbackHandler callbackHandler)
This method constructs an object by business context and call back handler.
|
Modifier and Type | Method and Description |
---|---|
java.util.Map | addOrderItem(java.util.Map parameters)
This method adds an order item.
|
RespondOrderDataAreaType | addOrderItem(OrderIdentifierType orderId, OrderItemType[] orderItems)
Deprecated.
Replaced by addOrderItem(OrderType, OrderItemType[])
|
RespondOrderDataAreaType | addOrderItem(OrderType order, OrderItemType[] orderItems)
Deprecated.
Replaced by addOrderItem(String, OrderType, OrderItemType[])
|
RespondOrderDataAreaType | addOrderItem(java.lang.String actionCode, OrderType order, OrderItemType[] orderItems)
This method adds an order item.
|
java.util.Map | addPaymentInstruction(java.util.Map parameters)
This method adds the payment instruction list.
|
RespondOrderDataAreaType | addPaymentInstruction(OrderIdentifierType orderId, PaymentInstructionType[] paymentInstructions)
This method adds payment instructions for an order.
|
java.util.Map | applyCoupon(java.util.Map parameters)
It will send a BOD with process verb and action code 'ApplyCoupon' to order server.
|
AcknowledgeOrderDataAreaType | applyCoupon(OrderType order)
It will send a BOD with process verb and action code 'ApplyCoupon' to order server.
|
java.util.Map | applyPromotionCode(java.util.Map parameters)
It will send a BOD with process verb and action code 'ApplyPromotionCode' to order server.
|
AcknowledgeOrderDataAreaType | applyPromotionCode(OrderType order)
It will send a BOD with process verb and action code 'ApplyPromotionCode' to order server.
|
protected com.ibm.commerce.order.facade.datatypes.CalculationInfoType | buildCalculationInfo(java.util.Map parameters, java.lang.String actionName)
This method creates the CalculationInfoType object.
|
protected void | buildCustomizationFieldsToOrderUserData(OrderType order, java.util.Map parameters, java.lang.String actionName)
This method builds the customization fields to the order user data.
|
protected UserDataType | buildInventoryReservationToOrderUserData(java.util.Map parameters)
This method builds the inventory reservation into order userdata from the parameters.
|
protected OrderType | buildOrder(java.util.Map parameters, java.lang.String actionName)
This method is called by the methods addOrderItem(Map),deleteOrderItem(Map), updateOrderItem(Map),updateOrderShippingInfo(Map) ,updateOrderGiftInfo(Map) to build the order object.
|
protected OrderIdentifierType | buildOrderIdentifier(java.util.Map parameters, java.lang.String actionName)
This method builds an order Identifier object.
|
protected OrderItemType[] | buildOrderItem(java.util.Map parameters, java.lang.String actionName)
This method builds the order item object.
|
protected OrderNotificationInfoType | buildOrderNotification(java.util.Map parameters)
This method builds the order notification from the parameters.
|
protected UserDataType | buildOrderNotificationUserData(java.util.Map parameters)
The method builds a UserDataType object, which saves all customized notification parameters.
|
protected PaymentInstructionType[] | buildPaymentInstruction(java.util.Map parameters, java.lang.String actionName)
This method builds payment instructions.
|
protected RewardOptionType | buildRewardOption(java.util.Map parameters, java.lang.String actionName)
This method builds the reward option type.
|
java.util.Map | calculateOrder(java.util.Map parameters)
It will send a BOD with process verb and action code 'CalculateInternally' to order server.
|
AcknowledgeOrderDataAreaType | calculateOrder(OrderType order)
This method calculates the order
|
java.util.Map | cancelScheduledOrder(java.util.Map parameters)
This method cancels a scheduled order and deactivates the related schedule job.
|
java.util.Map | cancelShoppingCart(java.util.Map parameters)
This method deletes the order.
|
AcknowledgeOrderDataAreaType | cancelShoppingCart(OrderIdentifierType orderId)
This method deletes the order.
|
RespondOrderDataAreaType | changeOrder(java.lang.String action, OrderType order, java.lang.String expression)
This method changes the order.
|
protected void | checkConfirmBODOrder(ConfirmBODDataAreaType confirmBODDataArea)
This method examines the ConfirmBOD to see if there is any error information reported.
|
AcknowledgeOrderType | createAcknowledgeOrder()
This method returns a new instance of the AcknowledgeOrder object.
|
protected com.ibm.commerce.order.facade.datatypes.CalculationInfoType | createCalculationInfoType()
This method creates an empty CalculationInfoType object.
|
ChangeOrderType | createChangeOrder()
This method creates an instance of ChangeOrder object.
|
GetOrderType | createGetOrder()
This method returns a new instance of the GetOrder object.
|
static GetType | createGetVerb(ExpressionType selectionCriteriaExpression, java.lang.String recordSetReferenceId, int recordSetStartNumber, int maxItems)
This is a utility method to create the Get verb.
|
protected com.ibm.commerce.order.facade.datatypes.GiftItemInfoType[] | createGiftItemInfo(java.util.Map parameters, int orderItemNum)
This method creates an array of GiftItemInfoType objects with the same length of an order item list.
|
protected OrderIdentifierType | createOrderIdentifierType()
This method creates an empty OrderIdentifierType object.
|
protected OrderItemShippingInfoType | createOrderItemShippingInfoType()
This method creates an empty OrderItemShippingInfoType object.
|
protected OrderItemType | createOrderItemType()
This method creates an empty OrderItemType object.
|
protected OrderShippingInfoType | createOrderShippingInfoType()
This method creates an empty OrderShippingInfoType object.
|
protected PaymentInstructionType | createPaymentInstructionType()
This method creates an empty PaymentInstructionType object.
|
ProcessOrderType | createProcessOrder()
This method returns a new instance of the ProcessOrder object.
|
RespondOrderType | createRespondOrder()
This method returns a new instance of the RespondOrder object.
|
protected RewardChoiceType | createRewardChoiceType()
This method creates an empty RewardChoiceType object.
|
protected RewardOptionType | createRewardOptionType()
This method creates an empty RewardOptionType object.
|
ShowOrderType | createShowOrder()
This method returns a new instance of the ShowOrder object.
|
SyncOrderType | createSyncOrder()
This method creates an instance of SyncOrder object.
|
java.util.Map | deleteOrderItem(java.util.Map parameters)
This method deletes order items.
|
ShowOrderDataAreaType | findByOrderId(java.lang.String[] orderIdTypes, boolean isSummary)
Retrieves orders based on their order IDs, and specifies the level of detail of the returned data.
|
ShowOrderDataAreaType | findByOrderId(java.lang.String orderID, java.math.BigInteger recordSetStartNumber, java.math.BigInteger maxItems)
Retrieves a single order based on its order ID, and whether noun-parts should be paginated.
|
ShowOrderDataAreaType | findByOrderStatus(java.lang.String[] orderStatusTypes, boolean isSummary)
This method retrieves orders according to the given status.
|
ShowOrderDataAreaType | findByOrderStatus(java.lang.String[] orderStatusTypes, boolean isSummary, java.math.BigInteger recordSetStartNumber, java.math.BigInteger maxItems)
This method retrieves orders according to the given status.
|
ShowOrderDataAreaType | findConfigurationByOrderItemId(java.lang.String orderItemId)
This method retrieves order item configuration according to the given order item id.
|
ShowOrderDataAreaType | findCurrentShoppingCart(boolean isSummary)
Retrieves the order that represents the current shopping cart, and specifies the level of detail of the returned data.
|
ShowOrderDataAreaType | findCurrentShoppingCart(boolean isSummary, java.lang.String sortOrderItemBy)
Retrieves the order that represents the current shopping cart, and specifies the level of detail of the returned data.
|
ShowOrderDataAreaType | findCurrentShoppingCart(java.lang.String sortOrderItemBy, java.math.BigInteger recordSetStartNumber, java.math.BigInteger maxItems)
Retrieves the order that represents the current shopping cart, and how sorting and pagination are to be performed.
|
ShowOrderDataAreaType | findOrderByExternalOrderID(java.lang.String[] astrOrderId, boolean isSummary, java.math.BigInteger recordSetStartNumber, java.math.BigInteger maxItems)
This method retrieves orders from external system according to the given external order id.
|
ShowOrderDataAreaType | findOrderByStoreMemberAndPlacedDate(java.lang.String strAccessProfile, java.lang.String[] orderStatuses, java.lang.String storeId, java.lang.String[] memberIds, java.lang.String dispayCurrency, java.lang.String startPlacedDate, java.lang.String endPlacedDate, java.math.BigInteger recordSetStartNumber, java.math.BigInteger maxItems)
This method retrieves orders according to the give store ID, member IDs, and placed date.
|
ShowOrderDataAreaType | findOrderItemByStoreMemberAndCreateDate(java.lang.String strAccessProfile, java.lang.String[] orderItemStatuses, java.lang.String storeId, java.lang.String[] memberIds, java.lang.String dispayCurrency, java.lang.String startCreateDate, java.lang.String endCreateDate, java.math.BigInteger recordSetStartNumber, java.math.BigInteger maxItems)
This method retrieves order items according to the given store ID, member IDs, and create date.
|
ShowOrderDataAreaType | findPurchaseHistory(java.lang.String storeId, java.lang.String[] memberIds, java.lang.String dispayCurrency, java.lang.String startPlacedDate, java.lang.String endPlacedDate, java.math.BigInteger recordSetStartNumber, java.math.BigInteger maxItems)
This method retrieves the customers' purchase history.
|
ShowOrderDataAreaType | findPurchaseHistoryItemsWithProductID(java.lang.String storeId, java.lang.String[] memberIds, java.lang.String startCreateDate, java.lang.String endCreateDate, java.math.BigInteger recordSetStartNumber, java.math.BigInteger maxItems)
This method retrieves the order items that customers have purchased.
|
ShowOrderDataAreaType | findPurchaseHistoryItemsWithValue(java.lang.String storeId, java.lang.String[] memberIds, java.lang.String dispayCurrency, java.lang.String startCreateDate, java.lang.String endCreateDate, java.math.BigInteger recordSetStartNumber, java.math.BigInteger maxItems)
This method retrieves a customer's purchased order items and their values, and quantities.
|
ShowQuoteDataAreaType | findQuoteByExternalQuoteID(java.lang.String[] astrQuoteId, boolean isSummary, java.math.BigInteger recordSetStartNumber, java.math.BigInteger maxItems)
This method retrieves quotes according to the given quote id.
|
ShowQuoteDataAreaType | findQuotesByStatus(java.lang.String[] orderStatusTypes, boolean isSummary, java.math.BigInteger recordSetStartNumber, java.math.BigInteger maxItems)
This method retrieves quotes according to the given status.
|
ShowOrderDataAreaType | findScheduledOrder(boolean isSummary, java.lang.String memberId, java.lang.String storeId, java.lang.String startTime, java.math.BigInteger recordSetStartNumber, java.math.BigInteger maxItems)
This method retrieves scheduled orders according to the start time, member and store.
|
ShowOrderDataAreaType | findShoppingCartItemsWithProductID(java.lang.String storeId, java.lang.String memberId, java.lang.String startCreateDate, java.lang.String endCreateDate, java.math.BigInteger recordSetStartNumber, java.math.BigInteger maxItems)
This method retrieves items and their values, and quantities from a customer's shopping cart.
|
ShowOrderDataAreaType | findShoppingCartItemsWithValue(java.lang.String storeId, java.lang.String memberId, java.lang.String dispayCurrency, java.lang.String startCreateDate, java.lang.String endCreateDate, java.math.BigInteger recordSetStartNumber, java.math.BigInteger maxItems)
This method retrieves the items in a customer's shopping cart.
|
ShowOrderDataAreaType | findUsablePaymentOrShipInformation(java.lang.String[] orderIdTypes, boolean isPaymentInfo)
This method finds usable payment or shipping information for the specified order.
|
ShowOrderDataAreaType | findUsableShippingInfoByOrderID(java.lang.String orderID, java.math.BigInteger recordSetStartNumber, java.math.BigInteger maxItems)
Retrieves the usable shipping information of a particular order.
|
java.util.Map | lockOrder(java.util.Map parameters)
It will send a BOD with process verb and action code 'lock' to order server.
|
AcknowledgeOrderDataAreaType | lockOrder(OrderType order)
This method locks the order.
|
protected void | populateOrderResponse(java.util.Map response, ConfirmBODDataAreaType confirmBODDataArea)
In future, put the Order identifiers in the response Map.
|
protected void | populateResponse(java.util.Map response, java.lang.String actionName, AcknowledgeOrderDataAreaType acknowledgeOrderDataArea)
You can extend this method to retrieve more information from the AcknowledgeOrder.
|
protected void | populateResponse(java.util.Map response, java.lang.String actionName, RespondOrderDataAreaType respondOrderDataArea)
You can extend this method to retrieve more information from the RespondOrder.
|
java.util.Map | prepareOrder(java.util.Map parameters)
This method prepares the order.
|
AcknowledgeOrderDataAreaType | prepareOrder(OrderType order)
This method prepares the order.
|
AcknowledgeOrderDataAreaType | processOrder(java.lang.String action, OrderType order)
This method processes the order.
|
AcknowledgeOrderDataAreaType | processOrder(java.lang.String action, OrderType order, java.lang.String expression)
This method processes the order.
|
java.util.Map | removeCoupon(java.util.Map parameters)
It will send a BOD with process verb and action code 'RemoveCoupon' to order server.
|
AcknowledgeOrderDataAreaType | removeCoupon(OrderType order)
It will send a BOD with process verb and action code 'RemoveCoupon' to order server.
|
java.util.Map | removePaymentInstruction(java.util.Map parameters)
This method removes the list of payment instructions.
|
RespondOrderDataAreaType | removePaymentInstruction(OrderIdentifierType orderId, PaymentInstructionType[] paymentInstruction)
This method removes the payment instructions.
|
java.util.Map | removePromotionCode(java.util.Map parameters)
It will send a BOD with process verb and action code 'RemovePromotionCode' to order server.
|
AcknowledgeOrderDataAreaType | removePromotionCode(OrderType order)
It will send a BOD with process verb and action code 'RemovePromotionCode' to order server.
|
java.util.Map | repay(java.util.Map parameters)
It will send a BOD with process verb and action code 'Repay' to order server.
|
AcknowledgeOrderDataAreaType | repay(OrderType order)
It will send a BOD with process verb and action code 'Repay' to order server.
|
protected java.lang.String[] | resolveParameter(java.util.Map parameters, java.lang.String key)
This method resolves parameters from the input Map.
|
protected java.util.HashMap | resolveParameterForHashMap(java.util.Map parameters, java.lang.String key)
This method resolves parameters(Vector type) from the input Map.
|
java.util.Map | scheduleOrder(java.util.Map parameters)
This method creates a schedule order which related to a schedule job.
The following sample code demonstrates how to use the API: |
java.util.Map | submitOrder(java.util.Map parameters)
This method submits the order.
|
AcknowledgeOrderDataAreaType | submitOrder(OrderType order)
This method submits the order
|
ConfirmBODType | syncOrder(java.lang.String actionCode, OrderType order)
This method synchronizes the order.
|
ConfirmBODType | syncOrder(java.lang.String actionCode, OrderType order, java.lang.String expression)
This method synchronizes the order.
|
java.util.Map | unlockOrder(java.util.Map parameters)
It will send a BOD with process verb and action code 'Unlock' to order server.
|
AcknowledgeOrderDataAreaType | unlockOrder(OrderType order)
This method unlocks the order
|
java.util.Map | updateOrderGiftInfo(java.util.Map parameters)
This method updates the gift information of the order.
|
java.util.Map | updateOrderItem(java.util.Map parameters)
This method updates multiple order items of an order.
|
RespondOrderDataAreaType | updateOrderItem(OrderIdentifierType orderId, OrderItemType[] orderItems)
Deprecated.
Replaced by updateOrderItem(OrderType, OrderItemType[])
|
RespondOrderDataAreaType | updateOrderItem(OrderType order, OrderItemType[] orderItems)
This method updates order items.
|
java.util.Map | updateOrderShippingInfo(java.util.Map parameters)
This method updates the shipping information of the order.
|
RespondOrderDataAreaType | updateOrderShippingInfo(OrderIdentifierType orderId, java.lang.Boolean isShipAsComplete, OrderItemType[] orderItems)
Deprecated.
|
RespondOrderDataAreaType | updateOrderShippingInfo(OrderType order, OrderItemType[] orderItems)
This method updates the shipping information of the order.
|
java.util.Map | updatePaymentInstruction(java.util.Map parameters)
This method updates the payment instruction list.
|
RespondOrderDataAreaType | updatePaymentInstruction(OrderIdentifierType orderId, PaymentInstructionType[] paymentInstructions)
This method updates the payment instructions.
|
java.util.Map | updateRewardOption(java.util.Map parameters)
This method updates the reward option.
|
RespondOrderDataAreaType | updateRewardOption(OrderType order, RewardOptionType rewardOption)
This method updates the reward option.
|
public static final java.lang.String COPYRIGHT
public static final java.lang.String COMPONENT_NAME
public CommonOrderFacadeClient()
public CommonOrderFacadeClient(BusinessContextType businessContext, javax.security.auth.callback.CallbackHandler callbackHandler)
public GetOrderType createGetOrder()
protected OrderShippingInfoType createOrderShippingInfoType()
public ShowOrderType createShowOrder()
public ProcessOrderType createProcessOrder()
public ChangeOrderType createChangeOrder()
public SyncOrderType createSyncOrder()
public AcknowledgeOrderType createAcknowledgeOrder()
public RespondOrderType createRespondOrder()
protected java.lang.String[] resolveParameter(java.util.Map parameters, java.lang.String key) throws OrderException
protected java.util.HashMap resolveParameterForHashMap(java.util.Map parameters, java.lang.String key) throws OrderException
protected OrderIdentifierType buildOrderIdentifier(java.util.Map parameters, java.lang.String actionName) throws OrderException
protected void buildCustomizationFieldsToOrderUserData(OrderType order, java.util.Map parameters, java.lang.String actionName) throws OrderException
protected com.ibm.commerce.order.facade.datatypes.CalculationInfoType buildCalculationInfo(java.util.Map parameters, java.lang.String actionName) throws OrderException
protected OrderItemShippingInfoType createOrderItemShippingInfoType()
protected OrderItemType createOrderItemType()
protected OrderIdentifierType createOrderIdentifierType()
protected com.ibm.commerce.order.facade.datatypes.CalculationInfoType createCalculationInfoType()
protected RewardOptionType createRewardOptionType()
protected RewardChoiceType createRewardChoiceType()
protected PaymentInstructionType createPaymentInstructionType()
protected com.ibm.commerce.order.facade.datatypes.GiftItemInfoType[] createGiftItemInfo(java.util.Map parameters, int orderItemNum) throws OrderException
protected OrderItemType[] buildOrderItem(java.util.Map parameters, java.lang.String actionName) throws OrderException
protected OrderType buildOrder(java.util.Map parameters, java.lang.String actionName) throws OrderException
public java.util.Map addOrderItem(java.util.Map parameters) throws OrderException
Map parameters = new HashMap(); parameters.put("quantity", new String[] { "3", "4" }); parameters.put("catEntryId", new String[] { "10002", "10003" }); parameters.put("contractId", new String[] { "10001", "10001" }); parameters.put("UOM", new String[] { "C62", "C62" }); parameters.put("calculationUsage", new String[] { "-1,-7" }); parameters.put("externalId",new String[] {"10001", "10002"}); parameters.put("giftMessage",new String[]{"a message to giver","another message to giver"}; parameters.put("shipToRegistrant", new String[]{"1","1"}; OrderFacadeClient client = new OrderFacadeClient(businessContext,null); Map response = client.addOrderItem(parameters); String[] outorderId = (String[]) response.get("orderId"); String[] outOrderItemId = (String[]) response.get("orderItemId");The behavior is:
orderId: The order ID of the order to which the order item will be added; if no order ID is proviede, the current pending order is used. quantity: The quantity of the added product. catEntryId: The catalog entry ID of the added product. contractId: The contract ID of the contract on which the order item addition is based. UOM: The unit of measure of the order item. externalId: The external gift list id. giftMessage: The gift message along with the gift. shipToRegistrant: A parameter indicating to ship the gift to register or shopper.
protected void populateResponse(java.util.Map response, java.lang.String actionName, RespondOrderDataAreaType respondOrderDataArea) throws OrderException
protected void populateResponse(java.util.Map response, java.lang.String actionName, AcknowledgeOrderDataAreaType acknowledgeOrderDataArea) throws OrderException
public java.util.Map deleteOrderItem(java.util.Map parameters) throws OrderException
Map parameters = new HashMap(); parameters.put("orderItemId", new String[] { "10002", "10003" }); parameters.put("calculationUsage", new String[] { "-1,-7" }); OrderFacadeClient client = new OrderFacadeClient(businessContext,null); Map response = client.deleteOrderItem(parameters); String[] outorderId = (String[]) response.get("orderId");The behavior is:
<code>orderId</code>: An optional parameter that contains the order ID of the order from which the order item will be deleted. <code>orderItemId</code>: The order item ID to delete.
public java.util.Map updateOrderItem(java.util.Map parameters) throws OrderException
Map parameters = new HashMap(); parameters.put("quantity",new String[]{"30","40"}); parameters.put("orderItemId",new String[]{orderItemId1,orderItemId2}); parameters.put("contractId",new String[]{"10001","10001"}); parameters.put("UOM",new String[]{"C62","C62"}); parameters.put("calculationUsage", new String[] { "-1,-7" }); parameters.put("externalId",new String[] {"10001", "10002"}); parameters.put("giftMessage",new String[]{"a message along with the gift","another message along with the gift"}; parameters.put("shipToRegistrant", new String[]{"1","1"}; OrderFacadeClient client = new OrderFacadeClient(businessContext,null); Map response = client.updateOrderItem(parameters); String[] outorderId = (String[]) response.get("orderId"); String[] outOrderItemId = (String[]) response.get("orderItemId");The behavior is:
<code>orderId</code>: An optional parameter that contains the order ID of the order that contains the order items to update. <code>quantity</code>: The quantity of the updated product. <code>orderItemId</code>: The order item ID to be updated. <code>contractId</code>: The contract ID of the contract on which the order item update is based. <code>UOM</code>: The unit of measure of the order item. <code>externalId</code>: The external gift list id. <code>giftMessage</code>: The gift message along with the gift. <code>shipToRegistrant</code>: A parameter indicating to ship the gift to register or shopper.
public java.util.Map updateOrderShippingInfo(java.util.Map parameters) throws OrderException
Map parameters = new HashMap(); parameters.put("ShipAsComplete",new String[]{"N"}); parameters.put("orderId",new String[]{"10001"}); parameters.put("requestedShipDate",new String[]{"2006-12-24T03:32:34.953Z"}); parameters.put("shipModeId",new String[]{"10001"}); parameters.put("addressId",new String[]{"11301"}); parameters.put("shipInstructions",new String[]{"hello"}); parameters.put("orderItemId",new String[]{"120001"}); parameters.put("calculationUsage", new String[] { "-1,-7" }); parameters.put("allocate", new String[]{"*aig,*ubg"}); parameters.put("backorder", new String[]{"***"}); parameters.put("externalId",new String[] {"10001", "10002"}); parameters.put("giftMessage",new String[]{"a message along with the gift","another message along with the gift"}; parameters.put("shipToRegistrant", new String[]{"1","1"}; OrderFacadeClient client = new OrderFacadeClient(businessContext,null); Map response = client.updateOrderShippingInfo(parameters); String[] outorderId = (String[]) response.get("orderId"); String[] outOrderItemId = (String[]) response.get("orderItemId");The behavior is:
<code>orderId</code>: The order ID to be updated. <code>orderItemId</code>: The order item ID to be updated. <code>ShipAsComplete</code>: The flag which specifies whether the order is shipped as complete. <code>requestedShipDate</code>: The requested ship date of the order item. <code>shipModeId</code>: The ship mode ID. <code>isExpedited</code>: The value to specify whether the ship information is expedited. <code>addressId</code>: The address ID. <code>shipInstructions</code>: The ship instructions of the order. <code>tieShipCode</code>: The tie ship code. <code>externalId</code>: The external gift list id. <code>giftMessage</code>: The gift message along with the gift. <code>shipToRegistrant</code>: A parameter indicating to ship the gift to register or shopper.
public java.util.Map updateOrderGiftInfo(java.util.Map parameters) throws OrderException
Map parameters = new HashMap(); parameters.put("orderId",new String[]{"10001"}); parameters.put("giftMessage",new String[]{"Happy Birthday"}; parameters.put("shipToRegistrant", new String[]{"1"}; OrderFacadeClient client = new OrderFacadeClient(businessContext,null); Map response = client.updateOrderGiftInfo(parameters); String[] outorderId = (String[]) response.get("orderId"); String[] outOrderItemId = (String[]) response.get("orderItemId");The behavior is:
<code>orderId</code>: The order ID to be updated. <code>giftMessage</code>: The gift message along with the gift. <code>shipToRegistrant</code>: A parameter indicating to ship the gift to register or shopper.
public java.util.Map cancelShoppingCart(java.util.Map parameters) throws OrderException
Map parameters = new HashMap(); parameters.put("orderId", new String[] { "10001" }); OrderFacadeClient client = new OrderFacadeClient(businessContext,null); Map response = client.cancelShoppingCart(parameters); String[] outorderId = (String[]) response.get("orderId");
<code>orderId</code>: The order ID of the order to delete.
protected UserDataType buildInventoryReservationToOrderUserData(java.util.Map parameters) throws OrderException
protected RewardOptionType buildRewardOption(java.util.Map parameters, java.lang.String actionName) throws OrderException
protected PaymentInstructionType[] buildPaymentInstruction(java.util.Map parameters, java.lang.String actionName) throws OrderException
protected OrderNotificationInfoType buildOrderNotification(java.util.Map parameters) throws OrderException
public RespondOrderDataAreaType updateRewardOption(OrderType order, RewardOptionType rewardOption) throws OrderException
public java.util.Map updateRewardOption(java.util.Map parameters) throws OrderException
Map parameters = new HashMap(); parameters.put("orderId",new String[]{"10001"}); parameters.put("rewardOptionId",new String[]{"801"}); parameters.put("catEntryId",new String[]{"10254", "10252"}); parameters.put("quantity",new String[]{"1", "1"}); OrderFacadeClient client = new OrderFacadeClient(businessContext,null); Map response = client.updateRewardOption(parameters); String[] outorderId = (String[]) response.get("orderId");The behavior is:
<code>orderId</code>: The order ID to which the reward option will be updated. <code>rewardOptionId</code>: The reward option ID to update. <code>catEntryId</code>: The ID of the catalog entry chosen. <code>quantity</code>: The quantity of the catalog entry chosen. <code>UOM</code>: The unit of measure of the quantity of the catalog entry chosen. If nothing is specified, then the default value of "C62" is used.
public java.util.Map addPaymentInstruction(java.util.Map parameters) throws OrderException
Map parameters = new HashMap(); parameters.put("orderId",new String[]{"10001"}); parameters.put("payMethodId",new String[]{"VISA"}); parameters.put("piAmount",new String[]{"200"}); parameters.put("billing_address_id",new String[]{"11301"}); parameters.put("account",new String[]{"4111111111111111"}); parameters.put("cc_brand",new String[]{"VISA"}); parameters.put("expire_month",new String[]{"12"}); parameters.put("expire_year",new String[]{"2009"}); OrderFacadeClient client = new OrderFacadeClient(businessContext,null); Map response = client.addPaymentInstruction(parameters); String[] outorderId = (String[]) response.get("orderId"); String[] outpiId = (String[]) response.get("piId");
<code>orderId</code>: The order ID to which the payment instruction will be added; <code>payMethodId</code>: The payment method. <code>piAmount</code>: The amount of the payment instruction. <code>paymentTCId</code>: The <code>paymentTC</code> ID. <code>billing_address_id</code>: The billing address of the payment instruction.
public java.util.Map updatePaymentInstruction(java.util.Map parameters) throws OrderException
Map parameters = new HashMap(); parameters.put("piId",new String[]{"10002"}); parameters.put("orderId",new String[]{"10001"}); parameters.put("payMethodId",new String[]{"VISA"}); parameters.put("piAmount",new String[]{"300"}); parameters.put("billing_address_id",new String[]{"11301"}); parameters.put("account",new String[]{"4111111111111111"}); parameters.put("cc_brand",new String[]{"VISA"}); parameters.put("expire_month",new String[]{"12"}); parameters.put("expire_year",new String[]{"2009"}); OrderFacadeClient client = new OrderFacadeClient(businessContext,null); Map response = client.updatePaymentInstruction(parameters); String[] outorderId = (String[]) response.get("orderId"); String[] outpiId = (String[]) response.get("piId");
orderId: The order ID of the order for which the payment instruction will be updated. piId: The payment instruction to be updated. payMethodId: The payment method. piAmount: The amount of the payment instruction. paymentTCId : The <code>paymentTC</code> ID. <code>billing_address_id</code>: The billing address of the payment instruction.
public java.util.Map removePaymentInstruction(java.util.Map parameters) throws OrderException, java.lang.NumberFormatException
Map parameters = new HashMap(); parameters.put("piId",new String[]{"10002"}); parameters.put("orderId",new String[]{"10001"}); OrderFacadeClient client = new OrderFacadeClient(businessContext,null); Map response = client.removePaymentInstruction(parameters); String[] outorderId = (String[]) response.get("orderId");
<code>orderId</code>: The order ID of the order from which the payment instruction will be deleted. <code>piId</code>: The payment instruction to be deleted.
public java.util.Map prepareOrder(java.util.Map parameters) throws OrderException
Map parameters = new HashMap(); parameters.put("orderId", new String[] { "10001"}); OrderFacadeClient client = new OrderFacadeClient(businessContext,null); Map response = client.prepareOrder(parameters); String[] outorderId = (String[]) response.get("orderId");
public java.util.Map submitOrder(java.util.Map parameters) throws OrderException
Map parameters = new HashMap(); parameters.put("orderId", new String[] { "10001"}); OrderFacadeClient client = new OrderFacadeClient(businessContext,null); Map response = client.submitOrder(parameters); String[] outorderId = (String[]) response.get("orderId");
purchaseorder_id: The purchase order ID. orderId: The order ID to be submitted. orderId: The order ID to be submitted. payMethodId: The ID of the payment method. piAmount: The amount of the payment instruction of the order. paymentTCId: The <code>paymentTC</code> ID. billing_address_id: The billing address of the payment instruction. updateChannelId: Whether to update business channel id for order "Y" indicates that business channel id need to be updated "N" indicates that business channel id does not need to be updated
public RespondOrderDataAreaType addOrderItem(OrderIdentifierType orderId, OrderItemType[] orderItems) throws OrderException
public RespondOrderDataAreaType addOrderItem(OrderType order, OrderItemType[] orderItems) throws OrderException
public RespondOrderDataAreaType addOrderItem(java.lang.String actionCode, OrderType order, OrderItemType[] orderItems) throws OrderException
public RespondOrderDataAreaType updateOrderItem(OrderIdentifierType orderId, OrderItemType[] orderItems) throws OrderException
public RespondOrderDataAreaType updateOrderItem(OrderType order, OrderItemType[] orderItems) throws OrderException
public RespondOrderDataAreaType updateOrderShippingInfo(OrderIdentifierType orderId, java.lang.Boolean isShipAsComplete, OrderItemType[] orderItems) throws OrderException
public RespondOrderDataAreaType updateOrderShippingInfo(OrderType order, OrderItemType[] orderItems) throws OrderException
public AcknowledgeOrderDataAreaType cancelShoppingCart(OrderIdentifierType orderId) throws OrderException
public RespondOrderDataAreaType addPaymentInstruction(OrderIdentifierType orderId, PaymentInstructionType[] paymentInstructions) throws OrderException
public RespondOrderDataAreaType updatePaymentInstruction(OrderIdentifierType orderId, PaymentInstructionType[] paymentInstructions) throws OrderException
public RespondOrderDataAreaType removePaymentInstruction(OrderIdentifierType orderId, PaymentInstructionType[] paymentInstruction) throws OrderException
public AcknowledgeOrderDataAreaType prepareOrder(OrderType order) throws OrderException
public AcknowledgeOrderDataAreaType submitOrder(OrderType order) throws OrderException
public AcknowledgeOrderDataAreaType processOrder(java.lang.String action, OrderType order) throws OrderException
public AcknowledgeOrderDataAreaType processOrder(java.lang.String action, OrderType order, java.lang.String expression)
protected void populateOrderResponse(java.util.Map response, ConfirmBODDataAreaType confirmBODDataArea)
public ConfirmBODType syncOrder(java.lang.String actionCode, OrderType order) throws OrderException
public ConfirmBODType syncOrder(java.lang.String actionCode, OrderType order, java.lang.String expression) throws OrderException
protected void checkConfirmBODOrder(ConfirmBODDataAreaType confirmBODDataArea) throws OrderException
public RespondOrderDataAreaType changeOrder(java.lang.String action, OrderType order, java.lang.String expression) throws OrderException
public ShowOrderDataAreaType findShoppingCartItemsWithValue(java.lang.String storeId, java.lang.String memberId, java.lang.String dispayCurrency, java.lang.String startCreateDate, java.lang.String endCreateDate, java.math.BigInteger recordSetStartNumber, java.math.BigInteger maxItems) throws OrderException
public ShowOrderDataAreaType findShoppingCartItemsWithProductID(java.lang.String storeId, java.lang.String memberId, java.lang.String startCreateDate, java.lang.String endCreateDate, java.math.BigInteger recordSetStartNumber, java.math.BigInteger maxItems) throws OrderException
public ShowOrderDataAreaType findPurchaseHistoryItemsWithValue(java.lang.String storeId, java.lang.String[] memberIds, java.lang.String dispayCurrency, java.lang.String startCreateDate, java.lang.String endCreateDate, java.math.BigInteger recordSetStartNumber, java.math.BigInteger maxItems) throws OrderException
public ShowOrderDataAreaType findPurchaseHistoryItemsWithProductID(java.lang.String storeId, java.lang.String[] memberIds, java.lang.String startCreateDate, java.lang.String endCreateDate, java.math.BigInteger recordSetStartNumber, java.math.BigInteger maxItems) throws OrderException
public ShowOrderDataAreaType findPurchaseHistory(java.lang.String storeId, java.lang.String[] memberIds, java.lang.String dispayCurrency, java.lang.String startPlacedDate, java.lang.String endPlacedDate, java.math.BigInteger recordSetStartNumber, java.math.BigInteger maxItems) throws OrderException
public ShowOrderDataAreaType findOrderItemByStoreMemberAndCreateDate(java.lang.String strAccessProfile, java.lang.String[] orderItemStatuses, java.lang.String storeId, java.lang.String[] memberIds, java.lang.String dispayCurrency, java.lang.String startCreateDate, java.lang.String endCreateDate, java.math.BigInteger recordSetStartNumber, java.math.BigInteger maxItems) throws OrderException
public ShowOrderDataAreaType findOrderByStoreMemberAndPlacedDate(java.lang.String strAccessProfile, java.lang.String[] orderStatuses, java.lang.String storeId, java.lang.String[] memberIds, java.lang.String dispayCurrency, java.lang.String startPlacedDate, java.lang.String endPlacedDate, java.math.BigInteger recordSetStartNumber, java.math.BigInteger maxItems) throws OrderException
public ShowOrderDataAreaType findByOrderStatus(java.lang.String[] orderStatusTypes, boolean isSummary) throws OrderException
public ShowOrderDataAreaType findByOrderStatus(java.lang.String[] orderStatusTypes, boolean isSummary, java.math.BigInteger recordSetStartNumber, java.math.BigInteger maxItems) throws OrderException
public ShowOrderDataAreaType findByOrderId(java.lang.String[] orderIdTypes, boolean isSummary) throws OrderException
public ShowOrderDataAreaType findByOrderId(java.lang.String orderID, java.math.BigInteger recordSetStartNumber, java.math.BigInteger maxItems) throws OrderException
public ShowOrderDataAreaType findCurrentShoppingCart(boolean isSummary) throws OrderException
public ShowOrderDataAreaType findCurrentShoppingCart(boolean isSummary, java.lang.String sortOrderItemBy) throws OrderException
public ShowOrderDataAreaType findCurrentShoppingCart(java.lang.String sortOrderItemBy, java.math.BigInteger recordSetStartNumber, java.math.BigInteger maxItems) throws OrderException
public ShowOrderDataAreaType findUsablePaymentOrShipInformation(java.lang.String[] orderIdTypes, boolean isPaymentInfo) throws OrderException
public static GetType createGetVerb(ExpressionType selectionCriteriaExpression, java.lang.String recordSetReferenceId, int recordSetStartNumber, int maxItems)
protected UserDataType buildOrderNotificationUserData(java.util.Map parameters) throws OrderException
public ShowOrderDataAreaType findUsableShippingInfoByOrderID(java.lang.String orderID, java.math.BigInteger recordSetStartNumber, java.math.BigInteger maxItems) throws OrderException
public java.util.Map scheduleOrder(java.util.Map parameters) throws OrderException
Map parameters = new HashMap(); parameters.put("orderId",new String[]{"10001"}); parameters.put("strStartDate",new String[]{"2006-12-24T03:32:34.953Z"}); parameters.put("interval",new String[]{"10"}); parameters.put("PONumber", new String[]{"PONumber101"}); Map response = client.scheduleOrder(parameters); String[] outorderId = (String[]) response.get("orderId");The behavior is:
<code>orderId</code>: The order ID of the order to be schedule. <code>strStartDate</code>: The start date of the scheduled order. <code>interval</code>: The time interval of the repeated schedule task.
public ShowOrderDataAreaType findScheduledOrder(boolean isSummary, java.lang.String memberId, java.lang.String storeId, java.lang.String startTime, java.math.BigInteger recordSetStartNumber, java.math.BigInteger maxItems) throws OrderException
public java.util.Map cancelScheduledOrder(java.util.Map parameters) throws OrderException
The following sample code demonstrates how to use the API:
Map parameters = new HashMap(); parameters.put("orderId",new String[]{"10001"}); Map response = client.cancelScheduledOrder(parameters); String[] outorderId = (String[]) response.get("orderId");The behavior is:
orderId: The order ID of the order to be schedule.
public ShowOrderDataAreaType findOrderByExternalOrderID(java.lang.String[] astrOrderId, boolean isSummary, java.math.BigInteger recordSetStartNumber, java.math.BigInteger maxItems) throws OrderException
public ShowQuoteDataAreaType findQuoteByExternalQuoteID(java.lang.String[] astrQuoteId, boolean isSummary, java.math.BigInteger recordSetStartNumber, java.math.BigInteger maxItems) throws QuoteException
public ShowQuoteDataAreaType findQuotesByStatus(java.lang.String[] orderStatusTypes, boolean isSummary, java.math.BigInteger recordSetStartNumber, java.math.BigInteger maxItems) throws QuoteException
public java.util.Map repay(java.util.Map parameters) throws OrderException
public AcknowledgeOrderDataAreaType repay(OrderType order) throws OrderException
public ShowOrderDataAreaType findConfigurationByOrderItemId(java.lang.String orderItemId) throws OrderException
public java.util.Map applyCoupon(java.util.Map parameters) throws OrderException
public AcknowledgeOrderDataAreaType applyCoupon(OrderType order) throws OrderException
public java.util.Map removeCoupon(java.util.Map parameters) throws OrderException
public AcknowledgeOrderDataAreaType removeCoupon(OrderType order) throws OrderException
public java.util.Map applyPromotionCode(java.util.Map parameters) throws OrderException
public AcknowledgeOrderDataAreaType applyPromotionCode(OrderType order) throws OrderException
public java.util.Map removePromotionCode(java.util.Map parameters) throws OrderException
public AcknowledgeOrderDataAreaType removePromotionCode(OrderType order) throws OrderException
public java.util.Map lockOrder(java.util.Map parameters) throws OrderException
public java.util.Map unlockOrder(java.util.Map parameters) throws OrderException
public AcknowledgeOrderDataAreaType lockOrder(OrderType order) throws OrderException
public AcknowledgeOrderDataAreaType unlockOrder(OrderType order) throws OrderException
public java.util.Map calculateOrder(java.util.Map parameters) throws OrderException
public AcknowledgeOrderDataAreaType calculateOrder(OrderType order) throws OrderException