Mirakl settings

Every setting on the Mirakl order and inventory Configurations, including which order states to import and how to wait for the customer's payment to clear.

The Mirakl connector imports orders from a Mirakl-powered marketplace and sends stock levels back. Its settings live on two Configurations: Mirakl Order and Mirakl Inventory.

Order import: what gets imported

These settings, and those in the next section, are on the Mirakl Order Configuration.

Setting	What it does	Values / default	When to change it
Setup date `setupDate`	Only orders created on or after this date are imported, so historical orders aren't pulled in at go-live.	Date. Set automatically when the Integration is first configured.	Not normally changed afterwards.
Last import date `lastImportDate`	The import watermark. Each run fetches only orders modified after it.	Date and time. Managed by the system.	Don't edit it by hand.
Import delay `importDelay`	Waits this long before importing an order, so other Mirakl apps can update it first, or the marketplace can fill in details such as the customer after the payment has debited.	Duration, for example `00:05:00` for five minutes.	Add a delay if orders arrive incomplete.
Order states to import `includeOrderStatuses`	Only orders currently in one of these Mirakl states are requested. See below.	List of state codes. Empty means any state.	Narrow the import to the states you act on.
Customer debited only `customerDebitedOnly`	Only orders whose customer payment has been debited are requested.	`true` or `false`.	Turn on if the marketplace withholds customer details until the debit clears. Not suitable when you send order acknowledgements.

Order states

includeOrderStatuses takes these Mirakl state codes, in any case: STAGING, WAITING_ACCEPTANCE, WAITING_DEBIT, WAITING_DEBIT_PAYMENT, SHIPPING, SHIPPED, TO_COLLECT, RECEIVED, CLOSED, REFUSED and CANCELED (Mirakl spells it with one L).

A value that isn't one of these fails the import with an error naming it, rather than being ignored.
An order left out because of its state is picked up on a later import, once it moves into an included state.

Waiting for the debit

Some marketplaces withhold the whole customer record (name, contact details and addresses) until the customer's payment is debited. An order imported before then arrives with no customer and isn't re-read afterwards. With customerDebitedOnly on, the order is held back and imported, complete, on the first import after the debit.

Order acknowledgements

Orders can only be accepted in Mirakl while they're in WAITING_ACCEPTANCE, and they haven't been debited at that point. If you send order acknowledgements to Mirakl, don't leave WAITING_ACCEPTANCE out of includeOrderStatuses, and don't turn on customerDebitedOnly. Either would stop those orders ever being imported to be accepted.

Order import: customers and fulfilment

Setting	What it does	Values / default	When to change it
Default customer `defaultCustomerId`	The Party used when an order has no identifiable customer.	A Party ID.	Set it as a fallback.
Always use the default customer `alwaysSetDefaultCustomerId`	Uses `defaultCustomerId` for every order, whether or not a customer could be identified.	`true` or `false`.	Turn on when all orders should go to one generic customer account.
Default fulfilment location `defaultFulfillmentLocationId`	The ship-from Location for every imported order. When set, it always wins over the warehouse and fulfilment centre codes Mirakl sends (those codes are still recorded on the Document).	A Location ID.	Set it when everything ships from one Location, or you don't use Mirakl warehouses.
Disable the expected payable tag `disableExpectedPayableTag`	Stops the expected payable tag being added. That tag is normally used to check that the calculated order total matches the expected amount.	On or off.	Turn on only to skip the total check.

Inventory

This setting is on the Mirakl Inventory Configuration.

Setting	What it does	Values / default	When to change it
Split by location `splitByLocation`	Sends stock to Mirakl as a separate record per fulfilment Location rather than one total.	`true` or `false`.	Turn on so Mirakl can track stock at each warehouse.