Related Documents
Document Properties
Kbid2516P8
Last Modified23-Jun-2020
Added to KB20-Sep-2013
Public AccessEveryone
StatusOnline
Doc TypeReferences
Product
  • ICM 7.6
  • ICM 7.7
  • ICM 7.8

REST API - Get order history list (until 7.8)

URI

/orders

Http Method

GET

Short Description

Get a list of links to orders of logged-in user

Query Parameters

optional:

  • pageable – the pageable-ID
  • amount – the size of a page
  • offset – the offset of the first element of the current page

Example Requests

/orders

HTTP Status Codes

200 OK

400 Bad Request

401 Unauthorized

403 Forbidden

500 Internal Server Error

       Possible values for header value "error-key":

    • search.error

Description

The request returns a pageable collection of links to the users orders.
URI:
/orders
/orders?pageable=ZPDAqMgonYMAAAE8Je9sqjkf&amount=5&offset=10
Header: authentication-token: jGb5QloD3p6oUib9wDrAgu0Ib3Hybw5Rl42P9A6fRtlH5RPUbvb9oQ==

Cartridge

app_sf_rest

Application

B2C Web Shop, SMB Web Shop

Product Version

7.4

Product To Version

7.8

Status

final

JSON

Request Data Format

Request related java object

n/a

Request Example

n/a

Response Data Format

application/json

Response related java object

com.intershop.sellside.rest.common.capi.resource.OrderListResource
com.intershop.component.rest.capi.resourceobject.ResourceCollectionRO<LinkRO>

Response Example

{
    "elements": [
        {
            "name": "order",
            "type": "Link",
            "uri": "PrimeTech-PrimeTechSpecials-Site/-/orders/dR8KDgAbeewAAAFBanV9.AGv"
        },
        {
            "name": "order",
            "type": "Link",
            "uri": "PrimeTech-PrimeTechSpecials-Site/-/orders/FNYKDgAb3xQAAAFBjGV9.AGv"
        }
    ],
    "type": "ResourceCollection",
    "name": "orders"
}

XML

XML Request Data Format

XML Request Java Objects

n/a

XML Request Example

n/a

XML Response Data Format

text/xml

XML Response Java Objects

com.intershop.sellside.rest.common.capi.resource.OrderListResource
com.intershop.component.rest.capi.resourceobject.ResourceCollectionRO<LinkRO>

XML Response Example

<?xml version="1.0" encoding="UTF-8" standalone="yes"?>
<ResourceCollection name="orders" type="ResourceCollection">
    <elements>
        <Link name="order" type="Link">
            <uri>PrimeTech-PrimeTechSpecials-Site/-/orders/dR8KDgAbeewAAAFBanV9.AGv</uri>
        </Link>
        <Link name="order" type="Link">
            <uri>PrimeTech-PrimeTechSpecials-Site/-/orders/FNYKDgAb3xQAAAFBjGV9.AGv</uri>
        </Link>
    </elements>
</ResourceCollection>

Reference - WebShop REST APIs

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.

Customer Support
Knowledge Base
Product Resources
Support Tickets