Skip to main content

How to Bulk Import Prices

In this document, you’ll learn how to bulk import prices into a price list using the Admin APIs.

Overview​

Using Medusa’s Batch Job Admin APIs, you can import prices into a price list.

Importing prices into a price list removes all existing prices in the price list and adds the imported prices.

Prerequisites​

Medusa Components​

It is assumed that you already have a Medusa backend installed and set up. If not, you can follow our quickstart guide to get started. The Medusa backend must also have an event bus module installed, which is available when using the default Medusa backend starter.

File Service Plugin​

Part of the process of importing prices is uploading a CSV file. This requires a file service plugin to be installed on your backend. If you don’t have any installed, you can install one of the following options:

CSV File​

You must have a CSV file that you will use to import prices into your Medusa backend. You can check this CSV example file to see which format is required for your import.

JS Client​

This guide includes code snippets to send requests to your Medusa backend using Medusa’s JS Client, among other methods.

If you follow the JS Client code blocks, it’s assumed you already have Medusa’s JS Client installed and have created an instance of the client.

Medusa React​

This guide also includes code snippets to send requests to your Medusa backend using Medusa React, among other methods.

If you follow the Medusa React code blocks, it's assumed you already have Medusa React installed and have used MedusaProvider higher in your component tree.

Authenticated Admin User​

You must be an authenticated admin user before following along with the steps in the tutorial.

You can learn more about authenticating as an admin user in the API reference.

Created Price List​

Before importing the prices, you must have a price list to import them to.

You can use the Create Price List endpoint, or follow the how-to guide to learn how to create and manage price lists using the Admin API.

1. Upload CSV File​

The first step is to upload the CSV file to import prices from.

You can do that by sending the following request to the Upload Files endpoint:

medusa.admin.uploads.create(file) // file is an instance of File
.then(({ uploads }) => {
    const key = uploads[0].key
})

This request returns an array of uploads. Each item in the array is an object that includes the properties url and key. You’ll need the key to import the prices next.

2. Create a Batch Job for Prices Import​

To start a new price import, you must create a batch job.

You can do that by sending the following request to the Create a Batch Job endpoint:

medusa.admin.batchJobs.create({
    type: "price-list-import",
    context: {
        fileKey: key, // obtained from previous step
        price_list_id,
    },
    dry_run: true,
})
.then(( batch_job ) => {
    console.log(batch_job.status)
})

In the body of the request, you must pass the following parameters:

  • type: Batch jobs can be of different types. For price imports, the type should always be price-list-import.
  • context: An object that must contain:
    • The fileKey property. The value of this property is the key received when you uploaded the CSV file.
    • The price_list_id property. The value of this property is the ID of the price list you’re importing the prices into.
  • dry_run: This is optional to include. If not set or if its value is false, the price import will start right after you send this request. Settings its value to true allows you to retrieve afterward a brief of the number of prices that will be added.

This request returns the batch job with its details such as the status or id.

If you don’t set dry_run or you set it to false, you don’t need to follow the rest of these steps.

(Optional) Retrieve Batch Job​

After creating the batch job, it will be pre-processed. At this point, the CSV file will be validated, and the number of prices to add are counted.

You can retrieve all the details of the batch job, including its status and the brief statistics related to the prices by sending the following request:

medusa.admin.batchJobs.retrieve(batchJobId)
.then(( batch_job ) => {
    console.log(batch_job.status, batch_job.result)
})

This request accepts the batch job’s ID as a parameter, which can be retrieved from the previous request. It returns the batch job in the response.

If the batch job has been pre-processed, the status of the batch job will be pre_processed and the result property will contain details about the import.

Here’s an example of the result property:

"result": {
    "count": 5, // Total number of prices to be added
    "stat_descriptors": [ //details about the prices to be added
        {
            "key": "price-list-import-count",
            "name": "PriceList to import",
            "message": "5 prices will be added"
        }
    ],
    "advancement_count": 0 //number of prices processed so far.
},

3. Confirm Batch Job​

A batch job can be confirmed only once the batch job has the status pre_processed. Once you confirm a batch job, the price import will start which will add prices to the price list

To confirm a batch job send the following request:

medusa.admin.batchJobs.confirm(batchJobId)
.then(( batch_job ) => {
    console.log(batch_job.status)
})

This request accepts the ID of the batch job as a path parameter and returns the updated batch job. The returned batch job should have the status confirmed, which indicates that the batch job will now start processing.

Checking the Status After Confirmation​

After confirming the batch job, you can check the status while it is processing at any given point by retrieving the batch job. Based on the status, you can infer the progress of the batch job:

  • If the status is processing, it means that the import is currently in progress. You can also check result.advancement_count to find out how many prices have been added so far.
  • If the status is failed, it means an error has occurred during the import. You can check the error in result.errors.
  • If the status is completed, it means the import has finished successfully.

See Also​