Request and response for Optimizer API V2
The Optimizer API V2 accepts requests for a promise order from IBM® Sterling Order Management System Software
Optimizer API V2 request and response
The Optimizer API V2 request is accepted in the XML format. For more
information about the Optimizer API V2 request input, see the Optimizer
API.
<Promise OrderDate="" OrderNo="">
<PromiseLines>
<PromiseLine CarrierServiceCode="" ItemID="" LineId="" ProductClass="" RequiredQty="" UnitOfMeasure="" DeliveryMethod="" IsPreDefinedNode="">
<ShipToAddress Country="" State="" ZipCode="" />
<PossibleAssignments>
<Assignment AssignmentKey="" CapacityConsumed="" CapacityUtilization="" Distance="" Quantity="" ShipNode="" IsExternalNode="" DeliveryDate="" ShipDate="">
<Supplies>
<Supply AvailableQuantity="" FirstShipDate="" LastShipDate="" SafetyQuantity="" Track="" />
</Supplies>
</Assignment>
</PossibleAssignments>
</PromiseLine>
</PromiseLines>
<SuggestedOption>
<Option FirstDate="" HasAnyUnavailableQty="" LastDate="" TotalShipments="">
<PromiseLines>
<PromiseLine LineId="">
<Assignments>
<Assignment DeliveryDate="" Distance="" EmptyAssignmentReason="" InteractionNo="" Quantity="" ShipDate="" ShipNode="" /> </Assignments>
</PromiseLine>
</PromiseLines>
<Interactions>
<Interaction Carrier="" CarrierServiceCode="" DeliveryDate="" DeliveryMethod="" InteractionNo="" Node="" ShipDate="">
<PersonInfoShipTo Country="" State="" ZipCode="" /> </Interaction>
</Interactions>
</Option>
</SuggestedOption>
</Promise>
The Optimizer API response is returned in XML format.
<Promise OrderNo="" OrderDate="">
<PromiseLines>
<PromiseLine LineId="" ItemID="">
<PossibleAssignments>
<Assignment AssignmentKey="" Quantity="" IsExternalNode="" RejectChoice="" RejectionReason="" FirstShipDate="">
<PossibleCarriers>
<Carrier CarrierServiceCode="" Scac="" ExpectedShipDate=""></Carrier>
</PossibleCarriers>
<Costs AssignmentPriority=""></Costs>
</Assignment>
</PossibleAssignments>
</PromiseLine>
</PromiseLines>
</Promise>
The CapacityConsumed attribute is required when the fulfillment network load balancing cost configuration is set to greater than 0. Otherwise, it is optional.