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

REST API - Get customer address details


Note

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

URI

/customers/<customer-id>/addresses/<address-id>

OR

/customers/-/addresses/<address-id> (deprecated)

Http Method

GET

Short Description

Returns details about customer's address to the client

Query Parameters

none

Example Requests

/customers/vTwKAB2YqvEAAAFb8BMYJJBT/addresses/.uUKAB2YsVEAAAFb9RMYJJBT

HTTP Status Codes

200 OK
401 Unauthorized 
404 Not found 

       Possible values for header ‘error-key’:

    • customer.address_not_found.error

Description

Returns address details to the client.

Cartridge

app_sf_rest

Application

B2C Web Shop, SMB Web Shop

Product Version

7.8

Product To Version

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

Response Example

{
  "type": "Address",
  "urn": "urn:address:customer:vTwKAB2YqvEAAAFb8BMYJJBT:.uUKAB2YsVEAAAFb9RMYJJBT",
  "id": ".uUKAB2YsVEAAAFb9RMYJJBT",
  "addressName": "customeraddr-YXEwLKSprCWPRMuMCscyXgSRVU",
  "title": "Ms.",
  "firstName": "Patricia",
  "lastName": "Miller",
  "addressLine1": "Berliner Str. 20",
  "postalCode": "14482",
  "phoneHome": "049364112677",
  "country": "Germany",
  "countryCode": "DE",
  "city": "Potsdam",
  "preferredShippingAddress": "true",
  "usage": [
    true,
    true
  ],
  "invoiceToAddress": true,
  "shipFromAddress": false,
  "serviceToAddress": false,
  "installToAddress": false,
  "shipToAddress": true,
  "street": "Berliner Str. 20"
}

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

XML Response Example

<?xml version="1.0" encoding="UTF-8" standalone="yes"?>
<Address type="Address">
    <addressLine1>Berliner Str. 20</addressLine1>
    <addressName>customeraddr-YXEwLKSprCWPRMuMCscyXgSRVU</addressName>
    <city>Potsdam</city>
    <country>Germany</country>
    <countryCode>DE</countryCode>
    <firstName>Patricia</firstName>
    <id>.uUKAB2YsVEAAAFb9RMYJJBT</id>
    <installToAddress>false</installToAddress>
    <invoiceToAddress>true</invoiceToAddress>
    <lastName>Miller</lastName>
    <phoneHome>049364112677</phoneHome>
    <postalCode>14482</postalCode>
    <preferredShippingAddress>true</preferredShippingAddress>
    <serviceToAddress>false</serviceToAddress>
    <shipFromAddress>false</shipFromAddress>
    <shipToAddress>true</shipToAddress>
    <street>Berliner Str. 20</street>
    <title>Ms.</title>
    <urn>urn:address:customer:vTwKAB2YqvEAAAFb8BMYJJBT:.uUKAB2YsVEAAAFb9RMYJJBT</urn>
    <usage/>
</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
Support Tickets