IOM Connector 4.0 - REST API - Get Document Information

Personal Library

https://support.intershop.com/kb/2P8197

URI	/orders/<order-id>/documents/<document-id>
Http Method	GET
Short Description	Provides an information for a given order document.
Query Parameters	none
Example Requests	/orders/y.UKDACPMIQAAAFYFlQGqAA1/documents/k%3D10461170bff6fdf19839458e596bb7ddeae8eddbfb8b797e2f1073935c90614e4bb4be53975de524b0c1b4e1aad498ac95fc642ab23f3054fad168640b753c0168a44%26i%3D10461%26s%3D10000
HTTP Status Codes	200 OK 403 Forbidden 404 Not found
Description	Provides an information for a given order document. This information include: Document's type Document's name URI to download the document Creation date of the document
Cartridge	ac_iomconnector_orderhistory
Application	B2C Web Shop, SMB Web Shop

Product Version	4.0
Product To Version
Status	New Labels

JSON

Request data format	n.a.
Request related java object	n/a
Request data example	n/a
Response data format	application/json
Response related java object	com.intershop.adapter.iomconnector.rest.capi.resource.order.document.OrderDocumentResource com.intershop.adapter.iomconnector.rest.capi.resourceobject.order.document.OrderDocumentRO
Response data example	{ "type": "invoiceNote", "name": "invoiceNote_26102603_2016-10-26T11:54:29.364", "downloadLink": "inSPIRED-inTRONICS-Site/-/orders/y.UKDACPMIQAAAFYFlQGqAA1/documents/k=10461170bff6fdf19839458e596bb7ddeae8eddbfb8b797e2f1073935c90614e4bb4be53975de524b0c1b4e1aad498ac95fc642ab23f3054fad168640b753c0168a44&i=10461&s=10000/download", "creationDate": [ 2016, 10, 26, 11, 54, 29, 364000000 ], "id": "k=10461170bff6fdf19839458e596bb7ddeae8eddbfb8b797e2f1073935c90614e4bb4be53975de524b0c1b4e1aad498ac95fc642ab23f3054fad168640b753c0168a44&i=10461&s=10000" }

XML

Request data format	n.a.
Request related java object	n/a
Request data example	n/a
Response data format	text/xml
Response related java object	com.intershop.adapter.iomconnector.rest.capi.resource.order.document.OrderDocumentResource com.intershop.adapter.iomconnector.rest.capi.resourceobject.order.document.OrderDocumentRO
Response data example	<?xml version="1.0" encoding="UTF-8" standalone="yes"?> <OrderDocumentRO name="invoiceNote_26102603_2016-10-26T11:54:29.364" type="invoiceNote"> <downloadLink>inSPIRED-inTRONICS-Site/-/orders/y.UKDACPMIQAAAFYFlQGqAA1/documents/k=10461170bff6fdf19839458e596bb7ddeae8eddbfb8b797e2f1073935c90614e4bb4be53975de524b0c1b4e1aad498ac95fc642ab23f3054fad168640b753c0168a44&i=10461&s=10000/download</downloadLink> <ID>k=10461170bff6fdf19839458e596bb7ddeae8eddbfb8b797e2f1073935c90614e4bb4be53975de524b0c1b4e1aad498ac95fc642ab23f3054fad168640b753c0168a44&i=10461&s=10000</ID> </OrderDocumentRO>

Disclaimer

The information provided in the Knowledge Base may not be applicable to all systems and situations. Intershop Communications will not be liable to any party for any direct or indirect damages resulting from the use of the Customer Support section of the Intershop Corporate Web site, including, without limitation, any lost profits, business interruption, loss of programs or other data on your information handling system.