Skip to content

Importing Shipments into Mirakl

This task will create shipments for existing order lines in Mirakl, based on data supplied in an XML file. You can optionally provide tracking information as part of the data.

Important

The task supports matching lines based on OfferSku. But if the same SKU appears on more than one order line, you will need to provide OrderLineId instead.

Settings

Mirakl Connection

Required
The Mirakl connection to use. See the Connecting to Mirakl article if you require more information on how to create/manage connections.

Fail File

Required
The name of the file to write failed records to. The data will be output in the same XML format as the Input File. A sample can be found below.

Input File

Required
The name of the file containing the data you want to import into Mirakl. The data must be in XML format, a sample of which is shown below.

Fail File

Required
The name of the file to write successfully imported records to. The data will be output in the same XML format as the Input File. A sample can be found below.

Prevent Reprocessing

Required
Set to 'True' to prevent the same record being processed more than once. This works based on the value of the ExternalId element provided within the Input File.

Shop ID

Optional
If your user has access to multiple shops, use this setting to specify which shop the task should use. If not specified, your default shop will be used.

Timeout

Optional
The length of time to wait for responses from the Mirakl API. If not specified, the timeout will default to 100 seconds.

Zynk Settings

See Common Task Settings

Examples

Sample output file:

<?xml version="1.0" encoding="utf-8"?>
<Shipments>
  <Shipment>
    <ExternalId>5230</ExternalId>
    <InvoiceReference>12345</InvoiceReference>
    <OrderId>123456789-1234567-A</OrderId>
    <ShipmentAdditionalInformations>
      <ShipmentAdditionalInformation>
        <Code>DELIVERY_BILL_DATE</Code>
        <Type>DATE</Type>
        <Value>2026-01-01</Value>
      </ShipmentAdditionalInformation>
    </ShipmentAdditionalInformations>
    <ShipmentLines>
      <ShipmentLine>
        <OfferSku>703515-BLK-S</OfferSku>
        <OrderLineId>123456789-1234567-A-1</OrderLineId>
        <PackageReference>package_ref_1</PackageReference>
        <Quantity>1</Quantity>
      </ShipmentLine>
    </ShipmentLines>
    <Shipped>true</Shipped>
    <ShippingFrom>
      <Warehouse>
        <Code>DEFAULT_WAREHOUSE</Code>
      </Warehouse>
    </ShippingFrom>
    <Tracking>
      <CarrierCode>UPS</CarrierCode>
      <CarrierName>UPS</CarrierName>
      <CarrierStandardCode>UPS</CarrierStandardCode>
      <TrackingNumber>1Z2356F1ZJ98L9733M5</TrackingNumber>
      <TrackingUrl>https://wwwapps.ups.com/WebTracking/track?track=yes&amp;trackNums={trackingId}</TrackingUrl>
    </Tracking>
  </Shipment>
</Shipments>