Orderlist read v2
The GET orderlist function returns a set of orders, filtered by the parameters in your payload.
Orderslist results will be capped at 500 orders. You can use filters to specify your results.
Orders older than 30 days cannot be retrieved through the API.
Request payload
| Field | Obligatory | Type | Default value | Description |
| filters | no | FilterType | Filter to be applied when fetching orders |
Response payload
| Field | Obligatory | Type | Description |
| Count | yes | integer | Number of orders returned |
| Orders | yes | collection of order |
xsd: https://submit.effectconnect.com/xsd/order_read_response
Request example
<?xml version="1.0" encoding="utf-8"?>
<list>
<filters>
<fromDateFilter>
<filterValue>2018-06-14T12:12:12</filterValue>
</fromDateFilter>
<toDateFilter>
<filterValue>2018-06-16T23:59:59</filterValue>
</toDateFilter>
<hasStatusFilter>
<filterValue>paid</filterValue>
</hasStatusFilter>
<hasTagFilter>
<filterValue>
<tagName>Test</tagName>
<exclude>false</exclude>
</filterValue>
</hasTagFilter>
</filters>
</list>
Response payload
<?xml version="1.0" encoding="utf-8"?>
<ApiResponseContainer>
<Request>
<RequestType>OrderList</RequestType>
<RequestAction>Read</RequestAction>
<RequestVersion>2.0</RequestVersion>
<RequestIdentifier/>
<ProcessedAt>2018-06-18T13:48:18+02:00</ProcessedAt>
</Request>
<Response>
<Result>Success</Result>
<OrderListReadResponseContainer>
<Count>1</Count>
<Orders>
<order>
<identifiers>
<connectionNumber>str1234</connectionNumber>
<effectConnectNumber>str1234</effectConnectNumber>
<channelNumber>str1234</channelNumber>
</identifiers>
<channelInfo>
<id>123</id>
<type>bol.com</type>
<subtype>nl</subtype>
<title>Bol.com kanaal</title>
</channelInfo>
<currency>EUR</currency>
<isTaxShifted>false</isTaxShifted>
<date>2018-06-15T12:12:12+02:00</date>
<status>paid</status>
<billingAddress>
<salutation>m</salutation>
<firstName>Jan</firstName>
<lastName>Janssen</lastName>
<company>Janssen en co b.v.</company>
<street>Straat</street>
<houseNumber>1</houseNumber>
<houseNumberExtension>a</houseNumberExtension>
<addressNote>verdieping</addressNote>
<zipCode>1234AB</zipCode>
<city>Testcity</city>
<state>Limburg</state>
<country>NL</country>
<phone>0859021855</phone>
<email>support@effectconnect.com</email>
</billingAddress>
<shippingAddress>
<salutation>m</salutation>
<firstName>Jan</firstName>
<lastName>Janssen</lastName>
<company>Janssen en co b.v.</company>
<street>Straat</street>
<houseNumber>1</houseNumber>
<houseNumberExtension>a</houseNumberExtension>
<addressNote>verdieping</addressNote>
<zipCode>1234AB</zipCode>
<city>Testcity</city>
<state>Limburg</state>
<country>NL</country>
<phone>0859021855</phone>
<email>support@effectconnect.com</email>
</shippingAddress>
<lines>
<line>
<identifiers>
<connectionLineId>str1234</connectionLineId>
<effectConnectLineId>str5678</effectConnectLineId>
<channelLineId>str91011</channelLineId>
</identifiers>
<product>
<ID>12345</ID>
<EAN>1234567890123</EAN>
<SKU>SK123-A</SKU>
</product>
<productId>12345</productId>
<productTitle>Test product</productTitle>
<lineAmount>123.45</lineAmount>
<status>line_paid</status>
<statusHistory>
<status>
<date>2018-06-15T12:12:12+02:00</date>
<status>line_paid</status>
</status>
</statusHistory>
<fees>
<fee>
<type>commission</type>
<amount>12.34</amount>
</fee>
</fees>
<attributes>
<attribute>
<code>additional_services</code>
<values>
<value>packing_service</value>
<value>shipping_name_on_box</value>
</values>
</attribute>
</attributes>
</line>
</lines>
<fees>
<fee>
<type>commission</type>
<amount>12.34</amount>
</fee>
</fees>
<attributes>
<attribute>
<code>customer_language</code>
<values>
<value>NL</value>
</values>
</attribute>
</attributes>
<tags>
<tag>customtesttag</tag>
</tags>
</order>
</Orders>
</OrderListReadResponseContainer>
</Response>
</ApiResponseContainer>