Skip to content

Latest commit

 

History

History
53 lines (37 loc) · 3.16 KB

RedemptionsGetResponseBodyOrder.md

File metadata and controls

53 lines (37 loc) · 3.16 KB
Raw

RedemptionsGetResponseBodyOrder

Properties

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

Enum: StatusEnum

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

Enum: ObjectEnum

Name Value
ORDER "order"