@plentymarkets/shop-api / getAddresses

Function: getAddresses()

getAddresses(context, params): Promise<Data<Address[]>>

Defined in: api/getAddresses/index.ts:22

Method getAddresses - Get billing or shipping addresses from the current session (guest or logged in).

Parameters

context

PlentysystemsIntegrationContext

params

GetAddressesParams

Returns

Promise<Data<Address[]>>

Remarks

• Calls /rest/storefront/contact/addresses
• This method is used to get all billing or shipping addresses

Example

const { data } = await useSdk().plentysystems.getAddresses({typeId: AddressType.Billing});
const { data } = await useSdk().plentysystems.getAddresses({typeId: AddressType.Shipping});