Skip to content

Latest commit

 

History

History
50 lines (34 loc) · 3.2 KB

OrderCalculatedItem.md

File metadata and controls

50 lines (34 loc) · 3.2 KB

OrderCalculatedItem

Properties

Name Type Description
id String Unique identifier of the order line item.
skuId String Unique identifier of the SKU. It is assigned by Voucherify.
productId String Unique identifier of the product. It is assigned by Voucherify.
relatedObject RelatedObjectEnum Used along with the source_id property, can be set to either sku or product.
sourceId String The merchant's product/SKU ID (if it is different from the Voucherify product/SKU ID). It is useful in the integration between multiple systems. It can be an ID from an eCommerce site, a database, or a third-party service.
quantity Integer The quantity of the particular item in the cart.
discountQuantity Integer Number of dicounted items.
initialQuantity Integer A positive integer in the smallest unit quantity representing the total amount of the order; this is the sum of the order items' quantity.
amount Integer The total amount of the order item (price * quantity).
discountAmount Integer Sum of all order-item-level discounts applied to the order.
appliedDiscountAmount Integer This field shows the order-level discount applied.
appliedDiscountQuantity Integer Number of the discounted items applied in the transaction.
appliedQuantity Integer Quantity of items changed by the application of a new quantity items. It can be positive when an item is added or negative if an item is replaced.
appliedQuantityAmount Integer Amount for the items changed by the application of a new quantity items. It can be positive when an item is added or negative if an item is replaced.
initialAmount Integer A positive integer in the smallest currency unit (e.g. 100 cents for $1.00) representing the total amount of the order. This is the sum of the order items' amounts.
price Integer Unit price of an item. Value is multiplied by 100 to precisely represent 2 decimal places. For example `10000 cents` for `$100.00`.
subtotalAmount Integer Final order item amount after the applied item-level discount. If there are no item-level discounts applied, this item is equal to the `amount`. `subtotal_amount`=`amount`-`applied_discount_amount`
product OrderCalculatedItemProduct
sku OrderCalculatedItemSku
_object ObjectEnum The type of the object represented by JSON.
metadata Object A set of custom key/value pairs that you can attach to an item object. It can be useful for storing additional information about the item in a structured format. It can be used to define business validation rules or discount formulas.

Enum: RelatedObjectEnum

Name Value
PRODUCT "product"
SKU "sku"

Enum: ObjectEnum

Name Value
ORDER_ITEM "order_item"