Sitecore OrderCloud Documentation

docs

Portal login

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

Name

Type

Description

UserContext

UserContext

The user context.

ID

string

Identifier of the inventory record.

ProductID

string

Identifier of the product.

InventoryRecords

List<InventoryRecord>

List 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

Name

Type

Description

ID

string

The inventory record identifier.

OwnerID

string

Owner of the inventory.

AddressID

string

The address identifier.

OrderCanExceed

boolean

Indicates if a user is allowed to buy a product even if it’s inventory has been depleted.

QuantityAvailable

int

Amount of remaining items in inventory.

Zip

string

Zip code associated with the address.

xp

dynamic

Dynamic properties assigned by the marketplace owner.

Sitecore Logo

© Copyright 2024, Sitecore OrderCloud®. All rights reserved.

Contact Us
Privacy Policy
Sitecore