Order sync updated message

Custom payload definition of the following Delivery Configuration message namespaces:

sitecore.ordercloud.messages.ordersync.updated

Models

Order

Name	Type	Description
UserContext	UserContext	The user context.
ID	string	The order identifier.
FromUser	User	User placing the order.
FromUserID	string	This property is only writable when creating an order on behalf of a buyer user.
FromCompanyID	string	ID of the Buyer or Marketplace Owner placing the order. Mainly useful to the Marketplace Owner or Supplier receiving it.
ToCompanyID	string	ID of the Marketplace Owner or Supplier receiving the order, only writable on create. Mainly useful to the user placing it.
BillingAddress	Address	Full billing address.
BillingAddressID	string	Reference to a billing address.
ShippingAddressID	string	ID of the Shipping Address for all LineItems on the Order. Null when there are multiple Shipping Addresses involved.
Comments	string	Comments of the order.
LineItemCount	int	Number of line items associated with this order.
Status	OrderStatus	The order status. Will be one of the following values: 1 - Unsubmitted 2 - Awaiting approval 3 - Declined 4 - Open 5 - Completed 6 - Canceled
DateCreated	DateTimeOffset	Date created
DateSubmitted	DateTimeOffset	Date submitted.
DateApproved	DateTimeOffset	Date approved.
DateDeclined	DateTimeOffset	Date declined.
DateCanceled	DateTimeOffset	Date canceled.
DateCompleted	DateTimeOffset	Populated when all items on an order have shipped, or the order is explicitly completed.
LastUpdated	DateTimeOffset	Last time the order was updated.
Subtotal	decimal	Sum of all LineItem.LineSubtotals.
ShippingCost	decimal	Shipping cost.
TaxCost	decimal	Tax cost.
PromotionDiscount	decimal	Sum of all Promotion.Amounts applied to the order.
Currency	string	Currency of the order which is inherited from the user placing the order.
Total	decimal	Subtotal + TaxCost + ShippingCost - PromotionDiscount.
IsSubmitted	bool	True if this Order has been passed from the Buyer to the Marketplace Owner.
SubscriptionID	string	ID of the subscription used to create an order in an automated process.
LineItems	LineItem[]	Array of line items.
Shipments	Shipment[]	Array of shipments.
Payments	Payment[]	Array of payments.
xp	Json	Extended properties.

User

Name	Type	Description
ID	string	The user identifier.
CompanyID	string	Buyer of the buyer user.
Username	string	User name of the user placing the order.
Password	string	Always null.
FirstName	string	First name of the user.
LastName	string	Last name of the user.
Email	string	Email name of the user.
Phone	string	Phone number of the user.
Active	bool	Active flag.
AvailableRoles	string[]	List of Roles currently available to the user via all SecurityProfile Assignments.
Locale	Locale	Locale of the user.
DateCreated	DateTimeOffset	Date created.
PasswordLastSetDate	DateTimeOffset	Date the password was last set.
xp	Json	Extended properties.

LineItem

Name	Type	Description
ID	string	The line item identifier.
ProductID	string	Identifier of the product associated with the line item.
Quantity	int	Quantity of products purchased.
DateAdded	DateTimeOffset	Date the line item was added to the order.
QuantityShipped	int	Sum of QuantityShipped from all shipment items.
UnitPrice	decimal	Price of a single unit.
PromotionDiscount	decimal	Sum of all line item level promotion discount amounts applied.
LineTotal	decimal	LineSubtotal - PromotionDiscount
LineSubtotal	decimal	UnitPrice x Quantity
CostCenter	string	For reference only, does not influence any OrderCloud behavior.
DateNeeded	DateTimeOffset	Date the product is needed by.
ShippingAccount	string	For reference only, does not influence any OrderCloud behavior.
ShippingAddressID	string	Reference to the shipping address of the product associated with this line item.
ShipFromAddressID	string	Marketplace Owner or Supplier AddressID where the product will be shipped from. Can be used to calculate shipping costs.
Product	LineItemProduct	Product information for this line item.
Variant	LineItemVariant	Variant information for this line item.
ShippingAddress	Address	Full shipping address.
ShipFromAddress	Address	Full address of where the product is shipping from.
SupplierID	string	Supplier identifier.
InventoryRecordID	string	Inventory Record ID of which product inventory location to use. The Inventory Record ID cannot be modified once an order is submitted.
PriceScheduleID	string	ID of the Price Schedule used to determine Unit price.
PriceOverridden	bool	If true, UnitPrice was overwritten.
xp	Json	Extended properties.

LineItemProduct

Name	Type	Description
ID	string	Identifier of the product.
Name	string	Name of the product.
Description	string	Description of the product.
Returnable	bool	Indicates of the item is returnable.
QuantityMultiplier	int	This field does not affect any functionality. If we were selling a pack of 5 shirts, we may change this value to 5 to indicate that in the user experience.
ShipWeight	decimal	Weight of the packaged product.
ShipHeight	decimal	Height of the packaged product.
ShipWidth	decimal	Width of the packaged product.
ShipLength	decimal	Length of the packaged product.
DefaultSupplierID	string	Default supplier of this product.
ParentID	string	Parent product identifier.
xp	Json	Extended properties.

LineItemVariant

Name	Type	Description
ID	string	Variant identifier.
Name	string	Name of the variant.
Description	string	Description of the variant.
ShipWeight	decimal	Weight of the packaged variant.
ShipHeight	decimal	Height of the packaged variant.
ShipWidth	decimal	Width of the packaged variant.
ShipLength	decimal	Length of the packaged variant.
xp	Json	Extended properties.

Shipment

Name	Type	Description
ID	string	Identifier of the shipment.
BuyerID	string	Identifier of the buyer.
Shipper	string	For reference only, does not influence any OrderCloud behavior.
DateShipped	DateTimeOffset	Date shipped.
DateDelivered	DateTimeOffset	Date delivered.
TrackingNumber	string	Associated tracking number.
Cost	decimal	For reference only, does not influence any OrderCloud behavior.
OwnerID	string	ID of the organization that owns the Shipment. Only the Marketplace Owner can override the OwnerID on create.
Account	string	Account.
FromAddressID	string	Marketplace Owner or Supplier AddressID where the product will be shipped from.
ToAddressID	string	Destination address of the shipment.
FromAddress	Address	Marketplace Owner or Supplier Full Address where the product will be shipped from.
ToAddress	Address	Destination Full address of the shipment.
xp	Json	Extended properties.

Payment

Name	Type	Description
ID	string	Payment identifier.
Type	PaymentType	When set, will be one of the following values: 1 - Purchase order 2 - Credit card 3 - Spending account
DateCreated	DateTimeOffset	Date the payment was added.
CreditCardID	string	Credit card identifier.
SpendingAccountID	string	Spending account identifier.
Description	string	Descrption of the payment.
Currency	string	Inherited from Order.
Amount	decimal	If null, Payment applies to order total (or total of specific Line Items, if set), minus any other Payments where Amount is set. Value can only be negative if processing a payment for an OrderReturn.
Accepted	bool	All payments must be Accepted to submit an order.
OrderReturnID	string	Used to indicate this payment is associated with an Order Return.
Transactions	PaymentTransaction	Payment transaction information.
xp	Json	Extended properties.

PaymentTransaction

Name	Type	Description
ID	string	Transaction identifier.
Type	string	Type information.
DateExecuted	DateTimeOffset	Date the transaction was executed.
Currency	string	Usually the same as Payment Currency, but can be different. A marketplace may capture funds from the buyer user in one currency and process a payout to the seller in another.
Amount	decimal	Usually the same as Payment Amount, but can be different. A charge might have a subsequent partial credit, for example.
Succeeded	bool	Success flag.
ResultCode	string	Result of the transaction.
ResultMessage	string	Result message.
xp	Json	Extended properties.
Succeeded	bool	Success flag.
ResultCode	string	Result of the transaction.
ResultMessage	string	Result message.
xp	Json	Extended properties.

If you have suggestions for improving this article, let us know!