1. Developers

Inventory record message

Custom payload definition of the following Delivery Configuration message namespaces:

  • sitecore.ordercloud.messages.entitysync.inventoryrecord.updated

  • sitecore.ordercloud.messages.entitysync.inventoryrecord.full.updated

Models

InventoryRecordChanged

NameTypeDescription
UserContextUserContextThe user context.
IDstringIdentifier of the inventory record.
ProductIDstringIdentifier of the product.
InventoryRecordsListList of inventory records affected by the change.
When an inventoryrecord.updated message namespace is sent, only 1 inventory record, the one that was updated, will be in the list.
When an inventoryrecord.full.update message namespace is sent, this is as a result of a full entity sync. Every inventory record associated with the product will be found in this list.

InventoryRecord

NameTypeDescription
IDstringThe inventory record identifier.
OwnerIDstringOwner of the inventory.
AddressIDstringThe address identifier.
OrderCanExceedbooleanIndicates if a user is allowed to buy a product even if it’s inventory has been depleted.
QuantityAvailableintAmount of remaining items in inventory.
ZipstringZip code associated with the address.
xpdynamicDynamic properties assigned by the marketplace owner.
If you have suggestions for improving this article, let us know!