Personal Library

Reference - Address Check REST API 1.0.0

https://support.intershop.com/kb/2D9682

Share this document

ReDoc View
Document View

Product Version	7.10
Product To Version	7.10
Status	New Labels

This API specification is available for download as an Open API 3.0 YAML file:

icm-b2b-address-check-1x0x0.yaml

References

The following page lists available REST APIs for ICM 7.10 and their version dependencies:

Reference - Intershop Commerce Management 7.10 REST API

API Specification

Introduction

OpenAPI Version: 3.0.1

Address Check Version: 1.0.0

This is Intershop ICM REST API documentation.

This reference lists the REST API for storefront development. The REST API covers features of both, the B2C (SMB - Small and Medium-sized businesses) and the B2B storefront development.
This reference is intended for developers who want to make use of an easy-to-use API when developing frontend solutions.
You can find more information at Intershop Communications. Contact our Intershop experts at Support - Intershop Communications

Introduction

This API is documented in OpenAPI format.

Address Check API

/customers/{CustomerKey}/addresses/{CustomerAddressKey}/suggestions

GET: Get list of links to suggested addresses

Description

Returns a list of resources links that a client could access to view suggested addresses details

Java Method

public com.intershop.component.rest.capi.resourceobject.ResourceCollectionRO com.intershop.sellside.rest.common.capi.resource.customer.address.CustomerAddressItemSuggestionListResource.getAddressesLinks()

Request Body

Request Parameters

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

Response

200 - OK

ResourceCollectionROLinkRO application/json

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}

GET: Get suggested address details

Description

Returns details about suggested address to the client

Java Method

public com.intershop.sellside.rest.common.capi.resourceobject.AddressRO com.intershop.sellside.rest.common.capi.resource.customer.address.CustomerAddressItemSuggestionItemResource.getAddress()

Request Body

Request Parameters

Location	Name	Format	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

Response

200 - OK

AddressRO application/json

401 - Unauthorized

404 - Not Found possible values for header error-key:
- customer.address_not_found

PUT: Update address details as suggested

Description

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

Java Method

public com.intershop.sellside.rest.common.capi.resourceobject.AddressRO com.intershop.sellside.rest.common.capi.resource.customer.address.CustomerAddressItemSuggestionItemResource.update()

Request Body

Request Parameters

Location	Name	Format	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

Response

200 - OK

AddressRO application/json

204 - No Content

401 - Unauthorized

404 - Not Found possible values for header error-key:
- customer.address_not_found

/privatecustomers/{CustomerKey}/addresses/{CustomerAddressKey}/suggestions

GET: Get list of links to suggested addresses

Description

Returns a list of resources links that a client could access to view suggested addresses details

Java Method

public com.intershop.component.rest.capi.resourceobject.ResourceCollectionRO com.intershop.sellside.rest.common.capi.resource.customer.address.CustomerAddressItemSuggestionListResource.getAddressesLinks()

Request Body

Request Parameters

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

Response

200 - OK

ResourceCollectionROLinkRO application/json

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}

GET: Get suggested address details

Description

Returns details about suggested address to the client

Java Method

public com.intershop.sellside.rest.common.capi.resourceobject.AddressRO com.intershop.sellside.rest.common.capi.resource.customer.address.CustomerAddressItemSuggestionItemResource.getAddress()

Request Body

Request Parameters

Location	Name	Format	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

Response

200 - OK

AddressRO application/json

401 - Unauthorized

404 - Not Found possible values for header error-key:
- customer.address_not_found

PUT: Update address details as suggested

Description

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

Java Method

public com.intershop.sellside.rest.common.capi.resourceobject.AddressRO com.intershop.sellside.rest.common.capi.resource.customer.address.CustomerAddressItemSuggestionItemResource.update()

Request Body

Request Parameters

Location	Name	Format	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

Response

200 - OK

AddressRO application/json

204 - No Content

401 - Unauthorized

404 - Not Found possible values for header error-key:
- customer.address_not_found

Request and Response Object Schemata

AddressRO application/json

{

"name":
string
The name of an element
"type":
string
The type of the element. This is normally a constant that can be used to differentiate elements by their type. | Example: Address
"urn":
string
the URN representation of this address | Example: urn:address:customer:1234567890:0987654321
"id":
string
The ID of the returned element | Example: vagKAB17gg4AAAFGSkFqQASI
"addressName":
string
The name of the address | Example: customeraddr-ABCDEFGPRMuMCscyXgSRVU
"title":
string
The (personal) title of the contact person, like 'Mr.' or 'Ms.' | Example: Mrs.
"aristocraticTitle":
string
the aristocratic title of the contact person, like Lord or Lady
"jobTitle":
string
the job title of the contact person | Example: CEO
"honorific":
string
the honorific title of the contact person that denotes the honored person's occupation, like Captain, Coach, Officer, Reverend or the academic title, like PhD
"firstName":
string
The (first) given name of the contact person | Example: Patricia
"secondName":
string
the second given name of the contact person | Example: Luise
"lastName":
string
The last name of the contact person | Example: Miller
"secondLastName":
string
the second last name of the contact person
"companyName1":
string
the company name | Example: PMiller ltd.
"companyName2":
string
The second company name
"addressLine1":
string
the first address line | Example: Berliner Str. 20
"addressLine2":
string
the second address line | Example: 1st Floor
"addressLine3":
string
The third address line | Example: Second door on the right
"postBox":
string
the post-office box | Example: PO Box 42
"mainDivision":
string
the main division of the country, e. g. a state or province | Example: AL
"mainDivisionName":
string
The localized display name of the main division | Example: Alabama
"subDivision":
string
The sub division code of the country. | Example: GB-PKN
"subDivisionName":
string
The localized display name of the sub division | Example: Perth and Kinross
"postalCode":
string
The postal code | Example: 14482
"email":
string
the e-mail address of the contact person | Example: pmiller@intershop.de
"phoneMobile":
string
The number of the contact person's cell phone | Example: 49364112677
"phoneHome":
string
The phone number of the house or apartment where the contact person lives | Example: 049364112677
"phoneBusiness":
string
The phone number of the contact person's company | Example: 049364112699
"phoneBusinessDirect":
string
the business phone number of the contact person that allows an outside caller to connect directly to the contact person without any help of an attendant or operator | Example: 049364112659
"country":
string
The display name of the country in the current locale | Example: Germany
"countryCode":
string
The country code | Example: DE
"city":
string
The name of the city | Example: Potsdam
"fax":
string
the fax number | Example: 049364112643
"usage":
object
Returns usage information for the address. Every bit in the returned set marks a specific usage type, like ship-from or invoice-to address. If a bit is set, the address may be used for the specific purpose mapped to this bit. Further bits may be used for custom types. Default usage for first 4 bits are Invoice-to, Ship-to, Service-to and Install-to
{
- "empty":
  boolean
}

}

ResourceCollectionROLinkRO application/json

{

"pageable":
string
The pageable ID.
"total":
integer
The pageable amount total | Format: int32
"offset":
integer
The pageable offset | Format: int32
"amount":
integer
The pageable amount | Format: int32
"elements":
array
An array of LinkRO objects. The list of elements
[
LinkRO: A Link pointing to a resource
{
- "name":
  string
  The name of the returned element
- "type":
  string
  Readonly | This is a constant: Link | Example: Link
- "attributes":
  array
  An array of ResourceAttribute objects. The list of attributes
  [
  ResourceAttribute: An attribute
  {
  "name":
  string
  The attribute's name
  "type":
  string
  This is a constant: ResourceAttribute | Example: ResourceAttribute
  "value":
  object
  The attribute's value.
  }
  ]
- "uri":
  string
  The URI
- "relation":
  string
  The relation of the link | Documentation: Link Relations (www.iana.org) | Possible Values: aboutalternateappendixarchivesauthorbookmarkcanonicalchaptercollectioncontentscopyrightcreate-formcurrentdescribedbydescribesdisclosureduplicateeditedit-formedit-mediaenclosurefirstglossaryhelphostshubiconindexitemlastlatest-versionlicenselrddmonitormonitor-groupnextnext-archivenofollownoreferrerpaymentpredecessor-versionprefetchprevpreviewpreviousprev-archiveprivacy-policyprofilerelatedrepliessearchsectionselfservicestartstylesheetsubsectionsuccessor-versiontagterms-of-servicetypeupversion-historyviaworking-copyworking-copy-of
- "title":
  string
  The title of the link
- "description":
  string
  The description of the link
- "itemId":
  string
  The ID of the linked item
- "attribute":
  object
  A ResourceAttribute object. An attribute
  {
  "name":
  string
  The attribute's name
  "type":
  string
  This is a constant: ResourceAttribute | Example: ResourceAttribute
  "value":
  object
  The attribute's value.
  }
}
]
"type":
string
This is a constant: ResourceCollection | Example: ResourceCollection
"sortKeys":
array
An array of string literals. The keys to sort for
"name":
string
The name of the returned element

}

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.