Fulfillment messages include some messages that are sent by default to the scenario manager, and messages intended for use within the fulfillment system.
The scenario messages are all sent by the OrderChangeHandler
component. This component listens for internal fulfillment messages (such as ModifyOrderNotification
) and creates messages for consumption by scenarios.
The following messages are sent to the scenario manager during fulfillment.
atg.commerce.fulfillment.scenario.OrderModified
atg.commerce.fulfillment.scenario.PaymentGroupModified
atg.commerce.fulfillment.scenario.ShippingGroupModified
The following messages are used within the fulfillment system.
atg.commerce.fulfillment.UpdateInventoryImpl
atg.commerce.fulfillment.FulfillOrderFragment
atg.commerce.fulfillment.ModifyOrderNotification
atg.commerce.fulfillment.ModifyOrder
atg.commerce.fulfillment.SubmitOrder
The SubmitOrder
message is sent when an order has been submitted for fulfillment (checkout complete).
Base type: CommerceMessageImpl
JMS type: atg.commerce.fulfillment.SubmitOrder
Source
The ProcSendFulfillmentMessage
processor, which is part of the processOrder
pipeline chain.
Properties
order
orderId
originalId
originalSource
parentsessionId
profile
sessionId
siteId
sourceId
type
userId
atg.commerce.fulfillment.scenario.OrderModified
The OrderModified
message is sent when an order is modified.
JMS type: atg.commerce.fulfillment.scenario.OrderModified
Base type: ScenarioEvent
Four possible kinds of modifications are accessible in the subType
property:
Order is finished
Order has unavailable items
Order is pending merchant action
Order was removed
Source
The OrderChangeHandler
component.
Properties
order
shipItemRels
(the list of unavailable items)subType
type
atg.commerce.fulfillment.scenario.PaymentGroupModified
The PaymentGroupModified
event is sent when a payment group is modified.
Base type: ScenarioEvent
JMS type: atg.commerce.fulfillment.scenario.PaymentGroupModified
Three possible kinds of modifications are accessible in the subType
property:
Payment group has been credited
Payment group has been debited
Payment group has failed to debit
Source
The OrderChangeHandler
component.
Properties
order
paymentGroups
subType
type
atg.commerce.fulfillment.scenario.ShippingGroupModified
The ShippingGroupModified
event is sent when a shipping group is modified.
Base type: ScenarioEvent
JMS type: atg.commerce.fulfillment.scenario.ShippingGroupModified
Six possible kinds of modifications are accessible in the subType
property:
Shipping group has been removed
Shipping group shipped
Shipping group split for unknown reasons
Shipping group split to partially ship
Shipping group split to use multiple fulfillers
Shipping group is pending merchant action
Source
The OrderChangeHandler
component.
Properties
order
shippingGroup
newShippingGroup
(if split)subType
type
atg.commerce.fulfillment.UpdateInventoryImpl
The UpdateInventoryImpl
message is used if there is new inventory available.
Base type: CommerceMessageImpl
JMS type: atg.commerce.fulfillment.UpdateInventoryImpl
Source
The RepositoryInventoryManager
sends this whenever inventoryWasUpdated
is called. This method is called by fulfillment if an order is cancelled. It may also be called by administrative tools. Oracle ATG Web Commerce includes an InventoryFormHandler
that calls this method and is accessible through the Dynamo Server Admin pages.
Properties
itemIds
type
atg.commerce.fulfillment.FulfillOrderFragment
This message is used within fulfillment to notify a particular fulfiller of new items to fulfill. The SubmitOrder
message includes the entire order. Fulfillment splits this message into one message per fulfiller. The FulfillOrderFragment
message includes this per-fulfiller information.
Base type:CommerceMessageImpl
JMS type: atg.commerce.fulfillment.FulfillOrderFragment
Source
The source is ProcSendFulfillOrderFragment
, which is one of the fulfillment pipeline processors
Properties
order
shippingGroupIds
—Shipping groups for which the fulfiller is responsible.type
atg.commerce.fulfillment.ModifyOrderNotification
Base type: CommerceMessageImpl
JMS type: atg.commerce.fulfillment.ModifyOrderNotification
The ModifyOrderNotification
message is used to announce that changes were made to an order during fulfillment. Each change is represented as a Modification
object. Modifications can tell you things like which payment groups have changed, which shipping groups have changed, or when the state of an order object has changed.
Source
The fulfillment system can send this message when an order changes.
Properties
modifyOrderSource
(If this message was a response to aModifyOrder
message, this property references the source of thatModifyOrder
message.)modifications
orderId
originalSource
originalId
parentSessionId
sessionId
siteId
sourceId
type
userId
atg.commerce.fulfillment.ModifyOrder
The ModifyOrder
message is used to request that a change be made to an order during fulfillment. Each change request is represented as a Modification
object. Examples of modifications are to remove an order or change the state of this order object.
Base type: CommerceMessageImpl
JMS type: atg.commerce.fulfillment.ModifyOrder
Source
This message is sent by the external fulfillment system. Whenever a change needs to be made by another part of fulfillment, a ModifyOrder
message is sent.
Properties
modifications
orderId
originalId
originalSource
parentSessionId
siteId
sourceId
sessionId
type
userId