Skip to content

Latest commit

 

History

History
30 lines (27 loc) · 3.33 KB

RedemptionEntryOrder.md

File metadata and controls

30 lines (27 loc) · 3.33 KB
Raw

# RedemptionEntryOrder

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]
status string The order status. [optional]
amount int 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 int 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 int Sum of all order-level discounts applied to the order. [optional]
itemsDiscountAmount int Sum of all product-specific discounts applied to the order. [optional]
totalDiscountAmount int Sum of all order-level AND all product-specific discounts applied to the order. [optional]
totalAmount int Order amount after undoing all the discounts through the rollback redemption. [optional]
appliedDiscountAmount int This field shows the order-level discount applied. [optional]
itemsAppliedDiscountAmount int Sum of all product-specific discounts applied in a particular request. `sum(items, i => i.applied_discount_amount)` [optional]
totalAppliedDiscountAmount int 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 \OpenAPI\Client\Model\OrderCalculatedItem[] Array of items applied to the order. It can include up 500 items. [optional]
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. It can be used to define business validation rules or discount formulas. [optional]
object string The type of the object represented by JSON. [optional] [default to 'order']
createdAt \DateTime Timestamp representing the date and time when the order was created. The value is shown in the ISO 8601 format. [optional]
updatedAt \DateTime Timestamp representing the date and time when the order was last updated in ISO 8601 format. [optional]
customerId string Unique customer ID of the customer making the purchase. [optional]
referrerId string Unique referrer ID. [optional]
customer \OpenAPI\Client\Model\RedemptionEntryOrderCustomer [optional]
referrer \OpenAPI\Client\Model\RedemptionEntryOrderReferrer [optional]
redemptions array<string,\OpenAPI\Client\Model\OrderRedemptionsEntry> [optional]

[Back to Model list] [Back to API list] [Back to README]