Create a Batch Job

Create a Batch Job to be executed asynchronously in the Medusa backend. If dry_run is set to true, the batch job will not be executed until the it is confirmed, which can be done using the Confirm Batch Job endpoint.

Request

Body Params application/json

type

string

required

The type of batch job to start, which is defined by the batchType property of the associated batch job strategy.

Example:

product-export

dry_run

boolean

optional

Set a batch job in dry_run mode, which would delay executing the batch job until it's confirmed.

Default:

false

context

object

required

Additional infomration regarding the batch to be used for processing.

Example:

{"list_config":{"skip":0,"take":50,"order":{"created_at":"DESC"},"relations":["variants","variant.prices","images"]},"shape":{"dynamicImageColumnCount":4,"dynamicOptionColumnCount":2,"prices":[{"region":null,"currency_code":"eur"}]}}

Example

{
  "type": "product-export",
  "dry_run": false,
  "context": {
    "list_config": {
      "skip": 0,
      "take": 50,
      "order": {
        "created_at": "DESC"
      },
      "relations": [
        "variants",
        "variant.prices",
        "images"
      ]
    },
    "shape": {
      "dynamicImageColumnCount": 4,
      "dynamicOptionColumnCount": 2,
      "prices": [
        {
          "region": null,
          "currency_code": "eur"
        }
      ]
    }
  }
}

Responses

🟢201OK

application/json

Body

batch_job

object (Batch Job)

required

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

string

required

The unique identifier for the batch job.

Example:

batch_01G8T782965PYFG0751G0Z38B4

created_by

string | null

required

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

Example:

usr_01G1G5V26F5TB3GPAPNJ8X1S3V

dry_run

boolean

required

Specify if the job must apply the modifications or not.

Default:

false

pre_processed_at

string <date-time> | null

required

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

processing_at

string <date-time> | null

required

The date the job is processing at.

confirmed_at

string <date-time> | null

required

The date when the confirmation has been done.

completed_at

string <date-time> | null

required

The date of the completion.

canceled_at

string <date-time> | null

required

The date of the concellation.

failed_at

string <date-time> | null

required

The date when the job failed.

created_at

string <date-time>

required

The date with timezone at which the resource was created.

updated_at

string <date-time>

required

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

deleted_at

string <date-time> | null

required

The date with timezone at which the resource was deleted.

type

enum<string>

required

The type of batch job.

Allowed values:

product-importproduct-export

status

enum<string>

required

The status of the batch job.

Allowed values:

createdpre_processedconfirmedprocessingcompletedcanceledfailed

Default:

created

context

object | null

required

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

Example:

result

object

required

The result of the batch job.

Examples:

{"stat_descriptors":[{"key":"product-export-count","name":"Product count to export","message":"There will be 8 products exported by this action"}],"errors":[{"code":"unknown","message":"Method not implemented.","err":[]}]}{}

created_by_user

object (User)

optional

A User is an administrator who can manage store settings and data.

Example

{
  "batch_job": {
    "id": "batch_01G8T782965PYFG0751G0Z38B4",
    "created_by": "usr_01G1G5V26F5TB3GPAPNJ8X1S3V",
    "dry_run": false,
    "pre_processed_at": "2019-08-24T14:15:22Z",
    "processing_at": "2019-08-24T14:15:22Z",
    "confirmed_at": "2019-08-24T14:15:22Z",
    "completed_at": "2019-08-24T14:15:22Z",
    "canceled_at": "2019-08-24T14:15:22Z",
    "failed_at": "2019-08-24T14:15:22Z",
    "created_at": "2019-08-24T14:15:22Z",
    "updated_at": "2019-08-24T14:15:22Z",
    "deleted_at": "2019-08-24T14:15:22Z",
    "type": "product-import",
    "status": "created",
    "context": {
      "list_config": {
        "skip": 0,
        "take": 50,
        "order": {
          "created_at": "DESC"
        },
        "relations": [
          "variants",
          "variant.prices",
          "images"
        ]
      },
      "shape": {
        "dynamicImageColumnCount": 4,
        "dynamicOptionColumnCount": 2,
        "prices": [
          {
            "region": null,
            "currency_code": "eur"
          }
        ]
      }
    },
    "result": {
      "stat_descriptors": {
        "0": {
          "key": "product-export-count",
          "name": "Product count to export",
          "message": "There will be 8 products exported by this action"
        },
        "key": "string",
        "name": "string",
        "message": "string"
      },
      "errors": {
        "0": {
          "code": "unknown",
          "message": "Method not implemented.",
          "err": []
        },
        "message": "string",
        "err": [
          "string"
        ],
        "code": "string"
      },
      "count": 0,
      "advancement_count": 0,
      "progress": 0,
      "file_key": "string",
      "file_size": 0
    },
    "created_by_user": {
      "id": "usr_01G1G5V26F5TB3GPAPNJ8X1S3V",
      "email": "user@example.com",
      "first_name": "Levi",
      "last_name": "Bogan",
      "api_token": null,
      "created_at": "2019-08-24T14:15:22Z",
      "updated_at": "2019-08-24T14:15:22Z",
      "deleted_at": "2019-08-24T14:15:22Z",
      "role": "member",
      "metadata": {
        "car": "white"
      }
    }
  }
}

🟠400Client Error or Multiple Errors

🟠401User is not authorized. Must log in first

🟠404Not Found Error

🟠409Invalid State Error

🟠422Invalid Request Error

🔴500Server Error

Create a Batch Job

Request

Request samples

Responses