Home > @vsf-enterprise/sap-commerce-webservices-sdk > AddressApi > getAddress

AddressApi.getAddress() method

Returns detailed information about address with a given id. Get info about address

Signature:

getAddress(addressId: string, baseSiteId: string, userId: string, fields?: string, options?: any): Promise<import("axios").AxiosResponse<Address>>;

Parameters

Parameter	Type	Description
addressId	string	Address identifier.
baseSiteId	string	Base site identifier
userId	string	User identifier or one of the literals : 'current' for currently authenticated user, 'anonymous' for anonymous user
fields	string	Response configuration. This is the list of fields that should be returned in the response body. Examples: BASIC, DEFAULT, FULL
options	any	Override http request option.

Returns:

Promise<import("axios").AxiosResponse<Address>>

Exceptions

{RequiredError} AddressApi