Related Documents
Document Properties
Kbid2Y7955
Last Modified23-Jun-2020
Added to KB01-Aug-2016
Public AccessEveryone
StatusOnline
Doc TypeReferences
Product
  • ICM 7.8
  • ICM 7.9
  • ICM 7.10

REST API - Get list of business user's recurring orders


Note

Starting with 7.10 our REST API is documented using Redoc accessible at docs.intershop.com.

URI

/customers/<customer-id>/recurringorders

Http Method

GET

Short Description

Returns a list of links of all recurring orders for the customer. Account administrator permissions required.

Query Parameters

none

Example Requests

/customers/AgroNet/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 customer with <customer-id>.
The logged in user has to be the account administrator to retrieve this list of all recurring orders of all users of the customer.

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

Note

Only account administrators can see this list of recurring orders.

Cartridge

app_sf_rest, app_sf_rest_smb
Application

SMB Web Shop

Product Version

7.8

Product To Version

 
Status

final

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

Response data example

{
  "elements": [
    {
      "type": "RecurringOrderLink",
      "creationDate": 1474292634000,
      "startDate": 1474279200000,
      "endDate": 1504260000000,
      "lastOrderDate": 1474292641000,
      "totalNet": {
        "type": "Money",
        "value": 57.77,
        "currencyMnemonic": "USD"
      },
      "totalGross": {
        "type": "Money",
        "value": 68.74,
        "currencyMnemonic": "USD"
      },
      "interval": "P3M",
      "repetitions": 0,
      "active": true,
      "itemCount": 1,
      "priceType": "net",
      "buyer": {
        "type": "RecurringOrderBuyer",
        "title": "",
        "firstName": "Fritz",
        "lastName": "Birdo",
        "businessPartnerNo": "fbirdo",
        "department": "",
        "login": "fbirdo@test.intershop.de"
      },
      "link": {
        "type": "Link",
        "uri": "inSPIRED-inTRONICS_Business-Site/-/customers/AgroNet/recurringorders/Or0KDgAh0r0AAAFX20iS9EKw",
        "title": "Or0KDgAh0r0AAAFX20iS9EKw"
      }
    },
    {
      "type": "RecurringOrderLink",
      "creationDate": 1474292650000,
      "startDate": 1474279200000,
      "endDate": 1504260000000,
      "lastOrderDate": 1474292713000,
      "totalNet": {
        "type": "Money",
        "value": 57.77,
        "currencyMnemonic": "USD"
      },
      "totalGross": {
        "type": "Money",
        "value": 68.74,
        "currencyMnemonic": "USD"
      },
      "interval": "P3M",
      "repetitions": 0,
      "active": true,
      "itemCount": 1,
      "priceType": "net",
      "buyer": {
        "type": "RecurringOrderBuyer",
        "title": "",
        "firstName": "Fritz",
        "lastName": "Birdo",
        "businessPartnerNo": "fbirdo",
        "department": "",
        "login": "fbirdo@test.intershop.de"
      },
      "link": {
        "type": "Link",
        "uri": "inSPIRED-inTRONICS_Business-Site/-/customers/AgroNet/recurringorders/0OkKDgAhljIAAAFXqYmS9EKw",
        "title": "0OkKDgAhljIAAAFXqYmS9EKw"
      }
    },
    {
      "type": "RecurringOrderLink",
      "creationDate": 1474293147000,
      "startDate": 1474279200000,
      "endDate": 1504260000000,
      "lastOrderDate": 1474293161000,
      "totalNet": {
        "type": "Money",
        "value": 57.77,
        "currencyMnemonic": "USD"
      },
      "totalGross": {
        "type": "Money",
        "value": 68.74,
        "currencyMnemonic": "USD"
      },
      "interval": "P3M",
      "repetitions": 0,
      "active": true,
      "itemCount": 1,
      "priceType": "net",
      "buyer": {
        "type": "RecurringOrderBuyer",
        "title": "",
        "firstName": "Emil",
        "lastName": "Ducking",
        "businessPartnerNo": "educking",
        "department": "",
        "login": "educking@test.intershop.de"
      },
      "link": {
        "type": "Link",
        "uri": "inSPIRED-inTRONICS_Business-Site/-/customers/AgroNet/recurringorders/QFcKDgAhVkwAAAFX7yCS9EK4",
        "title": "QFcKDgAhVkwAAAFX7yCS9EK4"
      }
    }
  ],
  "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

Response data example

<?xml version="1.0" encoding="UTF-8" standalone="yes"?>
<RecurringOrderLinkResourceCollection type="RecurringOrderLinkResourceCollection">
    <elements>
        <RecurringOrderLink type="RecurringOrderLink">
            <interval>P3M</interval>
            <active>true</active>
            <buyer type="RecurringOrderBuyer">
                <businessPartnerNo>fbirdo</businessPartnerNo>
                <department></department>
                <firstName>Fritz</firstName>
                <lastName>Birdo</lastName>
                <login>fbirdo@test.intershop.de</login>
                <title></title>
            </buyer>
            <creationDate>2016-09-19T15:43:54+02:00</creationDate>
            <endDate>2017-09-01T12:00:00+02:00</endDate>
            <itemCount>1</itemCount>
            <lastOrderDate>2016-09-19T15:44:01+02:00</lastOrderDate>
            <link type="Link">
                <title>Or0KDgAh0r0AAAFX20iS9EKw</title>
                <uri>inSPIRED-inTRONICS_Business-Site/-/customers/AgroNet/recurringorders/Or0KDgAh0r0AAAFX20iS9EKw</uri>
            </link>
            <priceType>net</priceType>
            <repetitions>0</repetitions>
            <startDate>2016-09-19T12:00:00+02:00</startDate>
            <totalGross type="Money">
                <currencyMnemonic>USD</currencyMnemonic>
                <value>68.74</value>
            </totalGross>
            <totalNet type="Money">
                <currencyMnemonic>USD</currencyMnemonic>
                <value>57.77</value>
            </totalNet>
        </RecurringOrderLink>
        <RecurringOrderLink type="RecurringOrderLink">
            <interval>P3M</interval>
            <active>true</active>
            <buyer type="RecurringOrderBuyer">
                <businessPartnerNo>fbirdo</businessPartnerNo>
                <department></department>
                <firstName>Fritz</firstName>
                <lastName>Birdo</lastName>
                <login>fbirdo@test.intershop.de</login>
                <title></title>
            </buyer>
            <creationDate>2016-09-19T15:44:10+02:00</creationDate>
            <endDate>2017-09-01T12:00:00+02:00</endDate>
            <itemCount>1</itemCount>
            <lastOrderDate>2016-09-19T15:45:13+02:00</lastOrderDate>
            <link type="Link">
                <title>0OkKDgAhljIAAAFXqYmS9EKw</title>
                <uri>inSPIRED-inTRONICS_Business-Site/-/customers/AgroNet/recurringorders/0OkKDgAhljIAAAFXqYmS9EKw</uri>
            </link>
            <priceType>net</priceType>
            <repetitions>0</repetitions>
            <startDate>2016-09-19T12:00:00+02:00</startDate>
            <totalGross type="Money">
                <currencyMnemonic>USD</currencyMnemonic>
                <value>68.74</value>
            </totalGross>
            <totalNet type="Money">
                <currencyMnemonic>USD</currencyMnemonic>
                <value>57.77</value>
            </totalNet>
        </RecurringOrderLink>
        <RecurringOrderLink type="RecurringOrderLink">
            <interval>P3M</interval>
            <active>true</active>
            <buyer type="RecurringOrderBuyer">
                <businessPartnerNo>educking</businessPartnerNo>
                <department></department>
                <firstName>Emil</firstName>
                <lastName>Ducking</lastName>
                <login>educking@test.intershop.de</login>
                <title></title>
            </buyer>
            <creationDate>2016-09-19T15:52:27+02:00</creationDate>
            <endDate>2017-09-01T12:00:00+02:00</endDate>
            <itemCount>1</itemCount>
            <lastOrderDate>2016-09-19T15:52:41+02:00</lastOrderDate>
            <link type="Link">
                <title>QFcKDgAhVkwAAAFX7yCS9EK4</title>
                <uri>inSPIRED-inTRONICS_Business-Site/-/customers/AgroNet/recurringorders/QFcKDgAhVkwAAAFX7yCS9EK4</uri>
            </link>
            <priceType>net</priceType>
            <repetitions>0</repetitions>
            <startDate>2016-09-19T12:00:00+02:00</startDate>
            <totalGross type="Money">
                <currencyMnemonic>USD</currencyMnemonic>
                <value>68.74</value>
            </totalGross>
            <totalNet type="Money">
                <currencyMnemonic>USD</currencyMnemonic>
                <value>57.77</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