Order Calculated
All of:
- Order Response Base
-
Order Calculated
Attributes Description customer One of: Customer With Summary Loyalty Referrals, Customer Id referrer One of: Referrer With Summary Loyalty Referrals, Referrer Id
Order Response Base
Attributes | Description | ||||
---|---|---|---|---|---|
idstring | Unique ID assigned by Voucherify of an existing order that will be linked to the redemption of this request. | ||||
source_idstring , null | Unique source ID of an existing order that will be linked to the redemption of this request. | ||||
created_atstring | Timestamp representing the date and time when the order was created. The value is shown in the ISO 8601 format. Example:2021-12-22T10:13:06.487Z | ||||
updated_atstring , null | Timestamp representing the date and time when the order was last updated in ISO 8601 format. Example:2021-12-22T10:14:45.316Z | ||||
statusstring | The order status. Available values:CREATED , PAID , CANCELED , FULFILLED | ||||
amountinteger | 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. | ||||
initial_amountinteger | 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. | ||||
discount_amountinteger | Sum of all order-level discounts applied to the order. | ||||
items_discount_amountinteger | Sum of all product-specific discounts applied to the order. | ||||
total_discount_amountinteger | Sum of all order-level AND all product-specific discounts applied to the order. | ||||
total_amountinteger | Order amount after undoing all the discounts through the rollback redemption. | ||||
applied_discount_amountinteger | This field shows the order-level discount applied. | ||||
items_applied_discount_amountinteger | Sum of all product-specific discounts applied in a particular request. | ||||
total_applied_discount_amountinteger | Sum of all order-level AND all product-specific discounts applied in a particular request. | ||||
itemsarray | Array of items applied to the order. Array of Order Item Calculated | ||||
metadataobject | 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. | ||||
customer_idstring , null | Unique customer ID of the customer making the purchase. Example:cust_7iUa6ICKyU6gH40dBU25kQU1 | ||||
referrer_idstring , null | Unique referrer ID. Example:cust_nM4jqPiaXUvQdVSA6vTRUnix | ||||
objectstring | The type of object represented by JSON. Available values:order | ||||
redemptionsobject |
|
Customer With Summary Loyalty Referrals
All of:
-
Customer Response Data
Attributes Description id string
The ID of an existing customer that will be linked to redemption in this request.
source_id string
A unique identifier of the customer who validates a voucher. It can be a customer ID or email from a CRM system, database, or a third-party service. If you also pass a customer ID (unique ID assigned by Voucherify), the source ID will be ignored.
summary Customer Summary loyalty Customer Loyalty referrals Customer Referrals system_metadata object
Object used to store system metadata information.
created_at string
Timestamp representing the date and time when the customer was created. The value is shown in the ISO 8601 format.
Example:2022-08-30T06:32:07.380Z
updated_at string
Timestamp representing the date and time when the customer was updated. The value is shown in the ISO 8601 format.
Example:2022-08-31T06:32:07.380Z
assets object
Contains information about the customer's cockpit.
Attributes Description cockpit_url string
Customer's cockpit URL address.
object string
The type of object represented by JSON.
Available values:customer
- Customer Base
Customer Id
Attributes | Description |
---|---|
idstring | A unique identifier of an existing customer. |
objectstring | The type of object represented by JSON. Available values:customer |
Referrer With Summary Loyalty Referrals
Customer With Summary Loyalty Referrals
Referrer Id
Order Item Calculated
Attributes | Description | ||||||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
sku_idstring | A unique SKU ID assigned by Voucherify. | ||||||||||||||
product_idstring | A unique product ID assigned by Voucherify. | ||||||||||||||
related_objectstring | Used along with the source_id property, can be set to either sku or product. Available values:product , sku | ||||||||||||||
source_idstring | The merchant’s product/SKU ID (if it is different from the Voucherify product/SKU ID). It is useful in the integration between multiple systems. It can be an ID from an eCommerce site, a database, or a third-party service. | ||||||||||||||
quantityinteger | The quantity of the particular item in the cart. | ||||||||||||||
discount_quantityinteger | Number of dicounted items. | ||||||||||||||
initial_quantityinteger | A positive integer in the smallest unit quantity representing the total amount of the order; this is the sum of the order items' quantity. | ||||||||||||||
amountinteger | The total amount of the order item (price * quantity). | ||||||||||||||
discount_amountinteger | Sum of all order-item-level discounts applied to the order. | ||||||||||||||
applied_discount_amountinteger | This field shows the order-level discount applied. | ||||||||||||||
initial_amountinteger | 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. | ||||||||||||||
total_applied_discount_amountinteger | Sum of all order-level AND all product-specific discounts applied in a particular request. | ||||||||||||||
priceinteger | Unit price of an item. Value is multiplied by 100 to precisely represent 2 decimal places. For example | ||||||||||||||
subtotal_amountinteger | Final order item amount after the applied item-level discount. If there are no item-level discounts applied, this item is equal to the | ||||||||||||||
productobject | An object containing details of the related product.
| ||||||||||||||
skuobject | An object containing details of the related SKU.
| ||||||||||||||
objectstring | The type of object represented by JSON. Available values:order_item | ||||||||||||||
metadataobject | A set of custom key/value pairs that you can attach to an SKU. It can be useful for storing additional information about the SKU in a structured format. |
Order Redemptions
Attributes | Description |
---|---|
datestring | Timestamp representing the date and time when the redemption was created. The value is shown in the ISO 8601 format. Example:2022-09-02T17:06:56.649Z |
rollback_idstring | Unique ID of the redemption rollback. Example:rr_0c63c84eb78ee0a6c0 |
rollback_datestring | Timestamp representing the date and tiem when the redemption rollback was created. The value is shown in the ISO 8601 format. Example:2023-01-31T14:18:37.150Z |
related_object_typestring | The source of the incentive. |
related_object_idstring | Unique ID of the parent redemption. Example:r_0ba186c4824e4881e1 |
related_object_parent_idstring | 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. |
stackedarray | Contains a list of unique IDs of child redemptions, which belong to the stacked incentives. |
rollback_stackedarray | Lists the rollback redemption IDs of the particular child redemptions. |
Customer Summary
Attributes | Description |
---|---|
redemptions | See: Customer Summary Redemptions |
orders | See: Customer Summary Orders |
Customer Loyalty
Attributes | Description | ||||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|---|---|
pointsinteger | Customer's loyalty points. | ||||||||||||
referred_customersinteger | Total number of customers referred by the customer. | ||||||||||||
campaignsobject | Contains campaigns with details about point balances and how many customers were referred by the customer.
|
Customer Referrals
Customer Base
Attributes | Description | ||||||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
namestring | Customer's first and last name. | ||||||||||||||
descriptionstring | An arbitrary string that you can attach to a customer object. | ||||||||||||||
emailstring | Customer's email address. | ||||||||||||||
phonestring | Customer's phone number. This parameter is mandatory when you try to send out codes to customers via an SMS channel. | ||||||||||||||
birthdaystring |
| ||||||||||||||
birthdatestring | Customer's birthdate; format YYYY-MM-DD. | ||||||||||||||
addressobject , null | Customer's address.
| ||||||||||||||
metadataobject | A set of custom key/value pairs that you can attach to a customer. The metadata object stores all custom attributes assigned to the customer. It can be useful for storing additional information about the customer in a structured format. This metadata can be used for validating whether the customer qualifies for a discount or it can be used in building customer segments. |
Customer Summary Redemptions
Attributes | Description | ||||||
---|---|---|---|---|---|---|---|
total_redeemedinteger | Total number of redemptions made by the customer. | ||||||
total_failedinteger | Total number of redemptions that failed. | ||||||
total_succeededinteger | Total number of redemptions that succeeded. | ||||||
total_rolled_backinteger | Total number of redemptions that were rolled back for the customer. | ||||||
total_rollback_failedinteger | Total number of redemption rollbacks that failed. | ||||||
total_rollback_succeededinteger | Total number of redemption rollbacks that succeeded. | ||||||
giftobject | Summary of gift card credits.
| ||||||
loyalty_cardobject | Summary of loyalty points.
|
Customer Summary Orders
Attributes | Description |
---|---|
total_amountinteger | The total amount spent by the customer. Value is multiplied by 100 to precisely represent 2 decimal places. For example |
total_countinteger | Total number of orders made by the customer. |
average_amountinteger | Average amount spent on orders. |
last_order_amountinteger | Amount spent on last order. Value is multiplied by 100 to precisely represent 2 decimal places. For example |
last_order_datestring | Timestamp representing the date and time of the customer's last order in ISO 8601 format. Example:2022-08-30T11:51:08.029Z |