Response body schema for PUT v1/orders/{orderId}
.
Name | Type | Description | Notes |
---|---|---|---|
id | str | Unique ID assigned by Voucherify of an existing order that will be linked to the redemption of this request. | [optional] |
source_id | str | Unique source ID of an existing order that will be linked to the redemption of this request. | [optional] |
status | str | 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] |
initial_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] |
discount_amount | int | Sum of all order-level discounts applied to the order. | [optional] |
items_discount_amount | int | Sum of all product-specific discounts applied to the order. | [optional] |
total_discount_amount | int | Sum of all order-level AND all product-specific discounts applied to the order. | [optional] |
total_amount | int | Order amount after undoing all the discounts through the rollback redemption. | [optional] |
applied_discount_amount | int | This field shows the order-level discount applied. | [optional] |
items_applied_discount_amount | int | Sum of all product-specific discounts applied in a particular request. `sum(items, i => i.applied_discount_amount)` | [optional] |
total_applied_discount_amount | 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 | List[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 | str | The type of the object represented by JSON. | [optional] [default to 'order'] |
created_at | datetime | Timestamp representing the date and time when the order was created. The value is shown in the ISO 8601 format. | [optional] |
updated_at | datetime | Timestamp representing the date and time when the order was last updated in ISO 8601 format. | [optional] |
customer_id | str | Unique customer ID of the customer making the purchase. | [optional] |
referrer_id | str | Unique referrer ID. | [optional] |
customer | CustomerId | [optional] | |
referrer | ReferrerId | [optional] | |
redemptions | object | [optional] |