Reference > WebSphere Commerce Web services > Order


Order


Noun Order


Description

 Order noun is used to model an Order.
This noun is used for order related business flows such as add/remove order item, add/remove payment instruction, change order, get order and so on.


BOD Summary

 Access Profile and Expression Builder columns are for Get BOD only.

BOD Action Code / Access Profile Action Expression Service Provided Sample XML Message Client Library / Expression Builder
ProcessOrder Prepare   Prepare Order. Request
Response 		OrderFacadeClient.prepareOrder(Map)/ OrderFacadeClient.prepareOrder(OrderType)
Submit   Submit Order. Request
Response 		OrderFacadeClient.submitOrder(Map)/ OrderFacadeClient.submitOrder(OrderType)
Cancel /Order Delete Shopping Cart. Request
Response 		OrderFacadeClient.cancelShoppingCart(Map)/ OrderFacadeClient.cancelShoppingCart(OrderIdentifierType)
Checkout   Check out order with profile.   OrderFacadeClient.processOrder(String, OrderType, String)
Schedule /Order Schedule an order. Request
Response 		OrderFacadeClient.scheduleOrder(Map)
CancelSchedule /Order Cancel a scheduled order. Request
Response 		OrderFacadeClient.cancelScheduledOrder(Map)
CalculateOrder   It is used to calculate charges for an order in external system. Request
Response 		ExternalOrderFacadeClient.calculateOrder(OrderType)
Repay   Re-process payment. Request
Response 		OrderFacadeClient.repay(Map) / OrderFacadeClient.repay(OrderType)
GetOrder IBM_Details IBM_Summary {ibmord.isCurrentShoppingCart='true'}/Order
Get the information of the current shopping cart. Request
Response 		OrderFacadeClient.getOrder(GetType)/ GetOrderExpressionBuilder.findCurrentShoppingCart(Map)
IBM_Details {ibmord.isCurrentShoppingCart='true';_ord.sortOrderItemBy='orderItemID'}/Order Get the current shopping cart. The order items returned are sorted by order item identifier. Request
Response 		OrderFacadeClient.getOrder(GetType)/ GetOrderExpressionBuilder.findCurrentShoppingCart(Map, String)
IBM_Details {ibmord.isCurrentShoppingCart='true';_ord.sortOrderItemBy='orderItemID'}/Order/OrderItem Get the current shopping cart. The order items returned are first sorted by order item identifier and then paginated. Request
Response 		OrderFacadeClient.getOrder(GetType)/ GetOrderExpressionBuilder.findCurrentShoppingCart(Map,string)
IBM_Details IBM_Summary /Order[OrderIdentifier[(UniqueID='$orderID$')]] Get the order information by order identifier. Request
Response 		OrderFacadeClient.getOrder(GetType)/ GetOrderExpressionBuilder.findByOrderId(Map)
IBM_Details /Order[OrderIdentifier[(UniqueID='$orderID$')]]/OrderItem Get the order items by order identifier with pagination information. Request
Response 		OrderFacadeClient.getOrder(GetType)/ GetOrderExpressionBuilder.findByOrderId(Map)
IBM_Details IBM_Summary /Order[OrderStatus[(status='$OrderStatus$')]] Get the information of the orders by order status. Request
Response 		OrderFacadeClient.getOrder(GetType)/ GetOrderExpressionBuilder.findByOrderStatus(Map)
IBM_Details IBM_Summary /Order[OrderStatus[(status='$OrderStatus1$' or Status='$OrderStatus2$')]] Get the information of the orders by order status with pagination information. The orders returned will depend on the total result by the status and the pagination information. Request
Response 		OrderFacadeClient.getOrder(GetType)/ GetOrderExpressionBuilder.findByOrderStatus(Map)
IBM_UsableShippingInfo /Order[OrderIdentifier[(UniqueID='$OrderID$')]] Get all the usable shipping information for the order. Request
Response 		OrderFacadeClient.getOrder(GetType)/ GetOrderExpressionBuilder.findByOrderId(Map)
IBM_UsableShippingInfo /Order[OrderIdentifier[(UniqueID='$OrderID$')]]/OrderItem Get all the usable shipping information for the order with pagination on order items. Request
Response 		OrderFacadeClient.getOrder(GetType)/ GetOrderExpressionBuilder.findByOrderId(Map)
IBM_UsablePaymentInfo /Order[OrderIdentifier[(UniqueID='$OrderID$')]] Get all the usable payment information for the order. Request
Response 		OrderFacadeClient.getOrder(GetType)/ GetOrderExpressionBuilder.findByOrderId(Map)
IBM_Order_Amount /Order[StoreIdentifier[UniqueID='$StoreID$'] and BuyerIdentifier[(UniqueID='$MemberID1$' or UniqueID='$MemberID2$')] and OrderStatus[(status='$OrderStatus1$' or Status='$OrderStatus2$'] and PlacedDate>='$StartDate$' and PlacedDate<'$EndDate$'] Get the order amount of the purchase history by the member identifier, order status and date. Request
Response 		OrderFacadeClient.findPurchaseHistory(String, String[], String, String, String, BigInteger, BigInteger)/ GetOrderExpressionBuilder.findOrderByStoreMemberAndPlacedDate(Map)
IBM_OrderItem_Amount_Quantity /Order[StoreIdentifier[UniqueID='$StoreID$'] and BuyerIdentifier[(UniqueID='$MemberID$')] and OrderItem/OrderItemStatus[(Status='$OrderItemStatus$')] and OrderItem[CreateDate>='$StartDate$'] and OrderItem[CreateDate<'$EndDate$']] Get the order item history by store identifier, order items status and order item create date. Request
Response 		OrderFacadeClient.findOrderItemByStoreMemberAndCreateDate(String, String[], String, String[], String, String, String, BigInteger, BigInteger)/ GetOrderExpressionBuilder.findOrderItemByStoreMemberAndCreateDate(Map)
IBM_OrderItem_Amount_Quantity /Order[StoreIdentifier[UniqueID='$StoreID$apos;] and BuyerIdentifier[(UniqueID='$MemberID$')] and OrderItem/OrderItemStatus[(Status='$OrderItemStatus1$' or Status='$OrderItemStatus2$')] and OrderItem[CreateDate>='$SartDate$'] and OrderItem[CreateDate<'$EndDate$']] Get the order item history by product identifier, store identifier, member identifier, order items status and order item create date. Request
Response 		OrderFacadeClient.findPurchaseHistoryItemsWithProductID(String, String[], String, String, BigInteger, BigInteger)/ GetOrderExpressionBuilder.findOrderItemByStoreMemberAndCreateDate(Map)
IBM_Order_Amount /Order[StoreIdentifier[UniqueID='$StoreID$'] and BuyerIdentifier[(UniqueID='$MemberID1$' or UniqueID='$MemberID2$')] and OrderStatus[(status='$OrderStatus1$' or Status='$OrderStatus2$'] and PlacedDate>='$StartDate$' and PlacedDate<'$EndDate$'] Get the purchase history by the member identifier, order status and date with pagination information. Request
Response 		OrderFacadeClient.findPurchaseHistory(String, String[], String, String, String, BigInteger, BigInteger)/ GetOrderExpressionBuilder.findOrderByStoreMemberAndPlacedDate(Map)
IBM_Summary /Order[BuyerIdentifier[(UniqueID='$MemberId$')] and OrderScheduleInfo[StartTime>'$StartTime$'] and StoreIdentifier[UniqueID='$StoreId$']] Get the all the scheduled order information by the member identifier, scheduled start time and store identifier. Request
Response 		OrderFacadeClient.findScheduledOrder(boolean, String, String, String, BigInteger, BigInteger)
IBM_External_Details /Order[OrderIdentifier[(ExternalOrderID='$orderId$')]] It is used to get order details by external order ID. It is an inbound service which calls GetOrder outbound service to get data from external system. Request
Response 		OrderFacadeClient.findOrderByExternalOrderID(String[] astrOrderId)/ GetOrderExpressionBuilder.findByExternalOrderId(HashMap)
ChangeOrder Create /Order/OrderItem Create order item. Request
Response 		OrderFacadeClient.addOrderItem(Map)
Update /Order/OrderItem Update order item. Request
Response 		OrderFacadeClient.updateOrderItem(Map)
Update /Order/OrderItem Delete order item. Request
Response 		OrderFacadeClient.deleteOrderItem(Map)
Create /Order/OrderPaymentInfo/PaymentInstruction Create the payment instruction. Request
Response 		OrderFacadeClient.addPaymentInstruction(Map)
Update /Order/OrderPaymentInfo/PaymentInstruction Update the payment instruction. Request
Response 		OrderFacadeClient.updatePaymentInstruction(Map)
Delete /Order/OrderPaymentInfo/PaymentInstruction Delete the payment instruction. Request
Response 		OrderFacadeClient.removePaymentInstruction(Map)
Create /Order/OrderPaymentInfo/PaymentInstruction Create multiple payment instructions. Request
Response 		OrderFacadeClient.addPaymentInstruction(Map)
Delete /Order/OrderPaymentInfo/PaymentInstruction Delete multiple payment instructions. Request
Response 		OrderFacadeClient.removePaymentInstruction(Map)
Update /Order/OrderItem/OrderItemShippingInfo Update the shipping information of the order item. Request
Response 		OrderFacadeClient.updateOrderShippingInfo(Map)
Update /Order/OrderShippingInfo Update the shipping information in order level. Request
Response 		OrderFacadeClient.updateOrderShippingInfo(Map)
Update /Order/OrderGiftInfo Update the gift information in order level. Request
Response 		OrderFacadeClient.updateOrderGiftInfo(Map)
Update /Order/RewardOption Update the reward option. Request
Response 		OrderFacadeClient.updateRewardOption(Map)
SyncOrder Change   sync the order status. Request
Response 		OrderFacadeClient.updateOrderStatus(Map)


Access Profile

Access Profile Data Returned Description Sample XML Message
IBM_Summary

  • /Order/@shipAsComplete

  • /Order/OrderIdentifier

  • /Order/StoreIdentifier

  • /Order/BuyerIdentifier

  • /Order/OrderAmount/GrandTotal

  • /Order/OrderAmount/GrandTotal/@currency

  • /Order/OrderAmount/TotalProductPrice

  • /Order/OrderAmount/TotalProductPrice/@currency

  • /Order/OrderAmount/TotalAdjustment

  • /Order/OrderAmount/TotalAdjustment/@currency

  • /Order/OrderAmount/Adjustment

  • /Order/OrderAmount/TotalShippingCharge

  • /Order/OrderAmount/TotalShippingCharge/@currency

  • /Order/OrderAmount/TotalSalesTax

  • /Order/OrderAmount/TotalSalesTax/@currency

  • /Order/OrderAmount/TotalShippingTax

  • /Order/OrderAmount/TotalShippingTax/@currency

  • /Order/OrderAmount/TotalTaxByTaxCategory

  • /Order/OrderAmount/TotalTaxByTaxCategory/@currency

  • /Order/OrderAmount/TotalTaxByTaxCategory/@taxCategoryCode

  • /Order/OrderPaymentInfo/PaymentInstruction/UniqueID

  • /Order/OrderPaymentInfo/PaymentInstruction/Amount

  • /Order/OrderPaymentInfo/PaymentInstruction/Amount/@currency

  • /Order/OrderPaymentInfo/PaymentInstruction/PaymentMethod

  • /Order/OrderPaymentInfo/PaymentInstruction/ProtocolData

  • /Order/OrderStatus

  • /Order/OrderStatus/@prepareIndicator

  • /Order/LastUpdateDate

  • /Order/PlacedDate

  Request
Response
IBM_Details

    IBM_Summary
    +

  • /Order/OrderItem/OrderItemIdentifier

  • /Order/OrderItem/CatalogEntryIdentifier

  • /Order/OrderItem/Quantity

  • /Order/OrderItem/ContractIdentifier

  • /Order/OrderItem/OrderItemAmount/@freeGift

  • /Order/OrderItem/OrderItemAmount/UnitPrice

  • /Order/OrderItem/OrderItemAmount/OrderItemPrice

  • /Order/OrderItem/OrderItemAmount/OrderItemPrice/@currency

  • /Order/OrderItem/OrderItemAmount/ShippingCharge

  • /Order/OrderItem/OrderItemAmount/SalesTax

  • /Order/OrderItem/OrderItemAmount/SalesTax/@currency

  • /Order/OrderItem/OrderItemAmount/ShippingTax

  • /Order/OrderItem/OrderItemAmount/ShippingTax/@currency

  • /Order/OrderItem/OrderItemShippingInfo/@expedite

  • /Order/OrderItem/OrderItemShippingInfo/ShippingAddress

  • /Order/OrderItem/OrderItemShippingInfo/ShippingMode

  • /Order/OrderItem/OrderItemStatus

  • /Order/OrderItem/OrderItemFulfillmentInfo

  • /Order/OrderItem/GiftItemInfo/GiftListIdentifier/GiftListExternalIdentifier

  • /Order/OrderItem/GiftItemInfo/GiftMessage

  • /Order/OrderItem/GiftItemInfo/ShipToRegistrant

  • /Order/OrderItem/FulfillmentCenter

  • /Order/OrderItem/Comments

  Request
Response
IBM_UsableShippingInfo

  • /Order/OrderIdentifier

  • /Order/OrderItem/OrderItemIdentifier

  • /Order/OrderItem/UsableShippingMode

  • /Order/OrderItem/UsableShippingMode/ShippingModeIdentifier

  • /Order/OrderItem/UsableShippingMode/Description

  • /Order/OrderItem/UsableShippingMode/Description/@language

  • /Order/OrderItem/UsableShippingChargePolicy

  • /Order/OrderItem/UsableShippingChargePolicy/UniqueID

  Request
Response
IBM_UsablePaymentInfo

  • /Order/OrderIdentifier

  • /Order/OrderPaymentInfo

  • /Order/UsablePaymentInformation

  • /Order/UsablePaymentInformation/PaymentMethod

  • /Order/UsablePaymentInformation/PaymentMethod/PaymentMethodName

  • /Order/UsablePaymentInformation/PaymentMethod/Description

  • /Order/UsablePaymentInformation/PaymentMethod/@language

  • /Order/UsablePaymentInformation/PaymentTermConditionId

  Request
Response
IBM_Order_Amount

  • /Order/OrderAmount/GenericTotal

  • /Order/OrderAmount/GenericTotal/@currency

  • /Order/OrderAmount/GenericTotal/@name

  Request
Response
IBM_OrderItem_Amount_Quantity

  • /Order/OrderItem/CatalogEntryIdentifier

  • /Order/OrderItem/Quantity

  • /Order/OrderItem/OrderItemAmount/GenericTotal

  • /Order/OrderItem/OrderItemAmount/GenericTotal/@currency

  • /Order/OrderItem/OrderItemAmount/GenericTotal/@name

  Request
Response
IBM_External_Details

  • /Order/@shipAsComplete

  • /Order/OrderIdentifier/ExternalOrderID

  • /Order/OrderAmount/TotalProductPrice

  • /Order/OrderAmount/TotalProductPrice/@currency

  • /Order/OrderAmount/TotalAdjustment

  • /Order/OrderAmount/TotalAdjustment/@currency

  • /Order/OrderAmount/Adjustment

  • /Order/OrderAmount/TotalShippingCharge

  • /Order/OrderAmount/TotalShippingCharge/@currency

  • /Order/OrderAmount/TotalSalesTax

  • /Order/OrderAmount/TotalSalesTax/@currency

  • /Order/OrderAmount/TotalShippingTax

  • /Order/OrderAmount/TotalShippingTax/@currency

  • /Order/OrderAmount/TotalTaxByTaxCategory

  • /Order/OrderAmount/TotalTaxByTaxCategory/@currency

  • /Order/OrderAmount/TotalTaxByTaxCategory/@taxCategoryCode

  • /Order/OrderPaymentInfo/PaymentInstruction/UniqueID

  • /Order/OrderPaymentInfo/PaymentInstruction/Amount

  • /Order/OrderPaymentInfo/PaymentInstruction/Amount/@currency

  • /Order/OrderPaymentInfo/PaymentInstruction/PaymentMethod

  • /Order/OrderPaymentInfo/PaymentInstruction/ProtocolData

  • /Order/LastUpdateDate

  • /Order/PlacedDate

  • /Order/OrderItem/OrderItemIdentifier/ExternalOrderItemID

  • /Order/OrderItem/CatalogEntryIdentifier

  • /Order/OrderItem/Quantity

  • /Order/OrderItem/Quantity/@uom

  • /Order/OrderItem/ContractIdentifier

  • /Order/OrderItem/OrderItemAmount/@freeGift

  • /Order/OrderItem/OrderItemAmount/UnitPrice/Price

  • /Order/OrderItem/OrderItemAmount/UnitPrice/Price/@currency

  • /Order/OrderItem/OrderItemAmount/OrderItemPrice

  • /Order/OrderItem/OrderItemAmount/OrderItemPrice/@currency

  • /Order/OrderItem/OrderItemAmount/ShippingCharge

  • /Order/OrderItem/OrderItemAmount/ShippingCharge/@currency

  • /Order/OrderItem/OrderItemAmount/SalesTax

  • /Order/OrderItem/OrderItemAmount/SalesTax/@currency

  • /Order/OrderItem/OrderItemAmount/ShippingTax

  • /Order/OrderItem/OrderItemAmount/ShippingTax/@currency

  • /Order/OrderItem/OrderItemAmount/Adjustment

  • /Order/OrderItem/OrderItemAmount/TotalAdjustment

  • /Order/OrderItem/OrderItemAmount/TotalAdjustment/@currency

  • /Order/OrderItem/OrderItemShippingInfo/@expedite

  • /Order/OrderItem/OrderItemShippingInfo/ShippingAddress

  • /Order/OrderItem/OrderItemShippingInfo/ShippingMode

  • /Order/OrderItem/OrderItemShippingInfo/ShippingInstruction

  • /Order/OrderItem/OrderItemShippingInfo/RequestedShipDate

  • /Order/OrderItem/OrderItemStatus

  • /Order/OrderItem/OrderItemFulfillmentInfo

  • /Order/OrderItem/FulfillmentCenter

  Request
Response


XSD files

Topic URL: _vcc_freeselect_bottom_


+

Search Tips   |   Advanced Search