Mimeeq API (1.0.0)

E-mail: [email protected] License: Apache 2.0

The Mimeeq API allows developers to access information from Mimeeq. You can use this API to build private services or public applications based on Mimeeq Configurator. To learn how to get your credentials, read our Authorization Guide. All endpoints are available via https and require API KEY authorization.

Find out more about Mimeeq Configurator

Authorization

This API requires API Key to access any endpoint. You may learn more about how to get your API Key here.

After you get your API Key you need to pass X-API-KEY header with said key to all requests.

Obtaining Short Code

Some of listed endpoints require short code to work. Although Mimeeq configurator provides multiple different codes these methods support only some of them.

These are

Configuration short code
Scene short code

You may learn more about various types of short codes and how to obtain them here

Product

Product API methods

Get product price by short code

Returns the product price by short code and quantity. Please note that one of publicListGroup, priceListIds, companyId, templateId parameters is required to calculate the price. Those parameters are mutually exclusive so they shouldn't be used simultaneously in a single request. In order to calculate price for different resources please use separate calls. If all parameters are provided the following priority is applied:

companyId
priceListIds
priceListGroup
templateId
lang

Authorizations:

ApiKeyAuth

query Parameters

shortCode required	string Short code generated for selected configuration
quantity required	number Quantity
lang	string Deprecated Custom language code. If not provided it will use default Customer language. Please use `priceListGroup` parameter instead as language price list groups are deprecated
priceListGroup	string A slug of a custom public price list group. Provide it in case you want to get a price from a specific public price list group
priceListIds	string Comma separated custom price list ids. Provide these in case you want get price from specific price list(s)
companyId	string Custom company Id. Provide it in case you want to get price for specific company
templateId	string A template Id of the selected embed template. Provide it in case you want to get a price from a specific public price list group assigned to the embed template
priceType	string Enum: "RRP" "SALE" "COST" Custom price type. Required if you want get price for specific company or from specific price list(s)
vatType	string Enum: "INCL_VAT" "EXCL_VAT" Custom VAT type. If not provided it will use default value from Customer's public price list

Responses

get/get-product-price-info

Request samples

curl --request GET \
  --url 'https://mimeeqapi.com/get-product-price-info?shortCode=SOME_STRING_VALUE&quantity=SOME_NUMBER_VALUE&lang=SOME_STRING_VALUE&priceListGroup=SOME_STRING_VALUE&priceListIds=SOME_STRING_VALUE&companyId=SOME_STRING_VALUE&templateId=SOME_STRING_VALUE&priceType=SOME_STRING_VALUE&vatType=SOME_STRING_VALUE' \
  --header 'X-API-KEY: REPLACE_KEY_VALUE'

Response samples

application/json

Example

ProductPriceStandardResponse

{"price": 0,
"unitPrice": 0,
"totalWeight": 0,
"unitWeight": 0,
"levels": [{"quantityMin": 0,
"quantityMax": 0,
"price": 0,
"pricePart": 0,
"discount": 0
}
],
"itemMasters": [{"code": "string",
"deliveryTime": 0,
"weight": 0,
"m3": 0,
"dimensions": {"width": 0,
"height": 0,
"depth": 0
}
}
],
"currency": "string",
"deliveryTime": 0,
"vatType": "VAT_INCL"
}

Find product info by short code

Get product info by short code.

Authorizations:

ApiKeyAuth

query Parameters

shortCode required	string Short code generated for selected configuration
quantity required	number Quantity
lang	string Custom language code. If not provided it will use default Customer language

Responses

get/get-product-info

Request samples

curl --request GET \
  --url 'https://mimeeqapi.com/get-product-info?shortCode=SOME_STRING_VALUE&quantity=SOME_NUMBER_VALUE&lang=SOME_STRING_VALUE' \
  --header 'X-API-KEY: REPLACE_KEY_VALUE'

Response samples

application/json

{"name": "string",
"code": "string",
"description": "string",
"configuration": [{"blockId": "string",
"blockName": "string",
"options": ["string"
],
"optionsData": [{"optionName": "string",
"image": "string"
}
]
}
],
"defaultImage": "string",
"SKU": "string",
"status": "ACTIVE",
"mode": "MODULAR",
"deliveryInfo": "string",
"components": [{"name": "string",
"code": "string",
"description": "string",
"configuration": [{"blockId": "string",
"blockName": "string",
"options": ["string"
],
"optionsData": [{"optionName": "string",
"image": "string"
}
]
}
],
"defaultImage": "string",
"SKU": "string",
"quantity": 0,
"shortCode": "string"
}
]
}

Get the list of products

Returns general information about all products defined for given customer

Authorizations:

ApiKeyAuth

Responses

get/get-products-general-info

Request samples

curl --request GET \
  --url https://mimeeqapi.com/get-products-general-info \
  --header 'X-API-KEY: REPLACE_KEY_VALUE'

Response samples

application/json

[{"productId": "PROD-e6e35a89-159c-413e-98b6-8260367c554a",
"variantCode": "CODE-1",
"name": {"en": "English text",
"de": "Deutscher Text"
},
"displayName": {"en": "English text",
"de": "Deutscher Text"
},
"description": {"en": "English text",
"de": "Deutscher Text"
},
"status": "ACTIVE",
"mode": "VARIANT",
"type": "3D",
"visibility": true,
"privacy": "PUBLIC",
"defaultConfigurationCode": "Fabric-a7&Colour-a1",
"manufacturer": "AB furniture",
"designer": "John Doe",
"collection": "Office",
"previewImage": "https://fsdfsfe3231.cloudfront.net/c_aer/3963efc7-e1b5-4a03-ab51-4e68efa5afdb.png",
"hoverImage": "https://fsdfsfe3231.cloudfront.net/c_aer/3963efc7-e1b5-4a03-ab51-4e68efa5afdb.png",
"isOwn": true,
"createdAt": "2022-04-19T00:41:33.721Z",
"modifiedAt": "2022-04-22T21:18:25.321Z",
"embedShortCode": "77NOCJ",
"tags": ["desk",
"adjustable"
]
}
]