Related Documents
Document Properties
Kbid28008T
Last Modified23-Jun-2020
Added to KB20-Sep-2016
Public AccessEveryone
StatusOnline
Doc TypeReferences
Product
  • ICM 7.8
  • ICM 7.9
  • ICM 7.10

REST API - Update business customer's recurring order


Note

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

URI

/customers/<customer-id>/users/<user-id>/recurringorders/<recurringorder-id>

Http Method

PUT

Short Description

Updates a recurring order, supports only activation and deactivation

Query Parameters

none

Example Requests

/customers/AgroNet/users/educking@test.intershop.de/recurringorders/iLQKDgAe_C8AAAFWoUIjwMCl

HTTP Status Codes

200 OK
401 Unauthorized
409 Conflict (if recurring order cannot be enabled)

Possible values for header value "error-key":

  • error.recurring_orders.enable-not-possible

500 Internal Server Error (If error occurred in Micro service)
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 microservice is not available and/or cannot be discovered)

Description

Updates the recurring order with the given <recurringorder-id> for business customers. Currently only activation and deactivation are supported.

Note

Expired recurring orders can not be set to active.

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

application/json

Request related java object

com.intershop.sellside.rest.common.capi.resource.recurringorder.RecurringOrderItemResource
com.intershop.sellside.rest.common.capi.resourceobject.recurringorder.UpdateRecurringOrderRO

Request data example

Activate a recurring order:

{
    "active": true
}

Deactivate a recurring order:

{
    "active": false
}

Response data format

application/json

Response related java object

com.intershop.sellside.rest.common.capi.resource.recurringorder.RecurringOrderItemResource
com.intershop.sellside.rest.common.capi.resourceobject.recurringorder.RecurringOrderRO

Response data example

{
  "type": "RecurringOrder",
  "id": "iLQKDgAe_C8AAAFWoUIjwMCl",
  "number": "3",
  "active": true,
  "expired": false,
  "multipleShipmentsSupported": false,
  "creationDate": 1472460493000,
  "interval": "P3M",
  "repetitions": 42,
  "startDate": 1464775200000,
  "endDate": 1496311200000,
  "buyer": {
    "type": "RecurringOrderBuyer",
    "title": "",
    "firstName": "Emil",
    "lastName": "Ducking",
    "businessPartnerNo": "educking",
    "department": "",
    "login": "educking@test.intershop.de"
  },
  "modifiedDate": 1472460493000,
  "itemCount": 1,
  "orderCount": 0,
  "invoiceToAddress": {
    "type": "Address",
    "urn": "urn:address:customer:ZP8KDgAe_0YAAAFWCJUkqNUk:RVYKDgAe2PsAAAFWbQokqNUw",
    "id": "RVYKDgAe2PsAAAFWbQokqNUw",
    "addressName": "customeraddr-CMsKGZB11qbwABLABLAUddH",
    "title": "Mr.",
    "firstName": "David",
    "secondName": "Anton",
    "lastName": "DaPayer",
    "companyName1": "Agro Net",
    "addressLine1": "Paying Street 12",
    "postalCode": "12546",
    "phoneHome": "49364565457",
    "country": "Germany",
    "countryCode": "DE",
    "city": "Berlin",
    "usage": [
      true
    ],
    "shipToAddress": false,
    "street": "Paying Street 12",
    "invoiceToAddress": true,
    "shipFromAddress": false,
    "serviceToAddress": false,
    "installToAddress": false,
    "company": "Agro Net"
  },
  "commonShipToAddress": {
    "type": "Address",
    "urn": "urn:address:customer:ZP8KDgAe_0YAAAFWCJUkqNUk:3.8KDgAe2PkAAAFWbQokqNUw",
    "id": "3.8KDgAe2PkAAAFWbQokqNUw",
    "addressName": "customeraddr-CMsKGZB11qbwAAAE8FH8tUddH",
    "title": "Mr.",
    "firstName": "Rene",
    "lastName": "Eckardt",
    "companyName1": "Agro Net",
    "addressLine1": "Shipping Street 12",
    "postalCode": "12546",
    "phoneHome": "49364565457",
    "country": "Germany",
    "countryCode": "DE",
    "city": "Berlin",
    "usage": [
      false,
      true
    ],
    "shipToAddress": true,
    "street": "Shipping Street 12",
    "invoiceToAddress": false,
    "shipFromAddress": false,
    "serviceToAddress": false,
    "installToAddress": false,
    "company": "Agro Net"
  },
  "commonShippingMethod": {
    "name": "Standard Ground",
    "type": "ShippingMethod",
    "id": "STD_GROUND",
    "shippingTimeMin": 3,
    "shippingTimeMax": 7
  },
  "payments": [
    {
      "name": "ISH_INVOICE",
      "type": "Payment",
      "id": "ISH_INVOICE",
      "parameters": []
    }
  ],
  "shippingBuckets": [
    {
      "type": "RecurringOrderShippingBucket",
      "shippingMethod": {
        "name": "Standard Ground",
        "type": "ShippingMethod",
        "id": "STD_GROUND",
        "shippingTimeMin": 3,
        "shippingTimeMax": 7
      },
      "lineItems": [
        {
          "name": "Acer C110",
          "type": "RecurringOrderLineItem",
          "sku": "9438012",
          "quantity": {
            "type": "Quantity",
            "value": 1,
            "unit": ""
          },
          "totals": {
            "type": "RecurringOrderLineItemTotals",
            "totalNet": {
              "type": "Money",
              "value": 237.5,
              "currencyMnemonic": "USD"
            },
            "shippingTotalNet": {
              "type": "Money",
              "value": 3.02,
              "currencyMnemonic": "USD"
            },
            "totalGross": {
              "type": "Money",
              "value": 251.75,
              "currencyMnemonic": "USD"
            },
            "shippingTotalGross": {
              "type": "Money",
              "value": 3.2,
              "currencyMnemonic": "USD"
            },
            "priceType": "net",
            "salesTaxTotal": {
              "type": "Money",
              "value": 14.25,
              "currencyMnemonic": "USD"
            },
            "shippingTaxTotal": {
              "type": "Money",
              "value": 0.18,
              "currencyMnemonic": "USD"
            }
          },
          "salesTaxes": [
            {
              "name": "name",
              "type": "AppliedTax",
              "rate": 0.06,
              "amount": {
                "type": "Money",
                "value": 14.25,
                "currencyMnemonic": "USD"
              }
            }
          ],
          "shippingTaxes": [
            {
              "name": "name",
              "type": "AppliedTax",
              "rate": 0.06,
              "amount": {
                "type": "Money",
                "value": 0.18,
                "currencyMnemonic": "USD"
              }
            }
          ],
          "product": {
            "type": "Link",
            "uri": "inSPIRED-inTRONICS_Business-Site/-/products/9438012",
            "title": "9438012",
            "description": "Acer C110"
          },
          "priceNet": {
            "type": "Money",
            "value": 237.5,
            "currencyMnemonic": "USD"
          },
          "singleBasePriceNet": {
            "type": "Money",
            "value": 237.5,
            "currencyMnemonic": "USD"
          },
          "priceGross": {
            "type": "Money",
            "value": 251.75,
            "currencyMnemonic": "USD"
          },
          "singleBasePriceGross": {
            "type": "Money",
            "value": 251.75,
            "currencyMnemonic": "USD"
          },
          "priceType": "net",
          "id": "FBQKDgAeSqMAAAFWRwEWqNV6",
          "position": 1,
          "isHiddenGift": false,
          "isFreeGift": false,
          "inStock": true,
          "variationProduct": false,
          "availability": true,
          "bundleProduct": false
        }
      ]
    }
  ],
  "totals": {
    "type": "RecurringOrderTotals",
    "itemTotalNet": {
      "type": "Money",
      "value": 237.5,
      "currencyMnemonic": "USD"
    },
    "shippingTotalNet": {
      "type": "Money",
      "value": 3.02,
      "currencyMnemonic": "USD"
    },
    "itemShippingRebatesTotalNet": {
      "type": "Money",
      "value": 0,
      "currencyMnemonic": "USD"
    },
    "bucketShippingRebatesTotalNet": {
      "type": "Money",
      "value": 0,
      "currencyMnemonic": "USD"
    },
    "rebatesTotalNet": {
      "type": "Money",
      "value": 0,
      "currencyMnemonic": "USD"
    },
    "shippingRebatesTotalNet": {
      "type": "Money",
      "value": 0,
      "currencyMnemonic": "USD"
    },
    "paymentCostsTotalNet": {
      "type": "Money",
      "value": 0,
      "currencyMnemonic": "USD"
    },
    "totalNet": {
      "type": "Money",
      "value": 240.52,
      "currencyMnemonic": "USD"
    },
    "itemTotalGross": {
      "type": "Money",
      "value": 251.75,
      "currencyMnemonic": "USD"
    },
    "shippingTotalGross": {
      "type": "Money",
      "value": 3.2,
      "currencyMnemonic": "USD"
    },
    "itemShippingRebatesTotalGross": {
      "type": "Money",
      "value": 0,
      "currencyMnemonic": "USD"
    },
    "bucketShippingRebatesTotalGross": {
      "type": "Money",
      "value": 0,
      "currencyMnemonic": "USD"
    },
    "rebatesTotalGross": {
      "type": "Money",
      "value": 0,
      "currencyMnemonic": "USD"
    },
    "shippingRebatesTotalGross": {
      "type": "Money",
      "value": 0,
      "currencyMnemonic": "USD"
    },
    "paymentCostsTotalGross": {
      "type": "Money",
      "value": 0,
      "currencyMnemonic": "USD"
    },
    "totalGross": {
      "type": "Money",
      "value": 254.95,
      "currencyMnemonic": "USD"
    },
    "taxTotal": {
      "type": "Money",
      "value": 14.43,
      "currencyMnemonic": "USD"
    },
    "dutiesAndSurchargesTotal": {
      "type": "Money",
      "value": 0,
      "currencyMnemonic": "USD"
    },
    "priceType": "net"
  }
}

XML

Request data format

text/xml

Request related java object

com.intershop.sellside.rest.common.capi.resource.recurringorder.RecurringOrderItemResource
com.intershop.sellside.rest.common.capi.resourceobject.recurringorder.UpdateRecurringOrderRO

Request data example

Activate a recurring order:

<?xml version="1.0" encoding="UTF-8" standalone="yes"?>
<RecurringOrder>
    <active>true</active>
</RecurringOrder>

Deactivate a recurring order:

<?xml version="1.0" encoding="UTF-8" standalone="yes"?>
<RecurringOrder>
    <active>false</active>
</RecurringOrder>

Response data format

text/xml

Response related java object

com.intershop.sellside.rest.common.capi.resource.recurringorder.RecurringOrderItemResource
com.intershop.sellside.rest.common.capi.resourceobject.recurringorder.RecurringOrderRO

Response data example

<?xml version="1.0" encoding="UTF-8" standalone="yes"?>
<RecurringOrder type="RecurringOrder">
  <id>iLQKDgAe_C8AAAFWoUIjwMCl</id>
  <number>3</number>
  <active>true</active>
  <expired>false</expired>
  <multipleShipmentsSupported>false</multipleShipmentsSupported>
  <creationDate>2016-08-29T08:48:13Z</creationDate>
  <interval>P3M</interval>
  <repetitions>42</repetitions>
  <startDate>2016-06-01T10:00:00Z</startDate>
  <endDate>2017-06-01T10:00:00Z</endDate>
  <buyer type="RecurringOrderBuyer">
    <businessPartnerNo>educking</businessPartnerNo>
    <department>
    </department>
    <firstName>Emil</firstName>
    <lastName>Ducking</lastName>
    <login>educking@test.intershop.de</login>
    <title>
    </title>
  </buyer>
  <modifiedDate>2016-08-29T08:48:13Z</modifiedDate>
  <itemCount>1</itemCount>
  <orderCount>0</orderCount>
  <invoiceToAddress type="Address">
    <addressLine1>Paying Street 12</addressLine1>
    <addressName>customeraddr-CMsKGZB11qbwABLABLAUddH</addressName>
    <city>Berlin</city>
    <company>Agro Net</company>
    <companyName1>Agro Net</companyName1>
    <country>Germany</country>
    <countryCode>DE</countryCode>
    <firstName>David</firstName>
    <id>RVYKDgAe2PsAAAFWbQokqNUw</id>
    <installToAddress>false</installToAddress>
    <invoiceToAddress>true</invoiceToAddress>
    <lastName>DaPayer</lastName>
    <phoneHome>49364565457</phoneHome>
    <postalCode>12546</postalCode>
    <secondName>Anton</secondName>
    <serviceToAddress>false</serviceToAddress>
    <shipFromAddress>false</shipFromAddress>
    <shipToAddress>false</shipToAddress>
    <street>Paying Street 12</street>
    <title>Mr.</title>
    <urn>urn:address:customer:ZP8KDgAe_0YAAAFWCJUkqNUk:RVYKDgAe2PsAAAFWbQokqNUw</urn>
    <usage/>
  </invoiceToAddress>
  <commonShipToAddress type="Address">
    <addressLine1>Shipping Street 12</addressLine1>
    <addressName>customeraddr-CMsKGZB11qbwAAAE8FH8tUddH</addressName>
    <city>Berlin</city>
    <company>Agro Net</company>
    <companyName1>Agro Net</companyName1>
    <country>Germany</country>
    <countryCode>DE</countryCode>
    <firstName>Rene</firstName>
    <id>3.8KDgAe2PkAAAFWbQokqNUw</id>
    <installToAddress>false</installToAddress>
    <invoiceToAddress>false</invoiceToAddress>
    <lastName>Eckardt</lastName>
    <phoneHome>49364565457</phoneHome>
    <postalCode>12546</postalCode>
    <serviceToAddress>false</serviceToAddress>
    <shipFromAddress>false</shipFromAddress>
    <shipToAddress>true</shipToAddress>
    <street>Shipping Street 12</street>
    <title>Mr.</title>
    <urn>urn:address:customer:ZP8KDgAe_0YAAAFWCJUkqNUk:3.8KDgAe2PkAAAFWbQokqNUw</urn>
    <usage/>
  </commonShipToAddress>
  <commonShippingMethod name="Standard Ground" type="ShippingMethod">
    <id>STD_GROUND</id>
    <shippingTimeMax>7</shippingTimeMax>
    <shippingTimeMin>3</shippingTimeMin>
  </commonShippingMethod>
  <payments>
    <Payment name="ISH_INVOICE" type="Payment">
      <id>ISH_INVOICE</id>
      <parameters/>
    </Payment>
  </payments>
  <shippingBuckets>
    <RecurringOrderShippingBucket type="RecurringOrderShippingBucket">
      <shippingMethod name="Standard Ground" type="ShippingMethod">
        <id>STD_GROUND</id>
        <shippingTimeMax>7</shippingTimeMax>
        <shippingTimeMin>3</shippingTimeMin>
      </shippingMethod>
      <lineItems>
        <RecurringOrderLineItem name="Acer C110" type="RecurringOrderLineItem">
          <availability>true</availability>
          <bundleProduct>false</bundleProduct>
          <id>FBQKDgAeSqMAAAFWRwEWqNV6</id>
          <inStock>true</inStock>
          <isFreeGift>false</isFreeGift>
          <isHiddenGift>false</isHiddenGift>
          <position>1</position>
          <priceGross type="Money">
            <currencyMnemonic>USD</currencyMnemonic>
            <value>251.75</value>
          </priceGross>
          <priceNet type="Money">
            <currencyMnemonic>USD</currencyMnemonic>
            <value>237.50</value>
          </priceNet>
          <priceType>net</priceType>
          <product type="Link">
            <description>Acer C110</description>
            <title>9438012</title>
            <uri>inSPIRED-inTRONICS_Business-Site/-/products/9438012</uri>
          </product>
          <quantity type="Quantity">
            <unit>
            </unit>
            <value>1</value>
          </quantity>
          <salesTaxes>
            <AppliedTax name="name" type="AppliedTax">
              <amount type="Money">
                <currencyMnemonic>USD</currencyMnemonic>
                <value>14.25</value>
              </amount>
              <rate>0.06</rate>
            </AppliedTax>
          </salesTaxes>
          <shippingTaxes>
            <AppliedTax name="name" type="AppliedTax">
              <amount type="Money">
                <currencyMnemonic>USD</currencyMnemonic>
                <value>0.18</value>
              </amount>
              <rate>0.06</rate>
            </AppliedTax>
          </shippingTaxes>
          <singleBasePriceGross type="Money">
            <currencyMnemonic>USD</currencyMnemonic>
            <value>251.75</value>
          </singleBasePriceGross>
          <singleBasePriceNet type="Money">
            <currencyMnemonic>USD</currencyMnemonic>
            <value>237.5</value>
          </singleBasePriceNet>
          <sku>9438012</sku>
          <totals type="RecurringOrderLineItemTotals">
            <priceType>net</priceType>
            <salesTaxTotal type="Money">
              <currencyMnemonic>USD</currencyMnemonic>
              <value>14.25</value>
            </salesTaxTotal>
            <shippingTaxTotal type="Money">
              <currencyMnemonic>USD</currencyMnemonic>
              <value>0.18</value>
            </shippingTaxTotal>
            <shippingTotalGross type="Money">
              <currencyMnemonic>USD</currencyMnemonic>
              <value>3.20</value>
            </shippingTotalGross>
            <shippingTotalNet type="Money">
              <currencyMnemonic>USD</currencyMnemonic>
              <value>3.02</value>
            </shippingTotalNet>
            <totalGross type="Money">
              <currencyMnemonic>USD</currencyMnemonic>
              <value>251.75</value>
            </totalGross>
            <totalNet type="Money">
              <currencyMnemonic>USD</currencyMnemonic>
              <value>237.5</value>
            </totalNet>
          </totals>
          <variationProduct>false</variationProduct>
        </RecurringOrderLineItem>
      </lineItems>
    </RecurringOrderShippingBucket>
  </shippingBuckets>
  <totals type="RecurringOrderTotals">
    <bucketShippingRebatesTotalGross type="Money">
      <currencyMnemonic>USD</currencyMnemonic>
      <value>0.0</value>
    </bucketShippingRebatesTotalGross>
    <bucketShippingRebatesTotalNet type="Money">
      <currencyMnemonic>USD</currencyMnemonic>
      <value>0.0</value>
    </bucketShippingRebatesTotalNet>
    <dutiesAndSurchargesTotal type="Money">
      <currencyMnemonic>USD</currencyMnemonic>
      <value>0.0</value>
    </dutiesAndSurchargesTotal>
    <itemShippingRebatesTotalGross type="Money">
      <currencyMnemonic>USD</currencyMnemonic>
      <value>0.0</value>
    </itemShippingRebatesTotalGross>
    <itemShippingRebatesTotalNet type="Money">
      <currencyMnemonic>USD</currencyMnemonic>
      <value>0.0</value>
    </itemShippingRebatesTotalNet>
    <itemTotalGross type="Money">
      <currencyMnemonic>USD</currencyMnemonic>
      <value>251.75</value>
    </itemTotalGross>
    <itemTotalNet type="Money">
      <currencyMnemonic>USD</currencyMnemonic>
      <value>237.5</value>
    </itemTotalNet>
    <paymentCostsTotalGross type="Money">
      <currencyMnemonic>USD</currencyMnemonic>
      <value>0.00</value>
    </paymentCostsTotalGross>
    <paymentCostsTotalNet type="Money">
      <currencyMnemonic>USD</currencyMnemonic>
      <value>0.0</value>
    </paymentCostsTotalNet>
    <priceType>net</priceType>
    <rebatesTotalGross type="Money">
      <currencyMnemonic>USD</currencyMnemonic>
      <value>0.00</value>
    </rebatesTotalGross>
    <rebatesTotalNet type="Money">
      <currencyMnemonic>USD</currencyMnemonic>
      <value>0.0</value>
    </rebatesTotalNet>
    <shippingRebatesTotalGross type="Money">
      <currencyMnemonic>USD</currencyMnemonic>
      <value>0.0</value>
    </shippingRebatesTotalGross>
    <shippingRebatesTotalNet type="Money">
      <currencyMnemonic>USD</currencyMnemonic>
      <value>0.0</value>
    </shippingRebatesTotalNet>
    <shippingTotalGross type="Money">
      <currencyMnemonic>USD</currencyMnemonic>
      <value>3.20</value>
    </shippingTotalGross>
    <shippingTotalNet type="Money">
      <currencyMnemonic>USD</currencyMnemonic>
      <value>3.02</value>
    </shippingTotalNet>
    <taxTotal type="Money">
      <currencyMnemonic>USD</currencyMnemonic>
      <value>14.43</value>
    </taxTotal>
    <totalGross type="Money">
      <currencyMnemonic>USD</currencyMnemonic>
      <value>254.95</value>
    </totalGross>
    <totalNet type="Money">
      <currencyMnemonic>USD</currencyMnemonic>
      <value>240.52</value>
    </totalNet>
  </totals>
</RecurringOrder>   

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