ExportJob
ObjectRepresents a long-running export job.
Fields
- DateTime
completedAt When the job reached a terminal state.
- DateTime!
createdAt When the job was created.
- String
errorMessage A human-readable error message if the job has failed.
- Long
fileSizeBytes The size of the generated file in bytes.
- String
fileUrl A pre-signed URL pointing to the generated CSV file. Available once the job has succeeded.
- ID!
id The unique identifier of the export job.
- ExportJobKind!
kind The kind of data the job exports.
Possible enum valuesPRODUCTSExports product catalog data.
TRANSLATIONSExports translatable content.
- String!
requestedByEmail The email address the result was delivered to.
- String
requestedByName The display name of the requester, if available.
- String!
requestedByUserId The identifier of the user who requested the export.
- Long
rowCount The number of rows in the generated file.
- DateTime
startedAt When processing started.
- ExportJobStatus!
status The current status of the job.
Possible enum valuesFAILEDThe export stopped without producing a successful result.
PENDINGThe export is queued and has not started.
RUNNINGThe export is currently being generated.
SUCCEEDEDThe export completed successfully.
Queries
Retrieves an export job by its identifier.
Mutations
Starts a product export job. The CSV result is delivered to the requester’s email once complete.
Starts a translation export job. The CSV result is delivered to the requester’s email once complete.