Response body schema for GET /exports/{exportId}
.
Name | Type | Description |
---|---|---|
id | String | Unique export ID. |
_object | ObjectEnum | The type of object being represented. This object stores information about the export. |
createdAt | OffsetDateTime | Timestamp representing the date and time when the export was scheduled in ISO 8601 format. |
status | StatusEnum | 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. |
channel | String | The channel through which the export was triggered. |
result | ExportResult | |
userId | String | Identifies the specific user who initiated the export through the Voucherify Dashboard; returned when the channel value is WEBSITE. |
exportedObject | ExportedObjectEnum | |
parameters | ExportParameters |
Name | Value |
---|---|
EXPORT | "export" |
Name | Value |
---|---|
SCHEDULED | "SCHEDULED" |
IN_PROGRESS | "IN_PROGRESS" |
DONE | "DONE" |
ERROR | "ERROR" |
Name | Value |
---|---|
VOUCHER | "voucher" |
REDEMPTION | "redemption" |
CUSTOMER | "customer" |
PUBLICATION | "publication" |
ORDER | "order" |
POINTS_EXPIRATION | "points_expiration" |
VOUCHER_TRANSACTIONS | "voucher_transactions" |