This API specification is available for download as an Open API 3.0 YAML file:
The following page lists available REST APIs for ICM 7.10 and their version dependencies:
/customers/{CustomerKey}/addresses/{CustomerAddressKey}/suggestions
Returns a list of resources links that a client could access to view suggested addresses details
public com.intershop.component.rest.capi.resourceobject.ResourceCollectionRO com.intershop.sellside.rest.common.capi.resource.customer.address.CustomerAddressItemSuggestionListResource.getAddressesLinks()
Location | Name | Format | Default | Example | Description |
---|---|---|---|---|---|
in path | CustomerKey | string | ExampleKey | Required | The key or UUID to resolve a single item | |
in path | CustomerAddressKey | string | ExampleKey | Required | The key or UUID to resolve a single item |
200 - OK
ResourceCollectionROLinkRO -> elements -> [..] -> itemId
can be used as {CustomerAddressItemSuggestionKey}
in subsequent requests. Links to item of type AddressRO.401 - Unauthorized
404 - Not Found possible values for header error-key
- customer.address_not_found
/customers/{CustomerKey}/addresses/{CustomerAddressKey}/suggestions/{CustomerAddressItemSuggestionKey}
Returns details about suggested address to the client
public com.intershop.sellside.rest.common.capi.resourceobject.AddressRO com.intershop.sellside.rest.common.capi.resource.customer.address.CustomerAddressItemSuggestionItemResource.getAddress()
Location | Name | Format | Default | Example | Description |
---|---|---|---|---|---|
in path | CustomerKey | string | ExampleKey | Required | The key or UUID to resolve a single item | |
in path | CustomerAddressKey | string | ExampleKey | Required | The key or UUID to resolve a single item | |
in path | CustomerAddressItemSuggestionKey | string | ExampleKey | Required | The key or UUID to resolve a single item |
200 - OK
401 - Unauthorized
404 - Not Found possible values for header error-key:
- customer.address_not_found
Updates address details by using the ones provided from the suggestion address
public com.intershop.sellside.rest.common.capi.resourceobject.AddressRO com.intershop.sellside.rest.common.capi.resource.customer.address.CustomerAddressItemSuggestionItemResource.update()
Location | Name | Format | Default | Example | Description |
---|---|---|---|---|---|
in path | CustomerKey | string | ExampleKey | Required | The key or UUID to resolve a single item | |
in path | CustomerAddressKey | string | ExampleKey | Required | The key or UUID to resolve a single item | |
in path | CustomerAddressItemSuggestionKey | string | ExampleKey | Required | The key or UUID to resolve a single item |
200 - OK
204 - No Content
401 - Unauthorized
404 - Not Found possible values for header error-key:
- customer.address_not_found
/privatecustomers/{CustomerKey}/addresses/{CustomerAddressKey}/suggestions
Returns a list of resources links that a client could access to view suggested addresses details
public com.intershop.component.rest.capi.resourceobject.ResourceCollectionRO com.intershop.sellside.rest.common.capi.resource.customer.address.CustomerAddressItemSuggestionListResource.getAddressesLinks()
Location | Name | Format | Default | Example | Description |
---|---|---|---|---|---|
in path | CustomerKey | string | ExampleKey | Required | The key or UUID to resolve a single item | |
in path | CustomerAddressKey | string | ExampleKey | Required | The key or UUID to resolve a single item |
200 - OK
ResourceCollectionROLinkRO -> elements -> [..] -> itemId
can be used as {CustomerAddressItemSuggestionKey}
in subsequent requests. Links to item of type AddressRO.401 - Unauthorized
404 - Not Found possible values for header error-key
- customer.address_not_found
/privatecustomers/{CustomerKey}/addresses/{CustomerAddressKey}/suggestions/{CustomerAddressItemSuggestionKey}
Returns details about suggested address to the client
public com.intershop.sellside.rest.common.capi.resourceobject.AddressRO com.intershop.sellside.rest.common.capi.resource.customer.address.CustomerAddressItemSuggestionItemResource.getAddress()
Location | Name | Format | Default | Example | Description |
---|---|---|---|---|---|
in path | CustomerKey | string | ExampleKey | Required | The key or UUID to resolve a single item | |
in path | CustomerAddressKey | string | ExampleKey | Required | The key or UUID to resolve a single item | |
in path | CustomerAddressItemSuggestionKey | string | ExampleKey | Required | The key or UUID to resolve a single item |
200 - OK
401 - Unauthorized
404 - Not Found possible values for header error-key:
- customer.address_not_found
Updates address details by using the ones provided from the suggestion address
public com.intershop.sellside.rest.common.capi.resourceobject.AddressRO com.intershop.sellside.rest.common.capi.resource.customer.address.CustomerAddressItemSuggestionItemResource.update()
Location | Name | Format | Default | Example | Description |
---|---|---|---|---|---|
in path | CustomerKey | string | ExampleKey | Required | The key or UUID to resolve a single item | |
in path | CustomerAddressKey | string | ExampleKey | Required | The key or UUID to resolve a single item | |
in path | CustomerAddressItemSuggestionKey | string | ExampleKey | Required | The key or UUID to resolve a single item |
200 - OK
204 - No Content
401 - Unauthorized
404 - Not Found possible values for header error-key:
- customer.address_not_found
Address
urn:address:customer:1234567890:0987654321
vagKAB17gg4AAAFGSkFqQASI
customeraddr-ABCDEFGPRMuMCscyXgSRVU
Mrs.
CEO
Patricia
Luise
Miller
PMiller ltd.
Berliner Str. 20
1st Floor
Second door on the right
PO Box 42
AL
Alabama
GB-PKN
Perth and Kinross
14482
pmiller@intershop.de
49364112677
049364112677
049364112699
049364112659
Germany
DE
Potsdam
049364112643
int32
int32
int32
LinkRO
objects. The list of elementsLinkRO
: A Link pointing to a resourceLink
ResourceAttribute
objects. The list of attributesResourceAttribute
: An attributeResourceAttribute
about
alternate
appendix
archives
author
bookmark
canonical
chapter
collection
contents
copyright
create-form
current
describedby
describes
disclosure
duplicate
edit
edit-form
edit-media
enclosure
first
glossary
help
hosts
hub
icon
index
item
last
latest-version
license
lrdd
monitor
monitor-group
next
next-archive
nofollow
noreferrer
payment
predecessor-version
prefetch
prev
preview
previous
prev-archive
privacy-policy
profile
related
replies
search
section
self
service
start
stylesheet
subsection
successor-version
tag
terms-of-service
type
up
version-history
via
working-copy
working-copy-of
ResourceAttribute
object. An attributeResourceAttribute
ResourceCollection
string
literals. The keys to sort forThe 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.