Skip to content

Exporting Orders from Mirakl

This task will export order information from your Mirakl account to an XML file.

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.

Channels

Optional
Filters the export by channel code. You can provide up to 100 codes in the form of a comma separated list.

Customer Debited

Required
Filters the export based on whether the customer has paid.

Export Settings

Required
Settings to control whether new, modified or all records will be exported from Mirakl. The following options are available:

  • Date Created - The date to use when exporting new records. Records created since this date will be exported. The date will update automatically each time the task runs.
  • Date Modified - The date to use when exporting modified records. Records updated since this date will be exported. The date will update automatically each time the task runs.
  • Export New, Modified or All Records - Choose whether the task should export new, modified or all records.

Fulfillment Centres

Optional
Filters the export by fulfilment centre code. You can provide up to 100 codes in the form of a comma separated list.

Order IDs

Optinal
Filters the export by order ID. You can provide multiple IDs in the form of a comma separated list.

Page Size

Required
The maximum number of records to fetch from the Mirakl API at a time. The value must be between 1 and 100, inclusive. Defaults to 100.

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.

State

Required
Filters the export by order state. The following options are available:

  • All
  • Closed
  • Received
  • Refused
  • Shipped
  • Shipping
  • Staging
  • ToCollect
  • WaitingAcceptance
  • WaitingDebit
  • WaitingDebitPayment

Tax Mode

Required
Choose whether price fields should show tax inclusive or exclusive amounts. When set to 'Default', the default tax mode of the platform is used. The following options are available:

  • Default
  • TaxExcluded
  • TaxIncluded

Timeout

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

Output File

Required
The name of the file to export the data to. The data will be output in XML format, a sample of which is shown below.

Zynk Settings

See Common Task Settings

Examples

Sample output file:

<?xml version="1.0" encoding="utf-8"?>
<Orders xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:xsd="http://www.w3.org/2001/XMLSchema">
  <Order>
    <AcceptanceDecisionDate>2025-07-03T17:33:07Z</AcceptanceDecisionDate>
    <CanCancel>false</CanCancel>
    <CanShopShip>false</CanShopShip>
    <CommercialId>123456789-1234567</CommercialId>
    <CreatedDate>2025-07-03T17:19:06Z</CreatedDate>
    <CurrencyIsoCode>GBP</CurrencyIsoCode>
    <Customer>
      <BillingAddress>
        <City>Newcastle</City>
        <Country>GB</Country>
        <CountryIsoCode>GBR</CountryIsoCode>
        <FirstName>John</FirstName>
        <LastName>Smith</LastName>
        <Phone>0191 820 1484</Phone>
        <State></State>
        <Street1>Office 16</Street1>
        <Street2>6-8 Charlotte Square</Street2>
        <ZipCode>NE1 4XF</ZipCode>
      </BillingAddress>
      <CustomerId>[email protected]</CustomerId>
      <FirstName>John</FirstName>
      <LastName>Smith</LastName>
      <ShippingAddress>
        <City>Newcastle</City>
        <Country>GB</Country>
        <CountryIsoCode>GBR</CountryIsoCode>
        <FirstName>John</FirstName>
        <LastName>Smith</LastName>
        <Phone>0191 820 1484</Phone>
        <State></State>
        <Street1>Office 16</Street1>
        <Street2>6-8 Charlotte Square</Street2>
        <ZipCode>NE1 4XF</ZipCode>
      </ShippingAddress>
    </Customer>
    <CustomerDebitedDate>2025-07-03T20:23:55.409Z</CustomerDebitedDate>
    <CustomerDirectlyPaysSeller>false</CustomerDirectlyPaysSeller>
    <CustomerNotificationEmail>[email protected]</CustomerNotificationEmail>
    <Fulfillment>
      <Center>
        <Code>DEFAULT</Code>
      </Center>
    </Fulfillment>
    <FullyRefunded>false</FullyRefunded>
    <HasCustomerMessage>false</HasCustomerMessage>
    <HasIncident>false</HasIncident>
    <HasInvoice>false</HasInvoice>
    <LastUpdatedDate>2026-02-23T01:00:59Z</LastUpdatedDate>
    <OrderAdditionalFields>
      <OrderAdditionalField Type="BOOLEAN">
        <Code>internationalorder</Code>
        <Value>false</Value>
      </OrderAdditionalField>
      <OrderAdditionalField Type="STRING">
        <Code>sfccorderno</Code>
        <Value>321978336</Value>
      </OrderAdditionalField>
    </OrderAdditionalFields>
    <OrderId>123456789-1234567-A</OrderId>
    <OrderLines>
      <OrderLine>
        <CanRefund>false</CanRefund>
        <Cancelations />
        <CategoryCode>1580311415881</CategoryCode>
        <CategoryLabel>T-Shirts</CategoryLabel>
        <CommissionFee>17.64</CommissionFee>
        <CommissionTaxes>
          <CommissionTax>
            <Amount>0.00</Amount>
            <Code>TAXDEFAULT</Code>
            <Rate>0.0000</Rate>
          </CommissionTax>
        </CommissionTaxes>
        <CreatedDate>2025-07-03T17:19:06Z</CreatedDate>
        <DebitedDate>2025-07-03T20:23:55Z</DebitedDate>
        <Fees />
        <LastUpdatedDate>2026-02-23T01:00:59Z</LastUpdatedDate>
        <OfferId>169787</OfferId>
        <OfferSku>703515-BLK-S</OfferSku>
        <OfferStateCode>11</OfferStateCode>
        <OrderLineAdditionalFields>
          <OrderLineAdditionalField Type="STRING">
            <Code>itemid</Code>
            <Value>19318481</Value>
          </OrderLineAdditionalField>
          <OrderLineAdditionalField Type="NUMERIC">
            <Code>orderlinetotal</Code>
            <Value>58.8</Value>
          </OrderLineAdditionalField>
          <OrderLineAdditionalField Type="BOOLEAN">
            <Code>signatureondelivery</Code>
            <Value>true</Value>
          </OrderLineAdditionalField>
        </OrderLineAdditionalFields>
        <OrderLineId>123456789-1234567-A-1</OrderLineId>
        <OrderLineIndex>1</OrderLineIndex>
        <OrderLineState>CLOSED</OrderLineState>
        <OrderLineStateReasonCode>AUTO_CLOSED</OrderLineStateReasonCode>
        <OrderLineStateReasonLabel>Closed automatically</OrderLineStateReasonLabel>
        <Price>58.80</Price>
        <PriceAmountBreakdown>
          <Parts>
            <Part>
              <Amount>58.80</Amount>
              <Commissionable>true</Commissionable>
              <DebitableFromCustomer>true</DebitableFromCustomer>
              <PayableToShop>true</PayableToShop>
            </Part>
          </Parts>
        </PriceAmountBreakdown>
        <PriceUnit>58.80</PriceUnit>
        <ProductMedias>
          <ProductMedia>
            <MediaUrl>/media/product/image/0f4d1bf4-8fb5-42b5-ac12-4c6169d4dfc3</MediaUrl>
            <MimeType>JPG</MimeType>
            <Type>LARGE</Type>
          </ProductMedia>
        </ProductMedias>
        <ProductShopSku>729250088773</ProductShopSku>
        <ProductSku>TEE0001</ProductSku>
        <ProductTitle>Shrunken Boy Friend Tee</ProductTitle>
        <Promotions />
        <Quantity>1</Quantity>
        <ReceivedDate>2025-07-05T00:16:21Z</ReceivedDate>
        <Refunds />
        <ShippedDate>2025-07-03T20:23:49Z</ShippedDate>
        <ShippingFrom>
          <Address>
            <CountryIsoCode>GBR</CountryIsoCode>
          </Address>
        </ShippingFrom>
        <ShippingPrice>0.00</ShippingPrice>
        <ShippingPriceAmountBreakdown>
          <Parts>
            <Part>
              <Amount>0.00</Amount>
              <Commissionable>false</Commissionable>
              <DebitableFromCustomer>true</DebitableFromCustomer>
              <PayableToShop>true</PayableToShop>
            </Part>
          </Parts>
        </ShippingPriceAmountBreakdown>
        <ShippingTaxes>
          <ShippingTax>
            <Amount>0.00</Amount>
            <AmountBreakdown>
              <Parts>
                <Part>
                  <Amount>0.00</Amount>
                  <Commissionable>false</Commissionable>
                  <DebitableFromCustomer>true</DebitableFromCustomer>
                  <PayableToShop>false</PayableToShop>
                </Part>
              </Parts>
            </AmountBreakdown>
            <Code>TAX</Code>
            <Rate>0.0000</Rate>
            <TaxCalculationRule>PROPORTIONAL_TO_AMOUNT</TaxCalculationRule>
          </ShippingTax>
        </ShippingTaxes>
        <Taxes>
          <Tax>
            <Amount>0.00</Amount>
            <AmountBreakdown>
              <Parts>
                <Part>
                  <Amount>0.00</Amount>
                  <Commissionable>false</Commissionable>
                  <DebitableFromCustomer>true</DebitableFromCustomer>
                  <PayableToShop>false</PayableToShop>
                </Part>
              </Parts>
            </AmountBreakdown>
            <Code>TAX</Code>
            <Rate>0.0000</Rate>
            <TaxCalculationRule>PROPORTIONAL_TO_AMOUNT</TaxCalculationRule>
          </Tax>
        </Taxes>
        <TotalCommission>17.64</TotalCommission>
        <TotalPrice>58.80</TotalPrice>
      </OrderLine>
    </OrderLines>
    <OrderState>CLOSED</OrderState>
    <OrderStateReasonCode>AUTO_CLOSED</OrderStateReasonCode>
    <OrderStateReasonLabel>Closed automatically</OrderStateReasonLabel>
    <OrderTaxMode>TAX_EXCLUDED</OrderTaxMode>
    <PaymentType>POS</PaymentType>
    <PaymentWorkflow>PAY_ON_SHIPMENT</PaymentWorkflow>
    <Price>58.80</Price>
    <Promotions>
      <AppliedPromotions />
      <TotalDeducedAmount>0</TotalDeducedAmount>
    </Promotions>
    <ShippingCompany>UPS®</ShippingCompany>
    <ShippingDeadline>2025-07-08T03:59:59.999Z</ShippingDeadline>
    <ShippingPrice>0.00</ShippingPrice>
    <ShippingTracking>1ZD012345678901234</ShippingTracking>
    <ShippingTrackingUrl>https://www.ups.com/WebTracking?loc=en_US&amp;requester=ST&amp;trackNums=1ZD012345678901234</ShippingTrackingUrl>
    <ShippingTypeCode>STD</ShippingTypeCode>
    <ShippingTypeLabel>Standard</ShippingTypeLabel>
    <ShippingTypeStandardCode>CU_ADD-STD</ShippingTypeStandardCode>
    <ShippingZoneCode>USA</ShippingZoneCode>
    <ShippingZoneLabel>USA</ShippingZoneLabel>
    <TotalCommission>17.64</TotalCommission>
    <TotalPrice>58.80</TotalPrice>
    <TransactionDate>2025-07-03T20:23:52Z</TransactionDate>
    <TransactionNumber>055a085c-2731-45fd-aead-401859f839ea-0</TransactionNumber>
  </Order>
</Orders>