Skip to content

Latest commit

 

History

History
52 lines (36 loc) · 2.97 KB

OrderCalculatedBase.md

File metadata and controls

52 lines (36 loc) · 2.97 KB
Raw

OrderCalculatedBase

Order information.

Properties

Name Type Description
id String Unique ID assigned by Voucherify of an existing order that will be linked to the redemption of this request.
sourceId String Unique source ID of an existing order that will be linked to the redemption of this request.
createdAt OffsetDateTime Timestamp representing the date and time when the order was created. The value is shown in the ISO 8601 format.
updatedAt OffsetDateTime Timestamp representing the date and time when the order was last updated in ISO 8601 format.
status StatusEnum The order status.
amount 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.
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.
discountAmount Integer Sum of all order-level discounts applied to the order.
itemsDiscountAmount Integer Sum of all product-specific discounts applied to the order.
totalDiscountAmount Integer Sum of all order-level AND all product-specific discounts applied to the order.
totalAmount Integer Order amount after undoing all the discounts through the rollback redemption.
appliedDiscountAmount Integer This field shows the order-level discount applied.
itemsAppliedDiscountAmount Integer Sum of all product-specific discounts applied in a particular request. `sum(items, i => i.applied_discount_amount)`
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`
items List<OrderItemCalculated> Array of items applied to the order.
metadata Object A set of custom key/value pairs that you can attach to an order. It can be useful for storing additional information about the order in a structured format.
customerId String Unique customer ID of the customer making the purchase.
referrerId String Unique referrer ID.
_object ObjectEnum The type of the object represented by JSON.
redemptions Map<String, OrderRedemptions>

Enum: StatusEnum

Name Value
CREATED "CREATED"
PAID "PAID"
CANCELED "CANCELED"
FULFILLED "FULFILLED"

Enum: ObjectEnum

Name Value
ORDER "order"