Skip to main content
POST
Create Export Schedule

Authorizations

Authorization
string
header
required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Query Parameters

fields
string

Comma-separated list of fields to include in the response. Supports dot notation for nested projection (e.g. id,name,user.email,trips.route.id). Unknown fields are silently dropped.

Body

application/json

Create scheduled export payload

columns
string[]
required

Requested export columns

Minimum array length: 1
Example:
filters
object
required

Requested export filters by field

resource
string
required

Export resource key

Example:

"order"

format
enum<string>
required

Export file format

Available options:
CSV,
XLSX
Example:

"CSV"

scheduledAt
string<date-time>
required
scopeType
enum<string>
required

Export scope type

Available options:
ORGANIZATION,
COMPANY,
COOPERATIVE,
BKO
Example:

"COMPANY"

fileNamePrefix
string | null

Generated file name prefix

Example:

"orders"

Response

Created

Export schedule

exportScheduledId
string<uuid>
required

Export schedule identifier

Example:

"0195e7a1-8b5c-7d3e-9f4a-2c6b8d0e1f3a"

requestedByUserId
string<uuid>
required

Requesting user identifier

Example:

"0195e7a1-8b5c-7d3e-9f4a-2c6b8d0e1f3d"

resource
string
required

Export resource key

Example:

"order"

scopeType
enum<string>
required

Export scope type

Available options:
ORGANIZATION,
COMPANY,
COOPERATIVE,
BKO
Example:

"COMPANY"

format
enum<string>
required

Export file format

Available options:
CSV,
XLSX
Example:

"CSV"

columns
string[]
required

Requested export columns

Minimum array length: 1
Example:
filters
object
required

Requested export filters by field

status
enum<string>
required

Scheduled export status

Available options:
SCHEDULED,
COMPLETED,
FAILED,
CANCELED
Example:

"SCHEDULED"

createdAt
string<date-time>
required

Creation timestamp

scheduledAt
string<date-time>
required

Scheduled execution timestamp

updatedAt
string<date-time>
required

Last update timestamp

organizationId
string<uuid> | null

Scoped organization identifier

Example:

"0195e7a1-8b5c-7d3e-9f4a-2c6b8d0e1f3b"

companyId
string<uuid> | null

Scoped company identifier

Example:

null

cooperativeId
string<uuid> | null

Scoped cooperative identifier

Example:

"0195e7a1-8b5c-7d3e-9f4a-2c6b8d0e1f3c"

fileNamePrefix
string | null

Generated file name prefix

Example:

"orders"

failureReason
string | null

Dispatch failure reason

Example:

null

deletedAt
string<date-time> | null

Soft deletion timestamp