retrieveCart - Cart Module Reference

This documentation provides a reference to the retrieveCart method. This belongs to the Cart Module.

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

This method retrieves a cart by its ID.

Example#

A simple example that retrieves a cart by its ID:

Code
const cart = await cartModuleService.retrieveCart("cart_123")

To specify relations that should be retrieved:

Note: You can only retrieve data models defined in the same module. To retrieve linked data models from other modules, use Query instead.

Code
1const cart = await cartModuleService.retrieveCart("cart_123", {2  relations: ["shipping_address"],3})

Parameters#

cartIdstring

The cart's ID.

configFindConfig<CartDTO>Optional

The configurations determining how the cart is retrieved. Its properties, such as select or relations, accept the attributes or relations associated with a cart.

sharedContextContextOptional

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

Returns#

PromisePromise<CartDTO>

The retrieved cart.