Get inventory availability

The get inventory availability communication maps the HCL Commerce GetInventoryAvailability request to the Sterling Order Management monitorItemAvailability (for an online store call) or findInventory (for a physical store call). It is possible to cache the result, which eliminates a real time call to Sterling Order Management for each inventory check and drastically increases performance.

findInventory Request

As both HCL Commerce and Sterling Order Management are customizable, assumptions are made with the mapping from one system to the other. The assumptions made for this call are:
Sterling Order Management API path Source
Promise/@OrganizationCode Set in the "OrganizationCodeSetter" node in the mediation flow
Promise/PromiseLines/PromiseLine@UnitOfMeasure “Each" unless defined otherwise in Common Attributes mapping in ValueMaps.xml
Promise/PromiseLines/PromiseLine@RequiredQty Always "999999999"
Promise/PromiseLines/PromiseLine@ItemID PartNumber param in the Xpath selection criteria
Promise/PromiseLines/PromiseLine@ShipNode
  • NameIdentifier in the Xpath selection criteria (if present) or
  • ExternalIdentifier in the Xpath selection criteria the online or physical store name(s)
Promise/PromiseLines/PromiseLine@LineId
  • online_#
  • physical_#
Where # is a number appended to ensure uniqueness.

findInventory Response

HCL Commerce path Source
_inv:ShowInventoryAvailability/_inv:DataArea/_inv:InventoryAvailability/_inv:InventoryAvailabilityIdentifier/_wcf:ExternalIdentifier/_wcf:CatalogEntryIdentifier/_wcf:ExternalIdentifier/_wcf;PartNumber PartNumber param in the Xpath selection criteria in the request XML
_inv:ShowInventoryAvailability/_inv:DataArea/_inv:InventoryAvailability/_inv:InventoryAvailabilityIdentifier/_wcf:ExternalIdentifier/_wcf:OnlineStoreIdentifier/_wcf:ExternalIdentifier/_wcf:NameIdentifier
  • NameIdentifier in the XPath selection criteria in the request XML (if present) or
  • ExternalIdentifier in the XPath selection criteria in the request XML
_inv:ShowInventoryAvailability/_inv:DataArea/_inv:InventoryAvailability/_inv:InventoryStatus
  • Available If available now according to product availability date
  • Backorderable If available in the future according to product availability date
  • Unavailable All Other cases
_inv:ShowInventoryAvailability/_inv:DataArea/_inv:InventoryAvailability/_inv:AvailableQuantity@uom "C62" unless defined otherwise in Common Attributes mapping in ValueMaps.xml
_inv:ShowInventoryAvailability/_inv:DataArea/_inv:InventoryAvailability/_inv:AvailableQuantity Assignments/Assignment/@Quantity A summation of all quantity values for available products.