Related Documents
Document Properties
Kbid27641V
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 - Customer addresses list


Note

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

URI

/customers/<customer-id>/addresses

OR

/customers/-/addresses (deprecated)

Http Method

GET

Short Description

Returns a list of links to customer addresses resources

Query Parameters

none

Example Requests

/customers/Ik0KAB2YzNcAAAFU54ZToKlg/addresses

HTTP Status Codes

200 OK
401 Unauthorized

Description

Clients accessing this URI will be provided with list of links to address details of currently logged in customer.

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.CustomerAddressListResource
com.intershop.component.rest.capi.resourceobject.ResourceCollectionRO<LinkRO>

Response Example

{
    "elements": [
        {
            "type": "Link",
            "uri": "inSPIRED-inTRONICS-Site/-/customers/Ik0KAB2YzNcAAAFU54ZToKlg/addresses/gLUKABvH8VgAAAFBBwwBOOLs",
            "title": "urn:address:customer:GPYKABsmGqQAAAFURGkrXM2F:gLUKABvH8VgAAAFBBwwBOOLs"
        }
    ],
    "type": "ResourceCollection",
    "name": "addresses"
}

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.CustomerAddressListResource
com.intershop.component.rest.capi.resourceobject.ResourceCollectionRO<LinkRO>

XML Response Example

<?xml version="1.0" encoding="UTF-8" standalone="yes"?>
<ResourceCollection name="addresses" type="ResourceCollection">
    <elements>
        <Link type="Link">
            <title>urn:address:customer:GPYKABsmGqQAAAFURGkrXM2F:gLUKABvH8VgAAAFBBwwBOOLs</title>
            <uri>inSPIRED-inTRONICS-Site/-/customers/Ik0KAB2YzNcAAAFU54ZToKlg/addresses/gLUKABvH8VgAAAFBBwwBOOLs</uri>
        </Link>
    </elements>
</ResourceCollection>
 

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