Skip to main content

How to Import Prices

In this document, you’ll learn how to 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 server installed and set up. If not, you can follow our quickstart guide to get started.

Redis

Redis is required for batch jobs to work. Make sure you install Redis and configure it with your Medusa server.

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 server. 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 server. 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 server using Medusa’s JS Client, JavaScript’s Fetch API, or cURL.

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.

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:

Report Incorrect CodeReport Incorrect CodeReport Incorrect CodeCopy to Clipboard
medusa.admin.uploads.create(file) //file is an instance of File
.then(({ uploads }) => {
const key = uploads[0].key;
});
Copy to Clipboard

This request returns an array of uploads. Each item in the array is an object that includes the properties Copy to Clipboard and Copy to Clipboard. You’ll need the Copy to Clipboard 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:

Report Incorrect CodeReport Incorrect CodeReport Incorrect CodeCopy to Clipboard
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);
});
Copy to Clipboard

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

  • Copy to Clipboard: Batch jobs can be of different types. For price imports, the type should always be Copy to Clipboard.
  • Copy to Clipboard: An object that must contain:
    • The Copy to Clipboard property. The value of this property is the key received when you uploaded the CSV file.
    • The Copy to Clipboard property. The value of this property is the ID of the price list you’re importing the prices into.
  • Copy to Clipboard: This is optional to include. If not set or if its value is Copy to Clipboard, the price import will start right after you send this request. Settings its value to Copy to Clipboard 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 Copy to Clipboard or Copy to Clipboard.

If you don’t set Copy to Clipboard or you set it to Copy to Clipboard, 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:

Report Incorrect CodeReport Incorrect CodeReport Incorrect CodeCopy to Clipboard
medusa.admin.batchJobs.retrieve(batchJobId)
.then(( batch_job ) => {
console.log(batch_job.status, batch_job.result);
});
Copy to Clipboard

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 Copy to Clipboard and the Copy to Clipboard property will contain details about the import.

Here’s an example of the Copy to Clipboard 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. Will be 0 before the import is confirmed.
},
Copy to Clipboard

3. Confirm Batch Job

A batch job can be confirmed only once the batch job has the status Copy to Clipboard. 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:

Report Incorrect CodeReport Incorrect CodeReport Incorrect CodeCopy to Clipboard
medusa.admin.batchJobs.confirm(batchJobId)
.then(( batch_job ) => {
console.log(batch_job.status);
});
Copy to Clipboard

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 Copy to Clipboard, 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 Copy to Clipboard, it means that the import is currently in progress. You can also check Copy to Clipboard to find out how many prices have been added so far.
  • If the status is Copy to Clipboard, it means an error has occurred during the import. You can check the error in Copy to Clipboard.
  • If the status is Copy to Clipboard, it means the import has finished successfully.

What’s Next 🚀