---
displayed_sidebar: homepage
---

import ParameterTypes from "@site/src/components/ParameterTypes"

# AdminBatchJobRes

 **AdminBatchJobRes**: `Object`

The batch job's details.

## Type declaration

<ParameterTypes parameters={[
  {
    "name": "batch_job",
    "type": "[BatchJob](../../entities/classes/entities.BatchJob.mdx)",
    "description": "Batch job details.",
    "optional": false,
    "defaultValue": "",
    "expandable": false,
    "children": [
      {
        "name": "canceled_at",
        "type": "`Date`",
        "description": "The date of the concellation.",
        "optional": true,
        "defaultValue": "",
        "expandable": false,
        "children": []
      },
      {
        "name": "completed_at",
        "type": "`Date`",
        "description": "The date of the completion.",
        "optional": true,
        "defaultValue": "",
        "expandable": false,
        "children": []
      },
      {
        "name": "confirmed_at",
        "type": "`Date`",
        "description": "The date when the confirmation has been done.",
        "optional": true,
        "defaultValue": "",
        "expandable": false,
        "children": []
      },
      {
        "name": "context",
        "type": "`Record<string, unknown>`",
        "description": "The context of the batch job, the type of the batch job determines what the context should contain.",
        "optional": false,
        "defaultValue": "",
        "expandable": false,
        "children": []
      },
      {
        "name": "created_at",
        "type": "`Date`",
        "description": "The date with timezone at which the resource was created.",
        "optional": false,
        "defaultValue": "",
        "expandable": false,
        "children": []
      },
      {
        "name": "created_by",
        "type": "`null` \\| `string`",
        "description": "The unique identifier of the user that created the batch job.",
        "optional": false,
        "defaultValue": "",
        "expandable": false,
        "children": []
      },
      {
        "name": "created_by_user",
        "type": "[User](../../entities/classes/entities.User.mdx)",
        "description": "The details of the user that created the batch job.",
        "optional": false,
        "defaultValue": "",
        "expandable": true,
        "children": []
      },
      {
        "name": "deleted_at",
        "type": "`null` \\| `Date`",
        "description": "The date with timezone at which the resource was deleted.",
        "optional": false,
        "defaultValue": "",
        "expandable": false,
        "children": []
      },
      {
        "name": "dry_run",
        "type": "`boolean`",
        "description": "Specify if the job must apply the modifications or not.",
        "optional": false,
        "defaultValue": "false",
        "expandable": false,
        "children": []
      },
      {
        "name": "failed_at",
        "type": "`Date`",
        "description": "The date when the job failed.",
        "optional": true,
        "defaultValue": "",
        "expandable": false,
        "children": []
      },
      {
        "name": "id",
        "type": "`string`",
        "description": "The unique identifier for the batch job.",
        "optional": false,
        "defaultValue": "",
        "expandable": false,
        "children": []
      },
      {
        "name": "pre_processed_at",
        "type": "`Date`",
        "description": "The date from which the job has been pre-processed.",
        "optional": true,
        "defaultValue": "",
        "expandable": false,
        "children": []
      },
      {
        "name": "processing_at",
        "type": "`Date`",
        "description": "The date the job is processing at.",
        "optional": true,
        "defaultValue": "",
        "expandable": false,
        "children": []
      },
      {
        "name": "result",
        "type": "`object` & `Record<string, unknown>`",
        "description": "The result of the batch job.",
        "optional": false,
        "defaultValue": "",
        "expandable": false,
        "children": []
      },
      {
        "name": "status",
        "type": "[BatchJobStatus](../enums/medusa.BatchJobStatus.mdx)",
        "description": "The status of the batch job.",
        "optional": false,
        "defaultValue": "created",
        "expandable": false,
        "children": []
      },
      {
        "name": "type",
        "type": "`string`",
        "description": "The type of batch job.",
        "optional": false,
        "defaultValue": "",
        "expandable": false,
        "children": []
      },
      {
        "name": "updated_at",
        "type": "`Date`",
        "description": "The date with timezone at which the resource was last updated.",
        "optional": false,
        "defaultValue": "",
        "expandable": false,
        "children": []
      }
    ]
  }
]} />
