54 lines (30 loc) · 1.78 KB

CampaignsTransactionsExportCreateResponseBody

Response body schema for POST v1/campaigns/{campaignId}/transactions/export.

Properties

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	ChannelEnum	The channel through which the export was triggered.
exportedObject	ExportedObjectEnum	The type of exported object.
parameters	CampaignsTransactionsExportCreateResponseBodyParameters
result	CampaignsTransactionsExportCreateResponseBodyResult
userId	String	Identifies the specific user who initiated the export through the Voucherify Dashboard; returned when the `channel` value is `WEBSITE`.

Enum: ObjectEnum

Name	Value
EXPORT	"export"

Enum: StatusEnum

Name	Value
SCHEDULED	"SCHEDULED"

Enum: ChannelEnum

Name	Value
API	"API"

Enum: ExportedObjectEnum

Name	Value
VOUCHER_TRANSACTIONS	"voucher_transactions"