ORDER_READ
The order details endpoint allows you to fetch order information for one specific order. By providing the ordernumber in the request,
the response will hold all the available information about the order.
Orders older than 30 days cannot be retrieved through the API.
Request payload
Field | Obligatory | Type | Description |
identifierType | yes | string (1-32) | Possible values: connectionIdentifier, connectionInvoice, connectionNumber, effectConnectNumber, channelIdentifier, channelNumber |
identifier | yes | string | Value of identifier |
Response payload
Field | Obligatory | Type | Description |
Order | yes | order |
xsd: https://submit.effectconnect.com/xsd/order_read_response
Request example
<?xml version="1.0" encoding="utf-8"?>
<order>
<identifierType>effectConnectNumber</identifierType>
<identifier>ec12355</identifier>
</order>
Response example
<?xml version="1.0" encoding="utf-8"?>
<ApiResponseContainer>
<Request>
<RequestType>OrderRead</RequestType>
<RequestAction>Read</RequestAction>
<RequestVersion>2.0</RequestVersion>
<RequestIdentifier/>
<ProcessedAt>2018-06-18T13:48:18+02:00</ProcessedAt>
</Request>
<Response>
<Result>Success</Result>
<OrderReadResponseContainer>
<order>
<identifiers>
<connectionNumber>shop12345</connectionNumber>
<effectConnectNumber>ec12355</effectConnectNumber>
<channelNumber>1234-sdsfd-1314</channelNumber>
</identifiers>
<channelInfo>
<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>
</OrderReadResponseContainer>
</Response>
</ApiResponseContainer>