BatchJob

A Batch Job indicates an asynchronus task stored in the Medusa backend. Its status determines whether it has been executed or not.

Properties

idstringRequired

The unique identifier for the batch job.

created_atDateRequired

The date with timezone at which the resource was created.

updated_atDateRequired

The date with timezone at which the resource was last updated.

deleted_atnull | DateRequired

The date with timezone at which the resource was deleted.

typestringRequired

The type of batch job.

created_bynull | stringRequired

The unique identifier of the user that created the batch job.

created_by_userUserRequired

The details of the user that created the batch job.

contextRecord<string, unknown>Required

The context of the batch job, the type of the batch job determines what the context should contain.

resultobject & Record<string, unknown>Required

The result of the batch job.

dry_runbooleanRequired

Specify if the job must apply the modifications or not.

Default: false

statusBatchJobStatusRequired

The status of the batch job.

Default: created

pre_processed_atDate

The date from which the job has been pre-processed.

processing_atDate

The date the job is processing at.

confirmed_atDate

The date when the confirmation has been done.

completed_atDate

The date of the completion.

canceled_atDate

The date of the concellation.

failed_atDate

The date when the job failed.