Reporting Feeds
Introduction
The purpose of this document is to provide an overview of the logistic XML interfaces of Magento Order Management System (Magento OMS) related to reporting feeds.
Outgoing files
Please, go to XML Interfaces Document where it is explained the OMS SFTP folder structure used file conventions to follow for incoming and outgoing files.
Order Detail
The order-details feed is sent to the partner to report sales. It includes all order item statuses and the status of the overall order. If an order has left the warehouse, it additionally includes order tracking information.
| Sender / Receiver | OMS > Partner |
| Frequency | Sent to the Partner when an order is completed (i.e., Fully shipped, canceled or partially shipped). Note that all returns and refunds done against the order are included in the schema but not sent at the time of sending the order-detail feed to Partner (i.e., when order status is COMPLETED) |
| Format | XML |
| Transport | sFTP |
| Filename | <client>_order-detail_YYYYMMDDHH24MISSUUUUUU.xml |
| Acknowledgement | Not applicable |
Schema
Overview
Example
<?xml version="1.0" encoding="UTF-8"?>
<orderDetail xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
xsi:noNamespaceSchemaLocation="../../schema/order-detail.xsd">
<client>CLIENT</client>
<feed>order-detail</feed>
<order>
<id>900102009</id>
<store>FR</store>
<details>
<customer>896157</customer>
<customerType>REGISTERED</customerType>
<ip>59.78.252.38</ip>
<language>fr-FR</language>
<vatCountry>FR</vatCountry>
<origin>WEB</origin>
<originDate>2013-12-18T10:22:33Z</originDate>
<customerReference>Deliver next door</customerReference>
<giftMessage>Happy Birthday </giftMessage>
<csAgent/>
<fingerprint/>
</details>
<status>
<code>COMPLETE</code>
<name>Complete</name>
<reasonCode>PARTIALLYSHIPPED</reasonCode>
<reasonName>Order processing completed</reasonName>
<date>2013-12-19T09:33:09Z</date>
</status>
<people>
<person>
<ref>9932</ref>
<title>Lady</title>
<firstName>Jane</firstName>
<lastName>Doe</lastName>
<phone>123456789</phone>
<fax>123456789</fax>
<mobile>123456789</mobile>
<email>jane@jane.com</email>
<department/>
<companyName/>
<gender>M</gender>
<dateofbirth>1976-05-12</dateofbirth>
</person>
</people>
<addresses>
<address>
<ref>8343</ref>
<addresstype>customer</addresstype>
<address1>Church road</address1>
<address2>33</address2>
<city>London</city>
<state/>
<zip>NW4 4EB</zip>
<country>
<code>GB</code>
<name>UNITED KINGDOM</name>
</country>
</address>
<address>
<ref>8361</ref>
<addresstype>customer</addresstype>
<address1>Place du Pantheon</address1>
<address2>10</address2>
<city>Paris</city>
<state/>
<zip>75005</zip>
<country>
<code>FR</code>
<name>FRANCE</name>
</country>
</address>
</addresses>
<payments>
<payment>
<ref>4616</ref>
<currency>EUR</currency>
<transactions>
<transaction>
<details>
<method>CC</method>
<submethod>VISA</submethod>
<amount>91.9</amount>
<amountCaptured>80</amountCaptured>
<expirationDate>2014-05-23 00:00:00</expirationDate>
</details>
<billToAddress>
<personRef>9932</personRef>
<addressRef>8361</addressRef>
</billToAddress>
</transaction>
</transactions>
</payment>
</payments>
<items>
<item>
<ref>42067</ref>
<line>1</line>
<id/>
<details>
<itemType>PHYSICAL</itemType>
<clientCode>F0CWT012</clientCode>
<styleCode>F0CWT012</styleCode>
<itemName/>
<clientSku>8718342982213</clientSku>
<sku>8718342982213</sku>
<serialNumber/>
<optionName>WMN 12-3V332 C&S TShirt aop</optionName>
<localName>WMN 12-3V332 C&S TShirt aop</localName>
</details>
<shipToAddress>
<personRef>9932</personRef>
<addressRef>8343</addressRef>
</shipToAddress>
<status>
<code>SHIPPED</code>
<name>Shipped</name>
<reasonCode>OSREPORT</reasonCode>
<reasonName>Reported shipped in OS feed</reasonName>
<date>2013-12-19T09:33:08Z</date>
</status>
<payments>
<payment>
<ref>46413</ref>
<paymentRef>4616</paymentRef>
<details>
<costGross>29.95</costGross>
<costNet>23.96</costNet>
<costVat>5.99</costVat>
<vatRate>25</vatRate>
<vatDetail>
<vat>
<type>VAT</type>
<amount>5.99</amount>
<rate>25.00</rate>
</vat>
</vatDetail>
</details>
<status>
<code>CAPTURED</code>
<name>Captured</name>
</status>
</payment>
</payments>
</item>
<item>
<ref>42068</ref>
<line>2</line>
<id/>
<details>
<itemType>PHYSICAL</itemType>
<clientCode>K1KHD002</clientCode>
<styleCode>K1KHD002</styleCode>
<itemName/>
<clientSku>8718342146752</clientSku>
<sku>8718342146752</sku>
<serialNumber/>
<optionName>Kids Girls Dress Light Weight</optionName>
<localName>Kids Girls Dress Light Weight</localName>
</details>
<shipToAddress>
<personRef>9932</personRef>
<addressRef>8343</addressRef>
</shipToAddress>
<status>
<code>CANCELLED</code>
<name>Cancelled</name>
<reasonCode>OUTOFSTOCK</reasonCode>
<reasonName>Out of stock</reasonName>
<date>2013-12-18T11:40:30Z</date>
</status>
<payments>
<payment>
<ref>46414</ref>
<paymentRef>4616</paymentRef>
<details>
<costGross>49.95</costGross>
<costNet>39.96</costNet>
<costVat>9.99</costVat>
<vatRate>25</vatRate>
<vatDetail>
<vat>
<type>VAT</type>
<amount>9.99</amount>
<rate>25.00</rate>
</vat>
</vatDetail>
</details>
<status>
<code>CANCELLED</code>
<name>Cancelled</name>
</status>
</payment>
</payments>
</item>
<item>
<ref>42069</ref>
<line>3</line>
<id/>
<details>
<itemType>SHIPPING</itemType>
<clientCode>SHIPPING</clientCode>
<styleCode>SHIPPING</styleCode>
<itemName/>
<clientSku>STANDARD</clientSku>
<sku>STANDARD</sku>
<serialNumber/>
<optionName>Standard</optionName>
<localName>Standard Shipping</localName>
</details>
<shipToAddress>
<personRef>9932</personRef>
<addressRef>8343</addressRef>
</shipToAddress>
<status>
<code>SHIPPED</code>
<name>Shipped</name>
<reasonCode>OSREPORT</reasonCode>
<reasonName>Reported shipped in OS feed</reasonName>
<date>2013-12-19T09:33:08Z</date>
</status>
<payments>
<payment>
<ref>46415</ref>
<paymentRef>4616</paymentRef>
<details>
<costGross>12</costGross>
<costNet>9.6</costNet>
<costVat>2.4</costVat>
<vatRate>25</vatRate>
<vatDetail>
<vat>
<type>VAT</type>
<amount>2.40</amount>
<rate>25.00</rate>
</vat>
</vatDetail>
</details>
<status>
<code>CAPTURED</code>
<name>Captured</name>
</status>
</payment>
</payments>
</item>
</items>
<shipments>
<shipment>
<ref>9212</ref>
<id>FR-900102009-1</id>
<logisticsId>900102009</logisticsId>
<invoiceNumber>FR6</invoiceNumber>
<details>
<created>2013-12-19T09:27:01Z</created>
<invoiceDate>2013-12-19T09:33:08Z</invoiceDate>
<methodCode>STANDARD</methodCode>
<methodName>Standard</methodName>
</details>
<status>
<code>COMPLETE</code>
<name>Complete</name>
<reasonCode>OSREPORTCOMP</reasonCode>
<reasonName>Reported complete in OS feed</reasonName>
<date>2013-12-19T09:33:08Z</date>
</status>
<shipToAddress>
<personRef>9932</personRef>
<addressRef>8343</addressRef>
</shipToAddress>
<lines>
<line>
<ref>70934</ref>
<orderItemRef>42067</orderItemRef>
<line>1</line>
<orderLine>1</orderLine>
</line>
<line>
<ref>70935</ref>
<orderItemRef>42069</orderItemRef>
<line>2</line>
<orderLine>3</orderLine>
</line>
</lines>
<packages>
<package>
<carrier>CARRIER</carrier>
<trackingNumber>123</trackingNumber>
<boxNumber>456</boxNumber>
<trackingLink>http://www.test.com/track?tn=123</trackingLink>
<lines>
<line>
<orderItemRef>42067</orderItemRef>
<orderLine>1</orderLine>
</line>
<line>
<orderItemRef>42069</orderItemRef>
<orderLine>3</orderLine>
</line>
</lines>
</package>
</packages>
</shipment>
</shipments>
<returns>
<return>
<ref>155</ref>
<rma>RMA-CS-900102009-1</rma>
<details>
<created>2013-12-19T09:49:15Z</created>
</details>
<status>
<code>APPROVED</code>
<name>Approved</name>
<reasonCode>LOST</reasonCode>
<reasonName>Return lost</reasonName>
<date>2013-12-19T09:49:23Z</date>
</status>
<lines>
<line>
<ref>165</ref>
<orderItemRef>42067</orderItemRef>
<line>1</line>
<orderLine>1</orderLine>
<details>
<reason>4</reason>
<reasonDescription>The customer reports that the t-shirt is not long enough in the arms.</reasonDescription>
<condition/>
<sourceId/>
</details>
</line>
</lines>
</return>
</returns>
<refunds>
<refund>
<ref>5090</ref>
<creditNoteNumber>CFR1</creditNoteNumber>
<details>
<creditNoteDate>2013-12-19T09:48:07Z</creditNoteDate>
<created>2013-12-19T09:47:43Z</created>
</details>
<payments>
<payment>
<ref>4616</ref>
<totalRefund>12</totalRefund>
</payment>
</payments>
<status>
<code>RELEASED</code>
<name>Released</name>
<reasonCode>RELEASEDOFFLINE</reasonCode>
<reasonName>Released Offline</reasonName>
<date>2013-12-19T09:48:07Z</date>
</status>
<lines>
<line>
<ref>272</ref>
<orderItemRef>42069</orderItemRef>
<orderLine>3</orderLine>
<details>
<reason>12</reason>
<reasonDescription>The user is disappointed with the delivery time.</reasonDescription>
</details>
<payments>
<payment>
<ref>6376</ref>
<paymentRef>4616</paymentRef>
<details>
<costGross>12</costGross>
<costNet>9.6</costNet>
<costVat>2.4</costVat>
</details>
<status>
<code>NEW</code>
<name>New</name>
</status>
</payment>
</payments>
</line>
</lines>
</refund>
<refund>
<ref>5091</ref>
<creditNoteNumber>CFR2</creditNoteNumber>
<details>
<creditNoteDate>2013-12-19T09:49:38Z</creditNoteDate>
<created>2013-12-19T09:49:15Z</created>
</details>
<status>
<code>RELEASED</code>
<name>Released</name>
<reasonCode>RELEASEDOFFLINE</reasonCode>
<reasonName>Released Offline</reasonName>
<date>2013-12-19T09:49:38Z</date>
</status>
<lines>
<line>
<ref>273</ref>
<orderItemRef>42067</orderItemRef>
<orderLine>1</orderLine>
<details>
<reason>RETURN</reason>
<reasonDescription>Refund for return RMA-CS-900102009-1</reasonDescription>
</details>
<payments>
<payment>
<ref>6377</ref>
<paymentRef>4616</paymentRef>
<details>
<costGross>29.95</costGross>
<costNet>23.96</costNet>
<costVat>5.99</costVat>
</details>
<status>
<code>NEW</code>
<name>New</name>
</status>
</payment>
</payments>
</line>
</lines>
</refund>
</refunds>
</order>
</orderDetail>
Refund Detail
The refund-detail feed notifies the partner of a completed refund made to the customer. This is identical to the refunds block in the main order-detail feed but sent separately, typically after each refund is completed.
| Sender / Receiver | OMS > Partner |
| Frequency | Near real time when the refund status is set to RELEASED |
| Format | XML |
| Transport | sFTP |
| Filename | <client>_refund-detail_YYYYMMDDHH24MISSUUUUUU.xml |
| Acknowledgement | Not applicable |
Schema
Overview
Example
<?xml version="1.0" encoding="UTF-8"?>
<refundDetail xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xsi:noNamespaceSchemaLocation="../../schema/refund-detail.xsd">
<client>CLIENT</client>
<order>
<ref>12235</ref>
<id>FR-900102009</id>
<store>FR</store>
<details>
<created>2013-12-18T11:40:28Z</created>
<customer>896157</customer>
<customerType>REGISTERED</customerType>
<ip>59.78.252.38</ip>
<language>fr-FR</language>
<vatCountry>FR</vatCountry>
<origin>WEB</origin>
<originDate>2013-12-18T10:22:33Z</originDate>
<customerReference>Deliver next door</customerReference>
<giftMessage>Happy Birthday </giftMessage>
<csAgent/>
<fingerprint/>
</details>
<status>
<code>COMPLETE</code>
<name>Complete</name>
<reasonCode>PARTIALLYSHIPPED</reasonCode>
<reasonName>Order processing completed</reasonName>
<date>2013-12-19T09:33:09Z</date>
</status>
<people>
<person>
<ref>9932</ref>
<title>Lady</title>
<firstName>Jane</firstName>
<lastName>Doe</lastName>
<phone>123456789</phone>
<fax>123456789</fax>
<mobile>123456789</mobile>
<email>jane@jane.com</email>
<department/>
<companyName/>
<gender>M</gender>
<dateofbirth>1976-05-12</dateofbirth>
</person>
</people>
<addresses>
<address>
<ref>8343</ref>
<addresstype>customer</addresstype>
<address1>Church road</address1>
<address2>33</address2>
<city>London</city>
<state/>
<zip>NW4 4EB</zip>
<country>
<code>GB</code>
<name>UNITED KINGDOM</name>
</country>
</address>
<address>
<ref>8361</ref>
<addresstype>customer</addresstype>
<address1>Place du Pantheon</address1>
<address2>10</address2>
<city>Paris</city>
<state/>
<zip>75005</zip>
<country>
<code>FR</code>
<name>FRANCE</name>
</country>
</address>
</addresses>
<payments>
<payment>
<ref>4616</ref>
<currency>EUR</currency>
<transactions>
<transaction>
<details>
<method>CC</method>
<submethod>VISA</submethod>
<amount>91.9</amount>
<expirationDate>2014-05-23 00:00:00</expirationDate>
</details>
<billToAddress>
<personRef>9932</personRef>
<addressRef>8361</addressRef>
</billToAddress>
</transaction>
</transactions>
</payment>
</payments>
<items>
<item>
<ref>42067</ref>
<line>1</line>
<id/>
<details>
<itemType>PHYSICAL</itemType>
<clientCode>F0CWT012</clientCode>
<styleCode>F0CWT012</styleCode>
<itemName/>
<clientSku>8718342982213</clientSku>
<sku>8718342982213</sku>
<serialNumber/>
<optionName>WMN 12-3V332 C&S TShirt</optionName>
<localName>WMN 12-3V332 C&S TShirt</localName>
<catalogId>500</catalogId>
<merchantId>RETAILER NAME</merchantId>
</details>
<shipToAddress>
<personRef>9932</personRef>
<addressRef>8343</addressRef>
</shipToAddress>
<status>
<code>SHIPPED</code>
<name>Shipped</name>
<reasonCode>OSREPORT</reasonCode>
<reasonName>Reported shipped in OS feed</reasonName>
<date>2013-12-19T09:33:08Z</date>
</status>
<payments>
<payment>
<ref>46413</ref>
<paymentRef>4616</paymentRef>
<details>
<costGross>29.95</costGross>
<costNet>23.96</costNet>
<costVat>5.99</costVat>
<vatRate>25</vatRate>
<vatDetail>
<vat>
<type>VAT</type>
<amount>5.99</amount>
<rate>25.00</rate>
</vat>
</vatDetail>
</details>
<status>
<code>CAPTURED</code>
<name>Captured</name>
</status>
</payment>
</payments>
</item>
<item>
<ref>42068</ref>
<line>2</line>
<id/>
<details>
<itemType>PHYSICAL</itemType>
<clientCode>K1KHD002</clientCode>
<styleCode>K1KHD002</styleCode>
<itemName/>
<clientSku>8718342146752</clientSku>
<sku>8718342146752</sku>
<serialNumber/>
<optionName>Kids Girls Dress Light Weight</optionName>
<localName>Kids Girls Dress Light Weight</localName>
<catalogId>500</catalogId>
<merchantId>RETAILER NAME</merchantId>
</details>
<shipToAddress>
<personRef>9932</personRef>
<addressRef>8343</addressRef>
</shipToAddress>
<status>
<code>CANCELLED</code>
<name>Cancelled</name>
<reasonCode>OUTOFSTOCK</reasonCode>
<reasonName>Out of stock</reasonName>
<date>2013-12-18T11:40:30Z</date>
</status>
<payments>
<payment>
<ref>46414</ref>
<paymentRef>4616</paymentRef>
<details>
<costGross>49.95</costGross>
<costNet>39.96</costNet>
<costVat>9.99</costVat>
<vatRate>25</vatRate>
<vatDetail>
<vat>
<type>VAT</type>
<amount>9.99</amount>
<rate>25.00</rate>
</vat>
</vatDetail>
</details>
<status>
<code>CANCELLED</code>
<name>Cancelled</name>
</status>
</payment>
</payments>
</item>
<item>
<ref>42069</ref>
<line>3</line>
<id/>
<details>
<itemType>SHIPPING</itemType>
<clientCode>SHIPPING</clientCode>
<styleCode>SHIPPING</styleCode>
<itemName/>
<clientSku>STANDARD</clientSku>
<sku>STANDARD</sku>
<serialNumber/>
<optionName>Standard</optionName>
<localName>Standard Shipping</localName>
<catalogId>500</catalogId>
<merchantId>RETAILER NAME</merchantId>
</details>
<shipToAddress>
<personRef>9932</personRef>
<addressRef>8343</addressRef>
</shipToAddress>
<status>
<code>SHIPPED</code>
<name>Shipped</name>
<reasonCode>OSREPORT</reasonCode>
<reasonName>Reported shipped in OS feed</reasonName>
<date>2013-12-19T09:33:08Z</date>
</status>
<payments>
<payment>
<ref>46415</ref>
<paymentRef>4616</paymentRef>
<details>
<costGross>12</costGross>
<costNet>9.6</costNet>
<costVat>2.4</costVat>
<vatRate>25</vatRate>
<vatDetail>
<vat>
<type>VAT</type>
<amount>2.40</amount>
<rate>25.00</rate>
</vat>
</vatDetail>
</details>
<status>
<code>CAPTURED</code>
<name>Captured</name>
</status>
</payment>
</payments>
</item>
</items>
<refunds>
<refund>
<ref>5090</ref>
<creditNoteNumber>CFR1</creditNoteNumber>
<details>
<creditNoteDate>2013-12-19T09:48:07Z</creditNoteDate>
<created>2013-12-19T09:47:43Z</created>
</details>
<status>
<code>RELEASED</code>
<name>Released</name>
<reasonCode>RELEASEDOFFLINE</reasonCode>
<reasonName>Released Offline</reasonName>
<date>2013-12-19T09:48:07Z</date>
</status>
<lines>
<line>
<ref>272</ref>
<orderItemRef>42069</orderItemRef>
<orderLine>3</orderLine>
<details>
<reason>12</reason>
<reasonDescription>The user is disappointed with the delivery time.</reasonDescription>
</details>
<payments>
<payment>
<ref>6376</ref>
<paymentRef>4616</paymentRef>
<details>
<costGross>12</costGross>
<costNet>9.6</costNet>
<costVat>2.4</costVat>
</details>
<status>
<code>NEW</code>
<name>New</name>
</status>
</payment>
</payments>
</line>
</lines>
</refund>
<refund>
<ref>5091</ref>
<creditNoteNumber>CFR2</creditNoteNumber>
<details>
<creditNoteDate>2013-12-19T09:49:38Z</creditNoteDate>
<created>2013-12-19T09:49:15Z</created>
</details>
<status>
<code>RELEASED</code>
<name>Released</name>
<reasonCode>RELEASEDOFFLINE</reasonCode>
<reasonName>Released Offline</reasonName>
<date>2013-12-19T09:49:38Z</date>
</status>
<lines>
<line>
<ref>273</ref>
<orderItemRef>42067</orderItemRef>
<orderLine>1</orderLine>
<details>
<reason>RETURN</reason>
<reasonDescription>Refund for return RMA-CS-900102009-1</reasonDescription>
</details>
<payments>
<payment>
<ref>6377</ref>
<paymentRef>4616</paymentRef>
<details>
<costGross>29.95</costGross>
<costNet>23.96</costNet>
<costVat>5.99</costVat>
</details>
<status>
<code>NEW</code>
<name>New</name>
</status>
</payment>
</payments>
</line>
</lines>
</refund>
</refunds>
</order>
</refundDetail>
Return Detail
The return-detail feed notifies the partner when a return is approved (E.g., a return is received and accepted by the LSP, a proof of delivery is provided to the customer if the return is lost). This is identical to the returns block in the main order-detail feed but sent individually, typically after each return is completed.
| Sender / Receiver | OMS > Partner |
| Frequency | Near real time when the return status is set to APPROVED |
| Format | XML |
| Transport | sFTP |
| Filename | <client>_return-detail_YYYYMMDDHH24MISSUUUUUU.xml |
| Acknowledgement | Not applicable |
Schema
Overview
Example
<?xml version="1.0" encoding="UTF-8"?>
<returnDetail xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xsi:noNamespaceSchemaLocation="../../schema/return-detail.xsd">
<client>CLIENT</client>
<order>
<ref>12235</ref>
<id>900102009</id>
<store>FR</store>
<details>
<created>2013-12-18T11:40:28Z</created>
<customer>896157</customer>
<customerType>REGISTERED</customerType>
<ip>59.78.252.38</ip>
<language>fr-FR</language>
<vatCountry>FR</vatCountry>
<origin>WEB</origin>
<originDate>2013-12-18T10:22:33Z</originDate>
<customerReference>Deliver next door</customerReference>
<giftMessage>Happy Birthday </giftMessage>
<csAgent/>
<fingerprint/>
</details>
<status>
<code>COMPLETE</code>
<name>Complete</name>
<reasonCode>PARTIALLYSHIPPED</reasonCode>
<reasonName>Order processing completed</reasonName>
<date>2013-12-19T09:33:09Z</date>
</status>
<people>
<person>
<ref>9932</ref>
<title>Lady</title>
<firstName>Jane</firstName>
<lastName>Doe</lastName>
<phone>123456789</phone>
<fax>123456789</fax>
<mobile>123456789</mobile>
<email>jane@jane.com</email>
<department/>
<companyName/>
<gender>M</gender>
<dateofbirth>1976-05-12</dateofbirth>
</person>
</people>
<addresses>
<address>
<ref>8343</ref>
<addresstype>customer</addresstype>
<address1>Church road</address1>
<address2>33</address2>
<city>London</city>
<state/>
<zip>NW4 4EB</zip>
<country>
<code>GB</code>
<name>UNITED KINGDOM</name>
</country>
</address>
<address>
<ref>8361</ref>
<addresstype>customer</addresstype>
<address1>Place du Pantheon</address1>
<address2>10</address2>
<city>Paris</city>
<state/>
<zip>75005</zip>
<country>
<code>FR</code>
<name>FRANCE</name>
</country>
</address>
</addresses>
<payments>
<payment>
<ref>4616</ref>
<currency>EUR</currency>
<transactions>
<transaction>
<details>
<method>CC</method>
<submethod>VISA</submethod>
<amount>91.9</amount>
<expirationDate>2014-05-23 00:00:00</expirationDate>
</details>
<billToAddress>
<personRef>9932</personRef>
<addressRef>8361</addressRef>
</billToAddress>
</transaction>
</transactions>
</payment>
</payments>
<items>
<item>
<ref>42067</ref>
<line>1</line>
<id/>
<details>
<itemType>PHYSICAL</itemType>
<clientCode>F0CWT012</clientCode>
<styleCode>F0CWT012</styleCode>
<itemName/>
<clientSku>8718342982213</clientSku>
<sku>8718342982213</sku>
<serialNumber/>
<optionName>WMN 12-3V332 C&S TShirt aop</optionName>
<localName>WMN 12-3V332 C&S TShirt aop</localName>
</details>
<shipToAddress>
<personRef>9932</personRef>
<addressRef>8343</addressRef>
</shipToAddress>
<status>
<code>SHIPPED</code>
<name>Shipped</name>
<reasonCode>OSREPORT</reasonCode>
<reasonName>Reported shipped in OS feed</reasonName>
<date>2013-12-19T09:33:08Z</date>
</status>
<payments>
<payment>
<ref>46413</ref>
<paymentRef>4616</paymentRef>
<details>
<costGross>29.95</costGross>
<costNet>23.96</costNet>
<costVat>5.99</costVat>
<vatRate>25</vatRate>
<vatDetail>
<vat>
<type>VAT</type>
<amount>5.99</amount>
<rate>25.00</rate>
</vat>
</vatDetail>
</details>
<status>
<code>CAPTURED</code>
<name>Captured</name>
</status>
</payment>
</payments>
</item>
<item>
<ref>42068</ref>
<line>2</line>
<id/>
<details>
<itemType>PHYSICAL</itemType>
<clientCode>K1KHD002</clientCode>
<styleCode>K1KHD002</styleCode>
<itemName/>
<clientSku>8718342146752</clientSku>
<sku>8718342146752</sku>
<serialNumber/>
<optionName>Kids Girls Dress Light Weight</optionName>
<localName>Kids Girls Dress Light Weight</localName>
</details>
<shipToAddress>
<personRef>9932</personRef>
<addressRef>8343</addressRef>
</shipToAddress>
<status>
<code>CANCELLED</code>
<name>Cancelled</name>
<reasonCode>OUTOFSTOCK</reasonCode>
<reasonName>Out of stock</reasonName>
<date>2013-12-18T11:40:30Z</date>
</status>
<payments>
<payment>
<ref>46414</ref>
<paymentRef>4616</paymentRef>
<details>
<costGross>49.95</costGross>
<costNet>39.96</costNet>
<costVat>9.99</costVat>
<vatRate>25</vatRate>
<vatDetail>
<vat>
<type>VAT</type>
<amount>9.99</amount>
<rate>25.00</rate>
</vat>
</vatDetail>
</details>
<status>
<code>CANCELLED</code>
<name>Cancelled</name>
</status>
</payment>
</payments>
</item>
<item>
<ref>42069</ref>
<line>3</line>
<id/>
<details>
<itemType>SHIPPING</itemType>
<clientCode>SHIPPING</clientCode>
<styleCode>SHIPPING</styleCode>
<itemName/>
<clientSku>STANDARD</clientSku>
<sku>STANDARD</sku>
<serialNumber/>
<optionName>Standard</optionName>
<localName>Standard Shipping</localName>
</details>
<shipToAddress>
<personRef>9932</personRef>
<addressRef>8343</addressRef>
</shipToAddress>
<status>
<code>SHIPPED</code>
<name>Shipped</name>
<reasonCode>OSREPORT</reasonCode>
<reasonName>Reported shipped in OS feed</reasonName>
<date>2013-12-19T09:33:08Z</date>
</status>
<payments>
<payment>
<ref>46415</ref>
<paymentRef>4616</paymentRef>
<details>
<costGross>12</costGross>
<costNet>9.6</costNet>
<costVat>2.4</costVat>
<vatRate>25</vatRate>
<vatDetail>
<vat>
<type>VAT</type>
<amount>2.40</amount>
<rate>25.00</rate>
</vat>
</vatDetail>
</details>
<status>
<code>CAPTURED</code>
<name>Captured</name>
</status>
</payment>
</payments>
</item>
</items>
<returns>
<return>
<ref>155</ref>
<rma>RMA-CS-900102009-1</rma>
<details>
<created>2013-12-19T09:49:15Z</created>
</details>
<status>
<code>APPROVED</code>
<name>Approved</name>
<reasonCode>LOST</reasonCode>
<reasonName>Return lost</reasonName>
<date>2013-12-19T09:49:23Z</date>
</status>
<lines>
<line>
<ref>165</ref>
<orderItemRef>42067</orderItemRef>
<line>1</line>
<orderLine>1</orderLine>
<details>
<reason>4</reason>
<reasonDescription>The customer reports that the t-shirt is not long enough in the arms.</reasonDescription>
<condition/>
<sourceId/>
</details>
</line>
</lines>
</return>
</returns>
</order>
</returnDetail>
Reshipments and Exchange Orders
Reshipments and Exchange orders are API based but are showed in the reporting feeds which are XML based. See two examples below for order-detail. It is the same for return-detail and refund-detail.
Reshipments Example
<?xml version="1.0" encoding="UTF-8"?>
<orderDetail xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
xsi:noNamespaceSchemaLocation="../../schema/order-detail.xsd">
<client>CLIENT</client>
<feed>order-detail</feed>
<order>
<id>R00152272</id>
<originalOrder>500354544</originalOrder>
<store>FR</store>
<details>
<created>2017-03-28T21:02:03+00:00</created>
<customer>896157</customer>
<customerType>REGISTERED</customerType>
<ip>59.78.252.38</ip>
<language>fr-FR</language>
<vatCountry>FR</vatCountry>
<origin>RE</origin>
<originDate>2017-03-28T21:02:02Z</originDate>
<customerReference>Deliver next door</customerReference>
<giftMessage>Happy Birthday </giftMessage>
<csAgent><![CDATA[CLIENT@cs_agent]]></csAgent>
<fingerprint/>
</details>
<status>
<code>COMPLETE</code>
<name>Complete</name>
<reasonCode>FULLYSHIPPED</reasonCode>
<reasonName><![CDATA[Order completed, fully shipped]]></reasonName>
<date>2017-03-29T11:17:11+00:00</date>
</status>
<people>
<person>
<ref>9932</ref>
<title>Lady</title>
<firstName>Jane</firstName>
<lastName>Doe</lastName>
<phone>123456789</phone>
<fax>123456789</fax>
<mobile>123456789</mobile>
<email><![CDATA[jane@jane.com]]></email>
<department/>
<companyName/>
<taxIdentifier/>
<gender>F</gender>
<dateofbirth>1976-05-12</dateofbirth>
<shipping>1</shipping>
</person>
<person>
<ref>9933</ref>
<title>Lady</title>
<firstName>Jane</firstName>
<lastName>Doe</lastName>
<phone>123456789</phone>
<fax>123456789</fax>
<mobile>123456789</mobile>
<email><![CDATA[jane@jane.com]]></email>
<department/>
<companyName/>
<taxIdentifier/>
<gender>F</gender>
<dateofbirth>1976-05-12</dateofbirth>
<billing>1</billing>
</person>
</people>
<addresses>
<address>
<ref>8343</ref>
<addresstype>customer</addresstype>
<address1><![CDATA[Church road]]></address1>
<address2>33</address2>
<city>London</city>
<state/>
<zip><![CDATA[NW4 4EB]]></zip>
<country>
<code>GB</code>
<name>UNITED KINGDOM</name>
</country>
<shipping>1</shipping>
</address>
<address>
<ref>8361</ref>
<addresstype>customer</addresstype>
<address1><![CDATA[Place du Pantheon]]></address1>
<address2>10</address2>
<city>Paris</city>
<state/>
<zip><![CDATA[75005]]></zip>
<country>
<code>FR</code>
<name>FRANCE</name>
</country>
<billing>1</billing>
</address>
</addresses>
<payments>
<payment>
<ref>4616</ref>
<currency>EUR</currency>
<transactions>
<transaction>
<details>
<method>ZEROPAY</method>
<submethod>ZEROPAY</submethod>
<amount>0</amount>
<amountCaptured>0</amountCaptured>
<expirationDate/>
</details>
<billToAddress>
<personRef>9933</personRef>
<addressRef>8361</addressRef>
</billToAddress>
</transaction>
</transactions>
</payment>
</payments>
<items>
<item>
<ref>42067</ref>
<line>1</line>
<originalLine>1</originalLine>
<id>F0CWT012</id>
<details>
<itemType>PHYSICAL</itemType>
<clientCode>F0CWT012</clientCode>
<styleCode>F0CWT012</styleCode>
<itemName/>
<clientSku>8718342982213</clientSku>
<sku>8718342982213</sku>
<serialNumber>KSQ980021876630103302</serialNumber>
<optionName><![CDATA[WMN 12-3V332 CS TShirt aop]]></optionName>
<localName><![CDATA[WMN 12-3V332 CS TShirt aop]]></localName>
<customDetails>
<param>
<key>productUrl</key>
<value><![CDATA[http://host.com/8718342982213.html]]></value>
</param>
<param>
<key>imageUrl</key>
<value><![CDATA[http:/host/8718342982213.jpg]]></value>
</param>
</customDetails>
<warehouseData>
<warehouseMeasurements/>
<warehouseInfo>
<param>
<key>UPC</key>
<value>6547456764456</value>
</param>
</warehouseInfo>
</warehouseData>
</details>
<shipToAddress>
<personRef>9932</personRef>
<addressRef>8343</addressRef>
</shipToAddress>
<status>
<code>SHIPPED</code>
<name>Shipped</name>
<reasonCode>OSREPORT</reasonCode>
<reasonName>Reported shipped in OS feed</reasonName>
<date>2017-03-29T11:17:02Z</date>
</status>
<payments>
<payment>
<ref>46413</ref>
<paymentRef>4616</paymentRef>
<details>
<costGross>0</costGross>
<costNet>0</costNet>
<costVat>0</costVat>
<vatRate>0</vatRate>
<vatDetail>
<vat>
<type>VAT</type>
<amount>0</amount>
<rate>0</rate>
</vat>
</vatDetail>
</details>
<status>
<code>CAPTURED</code>
<name>Captured</name>
</status>
</payment>
</payments>
</item>
<item>
<ref>42068</ref>
<line>2</line>
<id>SHIPPING</id>
<details>
<itemType>SHIPPING</itemType>
<clientCode>SHIPPING</clientCode>
<styleCode>SHIPPING</styleCode>
<itemName/>
<clientSku>STANDARD</clientSku>
<sku>STANDARD</sku>
<optionName><![CDATA[Standard]]></optionName>
<localName>Standard Shipping</localName>
</details>
<shipToAddress>
<personRef>9932</personRef>
<addressRef>8343</addressRef>
</shipToAddress>
<status>
<code>SHIPPED</code>
<name>Shipped</name>
<reasonCode>OSREPORT</reasonCode>
<reasonName>Reported shipped in OS feed</reasonName>
<date>2017-03-29T11:17:05Z</date>
</status>
<payments>
<payment>
<ref>46414</ref>
<paymentRef>4616</paymentRef>
<details>
<costGross>0</costGross>
<costNet>0</costNet>
<costVat>0</costVat>
<vatRate>0</vatRate>
<vatDetail>
<vat>
<type>VAT</type>
<amount>0</amount>
<rate>0</rate>
</vat>
</vatDetail>
</details>
<status>
<code>CAPTURED</code>
<name>Captured</name>
</status>
</payment>
</payments>
</item>
</items>
<shipments>
<shipment>
<ref>9212</ref>
<id>FR-R00152272-1</id>
<logisticsId>R00152272</logisticsId>
<invoiceNumber>FR6</invoiceNumber>
<details>
<created>2017-03-29T11:17:02+00:00</created>
<invoiceDate>2017-03-29T11:23:02+00:00</invoiceDate>
<methodCode>STANDARD</methodCode>
<methodName>Standard</methodName>
</details>
<status>
<code>SHIPPED</code>
<name>Shipped</name>
<reasonCode>OSREPORTCOMP</reasonCode>
<reasonName><![CDATA[Reported complete in OS feed]]></reasonName>
<date>2017-03-29T11:17:05+00:00</date>
</status>
<shipToAddress>
<personRef>9932</personRef>
<addressRef>8343</addressRef>
</shipToAddress>
<lines>
<line>
<ref>70934</ref>
<orderItemRef>42067</orderItemRef>
<line>1</line>
<orderLine>1</orderLine>
</line>
<line>
<ref>70935</ref>
<orderItemRef>42068</orderItemRef>
<line>2</line>
<orderLine>2</orderLine>
</line>
</lines>
<packages>
<package>
<carrier>CARRIER</carrier>
<trackingNumber>123456</trackingNumber>
<trackingComment/>
<boxNumber>456</boxNumber>
<trackingLink>http://www.test.com/track?tn=123456</trackingLink>
<lines>
<line>
<orderItemRef>42067</orderItemRef>
<orderLine>1</orderLine>
</line>
</lines>
</package>
</packages>
</shipment>
</shipments>
</order>
</orderDetail>
Exchange Example
<?xml version="1.0" encoding="UTF-8"?>
<orderDetail xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
xsi:noNamespaceSchemaLocation="../../schema/order-detail.xsd">
<client>CLIENT</client>
<feed>order-detail</feed>
<order>
<id>E00152272</id>
<originalOrder>500354544</originalOrder>
<store>FR</store>
<details>
<created>2017-03-28T21:02:03+00:00</created>
<customer>896157</customer>
<customerType>REGISTERED</customerType>
<ip>59.78.252.38</ip>
<language>fr-FR</language>
<vatCountry>FR</vatCountry>
<origin>EX</origin>
<originDate>2017-03-28T21:02:02Z</originDate>
<customerReference>Deliver next door</customerReference>
<giftMessage>Happy Birthday </giftMessage>
<csAgent><![CDATA[CLIENT@cs_agent]]></csAgent>
<fingerprint/>
</details>
<status>
<code>COMPLETE</code>
<name>Complete</name>
<reasonCode>FULLYSHIPPED</reasonCode>
<reasonName><![CDATA[Order completed, fully shipped]]></reasonName>
<date>2017-03-29T11:17:11+00:00</date>
</status>
<people>
<person>
<ref>9932</ref>
<title>Lady</title>
<firstName>Jane</firstName>
<lastName>Doe</lastName>
<phone>123456789</phone>
<fax>123456789</fax>
<mobile>123456789</mobile>
<email><![CDATA[jane@jane.com]]></email>
<department/>
<companyName/>
<taxIdentifier/>
<gender>F</gender>
<dateofbirth>1976-05-12</dateofbirth>
<shipping>1</shipping>
</person>
<person>
<ref>9933</ref>
<title>Lady</title>
<firstName>Jane</firstName>
<lastName>Doe</lastName>
<phone>123456789</phone>
<fax>123456789</fax>
<mobile>123456789</mobile>
<email><![CDATA[jane@jane.com]]></email>
<department/>
<companyName/>
<taxIdentifier/>
<gender>F</gender>
<dateofbirth>1976-05-12</dateofbirth>
<billing>1</billing>
</person>
</people>
<addresses>
<address>
<ref>8343</ref>
<addresstype>customer</addresstype>
<address1><![CDATA[Church road]]></address1>
<address2>33</address2>
<city>London</city>
<state/>
<zip><![CDATA[NW4 4EB]]></zip>
<country>
<code>GB</code>
<name>UNITED KINGDOM</name>
</country>
<shipping>1</shipping>
</address>
<address>
<ref>8361</ref>
<addresstype>customer</addresstype>
<address1><![CDATA[Place du Pantheon]]></address1>
<address2>10</address2>
<city>Paris</city>
<state/>
<zip><![CDATA[75005]]></zip>
<country>
<code>FR</code>
<name>FRANCE</name>
</country>
<billing>1</billing>
</address>
</addresses>
<payments>
<payment>
<ref>4616</ref>
<currency>EUR</currency>
<transactions>
<transaction>
<details>
<method>ZEROPAY</method>
<submethod>ZEROPAY</submethod>
<amount>0</amount>
<amountCaptured>0</amountCaptured>
<expirationDate/>
</details>
<billToAddress>
<personRef>9933</personRef>
<addressRef>8361</addressRef>
</billToAddress>
</transaction>
</transactions>
</payment>
</payments>
<items>
<item>
<ref>42067</ref>
<line>1</line>
<originalLine>1</originalLine>
<id>F0CWT012</id>
<details>
<itemType>PHYSICAL</itemType>
<clientCode>F0CWT012</clientCode>
<styleCode>F0CWT012</styleCode>
<itemName/>
<clientSku>8718342982213</clientSku>
<sku>8718342982213</sku>
<serialNumber>KSQ980021876630103302</serialNumber>
<optionName><![CDATA[WMN 12-3V332 CS TShirt aop]]></optionName>
<localName><![CDATA[WMN 12-3V332 CS TShirt aop]]></localName>
<customDetails>
<param>
<key>productUrl</key>
<value><![CDATA[http://host.com/8718342982213.html]]></value>
</param>
<param>
<key>imageUrl</key>
<value><![CDATA[http:/host/8718342982213.jpg]]></value>
</param>
</customDetails>
<warehouseData>
<warehouseMeasurements/>
<warehouseInfo>
<param>
<key>UPC</key>
<value>6547456764456</value>
</param>
</warehouseInfo>
</warehouseData>
</details>
<shipToAddress>
<personRef>9932</personRef>
<addressRef>8343</addressRef>
</shipToAddress>
<status>
<code>SHIPPED</code>
<name>Shipped</name>
<reasonCode>OSREPORT</reasonCode>
<reasonName>Reported shipped in OS feed</reasonName>
<date>2017-03-29T11:17:02Z</date>
</status>
<payments>
<payment>
<ref>46413</ref>
<paymentRef>4616</paymentRef>
<details>
<costGross>0</costGross>
<costNet>0</costNet>
<costVat>0</costVat>
<vatRate>0</vatRate>
<vatDetail>
<vat>
<type>VAT</type>
<amount>0</amount>
<rate>0</rate>
</vat>
</vatDetail>
</details>
<status>
<code>CAPTURED</code>
<name>Captured</name>
</status>
</payment>
</payments>
</item>
<item>
<ref>42068</ref>
<line>2</line>
<id>SHIPPING</id>
<details>
<itemType>SHIPPING</itemType>
<clientCode>SHIPPING</clientCode>
<styleCode>SHIPPING</styleCode>
<itemName/>
<clientSku>STANDARD</clientSku>
<sku>STANDARD</sku>
<optionName><![CDATA[Standard]]></optionName>
<localName>Standard Shipping</localName>
</details>
<shipToAddress>
<personRef>9932</personRef>
<addressRef>8343</addressRef>
</shipToAddress>
<status>
<code>SHIPPED</code>
<name>Shipped</name>
<reasonCode>OSREPORT</reasonCode>
<reasonName>Reported shipped in OS feed</reasonName>
<date>2017-03-29T11:17:05Z</date>
</status>
<payments>
<payment>
<ref>46414</ref>
<paymentRef>4616</paymentRef>
<details>
<costGross>0</costGross>
<costNet>0</costNet>
<costVat>0</costVat>
<vatRate>0</vatRate>
<vatDetail>
<vat>
<type>VAT</type>
<amount>0</amount>
<rate>0</rate>
</vat>
</vatDetail>
</details>
<status>
<code>CAPTURED</code>
<name>Captured</name>
</status>
</payment>
</payments>
</item>
</items>
<shipments>
<shipment>
<ref>9212</ref>
<id>FR-E00152272-1</id>
<logisticsId>E00152272</logisticsId>
<invoiceNumber>FR6</invoiceNumber>
<details>
<created>2017-03-29T11:17:02+00:00</created>
<invoiceDate>2017-03-29T11:23:02+00:00</invoiceDate>
<methodCode>STANDARD</methodCode>
<methodName>Standard</methodName>
</details>
<status>
<code>SHIPPED</code>
<name>Shipped</name>
<reasonCode>OSREPORTCOMP</reasonCode>
<reasonName><![CDATA[Reported complete in OS feed]]></reasonName>
<date>2017-03-29T11:17:05+00:00</date>
</status>
<shipToAddress>
<personRef>9932</personRef>
<addressRef>8343</addressRef>
</shipToAddress>
<lines>
<line>
<ref>70934</ref>
<orderItemRef>42067</orderItemRef>
<line>1</line>
<orderLine>1</orderLine>
</line>
<line>
<ref>70935</ref>
<orderItemRef>42068</orderItemRef>
<line>2</line>
<orderLine>2</orderLine>
</line>
</lines>
<packages>
<package>
<carrier>CARRIER</carrier>
<trackingNumber>123456</trackingNumber>
<trackingComment/>
<boxNumber>456</boxNumber>
<trackingLink>http://www.test.com/track?tn=123456</trackingLink>
<lines>
<line>
<orderItemRef>42067</orderItemRef>
<orderLine>1</orderLine>
</line>
</lines>
</package>
</packages>
</shipment>
</shipments>
</order>
</orderDetail>