API Guide

www.maisonsdumonde.com
The Big Picture of the feeds
The APIs are a means to automatize the management of 4 main areas of your marketplace activity:

• Your store account

• Your catalog
• Your orders
• Your accounting

As a seller, you are free to integrate all the APIs or to choose some of them among these four areas.

Example : a seller can choose to automatize the management of the marketplace orders but to manage manually the
import of its products (via the Mirakl backoffice)
API Boutique Mirakl

Products /
Store account
Offers
management
Management
Maisons du
IT application
Monde’s IT
of the seller
environment
Orders
Accounting
management

API Guide Maisons du Monde 2

APIs choice and integration strategy

It is entirely up to the seller to choose which APIs he wants to integrate as well as the strategy of integration he wants to
go for. Maisons du Monde will only provide the seller with the Mirakl documentation, in addition to this guide, based on his
chosen method. Maisons du Monde will also help the seller with his tests of integration in the test environment.

Here are the 3 possible integration methods :

Magento PHP or Java Via Development

If you are using Magento 1 ou 2 as an e-
If your e-commerce solutation is coded in
commerce solution, Mirakl has developed
PHP or Java, you can find the SDK Mirakl
a connector to which you can plug in.
on the Help Portal. The SDK is a If your e-commerce solution is not
Therefore, you will be able to manage the
ensemble of programming support tools Magento, nor is coded in PHP or Java,
import of your catalogue, your offers
that will help you to conveniently integrate you will have to set up your own IT
updates and the orders management from
the Mirakl API, while decreasing your developments to manage to integrate with
your Magento backoffice.
margin of error in the imported feeds. The APIs by yourself.
The documentation about the Magento
SDK Mirakl PHP and Java are available in
Connector is available in the Help Portal
the Help Portal.
of Mirakl.

The last two methods specifically require IT skills in development. If you do not have the IT ressources, or do not
wish to outsource it, you can opt for another integration method: the excel template, the manual one or FTP. Do
not hesitate to ask for advice to your Business Developer.

API Guide Maisons du Monde 3

 Understanding the integration process

Reads the
Asks for the documentation, Creates and sets up Tests and develops Tests et develops the
Seller

API integration chooses the APIs to POSTMAN to test the APIs in the test APIs in the prod
method be integrated and the APIs to integrate environment of environment
defines the API Maisons du Monde
integration

- Sends additionnal
Maisons du monde

documentation depending
on the method the seller has
selected.
Sends the API documentation : Checks and Creates the
- Creates a store account in
- API Guide validates the store in the prod
the test environment for the
- API Specifications store integration environment
seller.
- Seller APIs Collection test.
- Sends the Seller APIs
collection for Postman (json
file)

API Guide Maisons du Monde 4

The Big Picture of product-linked API.

MIRAKL SHOP
APIs
P41 Send your product files

P42 Follow up the import of your

catalog

P47
Download the transformation
SELLER report of the products import OPERATOR
CATALOG CATALOG
P46 Download the transformation
file of the products import

Download the report of the

P44 products integration
PXX Major API

P45 Download the transformation

error report
PXX Optional API

API Guide Maisons du Monde 5

Prerequisite to the automation of your products imports :
The Mapping
You must initialize the automation of your catalog on the platform by mapping your product format on Maisons du Monde’s. Once the mapping
is done, you will be able to import directly your new products through API.

If you already have a product data base, you will only need to make your product catalogs and Maisons du Monde’s requirements match
by mapping your categories, attributes, values lists on Maisons du Monde’s.

You will have to repeat this task for each new category you want to put online.

7 steps are necessary to set this mapping up :

My inventory > Import from file > Click on « Open the configuration wizard »

Let’s start your

mapping !

API Guide Maisons du Monde

The Big Picture of offer-linked APIs
MIRAKL SHOP
APIs
Send your offers via a csv file
OF
(Description of the format in
01
the annexe)

OF Display the offers integration

02 report

OF Download the offers integration

03 error report
SELLER OPERATOR
CATALOG OF List the offers of a store
CATALOG
21 account

OF Collect the information of one

22 offer
OF
OF Major APIs
Update the offers XX
24 (Json / XML)

OF
OF Collect the list of offers states Optional APIs
XX
61

API Guide Maisons du Monde 7

Orders life cycle on the Marketplace

Prepare the shipment of

Customer scoring in
Debit in progress the order
progress

1. 2.
NEW ORDER TO ORDER
ORDER PROCESS TO SHIP
OR11 OR11 OR11

ACCEPT OR
3. DF 4.
REJECT AN
ORDER LINE
Formulaire de livraison OR73
Track the delivery and
OR21 If no incident is
download the customer

5.
invoice declared
€
INFORMATION THE CUSTOMER
TRACKING AND xxx
CONFIRMS THE
INVOICE OR23 DELIVERY
OR11 7.
INVOICE DELIVERY 6. L

OR74 OR24

API Guide Maisons du Monde 8

The Big Picture of order-linked APIs
MIRAKL SHOP
APIs
Collect the orders list for the store and
OR
the orders details.
11

OR Decide on the order (accept or reject an

21 order)

OR Fill in the tracking number of an order

23

OR
THE SELLER’S 24 Confirm the shipment of an order
ORDERS OPERATOR
MANAGEME PLATFORM
OR Refund an order line
NT 28

OR Get an order’s rating

51

Download some documents linked to one

OR or several orders.
73

OR Upload the invoice linked to an order

73

If you do not want to automatize the orders management, you can still keep an eye on them and process them from
your seller backoffice.

API Guide Maisons du Monde 9

The Big Picture of quality-service-linked APIs

MIRAKL SHOP APIs

Collect the discussion thread for an order

M or an offer
11
MESSAGING
SERVICE OPERATOR
M Answer at the end of the discussion
SELLER 12 thread for an order or an offer PLATFORM
BACKOFFICE

OR Create a discussion thread for an order

43

The API messaging service allows the seller to discuss directly with a customer or to answer his/her question about
the orders or the offers on the Marketplace. The messages can be adressed to Maisons du Monde, to the customer,
or both.

API Guide Maisons du Monde 10

The Big Picture of invoice-linked APIs

MIRAKL SHOP APIs

IV List all of the invoices

01
MESSAGING
SERVICE OPERATOR
SELLER PLATFORM
BACKOFFICE IV Download all of the invoices
02

You can consult all of your invoices and credit notes, as well as your transactions daily report from your Seller
Backoffice.

API Guide Maisons du Monde 11

 Testing your integration with Postman
After reading the documentation about APIs and having defined your integration strategy, you need to make tests with Postman. You
can test your main APIs to automatize your activity on the marketplace

Reads the
Asks for the documentation, Creates and sets up Tests and develops Tests et dévelops the
Seller

API integration choose the APIs to POSTMAN to test the APIs in the test APIs in the prod
method integrate and define the APIs to integrate environment of environment
the API integration Maisons du Monde
(cf slide 10)

- Sends additionnal
documentation depending
Maisons du monde

on the method the seller

has selected.
Sends the API documentation : Checks and Creates the
- Creates a store account in
- API Guide validates the store in the prod
the test environment for
- API Specifications store integration environment
the seller.
- Seller APIs Collection test.
- Sends the API Seller APIs
collection for Postman
(json file)

API Guide Maisons du Monde 12

 About Postman
About de Postman
Postman is a 3rd party software which has not been developed by Mirakl and which allows to easily test the APIs calls.

Thanks to the Mirakl API collection to import in Postman, you will be able to test your API integration.
Ask your business developer the complete collection of APIs (JSON file).
Use Google Chrome for Postman.

Install Postman et import the Mirakl APIs collection :

1. In Chrome, click on this link
2. Download Postman and follow the installation instructions.
3. Start Postman
4. In the toolbar, click on « Import ». The importation window appears.
5. Click on « Choose Files » to import the Mirakl APIs collection (JSON file)
The Mirakl collection appears in the list of collections :

API Guide Maisons du Monde 13

About Postman
Postman set-up

You must use Postman with the Mirakl test environment.

In Postman, click on and select Manage Environments. A window appears.

1. Click on Add and enter a name
2. Click on the key field and fill in :
1. The URL (URL of the test environment of Maisons du Monde ex: https://maisonsdumonde5-dev.mirakl.net)
2. The SHOP_KEY (that you will find in your Backoffice : My User settings > API key)
3. For each API key, enter the value in the value field.
4. Click on Add and close the window "Manage Environments".
5. Click on the pull-down list No Environments and select the environment that
you have just set up.
You can now start to test Mirakl APIs

API Guide Maisons du Monde 14

 Test your integration with Postman
Test the integration through Postman with your account manager in his/her test environment. Here is an example of model actions linked
to your activity as a marketplace seller :

1. Before importing your catalog, read the operator arborescent carefully (parent/child categories) by calling H11, the mandatory and
optional attributes linked to the categories in which you want to import products with PM11, as well as the lists of values associated to
these attributes with VL11.
2. Hence adapt your products file, then map it with the operator product format, in your back office : My inventory > Import products
in your format > Open the configuration wizard.
3. Import your catalog thanks to P41. Download the information related to the import as well as the error report thanks to P42 and P44.
4. Import your offers through API thanks to OF01 : to do so, download the operator offers format in the backoffice : My inventory >
Import products in your format > Download an excel file template file for Offers. Download the information linked to the import as well
as the error report thanks to OF02 and OF03.
5. Once your catalogue is properly imported, ask you Account manager to create a test order in your store account.
6. Receive the order request thanks to OR11, accept it with OR21, and confirm its shipment with OR24. You can download then upload
the documents linked to one or several orders, thanks to OR73 and OR74.
7. Ask you Account manager to send you a test message on your order.
8. Collect the message with M11 and answer to it via M12.
9. Ask your Account manager to create an incident on the order.
10. Proceed to the total or partial reimbursement of the order affected by the incident, thanks to OR28.

All of the sellers APIs are not described in this example. Consult the technical documentation to see all the available APIs.
Reminder : You can automatize all or only some of your marketplace activities, and accordingly choose the APIs to be integrated.

API Guide Maisons du Monde 15

Thank you !