CSV export with API

Voucherify enables programmable export of the following objects to a CSV file:

• vouchers,
• redemptions,
• publications,
• customers,
• orders,
• products,
• SKUs,
• point expirations,
• voucher transactions

How to export data to CSV

1. Trigger the export with Create Export and store the id of the export object you’ll get in the response from Voucherify.

2. Get the export’s status providing the id and take a look at the status field from the response. If it’s still SCHEDULED, this means that the export is still in progress and you should ask later.

3. When the status is finally DONE, the result will store the URL as in the example below:

Response

{
  "id": "export_lhZvHKphiMESVdIncRKvoaZh",
  "object": "export",
  "created_at": "2017-02-24T14:03:00.196Z",
  "status": "DONE",
  "channel": "API",
  "exported_object": "voucher",
  "parameters": {
    "fields": [
      "code",
      "voucher_type"
    ],
    "filter": {
      "categories": {
        "conditions": {
          "$in": [
            "postman"
          ]
        }
      }
    }
  },
  "result": {
    "url": "https://download.voucherify.io/v1/exports/export_lhZvHKphiMESVdIncRKvoaZh?token=TOKEN"
  }
}

4. To download the export file, use the provided URL together with authentication headers.

The download URL stays valid for 90 days after the file is generated. Voucherify removes the file after 90 days. Deleting the export removes the file immediately.

File size and number of objects

One export request produces a single CSV file with every object that matches the filters. The file can be any size and can include any number of objects. Larger exports take longer to generate. Use a time range or other filters when you want a smaller file.

Filters

Voucherify allows you to specify the time frame for the records you want to retrieve. Thanks to this mechanism, it should be easy to implement a pagination mechanism. See the example of a request body:

Request

{
   "exported_object":"redemption",
   "parameters":{
      "order":"-created_at",
      "fields":[
         "id",
         "object",
         "date",
         "voucher_code",
         "customer_id",
         "result"
      ],
      "filters":{
         "junction":"and",
         "created_at":{
            "conditions":{
               "$after":[
                  "2018-05-30T22:00:00.000Z"
               ],
               "$before":[
                  "2018-06-29T22:00:00.000Z"
               ]
            }
         }
      }
   }
}