The merchant’s order ID if it is different from the Voucherify order ID. It is really useful in case of integration between multiple systems. It can be an order ID from CRM, database or 3rd party service.
created_at
Timestamp representing the date and time when the order was created in ISO 8601 format.
2022-03-09T11:19:04.819Z
updated_at
Timestamp representing the date and time when the order was updated in ISO 8601 format.
2022-08-12T13:34:10.681Z
status
Order status.
Available values: CREATED, PAID, CANCELED, FULFILLED
amount
Order amount before applying any discount.
discount_amount
Sum of all order-level discounts applied to the order.
items_discount_amount
Sum of all product-specific discounts applied to the order. sum(items, i => i.discount_amount)
total_discount_amount
Sum of all order-level AND all product-specific discounts applied to the order. total_discount_amount = discount_amount + items_discount_amount
total_amount
Order amount after applying all the discounts. total_amount = amount - total_discount_amount
items
Array of order items that have been applied to the order. Each order item can show the effects of particular discounts on the item-level.
Array of:
Attributes
Description
Example
object
The type of object represented by JSON. This object stores information about the order_item.
product_id
A unique identifier that represents the product and is assigned by Voucherify.
prod_5h0wc453_1
sku_id
A unique identifier that represents the SKU and is assigned by Voucherify.
sku_prod_5h0wc453_1_1
quantity
Quantity of the item in the cart.
amount
Represents a total pre-discount amount of order item (price * quantity).
discount_amount
The item-level discount applied to the item.
price
Unit price of an item. Value is multiplied by 100 to precisely represent 2 decimal places. For example, $100 is written as 10000.
subtotal_amount
Final order item amount after the applied item-level discount. If there are no item-level discounts applied, this item is equal to the amount. subtotal_amount=amount-discount_amount
product
This object stores more information about the related product.
Attributes
Description
Example
id
A unique identifier that represents the product and is assigned by Voucherify.
prod_5h0wc453_1
source_id
A unique product identifier from your inventory system.
illy-arabica
name
Product name.
Brewing System
price
Unit price of a product. Value is multiplied by 100 to precisely represent 2 decimal places. For example, $100 is written as 10000.
sku
This object stores more information about the related SKU.
Attributes
Description
Example
id
A unique identifier that represents the SKU and is assigned by Voucherify.
sku_prod_5h0wc453_1_1
source_id
A unique SKU identifier from your inventory system.
illy-arabica-250g
sku
SKU name.
price
Unit price of a SKU. Value is multiplied by 100 to precisely represent 2 decimal places. For example, $100 is written as 10000.
metadata
The metadata object stores all custom attributes assigned to the order. A set of key/value pairs that are attached to an order object. Stores additional information about the order in a structured format.
customer
Object containing information about the customer that is making the purchase.
Attributes
Description
Example
id
Unique customer ID of the customer making the purchase.
cust_7iUa6ICKyU6gH40dBU25kQU1
object
Type of object represented by the customer object.
referrer
Object containing information about the referrer.
Attributes
Description
Example
id
Unique referrer ID, who referred the customer making the purchase.
cust_7iUa6ICKyU6gH40dBU25kQU1
object
Type of object represented by the referrer object.
customer_id
Unique customer ID of the customer making the purchase.
cust_7iUa6ICKyU6gH40dBU25kQU1
referrer_id
Unique referrer ID.
cust_nM4jqPiaXUvQdVSA6vTRUnix
object
The type of object represented by JSON. This object stores information about the order.
redemptions
One of:
Unstacked Redemption
Attributes
Description
Example
redemption_ID
The property name is the unique redemption ID; i.e. r_0ba186c4824e4881e1. This object contains information about the redemption of an incentive.
Attributes
Description
Example
date
Timestamp representing the date and time when the redemption was created in ISO 8601 format.
2022-09-02T17:06:56.649Z
related_object_type
The source of the incentive.
Available values: voucher, promotion_tier
related_object_id
Unique ID of the related object that defines the incentive.
related_object_parent_id
Represent's the campaign ID of the voucher if the redemption was based on a voucher that was part of bulk codes generated within a campaign. In case of a promotion tier, this represents the campaign ID of the promotion tier's parent campaign.
Stacked Redemption
Attributes
Description
Example
redemption_ID
The property name is the unique parent redemption ID; i.e. r_0ba186c4824e4881e1. This object contains information about the redemption of multiple incentives.
Attributes
Description
Example
date
Timestamp representing the date and time when the redemption was created in ISO 8601 format.
2022-09-02T17:06:56.649Z
related_object_type
The source of the incentive.
related_object_id
Unique ID of the parent redemption.
r_0ba186c4824e4881e1
stacked
Contains a list of unique IDs of child redemptions, which belong to the stacked incentives.
Language
URL
Click Try It! to start a request and see the response here!
