Related Documents
Document Properties
Kbid
279E63
Last Modified
31-May-2022
Added to KB
01-Aug-2016
Public Access
Everyone
Status
Online
Doc Type
References
Product
  • ICM 7.8
  • ICM 7.9
  • ICM 7.10

REST API - Get list of individual customer's recurring orders


Note

Starting with Intershop 7.10 our REST API is provided in the Open API 3.0 format, see Reference - Intershop Commerce Management 7.10 REST API.

URI

/customers/<customer-id>/recurringorders

Http Method

GET

Short Description

Returns a list of recurring orders of the given individual customer

Query Parameters

none

Example Requests

/customers/Patricia/recurringorders

HTTP Status Codes

200 OK

401 Unauthorized

501 Not implemented (If the recurring order feature is disabled)

Possible values for header value "error-key":

    • error.recurring_orders.disabled

503 Service Unavailable (If Micro service is not available and/or can not be discovered)

Description

Clients accessing this URI will be provided with list of links to recurring orders details of individual customer with <customer-id>.

The most important attributes for each item are also included in this list.

Cartridge

app_sf_rest, app_sf_rest_b2c
Application

B2C Web Shop

Product Version

7.8

Product To Version

 
Status

JSON

Request data format

 

Request related java object

n/a

Request data example

n/a

Response data format

application/json

Response related java object

com.intershop.sellside.rest.common.capi.resource.recurringorder.RecurringOrderListResource
com.intershop.sellside.rest.common.capi.resourceobject.recurringorder.RecurringOrderLinkRO
com.intershop.sellside.rest.common.capi.resourceobject.recurringorder.RecurringOrderLinkROResourceCollection<RecurringOrderLinkRO>

Response data example

{
  "elements": [
    {
      "type": "RecurringOrderLink",
      "creationDate": 1477382251000,
      "startDate": 1477386600000,
      "endDate": 1496314800000,
      "totalNet": {
        "type": "Money",
        "value": 24.97,
        "currencyMnemonic": "USD"
      },
      "totalGross": {
        "type": "Money",
        "value": 29.71,
        "currencyMnemonic": "USD"
      },
      "number": "0000002",
      "interval": "P1D",
      "active": true,
      "itemCount": 1,
      "priceType": "gross",
      "buyer": {
        "type": "RecurringOrderBuyer",
        "title": "",
        "firstName": "Patricia",
        "lastName": "Miller",
        "businessPartnerNo": "Patricia",
        "department": "",
        "login": "patricia@test.intershop.de"
      },
      "link": {
        "type": "Link",
        "uri": "inSPIRED-inTRONICS-Site/-/customers/Patricia/recurringorders/Kq0KDgA.zVoAAAFXKCkm3PrX",
        "title": "Kq0KDgA.zVoAAAFXKCkm3PrX"
      }
    }
  ],
  "type": "RecurringOrderLinkResourceCollection"
}

XML

Request data format

 

Request related java object

n/a

Request data example

n/a

Response data format

text/xml

Response related java object

com.intershop.sellside.rest.common.capi.resource.recurringorder.RecurringOrderListResource
com.intershop.sellside.rest.common.capi.resourceobject.recurringorder.RecurringOrderLinkRO
com.intershop.sellside.rest.common.capi.resourceobject.recurringorder.RecurringOrderLinkROResourceCollection<RecurringOrderLinkRO>

Response data example

<?xml version="1.0" encoding="UTF-8" standalone="yes"?>
<RecurringOrderLinkResourceCollection type="RecurringOrderLinkResourceCollection">
    <elements>
        <RecurringOrderLink type="RecurringOrderLink">
            <interval>P1D</interval>
            <active>true</active>
            <buyer type="RecurringOrderBuyer">
                <businessPartnerNo>Patricia</businessPartnerNo>
                <department></department>
                <firstName>Patricia</firstName>
                <lastName>Miller</lastName>
                <login>patricia@test.intershop.de</login>
                <title></title>
            </buyer>
            <creationDate>2016-10-25T09:57:31+02:00</creationDate>
            <endDate>2017-06-01T13:00:00+02:00</endDate>
            <itemCount>1</itemCount>
            <link type="Link">
                <title>Kq0KDgA.zVoAAAFXKCkm3PrX</title>
                <uri>inSPIRED-inTRONICS-Site/-/customers/Patricia/recurringorders/Kq0KDgA.zVoAAAFXKCkm3PrX</uri>
            </link>
            <number>0000002</number>
            <priceType>gross</priceType>
            <startDate>2016-10-25T11:10:00+02:00</startDate>
            <totalGross type="Money">
                <currencyMnemonic>USD</currencyMnemonic>
                <value>29.71</value>
            </totalGross>
            <totalNet type="Money">
                <currencyMnemonic>USD</currencyMnemonic>
                <value>24.97</value>
            </totalNet>
        </RecurringOrderLink>
    </elements>
</RecurringOrderLinkResourceCollection>

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
Tickets