PlentyONE Shop Docs

Appearance

@plentymarkets/shop-api / getAddresses

Function: getAddresses() ​

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

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

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

Parameters ​

context ​

PlentysystemsIntegrationContext

params ​

GetAddressesParams

Returns ​

Promise<Data<Address[]>>

Deprecated ​

Use getAddressesData() instead. This method will be removed in the future.

Remarks ​

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

Example ​

ts
// Deprecated - don't use
const { data } = await useSdk().plentysystems.getAddresses({typeId: AddressType.Billing});

// Use this instead
const { data } = await useSdk().plentysystems.getAddressesData({types: [AddressType.Billing]});