IOM Connector 4.0 - REST API - Get List of Documents of the Order

Personal Library

URI	/orders/<order-id>/documents/
Http Method	GET
Short Description	Returns a list of links to order's documents resources
Query Parameters	none
Example Requests	/orders/y.UKDACPMIQAAAFYFlQGqAA1/documents/
HTTP Status Codes	200 OK 403 Forbidden
Description	List links to all order's documents resources are provided. Additionally, one could filter by document's type by issuing an request to the following URIs: /orders/<order-id>/documents/creditnotes /orders/<order-id>/documents/delivery /orders/<order-id>/documents/invoicecreditnotes /orders/<order-id>/documents/invoices Note Since 6.0.10 /orders/<order-id>/documents/returnlabel /orders/<order-id>/documents/returnslip
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.OrderDocumentsResource com.intershop.component.rest.capi.resourceobject.ResourceCollectionRO<LinkRO>
Response data example	{ "elements": [ { "type": "Link", "uri": "inSPIRED-inTRONICS-Site/-/orders/y.UKDACPMIQAAAFYFlQGqAA1/documents/k%3D10461170bff6fdf19839458e596bb7ddeae8eddbfb8b797e2f1073935c90614e4bb4be53975de524b0c1b4e1aad498ac95fc642ab23f3054fad168640b753c0168a44%26i%3D10461%26s%3D10000", "title": "invoiceNote_26102603_2016-10-26T11:54:29.364" } ], "type": "ResourceCollection" }

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.OrderDocumentsResource com.intershop.component.rest.capi.resourceobject.ResourceCollectionRO<LinkRO>
Response data example	<?xml version="1.0" encoding="UTF-8" standalone="yes"?> <ResourceCollection type="ResourceCollection"> <elements> <Link type="Link"> <title>invoiceNote_26102603_2016-10-26T11:54:29.364</title> <uri>inSPIRED-inTRONICS-Site/-/orders/y.UKDACPMIQAAAFYFlQGqAA1/documents/k%3D10461170bff6fdf19839458e596bb7ddeae8eddbfb8b797e2f1073935c90614e4bb4be53975de524b0c1b4e1aad498ac95fc642ab23f3054fad168640b753c0168a44%26i%3D10461%26s%3D10000</uri> </Link> </elements> </ResourceCollection>

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.