Sales Order :: Sales Order Product

Term URI: http://cloudinformationmodel.org/model/SalesOrderProduct

Description: A component of a Sales Order that identifies a product or service that will be sold to the customer

Related entities

Scalar Properties

Name Details
adjustedDeliveryTaxAmount
  • Term URI: http://cloudinformationmodel.org/model/adjustedDeliveryTaxAmount
  • Range: integer
  • Description: Rollup of Sales Order Product Tax rows, where the product is delivery fee, after any adjustments on delivery fees.
allocatedQuantity
  • Term URI: http://cloudinformationmodel.org/model/allocatedQuantity
  • Range: integer
  • Description: Quanity allocated for fulfillment
allocationGroupName
  • Term URI: http://cloudinformationmodel.org/model/allocationGroupName
  • Range: string
  • Description: ....not sure what this is so returned
allocationPartitionName
  • Term URI: http://cloudinformationmodel.org/model/allocationPartitionName
  • Range: string
  • Description: ....not sure what this is so returned
availableQuantity
  • Term URI: http://cloudinformationmodel.org/model/availableQuantity
  • Range: integer
  • Description: Amount of an order product that is available to be reduced. Value must be greater than or equal to 0. An order product is reducible only if AvailableQuantity is greater than 0. Value is always 0 if the order product's parent order is a reduction order.
cancelledQuantity
  • Term URI: http://cloudinformationmodel.org/model/cancelledQuantity
  • Range: integer
  • Description: The quantity of items that have been canceled. Does not consider credited or returned items
commentText
  • Term URI: http://cloudinformationmodel.org/model/commentText
  • Range: string
  • Description: A message displayed to the customer during order creation.
deliveryTaxAmount
  • Term URI: http://cloudinformationmodel.org/model/deliveryTaxAmount
  • Range: integer
  • Description: Rollup of Sales Order Product Tax rows, where the product is delivery fee, before any adjustments on delivery fees.
description
  • Term URI: http://cloudinformationmodel.org/model/description
  • Range: string
  • Description: Translated product description
  • mandatory: true
discountAmount
  • Term URI: http://cloudinformationmodel.org/model/discountAmount
  • Range: integer
  • Description: Discount amount applied to order line item
discountPercent
  • Term URI: http://cloudinformationmodel.org/model/discountPercent
  • Range: integer
  • Description: Discount percentage applied to this order line item
endDate
  • Term URI: http://cloudinformationmodel.org/model/endDate
  • Range: date
  • Description: ...returned as we have no idea why this is here
fulfilledQuantity
  • Term URI: http://cloudinformationmodel.org/model/fulfilledQuantity
  • Range: integer
  • Description: Quantity actually provided
giftOrderMessageText
  • Term URI: http://cloudinformationmodel.org/model/giftOrderMessageText
  • Range: string
  • Description: The message on the gift
giftRecipientTelephoneNumber
  • Term URI: http://cloudinformationmodel.org/model/giftRecipientTelephoneNumber
  • Range: string
  • Description: Telephone number of the gift recipient
handlingCostAmount
  • Term URI: http://cloudinformationmodel.org/model/handlingCostAmount
  • Range: integer
  • Description: Cost charged to customer for handling the order
id
  • Term URI: http://cloudinformationmodel.org/model/id
  • Range: guid
  • Description: Primary Key
  • mandatory: true
isAutomaticallyRenewed
  • Term URI: http://cloudinformationmodel.org/model/isAutomaticallyRenewed
  • Range: boolean
  • Description: For a subscription-type product that can be automatically renewed, this setting indicates the order selection was for auto-renewal
isBonusProduct
  • Term URI: http://cloudinformationmodel.org/model/isBonusProduct
  • Range: boolean
  • Description: Defines if the the sales order item a bonus product. Bonus products are usually free products add to an order. Being bonus has implications on returns and adjustments.
isBundleRoot
  • Term URI: http://cloudinformationmodel.org/model/isBundleRoot
  • Range: boolean
  • Description: Is the product the root-level of a bundled product?
isGift
  • Term URI: http://cloudinformationmodel.org/model/isGift
  • Range: boolean
  • Description: True if the delivery is a gift
lineAdjustmentSubTotalAmount
  • Term URI: http://cloudinformationmodel.org/model/lineAdjustmentSubTotalAmount
  • Range: integer
  • Description: Calculated as: UnitPriceTotalAmount - TotalLineAdjustmentAmount. TotalDistributedAdjustmentAmount is not included.
listPriceAmount
  • Term URI: http://cloudinformationmodel.org/model/listPriceAmount
  • Range: integer
  • Description: List price for one unit of the order product. Value is inherited from the associated PriceBookEntry upon order product creation.
listPriceQuantityUOM
  • Term URI: http://cloudinformationmodel.org/model/listPriceQuantityUOM
  • Range: string
  • Description: The unit of measure for the list price when the product is a physical product. Box, case and palette could be examples... are some examples
  • mandatory: true
orderAdjustmentSubTotalAmount
  • Term URI: http://cloudinformationmodel.org/model/orderAdjustmentSubTotalAmount
  • Range: integer
  • Description: Calculated as: TotalUnitPriceAmount - TotalDistributedAdjustmentAmount. TotalLineAdjustmentAmount is not included.
orderManualAdjustmentSubTotalAmount
  • Term URI: http://cloudinformationmodel.org/model/orderManualAdjustmentSubTotalAmount
  • Range: integer
  • Description: Calculated as: TotalUnitPriceAmount - TotalDistributedAdjustmentAmount. TotalLineAdjustmentAmount is not included.
orderProductNumber
  • Term URI: http://cloudinformationmodel.org/model/orderProductNumber
  • Range: string
  • Description: Automatically-generated number that identifies the order product.
  • mandatory: true
orderedQuantity
  • Term URI: http://cloudinformationmodel.org/model/orderedQuantity
  • Range: integer
  • Description: Number of units of this order product.
  • mandatory: true
promisedDate
  • Term URI: http://cloudinformationmodel.org/model/promisedDate
  • Range: date
  • Description: The date the seller promises to deliver the group of items
provisioningDate
  • Term URI: http://cloudinformationmodel.org/model/provisioningDate
  • Range: date
  • Description: The date when the seller expects to provision the service or product.
quantityOrderedUOM
  • Term URI: http://cloudinformationmodel.org/model/quantityOrderedUOM
  • Range: string
  • Description: The unit of measure for the quantity ordered. Item, box, palette could be examples.
  • mandatory: true
recurringPriceAmount
  • Term URI: http://cloudinformationmodel.org/model/recurringPriceAmount
  • Range: integer
  • Description: A charge that will be incurred by the buyer on a repeating basis.
requestedEndDate
  • Term URI: http://cloudinformationmodel.org/model/requestedEndDate
  • Range: date
  • Description: When the product or service provisioning will end, from an order perspective
requestedStartDate
  • Term URI: http://cloudinformationmodel.org/model/requestedStartDate
  • Range: date
  • Description: When the product or service provisioning will begin, from an order perspective
salesOrderProductAdjustedTaxAmount
  • Term URI: http://cloudinformationmodel.org/model/salesOrderProductAdjustedTaxAmount
  • Range: integer
  • Description: TotalPriceAmount + TotalTaxAmount. The adjusted product amount, with taxes and adjustment taxes applied.
salesOrderProductStatus
  • Term URI: http://cloudinformationmodel.org/model/salesOrderProductStatus
  • Range: string
  • Description: Status of the product within the order. Values may include Placed and Activated
  • mandatory: true
segmentIndex
  • Term URI: http://cloudinformationmodel.org/model/segmentIndex
  • Range: integer
  • Description: Used with Segment Indexes for pricing subscriptions. A Segment Index is unique to a customer's purchase of a product that uses segment pricing, and is used to group the segments together.
segmentIndexNumber
  • Term URI: http://cloudinformationmodel.org/model/segmentIndexNumber
  • Range: integer
  • Description: Used for pricing subscriptions, where sub-periods of the overall subscription are priced differently, and the pricing changes in a structured way over a series of segments, which are identified by numerically increasing Segment Numbers
shippingCostAmount
  • Term URI: http://cloudinformationmodel.org/model/shippingCostAmount
  • Range: integer
  • Description: Shipping cost charged to customer
shippingTaxAmount
  • Term URI: http://cloudinformationmodel.org/model/shippingTaxAmount
  • Range: integer
  • Description: Shipping tax charged to customer
subscriptionRenewalMonthQuantity
  • Term URI: http://cloudinformationmodel.org/model/subscriptionRenewalMonthQuantity
  • Range: integer
  • Description: Determines how often a new order is placed, in months, if this Order Item is a subscription.
subscriptionTermQuantity
  • Term URI: http://cloudinformationmodel.org/model/subscriptionTermQuantity
  • Range: integer
  • Description: Quantity of the Subscription Unit Term Unit of Measure
totalAdjustmentAmount
  • Term URI: http://cloudinformationmodel.org/model/totalAdjustmentAmount
  • Range: integer
  • Description: TotalLineAdjustmentAmount + TotalDistributedAdjustmentAmount + Total Manual Adjustment Amount. A positive value which when subtracted from (quantity*ListPriceAmount) determines TotalPriceAmount
totalAdjustmentTaxAmount
  • Term URI: http://cloudinformationmodel.org/model/totalAdjustmentTaxAmount
  • Range: integer
  • Description: If the order-level adjustment has been distributed to each Sales Order Product, then this contains a rollup of the tax allied to each of those Sales Order Product distributed amounts.
totalDistributedAdjustmentAmount
  • Term URI: http://cloudinformationmodel.org/model/totalDistributedAdjustmentAmount
  • Range: integer
  • Description: Σ SalesOrderProductPriceAdjustment(SalesOrderProductPriceAdjustmentType == Distributed): AdjustmentAmount. Excludes SalesOrderProduct and Manual adjustments.
totalDistributedAdjustmentTaxAmount
  • Term URI: http://cloudinformationmodel.org/model/totalDistributedAdjustmentTaxAmount
  • Range: integer
  • Description: The sum of all taxes computed on order-level adjustments that are prorated to SalesOrderProduct (excludes taxes on SalesOrderProduct-level adjustments). Σ SalesOrderProductPriceAdjustment: AdjustmentTax, where PriceAdjustmentGroup.PriceAdjustmentTypeID =
totalDistributedTaxAmount
  • Term URI: http://cloudinformationmodel.org/model/totalDistributedTaxAmount
  • Range: integer
  • Description: Total line level taxes on distributed adjustments
totalLineAdjustmentAmount
  • Term URI: http://cloudinformationmodel.org/model/totalLineAdjustmentAmount
  • Range: integer
  • Description: Σ SalesOrderProductPriceAdjustment(SalesOrderProductPriceAdjustmentType == SalesOrderProduct): AdjustmentAmount. Excludes Distributed and Manual adjustments.
totalLineAmount
  • Term URI: http://cloudinformationmodel.org/model/totalLineAmount
  • Range: integer
  • Description: Provides a way to override the standard calculation of the SalesOrderProduct's TotalPriceAmount.
totalListPriceAmount
  • Term URI: http://cloudinformationmodel.org/model/totalListPriceAmount
  • Range: integer
  • Description: Quantity * ListPriceAmount
totalManualAdjustmentAmount
  • Term URI: http://cloudinformationmodel.org/model/totalManualAdjustmentAmount
  • Range: integer
  • Description: Σ SalesOrderProductPriceAdjustment(SalesOrderProductPriceAdjustmentType == Manual): AdjustmentAmount. Excludes SalesOrderProduct and Distributed adjustments.
totalPriceAmount
  • Term URI: http://cloudinformationmodel.org/model/totalPriceAmount
  • Range: integer
  • Description: Σ SalesOrderProduct.TotalPriceAmount. Includes adjustments
  • mandatory: true
totalProductTaxAmount
  • Term URI: http://cloudinformationmodel.org/model/totalProductTaxAmount
  • Range: integer
  • Description: Σ SalesOrderProduct.TotalProductTaxAmount
totalRecurringPriceAmount
  • Term URI: http://cloudinformationmodel.org/model/totalRecurringPriceAmount
  • Range: integer
  • Description: For subscription products that have recurring charges, this total stores the total of recurring charges, when these are distinct from Product charges
totalTaxAmount
  • Term URI: http://cloudinformationmodel.org/model/totalTaxAmount
  • Range: integer
  • Description: Σ SalesOrderProduct.TotalTaxAmount
totalUnitPriceAmount
  • Term URI: http://cloudinformationmodel.org/model/totalUnitPriceAmount
  • Range: integer
  • Description: Σ SalesOrderProduct.TotalUnitPriceAmount. Excludes adjustments
unitPriceAmount
  • Term URI: http://cloudinformationmodel.org/model/unitPriceAmount
  • Range: integer
  • Description: What the customer is paying for one unit of the product. This provides a way to override the standard List price.
unitTaxAmount
  • Term URI: http://cloudinformationmodel.org/model/unitTaxAmount
  • Range: integer
  • Description: Unit tax amount for this order product

Link Properties

Name Details