Pricing API

Show special prices for logged-in users, companies or promotions in the configurator. Learn the ways to request prices from the Pricing API and set them in your embed.

Use the Mimeeq pricing API endpoint to request prices for a specific language, price list or company, then show them in the configurator.

---

Who this article is for

1. You have your own user management system and do not want to use Mimeeq's.

2. You need to show special prices for logged-in users.

3. You want to show special promotional prices.

4. You want to pull prices from an external source and show them in our configurator.

---

Concept and use case

Let's take an example use case where you want to provide special prices when one of your commerce customers logs into your website.

In this instance, you need to request from Mimeeq a special price list or price lists for this user or for the user's company.

With our pricing API endpoint you can request prices in the ways listed below.

1. Using a public price list assigned to a given language

This keeps it really simple and works nicely for a lot of customers. It allows you to set 1 or more price lists to a given language. Based on the display language, you pass the language parameter along with your API key and product short-code, and our API will return the public price.

If no language is supplied, it will use your default language.

2. Using price list IDs

This allows you to add as many price list IDs as you like. In such a case, we will return the cheapest price based on the price list IDs you specify. Keep in mind that if the price is 100 in price list one and 90 in price list two, we will only return 90.

If you wish to get the price for price lists separately, make separate API calls with one price list specified at a time. This can then be used for making some cross-analysis between the prices and displaying the difference as a discount.

3. Using a company ID

Mimeeq allows a single company to have multiple price lists. You can specify the company ID, and we will calculate the prices for this specific company based on all their price lists and return the price.

This is very useful when you want to return the prices for users who are assigned to a company (your customer). Set up the company in the Companies tab of the main app dashboard and assign the price lists for that company. Copy the company ID and store it in your website backend along with the user credentials. When the user logs in, pass this ID to our API and retrieve the specific prices for that user's company.

If you supply price list IDs, they will override the public price. If you supply a company ID, it will override everything.

---

Important information and developer docs

To set the price in the Mimeeq configurator, you must set the embed snippet with the parameter below. You can also turn it on in our embed snippet controller panel.

data-mimeeq-use-custom-pricing

• Setting the custom price: see our developer docs at https://docs.mimeeq.com/embeds-utils/#set-price. You can also set the decimal places displayed with min/max values, as well as set the delivery date.

• API reference: find details of our API at https://docs.mimeeq.com/api-reference/.

Below is a screenshot from the API documentation for quick reference. We suggest heading to our dedicated API reference page, where you can test it out for yourself.

Pricing endpoint in the Mimeeq API reference

If you need any help or have any questions, feel free to reach out to Mimeeq support.

---

Related articles

Pricing Overview

Set up currencies, markets, price lists and quantity breaks.

Promotional Prices

Show compare prices using promotional price lists.

Additional Price Codes

Show price differences between options in the configurator.