retrieveShippingProfile - Fulfillment Module Reference

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

This method retrieves a shipping profile by its ID.

Example

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

const shippingProfile =
  await fulfillmentModuleService.retrieveShippingProfile(
    "sp_123"
  )

To specify relations that should be retrieved:

const shippingProfile =
  await fulfillmentModuleService.retrieveShippingProfile(
    "sp_123",
    {
      relations: ["options"],
    }
  )

Parameters

idstringRequired

The ID of the shipping profile.

configFindConfig<ShippingProfileDTO>

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

sharedContextContext

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

Returns

PromisePromise<ShippingProfileDTO>Required

The retrieved shipping profile.