Client Requirements
Any client wanting to use this integration should already have a seller shop set up with Mirakle. The hostname, shop id and the API key required to configure the integration can all be obtained from the shop. Offers/Products are also listed on the seller shop.
Integration Settings
Shop ID: This is obtained from the My Account -> Settings page on the shop. The ID is located on the top left of the page.
API Key: The API Key is generated on the API Key tab in 'My User Settings' page on the seller shop. The 'My User Settings' page can be found by clicking on the user id in the top right hand corner of the seller's shop.
Obtain the above details from the client and input in the respective fields on the integration Settings page for the client.
How it works
Retrieving Orders:
The integration retrieves orders on statuses WAITING_ACCEPTANCE and SHIPPING.
When orders are placed on the Mirakl market place, they are on the status WAITING_ACCEPTANCE. Orders on this status do not have shipping address information and need to be accepted first. The integration accepts these orders by sending an accept true flag for each items in the order back to the Mirakl accept api endpoint. The status on these orders then changes to WAITING_DEBIT_PAYMENT. When on this status, the Mirakl Operator processes the payment on the order. The seller has no control over this and this stage may take a few minutes to a few hours. When the payment is successfully processed, the status on the order changes to SHIPPING. (Please this appears as 'shipping in progress' on the seller's shop).
When the status on the orders changes to SHIPPING', the integration picks them up again and the orders are processed into OMS. The orders should now have shipping address information. The items in the orders are saved into OMS as type textual.
Personalisation:
Messages entered by the customer are saved in the order attributes in OMS. They are not saved as item attributes because the messages are only available at the order level. The name of the attributes in OMS is called ':MiraklOrderMessage'.
Updating Orders on the Mirakl Seller Shop:
When orders are dispatched in OMS, the integration first checks for tracking and shipping carrier information on the order. If either of these is found, the information is first fed back to the seller.
The integration then updates the status on the order to SHIPPED in a separate API call. Please note that the status on the order is updated to SHIPPED regardless of whether there is tracking/carrier information or not.