curl --request GET \
--url https://{cluster}.voucherify.io/v1/exports/{exportId} \
--header 'X-App-Id: <api-key>' \
--header 'X-App-Token: <api-key>'{
"id": "exp_CGnCVltmWjI9V1pGlnunw2Nf",
"object": "export",
"created_at": "2022-01-13T09:03:18.293Z",
"status": "DONE",
"channel": "API",
"exported_object": "customer",
"parameters": {
"order": "",
"fields": [
"name",
"id",
"email",
"source_id",
"created_at"
],
"filters": {
"junction": "and"
},
"response_format": "CSV"
},
"result": {
"url": "{{internalVoucherifyURL}}"
},
"user_id": null
}{
"code": 404,
"key": "not_found",
"message": "Resource not found",
"details": "Cannot find export with id exp_8fNoLwgVPuhoxNzVsr50kq0",
"request_id": "v-0b029305af4524cf42",
"resource_id": "exp_8fNoLwgVPuhoxNzVsr50kq0",
"resource_type": "export"
}Retrieves the URL of the downloadable file, which was generated via the Create Export method.
curl --request GET \
--url https://{cluster}.voucherify.io/v1/exports/{exportId} \
--header 'X-App-Id: <api-key>' \
--header 'X-App-Token: <api-key>'{
"id": "exp_CGnCVltmWjI9V1pGlnunw2Nf",
"object": "export",
"created_at": "2022-01-13T09:03:18.293Z",
"status": "DONE",
"channel": "API",
"exported_object": "customer",
"parameters": {
"order": "",
"fields": [
"name",
"id",
"email",
"source_id",
"created_at"
],
"filters": {
"junction": "and"
},
"response_format": "CSV"
},
"result": {
"url": "{{internalVoucherifyURL}}"
},
"user_id": null
}{
"code": 404,
"key": "not_found",
"message": "Resource not found",
"details": "Cannot find export with id exp_8fNoLwgVPuhoxNzVsr50kq0",
"request_id": "v-0b029305af4524cf42",
"resource_id": "exp_8fNoLwgVPuhoxNzVsr50kq0",
"resource_type": "export"
}Authorizations
Path Parameters
Unique export object ID of previously created export. This object can be a: voucher, redemption, publication, customer, order, points_expiration, or voucher_transactions.
"exp_2bYLdY2lQ2886wmYIHyeBWUZ"
Response
Returns the export object if a valid identifier was provided in the path.
- Export Voucher
- Export Redemption
- Export Customers
- Export Publication
- Export Orders
- Export Points Expiration
- Export Vouchers Transactions
Response body schema for GET v1/exports/{exportId}.
Unique export ID.
The type of object being represented. This object stores information about the export.
export Timestamp representing the date and time when the export was scheduled in ISO 8601 format.
Status of the export. Informs you whether the export has already been completed, i.e. indicates whether the file containing the exported data has been generated.
SCHEDULED, IN_PROGRESS, DONE, ERROR Contains the URL of the CSV file.
Show child attributes
Show child attributes
Identifies the specific user who initiated the export through the Voucherify Dashboard; returned when the channel value is WEBSITE.
The type of object to be exported.
voucher The channel through which the export was triggered.
Show child attributes
Show child attributes
Was this page helpful?