Skip to content

Latest commit

 

History

History
47 lines (31 loc) · 2.81 KB

OrderItemCalculated.md

File metadata and controls

47 lines (31 loc) · 2.81 KB

OrderItemCalculated

Properties

Name Type Description
skuId String A unique SKU ID assigned by Voucherify.
productId String A unique product ID 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.
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.
totalAppliedDiscountAmount Integer Sum of all order-level AND all product-specific discounts applied in a particular request. `total_applied_discount_amount` = `applied_discount_amount` + `items_applied_discount_amount`
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 OrderItemCalculatedProduct
sku OrderItemCalculatedSku
_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 SKU. It can be useful for storing additional information about the SKU in a structured format.

Enum: RelatedObjectEnum

Name Value
PRODUCT "product"
SKU "sku"

Enum: ObjectEnum

Name Value
ORDER_ITEM "order_item"