listShippingMethods - Order Module Reference

This documentation provides a reference to the listShippingMethods method. This belongs to the Order Module.

This method retrieves a paginated list of {return type}(s) based on optional filters and configuration.

Example

await orderModuleService.listShippingMethods(
  { order_id: "order_123" },
  { limit: 10, offset: 0 }
);

Parameters

filtersFilterableOrderShippingMethodPropsRequired

The filters to apply on the retrieved order shipping method.

configFindConfig<OrderShippingMethodDTO>Required

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

sharedContextContext

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

Returns

PromisePromise<OrderShippingMethodDTO[]>Required

The list of {return type}(s).