retrieveShippingOptionRule - Fulfillment Module Reference

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

This method retrieves a shipping option rule by its ID.

Example

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

const shippingOptionRule =
  await fulfillmentModuleService.retrieveShippingOptionRule(
    "sorul_123"
  )

To specify relations that should be retrieved:

const shippingOptionRule =
  await fulfillmentModuleService.retrieveShippingOptionRule(
    "sorul_123",
    {
      relations: ["shipping_option"],
    }
  )

Parameters

idstringRequired

The ID of the shipping option rule.

configFindConfig<ShippingOptionRuleDTO>

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

sharedContextContext

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

Returns

PromisePromise<ShippingOptionRuleDTO>Required

The retrieved shipping option rule.