retrieveShippingOption - Fulfillment Module Reference

This documentation provides a reference to the retrieveShippingOption method. This belongs to the Fulfillment Module.

This method retrieves a shipping option by its ID.

Example

A simple example that retrieves a shipping option by its ID:

const shippingOption =
  await fulfillmentModuleService.retrieveShippingOption(
    "so_123"
  )

To specify relations that should be retrieved:

const shippingOption =
  await fulfillmentModuleService.retrieveShippingOption(
    "so_123",
    {
      relations: ["fulfillments"],
    }
  )

Parameters

idstringRequired

The ID of the shipping option.

configFindConfig<ShippingOptionDTO>

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

sharedContextContext

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

Returns

PromisePromise<ShippingOptionDTO>Required

The retrieved shipping option.