BatchJob
A Batch Job indicates an asynchronus task stored in the Medusa backend. Its status determines whether it has been executed or not.
Properties
id
stringRequiredThe unique identifier for the batch job.
created_at
DateRequiredThe date with timezone at which the resource was created.
updated_at
DateRequiredThe date with timezone at which the resource was last updated.
deleted_at
null | DateRequiredThe date with timezone at which the resource was deleted.
type
stringRequiredThe type of batch job.
created_by
null | stringRequiredThe unique identifier of the user that created the batch job.
The details of the user that created the batch job.
context
Record<string, unknown>RequiredThe context of the batch job, the type of the batch job determines what the context should contain.
result
object & Record<string, unknown>RequiredThe result of the batch job.
result
object & Record<string, unknown>Requireddry_run
booleanRequiredSpecify if the job must apply the modifications or not.
Default: false
The status of the batch job.Default: created
created
pre_processed_at
DateThe date from which the job has been pre-processed.
processing_at
DateThe date the job is processing at.
confirmed_at
DateThe date when the confirmation has been done.
completed_at
DateThe date of the completion.
canceled_at
DateThe date of the concellation.
failed_at
DateThe date when the job failed.
Was this section helpful?