Skip to content
This repository has been archived by the owner on May 7, 2024. It is now read-only.

Latest commit

 

History

History
29 lines (26 loc) · 3.02 KB

OrdersGetResponseBody.md

File metadata and controls

29 lines (26 loc) · 3.02 KB

VoucherifySdk::OrdersGetResponseBody

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]
source_id String Unique source ID of an existing order that will be linked to the redemption of this request.
created_at Time Timestamp representing the date and time when the order was created in ISO 8601 format. [optional]
updated_at Time Timestamp representing the date and time when the order was last updated in ISO 8601 format. [optional]
status String 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]
initial_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]
discount_amount Integer Sum of all order-level discounts applied to the order. [optional]
items_discount_amount Integer Sum of all product-specific discounts applied to the order. [optional]
total_discount_amount Integer Sum of all order-level AND all product-specific discounts applied to the order. [optional]
total_amount Integer Order amount after undoing all the discounts through the rollback redemption. [optional]
applied_discount_amount Integer This field shows the order-level discount applied. [optional]
items_applied_discount_amount Integer Sum of all product-specific discounts applied in a particular request. `sum(items, i => i.applied_discount_amount)` [optional]
total_applied_discount_amount 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 Array<OrderItemCalculated> Array of items applied to the order. [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. [optional]
customer_id String Unique customer ID of the customer making the purchase.
referrer_id String Unique referrer ID.
object String The type of object represented by JSON. [default to 'order']
redemptions Hash<String, OrderRedemptions> [optional]
customer CustomerId [optional]
referrer ReferrerId [optional]