retrieveShippingOptionType - Fulfillment Module Reference

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

This method retrieves a shipping option type by its ID.

Example

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

const shippingOptionType =
  await fulfillmentModuleService.retrieveShippingOptionType(
    "sotype_123"
  )

To specify relations that should be retrieved:

const shippingOptionType =
  await fulfillmentModuleService.retrieveShippingOptionType(
    "sotype_123",
    {
      relations: ["shipping_option"],
    }
  )

Parameters

idstringRequired

The ID of the shipping option type.

configFindConfig<ShippingOptionTypeDTO>

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

sharedContextContext

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

Returns

PromisePromise<ShippingOptionTypeDTO>Required

The retrieved shipping option type.