Product Updated Message
Custom payload definition of the following Delivery Configuration message namespaces:
sitecore.ordercloud.messages.product.updated
Models
Product
Name | Type | Description |
UserContext | The user context. | |
Product` | string | The product identifier. |
Marketplace | string | The marketplace identifier. |
OwnerID | string | Used to specify the identifier of the user or organization that owns or manages the product. Typically used to assign ownership or responsibility for a product to a specific entity. |
Name | string | The name of the product. |
Description | string | The description of the product. |
QuantityMultiplier | int | For reference only. Used to indicate an amount per quantity |
ShipWeight | decimal | The shipping weight. |
ShipHeight | decimal | The shipping height. |
ShipWidth | decimal | The shipping width. |
ShipLength | decimal | The shipping length. |
Active | boolean | Indicates if the product is active. When false, the product will not be visible to shoppers. |
AutoForward | boolean | If true, when this product is ordered by a Buyer, it will automatically be added to a new Order from the Marketplace Owner to the Default Supplier and submitted. Requires a valid DefaultSupplierID. |
SpecCount | int | The number of specs for this product. |
VariantCount | int | The number of variants for this product. |
ShipFromAddressID | string | The ID of the address this product will ship from. |
DefaultSupplierID | string | The ID of the default supplier of the product. |
AllSuppliersCanSell | boolean | Indicates that all suppliers can sell this product. |
Returnable | boolean | Indicates that this product can be returned after purchase. |
DefaultPriceScheduleID | string | The default price schedule for this product. |
Inventory | Inventory | The inventory of the product. |
DefaultPriceSchedule | PriceSchedule | The default price schedule of the product. |
PartyPriceSchedules | PartyPriceSchedule[] | Used to define pricing rules or schedules for specific parties within the platform. A party can refer to a buyer, supplier, or any other entity involved in the order and commerce process. PartyPriceSchedules allow you to set up custom pricing structures based on various criteria. |
SellerDefaultPriceSchedules | SellerDefaultPriceSchedule[] | Used to define pricing rules or schedules specifically for sellers. A seller typically represents a supplier or a group of suppliers within the OrderCloud platform. Allows you to set up custom pricing structures for products or services offered by sellers based on various criteria. |
InventoryRecords | InventoryRecord[] | Inventory when multiple inventory locations are supported. |
Catalogs | string[] | List of catalogs this product is associated with. |
Suppliers | string[] | List of suppliers of this product. |
Buyers | string[] | List of companies that can see this product. |
Categories | Category[] | List of categories this product is assigned to. |
UserGroups | string[] | List of user groups that can see this product. |
Specs | Spec[] | List of product specs. |
xp | dynamic | Dynamic properties assigned by the owner of the product. |
If you are using Sitecore Discover for product synchronization, you'll need to include xp.ThumbnailImageUrl with a value. That will enable showing the product thumbnail image in CEC.
PriceSchedule
Name | Type | Description |
OwnerID | string | Owner of the price schedule. |
ID | string | The price schedule identifier. |
Name | string | The name of the price schedule. |
ApplyTax | boolean | Indicates if tax is to be applied. |
ApplyShipping | boolean | Used to specify whether the pricing rules defined in a price schedule should be applied to the shipping costs associated with an order. |
MinQuantity | int | The minimum quantity allowed per order. |
MaxQuantity | int | The maximum quantity allowed per order. |
UseCumulativeQuantity | bool | If true, line items will be aggregated by product id when determining which price break applies, and when min/max quantities are met. |
RestrictedQuantity | boolean | If true, then product can only be ordered in quantities that exactly match once of the price breaks. |
Currency | string | The currency. |
SalesStart | DateTimeOffset | Start date/time of the price breaks. |
SalesEnd | DateTimeOffset | End date/time of the price breaks. |
IsOnSale | boolean | Indicates if the item is on sale. |
PriceBreaks | PriceBreak[] | List of price breaks associated with the price schedule. |
xp | dynamic | Dynamic properties assigned by the marketplace owner. |
PriceBreak
Name | Type | Description |
Quantity | int | Quantity this price break applies too. |
Price | decimal | Price of the product. |
SalePrice | decimal | If specified, specifies the on sale price. |
SubscriptionPrice | decimal | Per unit price when purchased as a recurring subscription. |
PartyPriceSchedule
Name | Type | Description |
Seller | string | Optional seller identifier. |
Party | string | Party identifier. |
PartyType | int | Type of the party identifier: |
PriceSchedule | PriceSchedule | Associated price schedule. |
SellerDefaultPriceSchedule
Name | Type | Description |
Seller | string | Seller company identifier. |
PriceSchedule | PriceSchedule | Associated price schedule. |
InventoryRecord
Name | Type | Description |
ID | string | The inventory record identifier. |
OwnerID | string | Owner of the inventory. |
Address | Address | Address of the inventory location. |
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. |
LastUpdated | DateTimeOffset | Last time the inventory was updated. |
xp | dynamic | Dynamic properties assigned by the marketplace owner. |
Address
Name | Type | Description |
ID | string | The address identifier. |
DateCreated | DateTimeOffset | The date the address was created. |
CompanyName | string | The name of the company. |
FirstName | string | The first name. |
LastName | string | The last name. |
Street1 | string | The first street address. |
Street2 | string | The second street address. |
City | string | The city. |
State | string | The state or province. |
Zip | string | The zip of postal code. |
Country | string | The country. |
Phone | string | The phone number. |
AddressName | string | The name of the address. |
xp | dynamic | Dynamic properties assigned by the marketplace owner. |
Category
Name | Type | Description |
ID | string | The category identifier. |
ListOrder | int | The order in which the category appears underneath the parent or catalog (if root level). |
Spec
Name | Type | Description |
ID | string | The spec identifier. |
ListOrder | int | The order in which this spec is shown. |
Name | string | The name of the spec. |
DefaultValue | string | If no Spec.Value is passed in the LineItemSpec, this value will be used. |
Required | bool | Indicates if the spec is required. |
AllowOpenText | bool | For Spec options that are not pre-defined, such as FirstName for a business card. |
DefaultOptionID | string | The default option. |
DefinesVariant | bool | If true, each unique combinations of this Spec's Options should map to a unique Product Variant. |
OptionCount | int | The number of options. |
Options | SpecOption[] | List of spec options. |
xp | Json |
SpecOption
Name | Type | Description |
ID | string | The spec option identifier. |
Value | string | Name of the option. |
ListOrder | int | The order in which the option is shown. |
IsOpenText | bool | |
PriceMarkupType | PriceMarkupType | Used to change the price of a product when a specific Spec Option is selected. It will be one of the following values: 1 - AmountPerQuantity 2 - AmountTotal 3 - Percentage |
PriceMarkup | decimal | Price markup. |
xp | Json |