Related Documents
Document Properties
Kbid24918M
Last Modified23-Jun-2020
Added to KB15-Jul-2013
Public AccessEveryone
StatusOnline
Doc TypeReferences
Product
  • ICM 7.6
  • ICM 7.7

REST API - Update address details as suggested (until 7.7)

URI

/customers/-/addresses/<address-id>/suggestions/<suggested-address-id>

Http Method

PUT

Short Description

Updates an address details by using the ones provided from the suggestion address

Query Parameters

none

Example Requests

/customers/-/addresses/cokKCgoKKaEAAAE_4SIKfNMG/suggestions/USCO123

HTTP Status Codes

200 OK
204 No Content
401 Unauthorized
404 Not found

       Possible values for header ‘error-key’:

    • customer.address_not_found

Description

Updates an address details by using the ones provided from the suggestion address. Updated address details are present to the client.

Cartridge

app_sf_rest

Application

B2C Web Shop, SMB Web Shop

Product Version

7.4

Product To Version

7.7

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.customer.address.CustomerAddressItemSuggestionItemResource
com.intershop.sellside.rest.common.capi.resourceobject.AddressRO

Response Example

 {
   "type": "Address",
   "state": "NY",
   "country": "United States",
   "id": "8XQKDgAOVcEAAAFC.IBOHHDH",
   "email": "",
   "countryCode": "US",
   "postalCode": "12121",
   "phoneBusiness": "",
   "city": "Norfolk",
   "street": "123 Pacific Ave",
   "street2": "",
   "street3": "",
   "mobile": "",
   "phoneHome": "",
   "firstName": "Patricia",
   "lastName": "Miller",
   "title": "",
   "addressName": "Patricia Miller, 123 Pacific Ave, Norfolk"
}

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.customer.address.CustomerAddressItemSuggestionItemResource
com.intershop.sellside.rest.common.capi.resourceobject.AddressRO

XML Response Example

<?xml version="1.0" encoding="UTF-8" standalone="yes"?>
<Address type="Address">
 <addressName>Patricia Miller, 123 Pacific Ave, Halle</addressName>
 <city>Halle</city>
 <country>United States</country>
 <countryCode>US</countryCode>
 <email>
 </email>
 <firstName>Patricia</firstName>
 <ID>7wsKDgAO0P0AAAFCe.BOHHC9</ID>
 <lastName>Miller</lastName>
 <mobile>
 </mobile>
 <phoneBusiness>
 </phoneBusiness>
 <phoneHome>
 </phoneHome>
 <postalCode>12121</postalCode>
 <state>NY</state>
 <street>123 Pacific Ave</street>
 <street2>
 </street2>
 <street3>
 </street3>
 <title>
 </title>
</Address>

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