Redemption Rollback
Attributes | Description | ||||||
---|---|---|---|---|---|---|---|
idstring | Unique identifier of the redemption rollback. Example:rr_0efeb3dab05e62e599 | ||||||
objectstring | The type of the object represented by the JSON Available values:redemption_rollback | ||||||
datestring | Timestamp representing the date and time when the object was created. The value is shown in the ISO 8601 format. Example:2021-12-22T10:13:06.487Z | ||||||
customer_idstring , null | Unique customer ID of the redeeming customer. Example:cust_i8t5Tt6eiKG5K79KQlJ0Vs64 | ||||||
tracking_idstring , null | Hashed customer source ID. | ||||||
metadataobject , null | The metadata object stores all custom attributes assigned to the redemption. | ||||||
amountinteger | For gift cards, this represents the number of the credits restored to the card in the rolledback redemption. The number is a negative integer in the smallest currency unit, e.g. -100 cents for $1.00 added back to the card. -10000 | ||||||
redemptionstring , null | Unique redemption ID of the parent redemption. Example:r_0c656311b5878a2031 | ||||||
reasonstring | System generated cause for the redemption being invalid in the context of the provided parameters. | ||||||
resultstring | Redemption result. Available values:SUCCESS , FAILURE | ||||||
statusstring | Redemption status. Available values:SUCCEEDED , FAILED | ||||||
related_redemptionsobject | |||||||
failure_codestring | If the result is customer_rules_violated | ||||||
failure_messagestring | If the result is | ||||||
order | Order Calculated No Customer Data | ||||||
channelobject | Defines the details of the channel through which the redemption was issued.
| ||||||
customer | Simple Customer | ||||||
related_object_typestring | Defines the related object. Available values:voucher , promotion_tier , redemption | ||||||
related_object_idstring | Unique identifier of the related object. It is assigned by Voucherify, i.e. | ||||||
voucher | Defines the details of the voucher being originally redeemed. Voucher | ||||||
promotion_tier | Contains details of the promotion tier and the parent campaign. Promotion Tier | ||||||
reward | See: Redemption Reward Result | ||||||
giftobject | Contains the amount returned to the gift card in the redemption rollback. It is expressed as a negative integer.
| ||||||
loyalty_cardobject | Contains the number of points returned to the loyalty card in the reward redemption rollback. It is expressed as a negative integer.
|
Order Calculated No Customer Data
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. | ||||
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. It can include up 500 items. 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. It can be used to define business validation rules or discount formulas. | ||||
objectstring | The type of the object represented by JSON. Available values:order | ||||
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 | ||||
customer_idstring , null | Unique customer ID of the customer making the purchase. Example:cust_7iUa6ICKyU6gH40dBU25kQU1 | ||||
referrer_idstring , null | Unique referrer ID. Example:cust_nM4jqPiaXUvQdVSA6vTRUnix | ||||
customer | Customer Id | ||||
referrer | Referrer Id | ||||
redemptionsobject |
|
Simple Customer
Attributes | Description |
---|---|
idstring | Unique identifier of an existing customer. It is assigned by Voucherify. |
namestring | Customer's first and last name. |
emailstring | Customer's email address. |
source_idstring | A unique identifier of the customer. It can be a customer ID or email from a CRM system, database, or a third-party service. |
metadataobject | A set of custom key/value pairs that are attached to the customer. It stores all custom attributes assigned to the customer. |
objectstring | The type of the object represented by JSON. Available values:customer |
Voucher
This is an object representing a voucher with categories and validation rules assignments.
All of:
- Voucher Base
-
Attributes Description categories array
Contains details about the category.
Array of Categoryvalidation_rules_assignments See: Validation Rules Assignments List
Promotion Tier
Attributes | Description | ||||||||||||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
idstring | Unique promotion tier ID. Example:promo_63fYCt81Aw0h7lzyRkrGZh9p | ||||||||||||||||||||
created_atstring | Timestamp representing the date and time when the promotion tier was created. The value is shown in the ISO 8601 format. Example:2021-12-15T11:34:01.333Z | ||||||||||||||||||||
updated_atstring | Timestamp representing the date and time when the promotion tier was updated. The value is shown in the ISO 8601 format. Example:2022-02-09T09:20:05.603Z | ||||||||||||||||||||
namestring | Name of the promotion tier. | ||||||||||||||||||||
bannerstring | Text to be displayed to your customers on your website. | ||||||||||||||||||||
actionobject | Contains details about the discount applied by the promotion tier.
| ||||||||||||||||||||
metadataobject | The metadata object stores all custom attributes assigned to the promotion tier. A set of key/value pairs that you can attach to a promotion tier object. It can be useful for storing additional information about the promotion tier in a structured format. | ||||||||||||||||||||
hierarchyinteger | The promotions hierarchy defines the order in which the discounts from different tiers will be applied to a customer's order. If a customer qualifies for discounts from more than one tier, discounts will be applied in the order defined in the hierarchy. | ||||||||||||||||||||
promotion_idstring | Promotion unique ID. | ||||||||||||||||||||
campaignobject | Contains details about promotion tier's parent campaign.
| ||||||||||||||||||||
campaign_idstring | Promotion tier's parent campaign's unique ID. | ||||||||||||||||||||
activeboolean | A flag to toggle the promotion tier on or off. You can disable a promotion tier even though it's within the active period defined by the
| ||||||||||||||||||||
start_datestring | Activation timestamp defines when the promotion tier starts to be active in ISO 8601 format. Promotion tier is inactive before this date. Example:2022-09-23T00:00:00.000Z | ||||||||||||||||||||
expiration_datestring | Activation timestamp defines when the promotion tier expires in ISO 8601 format. Promotion tier is inactive after this date. Example:2022-09-26T00:00:00.000Z | ||||||||||||||||||||
validity_timeframe | See: Validity Timeframe | ||||||||||||||||||||
validity_day_of_week | See: Validity Day Of Week | ||||||||||||||||||||
validity_hours | See: Validity Hours | ||||||||||||||||||||
summaryobject | Contains statistics about promotion tier redemptions and orders.
| ||||||||||||||||||||
objectstring | The type of the object represented by JSON. This object stores information about the promotion tier. | ||||||||||||||||||||
validation_rule_assignments | See: Validation Rule Assignments List | ||||||||||||||||||||
category_idstring | Promotion tier category ID. Example:cat_0c9da30e7116ba6bba | ||||||||||||||||||||
categoriesarray | Array of Category |
Redemption Reward Result
Attributes | Description | ||||||||||||||||||||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
customer | Simple Customer | ||||||||||||||||||||||||||||
assignment_idstring , null | Unique reward assignment ID assigned by Voucherify. | ||||||||||||||||||||||||||||
voucher | Voucher | ||||||||||||||||||||||||||||
product | Product | ||||||||||||||||||||||||||||
sku | SKU Object | ||||||||||||||||||||||||||||
loyalty_tier_idstring , null | Unique loyalty tier ID assigned by Voucherify. | ||||||||||||||||||||||||||||
idstring | Unique reward ID. Example:rew_0bc92f81a6801f9bca | ||||||||||||||||||||||||||||
namestring | Name of the reward. Example:Reward Name | ||||||||||||||||||||||||||||
objectstring | The type of the object represented by the JSON Available values:reward | ||||||||||||||||||||||||||||
created_atstring | Timestamp representing the date and time when the redemption was created. The value is shown in the ISO 8601 format. Example:2021-12-22T10:13:06.487Z | ||||||||||||||||||||||||||||
updated_atstring | Timestamp in ISO 8601 format indicating when the reward was updated. Example:2022-10-03T12:24:58.008Z | ||||||||||||||||||||||||||||
parametersobject | These are parameters representing a material reward.
| ||||||||||||||||||||||||||||
metadataobject | A set of custom key/value pairs that you can attach to a reward. The metadata object stores all custom attributes assigned to the reward. | ||||||||||||||||||||||||||||
typestring | Reward type. Available values:CAMPAIGN , COIN , MATERIAL |
Order Item Calculated
Attributes | Description | ||||||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
idstring | Unique identifier of the order line item. | ||||||||||||||
sku_idstring | Unique identifier of the SKU. It is assigned by Voucherify. | ||||||||||||||
product_idstring | Unique identifier of the product. It is 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. | ||||||||||||||
applied_discount_quantityinteger | Number of the discounted items applied in the transaction. | ||||||||||||||
applied_quantityinteger | Quantity of items changed by the application of a new quantity items. It can be positive when an item is added or negative if an item is replaced. | ||||||||||||||
applied_quantity_amountinteger | Amount for the items changed by the application of a new quantity items. It can be positive when an item is added or negative if an item is replaced. | ||||||||||||||
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. | ||||||||||||||
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 the object represented by JSON. Available values:order_item | ||||||||||||||
metadataobject | A set of custom key/value pairs that you can attach to an item object. It can be useful for storing additional information about the item in a structured format. It can be used to define business validation rules or discount formulas. |
Customer Id
Attributes | Description |
---|---|
idstring | A unique identifier of an existing customer. |
objectstring | The type of the object represented by JSON. Available values:customer |
Referrer Id
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. |
Voucher Base
Attributes | Description | ||||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|---|---|
idstring | Assigned by the Voucherify API, identifies the voucher. Example:v_mkZN9v7vjYUadXnHrMza8W5c34fE5KiV | ||||||||||||
codestring | A code that identifies a voucher. Pattern can use all letters of the English alphabet, Arabic numerals, and special characters. Example:WVPblOYX | ||||||||||||
campaignstring | A unique campaign name, identifies the voucher's parent campaign. Example:Gift Card Campaign | ||||||||||||
campaign_idstring | Assigned by the Voucherify API, identifies the voucher's parent campaign. Example:camp_FNYR4jhqZBM9xTptxDGgeNBV | ||||||||||||
categorystring | Tag defining the category that this voucher belongs to. Useful when listing vouchers using the List Vouchers endpoint. | ||||||||||||
category_idstring | Unique category ID assigned by Voucherify. Example:cat_0bb343dee3cdb5ec0c | ||||||||||||
typestring | Defines the type of the voucher. Available values:GIFT_VOUCHER , DISCOUNT_VOUCHER , LOYALTY_CARD | ||||||||||||
discount | See: Discount | ||||||||||||
giftobject | Object representing gift parameters. Child attributes are present only if
| ||||||||||||
loyalty_cardobject | Object representing loyalty card parameters. Child attributes are present only if
| ||||||||||||
start_datestring | Activation timestamp defines when the code starts to be active in ISO 8601 format. Voucher is inactive before this date. Example:2021-12-01T00:00:00.000Z | ||||||||||||
expiration_datestring | Expiration timestamp defines when the code expires in ISO 8601 format. Voucher is inactive after this date. Example:2021-12-31T00:00:00.000Z | ||||||||||||
validity_timeframe | See: Validity Timeframe | ||||||||||||
validity_day_of_week | See: Validity Day Of Week | ||||||||||||
validity_hours | See: Validity Hours | ||||||||||||
activeboolean , null | A flag to toggle the voucher on or off. You can disable a voucher even though it's within the active period defined by the
| ||||||||||||
additional_infostring | An optional field to keep any extra textual information about the code such as a code description and details. | ||||||||||||
metadataobject | The metadata object stores all custom attributes assigned to the code. A set of key/value pairs that you can attach to a voucher object. It can be useful for storing additional information about the voucher in a structured format. | ||||||||||||
assets | See: Voucher Assets | ||||||||||||
is_referral_codeboolean , null | Flag indicating whether this voucher is a referral code; | ||||||||||||
created_atstring | Timestamp representing the date and time when the voucher was created. The value is shown in the ISO 8601 format. Example:2021-12-22T10:13:06.487Z | ||||||||||||
updated_atstring | Timestamp representing the date and time when the voucher was last updated in ISO 8601 format. Example:2021-12-22T10:14:45.316Z | ||||||||||||
holder_idstring | Unique customer identifier of the redeemable holder. It equals to the customer ID assigned by Voucherify. Example:cust_eWgXlBBiY6THFRJwX45Iakv4 | ||||||||||||
referrer_idstring | Unique identifier of the referring person. Example:cust_Vzck5i8U3OhcEUFY6MKhN9Rv | ||||||||||||
objectstring | The type of the object represented by JSON. Default is | ||||||||||||
publishobject | Stores a summary of publication events: an event counter and endpoint to return details of each event. Publication is an assignment of a code to a customer, e.g. through a distribution.
| ||||||||||||
redemptionobject | Stores a summary of redemptions that have been applied to the voucher.
|
Category
Attributes | Description |
---|---|
idstring | Unique category ID assigned by Voucherify. |
namestring | Category name. |
hierarchyinteger | Category hierarchy. Categories with lower hierarchy are processed before categories with higher hierarchy value. |
objectstring | The type of the object represented by the JSON. This object stores information about the category. Available values:category |
created_atstring | Timestamp representing the date and time when the category was created. The value is shown in the ISO 8601 format. Example:2022-07-14T10:45:13.156Z |
updated_atstring | Timestamp representing the date and time when the category was updated. The value is shown in the ISO 8601 format. Example:2022-08-16T10:52:08.094Z |
Validation Rules Assignments List
Attributes | Description |
---|---|
objectstring | The type of the object represented by JSON. This object stores information about validation rules assignments. Available values:list |
data_refstring | Identifies the name of the attribute that contains the array of validation rules assignments. Available values:data |
dataarray | Contains array of validation rules assignments. Array of Business Validation Rule Assignment |
totalinteger | Total number of validation rules assignments. |
Discount
Contains information about discount.
One of:
Amount, Unit, Unit Multiple, Percent, Fixed
Validity Timeframe
Attributes | Description |
---|---|
durationstring | Defines the amount of time an earning rule will be active in ISO 8601 format. For example, an earning rule with a PT1H |
intervalstring | Defines the intervening time between two time points in ISO 8601 format, expressed as a duration. For example, an earning rule with an P2D |
Validity Day Of Week
Integer array corresponding to the particular days of the week in which the voucher is valid.
0
Sunday1
Monday2
Tuesday3
Wednesday4
Thursday5
Friday6
Saturday
Validity Hours
Attributes | Description | ||||||||
---|---|---|---|---|---|---|---|---|---|
dailyarray | Defines the reccuring period(s) when the resource is active. The periods should not overlap. Array of:
|
Validation Rule Assignments List
Attributes | Description |
---|---|
objectstring | The type of the object represented by JSON. This object stores information about validation rule assignments. |
data_refstring | Identifies the name of the JSON property that contains the array of validation rule assignments. |
dataarray | A dictionary that contains an array of validation rule assignments. Array of Validation Rule Assignment |
totalinteger | Total number of validation rule assignments. |
Product
This is an object representing a product.
This entity should be used to map product items from your inventory management system. The aim of products is to build which reflect product-specific campaigns.
All of:
- Product without Skus Object
-
Attributes Description skus See: Skus List For Product
SKU Object
Attributes | Description |
---|---|
idstring | A unique identifier that represents the SKU and is assigned by Voucherify. Example:sku_0b1621b319d248b79f |
source_idstring , null | A unique SKU identifier from your inventory system. Example:sku_source_id_4 |
product_idstring | The parent product's unique ID. Example:prod_0b15f6b9f650c16990 |
skustring , null | Unique user-defined SKU name. Example:Large Pink Shirt |
priceinteger , null | Unit price. It is represented by a value multiplied by 100 to accurately reflect 2 decimal places, such as |
currencystring , null | SKU price currency. Example:USD |
attributesobject | The attributes object stores values for all custom attributes inherited by the SKU from the parent product. A set of key/value pairs that are attached to a SKU object and are unique to each SKU within a product family. |
image_urlstring , null | The HTTPS URL pointing to the .png or .jpg file that will be used to render the SKU image. |
metadataobject | The metadata object stores all custom attributes assigned to the SKU. A set of key/value pairs that you can attach to a SKU object. It can be useful for storing additional information about the SKU in a structured format. It can be used to create product collections. |
created_atstring | Timestamp representing the date and time when the SKU was created. The value is shown in the ISO 8601 format. Example:2022-05-17T10:36:30.187Z |
updated_atstring , null | Timestamp representing the date and time when the SKU was updated. The value is shown in the ISO 8601 format. Example:2022-05-17T10:55:09.137Z |
objectstring | The type of the object represented by JSON. This object stores information about the sku |
Voucher Assets
Attributes | Description | ||||||
---|---|---|---|---|---|---|---|
qrobject | Stores Quick Response (QR) representation of encrypted code.
| ||||||
barcodeobject | Stores barcode representation of encrypted code.
|
Business Validation Rule Assignment
Attributes | Description |
---|---|
idstring | The unique identifier for a assignment |
rule_idstring | The unique identifier for a rule |
related_object_idstring | The unique identifier for a related object |
related_object_typestring | The type of related object |
created_atstring | Timestamp representing the date and time when the object was created. The value is shown in the ISO 8601 format. Example:2022-03-09T11:19:04.819Z |
updated_atstring | Timestamp representing the date and time when the object was last updated in ISO 8601 format. Example:2022-03-09T11:19:04.819Z |
objectstring | The type of the object represented by JSON. Available values:validation_rules_assignment |
validation_statusstring | The validation status of the assignment Available values:VALID , PARTIALLY_VALID , INVALID |
validation_omitted_rulesarray | The list of omitted rules |
Amount
Attributes | Description |
---|---|
typestring | Defines the type of the voucher. Available values:AMOUNT |
amount_offnumber | Amount taken off the subtotal of a price. Value is multiplied by 100 to precisely represent 2 decimal places. For example, a $10 discount is written as 1000. |
amount_off_formulastring | |
aggregated_amount_limitinteger | Maximum discount amount per order. |
effect | Defines how the discount is applied to the customer's order. Discount Amount Vouchers Effect Types |
is_dynamicboolean | Flag indicating whether the discount was calculated using a formula. |
Unit
Attributes | Description |
---|---|
typestring | Discount type. Available values:UNIT |
unit_offinteger | Number of units to be granted a full value discount. |
unit_off_formulastring | |
effect | Defines how the unit is added to the customer's order. Discount Unit Vouchers Effect Types |
unit_typestring | The product deemed as free, chosen from product inventory (e.g. time, items). |
product | Contains information about the product. Simple Product Discount Unit |
sku | See: Simple Sku Discount Unit |
is_dynamicboolean | Flag indicating whether the discount was calculated using a formula. |
Unit Multiple
Attributes | Description |
---|---|
typestring | Discount type. Available values:UNIT |
effectstring | Defines how the discount is applied to the customer's order. Available values:ADD_MANY_ITEMS |
unitsarray | Array of One Unit |
Percent
Attributes | Description |
---|---|
typestring | Defines the type of the voucher. Available values:PERCENT |
percent_offnumber | The percent discount that the customer will receive. |
percent_off_formulastring | |
amount_limitnumber | Upper limit allowed to be applied as a discount. Value is multiplied by 100 to precisely represent 2 decimal places. For example, a $6 maximum discount is written as 600. |
aggregated_amount_limitinteger | Maximum discount amount per order. |
effect | Defines how the discount is applied to the customer's order. Discount Percent Vouchers Effect Types |
is_dynamicboolean | Flag indicating whether the discount was calculated using a formula. |
Fixed
Attributes | Description |
---|---|
typestring | Defines the type of the voucher. Available values:FIXED |
fixed_amountnumber | Sets a fixed value for an order total or the item price. The value is multiplied by 100 to precisely represent 2 decimal places. For example, a $10 discount is written as 1000. If the fixed amount is calculated by the formula, i.e. the |
fixed_amount_formulastring | |
effect | Defines how the discount is applied to the customer's order. Discount Fixed Vouchers Effect Types |
is_dynamicboolean | Flag indicating whether the discount was calculated using a formula. |
Validation Rule Assignment
Attributes | Description |
---|---|
idstring | Validation rule assignment ID. Example:asgm_74F7QZoYbUoljwQO |
rule_idstring | Validation rule ID. Example:val_4j7DCRm2IS59 |
related_object_idstring | The resource ID to which the validation rule was assigned. Example:v_JtWunK6jUo7X2qOFj0SyRHq4p9tgENlT |
related_object_typestring | The type of resource to which the validation rule was assigned. Available values:voucher , campaign , earning_rule , reward_assignment , promotion_tier , distribution |
created_atstring | Timestamp representing the date and time when the validation rule assignment was created. The value is shown in the ISO 8601 format. Example:2022-02-17T08:18:15.085Z |
objectstring | The type of the object represented by the ID. Available values:validation_rules_assignment |
Product without Skus Object
Attributes | Description |
---|---|
idstring | Unique product ID assigned by Voucherify. Example:prod_0b1da8105693710357 |
source_idstring , null | Unique product source ID. Example:productSourceID16 |
namestring , null | Unique user-defined product name. Example:T-shirt |
priceinteger , null | Unit price. It is represented by a value multiplied by 100 to accurately reflect 2 decimal places, such as |
attributesarray | A list of product attributes whose values you can customize for given SKUs: |
metadataobject | The metadata object stores all custom attributes assigned to the product. A set of key/value pairs that you can attach to a product object. It can be useful for storing additional information about the product in a structured format. It can be used to create product collections. |
image_urlstring , null | The HTTPS URL pointing to the .png or .jpg file that will be used to render the product image. Example: |
created_atstring | Timestamp representing the date and time when the product was created. The value is shown in the ISO 8601 format. Example:2022-05-23T06:52:55.008Z |
updated_atstring , null | Timestamp representing the date and time when the product was updated. The value is shown in the ISO 8601 format. Example:2022-05-23T09:24:07.405Z |
objectstring | The type of the object represented by JSON. This object stores information about the product. Available values:product |
Skus List For Product
Attributes | Description |
---|---|
objectstring | The type of the object represented by JSON. This object stores information about SKUs. |
data_refstring | Identifies the name of the JSON property that contains the array of SKUs. |
dataarray | A dictionary that contains an array of SKUs. Array of SKU Object |
totalinteger | Total number of SKUs in the product. |
Discount Amount Vouchers Effect Types
Available values: APPLY_TO_ORDER
, APPLY_TO_ITEMS
, APPLY_TO_ITEMS_PROPORTIONALLY
, APPLY_TO_ITEMS_PROPORTIONALLY_BY_QUANTITY
, APPLY_TO_ITEMS_BY_QUANTITY
Discount Unit Vouchers Effect Types
Available values: ADD_MISSING_ITEMS
, ADD_NEW_ITEMS
, ADD_MANY_ITEMS
Simple Product Discount Unit
Attributes | Description |
---|---|
idstring | Unique product ID, assigned by Voucherify. |
source_idstring | Product's source ID. |
namestring | Product name. |
Simple Sku Discount Unit
Attributes | Description |
---|---|
idstring | Unique SKU ID, assigned by Voucherify. |
source_idstring | Product variant's source ID. |
namestring | Sku name |
One Unit
Attributes | Description |
---|---|
unit_offnumber | Number of units to be granted a full value discount. |
unit_off_formulastring | |
effectstring | Defines how the unit is added to the customer's order. Available values:ADD_NEW_ITEMS , ADD_MISSING_ITEMS |
unit_typestring | The product deemed as free, chosen from product inventory (e.g. time, items). |
product | Contains information about the product. Simple Product Discount Unit |
sku | Contains information about the sku. Simple Sku Discount Unit |
Discount Percent Vouchers Effect Types
Available values: APPLY_TO_ORDER
, APPLY_TO_ITEMS
Discount Fixed Vouchers Effect Types
Available values: APPLY_TO_ORDER
, APPLY_TO_ITEMS