Voucherify allows for launching product-specific promotions. For example, you can make a coupon valid only if a customer purchases a given product or apply a 10% discount if you detect the customer has an iPhone X 64GB in their cart. To start creating product-oriented deals, you should import your product catalog to Voucherify. You can achieve it in two ways, with the Dashboard, and through the API.
Object reference
Catalog structure
One product – many variants
Voucherify supports product → variants relationship by default. This means you can create a parent object (product) and attach several variants (SKUs). In the product object, you can define attributes to distinguish several SKUs. For example:
{
"id": "prod_yKHc4SyG1agSww",
"source_id": "internal_erp_id_1477390384",
"object": "product",
"name": "Apple iPhone 7",
"price" : 70000,
"attributes": [
"color",
"memory"
],
"created_at": "2016-10-25T10:12:58Z",
"skus": {
"object": "list",
"total": 0,
"data": []
}
}
{
"id":"sku_0KtP4rvwEECQ2U",
"source_id":"internal_erp_sku_id_1477475922",
"sku":"APPLE_IPHONE_7_BLACK_32",
"attributes":{
"color":"black",
"memory":"32"
},
"created_at":"2016-10-26T10:04:52Z",
"object":"sku",
"metadata": {
"country": "us"
}
}
Source_id
You can identify products using an internal
source_id.
Advanced catalog structure
If you want to map more advanced relationships like series, families, brands, etc. you should use metadata. By adding custom fields and applying respective validation rules in the metadata schema, you can model the whole structure for your inventory. You can mix the metadata-based relationships with products and SKUs.
{
"id": "prod_08c5bc59730e324dfb",
"source_id": null,
"name": "Headphones",
"price": 60000,
"attributes": [
"series",
"color"
],
"metadata": {
"category": 765,
"free_sample": true
},
"image_url": null,
"created_at": "2021-02-11T07:32:54.349Z",
"updated_at": "2021-02-11T11:00:03.995Z",
"object": "product",
"skus": {
"object": "list",
"total": 1,
"data_ref": "data",
"data": [
{
"id": "sku_08c5bc5abc8ab89468",
"source_id": null,
"product_id": "prod_08c5bc59730e324dfb",
"sku": "Headphones Limited Edition",
"price": 90000,
"currency": "USD",
"attributes": {
"color": "white",
"series": "543"
},
"image_url": null,
"metadata": {
"SALE": false,
"in_stock": "2021-02-01",
"free_sample": true
},
"created_at": "2021-02-11T07:32:55.666985+00:00",
"updated_at": "2021-02-11T11:00:04.256114+00:00",
"object": "sku"
}
]
}
}
{
"id": "sku_08c5bc5abc8ab89468",
"source_id": null,
"product_id": "prod_08c5bc59730e324dfb",
"sku": "Headphones Limited Edition",
"price": 90000,
"currency": "USD",
"attributes": {
"color": "white",
"series": "543"
},
"image_url": null,
"metadata": {
"SALE": false,
"in_stock": "2021-02-01",
"free_sample": true
},
"created_at": "2021-02-11T07:32:55.666Z",
"updated_at": "2021-02-11T11:00:04.256Z",
"object": "sku"
}
Validation of Product and SKU Metadata
When validating code or promotion, Voucherify treats SKUs as products. It means, that SKU inherits the metadata assigned to the product and combines product and SKU attributes. As a result, the SKUs will be considered in the evaluation of product-specific rules:
- validation process executes rules built with product metadata against all product SKUs;
- if you define a rule
discount applicable toa specific product id, the discount will be applied to the product and all product SKUs; - if you define a rule
discount applicable tobased on product metadata, the discount will be applied to the product or/and SKU that has a matching attribute in their metadata;
If you use product metadata satisfy in validation rules and pass product SKU in Validate Voucher or Redeem Voucher request, the app checks if SKU metadata match validation rules. If SKU metadata matches validation rules, validation is succeeded.
Validation rules with product metadata.
POST https://api.voucherify.io/v1/vouchers/SALE25/validate
{
"customer": {
"source_id": "[email protected]",
"name": "Stacey Orlando"
},
"order": {
"amount": 10200,
"items": [
{
"sku_id": "sku_08c5d46d5b5d787ab6",
"quantity": 1,
"metadata": {
"category": "SALE"
}
}
]
}
}
{
"code": "SALE25",
"discount": {
"type": "PERCENT",
"percent_off": 25.0
},
"tracking_id": "track_BX9Qc8nH77gbgQAq1OYBlx2yJcYhWIyyfIQXD6s23u0=",
"metadata": {},
"order": {
"amount": 10200,
"discount_amount": 2550,
"total_discount_amount": 2550,
"total_amount": 7650,
"items": [
{
"product_id": "prod_08c5d46d008a4f3e08",
"sku_id": "sku_08c5d46d5b5d787ab6",
"quantity": 1,
"price": 90000,
"amount": 90000,
"product": {
"id": "prod_08c5d46d008a4f3e08",
"name": "Headphones",
"price": 60000,
"metadata": {}
},
"sku": {
"id": "sku_08c5d46d5b5d787ab6",
"sku": "Headphones Limited Edition",
"price": 90000,
"metadata": {
"category": "SALE"
}
}
}
]
},
"valid": true,
"applicable_to": {
"data": [],
"object": "list",
"total": 0
}
}
Important notes
- If SKU and product have a different value for the same metadata definition, the SKU overwrites the product metadata value.
- Make sure you don't use different types of the same metadata definition in product and SKU schemas as it may break the validation process.
- to validate products against metadata-related rules you don't need to upload them to the app. When it comes to product SKUs, to validate SKUs and their metadata, you need to define them first via API or the UI.
Updated about a month ago