IWishlistModuleService Reference

This section of the documentation provides a reference to the IWishlistModuleService interface’s methods. This is the interface developers use to use the functionalities provided by the Wishlist Module.

You should only use the methods in this reference when implementing complex customizations. For common cases, check out available workflows instead.

The main service interface for the Wishlist Module.

createWishlists

This section provides a reference to the createWishlists method. This belongs to the Wishlist Module.

createWishlists(data, sharedContext?): Promise<WishlistDTO[]>

This method creates wishlist items.

Example

const wishlists = await wishlistModuleService.createWishlists([
  {
    reference: "product",
    reference_id: "prod_123",
    customer_id: "cus_123",
  },
])

Parameters

data

CreateWishlistDTO[]

required

The wishlist items to be created.

Show properties

reference

"product"

required

The type of the wishlist reference. Currently only supports product.

reference_id

string

required

The ID of the referenced entity (e.g., product ID).

customer_id

string

required

The ID of the customer who owns this wishlist item.

sharedContext

Context

A context used to share resources, such as transaction manager, between the application and the module.

Returns

Promise

Promise<WishlistDTO[]>

The created wishlist items.

createWishlists(data, sharedContext?): Promise<WishlistDTO>

This method creates a wishlist item.

Example

const wishlist = await wishlistModuleService.createWishlists({
  reference: "product",
  reference_id: "prod_123",
  customer_id: "cus_123",
})

Parameters

data

CreateWishlistDTO

required

The wishlist item to be created.

Show properties

reference

"product"

required

The type of the wishlist reference. Currently only supports product.

reference_id

string

required

The ID of the referenced entity (e.g., product ID).

customer_id

string

required

The ID of the customer who owns this wishlist item.

sharedContext

Context

A context used to share resources, such as transaction manager, between the application and the module.

Returns

Promise

Promise<WishlistDTO>

The created wishlist item.

updateWishlists

This section provides a reference to the updateWishlists method. This belongs to the Wishlist Module.

updateWishlists(id, data, sharedContext?): Promise<WishlistDTO>

This method updates an existing wishlist item.

Example

const wishlist = await wishlistModuleService.updateWishlists("wish_123", {
  reference_id: "prod_456",
})

Parameters

string

required

The ID of the wishlist item.

data

UpdateWishlistDTO

required

The attributes to update in the wishlist item.

Show properties

reference

"product"

The type of the wishlist reference.

reference_id

string

The ID of the referenced entity.

sharedContext

Context

A context used to share resources, such as transaction manager, between the application and the module.

Returns

Promise

Promise<WishlistDTO>

The updated wishlist item.

Show properties

string

The ID of the wishlist item.

reference

"product"

The type of the wishlist reference.

created_at

Date

The created date of the wishlist item.

updated_at

Date

The updated date of the wishlist item.

deleteWishlists

This section provides a reference to the deleteWishlists method. This belongs to the Wishlist Module.

deleteWishlists(ids, sharedContext?): Promise<void>

This method deletes wishlist items by their IDs.

Example

await wishlistModuleService.deleteWishlists(["wish_123", "wish_321"])

Parameters

ids

string[]

required

The IDs of the wishlist items.

sharedContext

Context

A context used to share resources, such as transaction manager, between the application and the module.

Returns

Promise

Promise<void>

Resolves when the wishlist items are deleted successfully.

deleteWishlists(id, sharedContext?): Promise<void>

This method deletes a wishlist item by its ID.

Example

await wishlistModuleService.deleteWishlists("wish_123")

Parameters

string

required

The ID of the wishlist item.

sharedContext

Context

A context used to share resources, such as transaction manager, between the application and the module.

Returns

Promise

Promise<void>

Resolves when the wishlist item is deleted successfully.

retrieveWishlist

This section provides a reference to the retrieveWishlist method. This belongs to the Wishlist Module. This method retrieves a wishlist item by its ID.

Example

const wishlist = await wishlistModuleService.retrieveWishlist("wish_123")

Parameters

string

required

The ID of the wishlist item.

config

FindConfig<WishlistDTO>

The configurations determining how the wishlist item is retrieved.

Show properties

select

string[]

An array of strings, each being attribute names of the entity to retrieve in the result.

skip

number

A number indicating the number of records to skip before retrieving the results.

take

number

A number indicating the number of records to return in the result.

relations

string[]

An array of strings, each being relation names of the entity to retrieve in the result. Use Query to retrieve linked product data.

order

Record<string, "ASC" | "DESC">

An object used to specify how to sort the returned records.

withDeleted

boolean

A boolean indicating whether deleted records should also be retrieved as part of the result.

sharedContext

Context

A context used to share resources, such as transaction manager, between the application and the module.

Returns

Promise

Promise<WishlistDTO>

The retrieved wishlist item.

Show properties

string

The ID of the wishlist item.

reference

"product"

The type of the wishlist reference.

created_at

Date

The created date of the wishlist item.

updated_at

Date

The updated date of the wishlist item.

listWishlists

This section provides a reference to the listWishlists method. This belongs to the Wishlist Module. This method retrieves a paginated list of wishlist items based on optional filters and configuration.

Example

To retrieve a customer’s wishlist:

const wishlists = await wishlistModuleService.listWishlists({
  customer_id: "cus_123",
})

To retrieve wishlist items for specific products:

const wishlists = await wishlistModuleService.listWishlists({
  reference_id: ["prod_123", "prod_456"],
})

By default, only the first 15 records are retrieved. You can control pagination by specifying the skip and take properties of the config parameter:

const wishlists = await wishlistModuleService.listWishlists(
  {
    customer_id: "cus_123",
  },
  {
    take: 20,
    skip: 2,
  }
)

Parameters

filters

FilterableWishlistProps

The filters to apply on the retrieved wishlist items.

Show properties

string | string[]

The IDs to filter the wishlist items by.

customer_id

string | string[]

Filter wishlist items by their customer IDs.

reference

string | string[]

Filter wishlist items by their reference type.

reference_id

string | string[]

Filter wishlist items by their reference IDs (e.g., product IDs).

config

FindConfig<WishlistDTO>

The configurations determining how the wishlist item is retrieved.

Show properties

select

string[]

An array of strings, each being attribute names of the entity to retrieve in the result.

skip

number

A number indicating the number of records to skip before retrieving the results.

take

number

A number indicating the number of records to return in the result.

relations

string[]

An array of strings, each being relation names of the entity to retrieve in the result.

order

Record<string, "ASC" | "DESC">

An object used to specify how to sort the returned records.

withDeleted

boolean

A boolean indicating whether deleted records should also be retrieved as part of the result.

sharedContext

Context

A context used to share resources, such as transaction manager, between the application and the module.

Returns

Promise

Promise<WishlistDTO[]>

The list of wishlist items.

listAndCountWishlists

This section provides a reference to the listAndCountWishlists method. This belongs to the Wishlist Module. This method retrieves a paginated list of wishlist items along with the total count of available wishlist items satisfying the provided filters.

Example

To retrieve a customer’s wishlist with count:

const [wishlists, count] = await wishlistModuleService.listAndCountWishlists({
  customer_id: "cus_123",
})

By default, only the first 15 records are retrieved. You can control pagination by specifying the skip and take properties of the config parameter:

const [wishlists, count] = await wishlistModuleService.listAndCountWishlists(
  {
    customer_id: "cus_123",
  },
  {
    take: 20,
    skip: 2,
  }
)

Parameters

filters

FilterableWishlistProps

The filters to apply on the retrieved wishlist items.

Show properties

string | string[]

The IDs to filter the wishlist items by.

customer_id

string | string[]

Filter wishlist items by their customer IDs.

reference

string | string[]

Filter wishlist items by their reference type.

reference_id

string | string[]

Filter wishlist items by their reference IDs (e.g., product IDs).

config

FindConfig<WishlistDTO>

The configurations determining how the wishlist item is retrieved.

Show properties

select

string[]

An array of strings, each being attribute names of the entity to retrieve in the result.

skip

number

A number indicating the number of records to skip before retrieving the results.

take

number

A number indicating the number of records to return in the result.

relations

string[]

An array of strings, each being relation names of the entity to retrieve in the result.

order

Record<string, "ASC" | "DESC">

An object used to specify how to sort the returned records.

withDeleted

boolean

A boolean indicating whether deleted records should also be retrieved as part of the result.

sharedContext

Context

A context used to share resources, such as transaction manager, between the application and the module.

Returns

Promise

Promise<[WishlistDTO[], number]>

The list of wishlist items along with their total count.

softDeleteWishlists

This section provides a reference to the softDeleteWishlists method. This belongs to the Wishlist Module. This method soft deletes wishlist items by their IDs.

Example

await wishlistModuleService.softDeleteWishlists([
  "wish_123",
  "wish_321",
])

Parameters

wishlistIds

string[]

required

The IDs of the wishlist items.

config

SoftDeleteReturn<TReturnableLinkableKeys>

An object that is used to specify an entity’s related entities that should be soft-deleted when the main entity is soft-deleted.

sharedContext

Context

A context used to share resources, such as transaction manager, between the application and the module.

Returns

Promise

Promise<void | Record<string, string[]>>

An object that includes the IDs of related records that were also soft deleted. If there are no related records, the promise resolves to void.

restoreWishlists

This section provides a reference to the restoreWishlists method. This belongs to the Wishlist Module. This method restores soft deleted wishlist items by their IDs.

Example

await wishlistModuleService.restoreWishlists(["wish_123", "wish_321"])

Parameters

wishlistIds

string[]

required

The IDs of the wishlist items.

config

RestoreReturn<TReturnableLinkableKeys>

Configurations determining which relations to restore along with each of the wishlist item.

sharedContext

Context

A context used to share resources, such as transaction manager, between the application and the module.

Returns

Promise

Promise<void | Record<string, string[]>>

An object that includes the IDs of related records that were restored. If there are no related records restored, the promise resolves to void.

Quick start

Components

Core Concepts

Product

Integrations

Deployment

Help

​IWishlistModuleService Reference

​Methods

​createWishlists

​createWishlists(data, sharedContext?): Promise<WishlistDTO[]>

​Example

​Parameters

​Returns

​createWishlists(data, sharedContext?): Promise<WishlistDTO>

​Example

​Parameters

​Returns

​updateWishlists

​updateWishlists(id, data, sharedContext?): Promise<WishlistDTO>

​Example

​Parameters

​Returns

​deleteWishlists

​deleteWishlists(ids, sharedContext?): Promise<void>

​Example

​Parameters

​Returns

​deleteWishlists(id, sharedContext?): Promise<void>

​Example

​Parameters

​Returns

​retrieveWishlist

​Example

​Parameters

​Returns

​listWishlists

​Example

​Parameters

​Returns

​listAndCountWishlists

​Example

​Parameters

​Returns

​softDeleteWishlists

​Example

​Parameters

​Returns

​restoreWishlists

​Example

​Parameters

​Returns

IWishlistModuleService Reference

Methods

createWishlists

createWishlists(data, sharedContext?): Promise<WishlistDTO[]>

Example

Parameters

Returns

createWishlists(data, sharedContext?): Promise<WishlistDTO>

Example

Parameters

Returns

updateWishlists

updateWishlists(id, data, sharedContext?): Promise<WishlistDTO>

Example

Parameters

Returns

deleteWishlists

deleteWishlists(ids, sharedContext?): Promise<void>

Example

Parameters

Returns

deleteWishlists(id, sharedContext?): Promise<void>

Example

Parameters

Returns

retrieveWishlist

Example

Parameters

Returns

listWishlists

Example

Parameters

Returns

listAndCountWishlists

Example

Parameters

Returns

softDeleteWishlists

Example

Parameters

Returns

restoreWishlists

Example

Parameters

Returns