The Voucherify Developer Hub

Welcome to the Voucherify developer hub. You'll find comprehensive guides and documentation to help you start working with Voucherify as quickly as possible, as well as support if you get stuck. Let's jump right in!

Get Started

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

Product object reference

SKU 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.

Updated about a month ago

Products


Suggested Edits are limited on API Reference Pages

You can only suggest edits to Markdown body content, but not to the API spec.