updateShippingOptions - Fulfillment Module Reference

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

updateShippingOptions(id, data, sharedContext?): Promise<ShippingOptionDTO>

This method updates an existing shipping option.

Example

const shippingOption =
  await fulfillmentModuleService.updateShippingOptions(
    "so_123",
    {
      name: "Express shipping",
    }
  )

Parameters

idstringRequired

The ID of the shipping option.

dataUpdateShippingOptionDTORequired

The attributes to update in the shipping option.

sharedContextContext

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

Returns

PromisePromise<ShippingOptionDTO>Required

The updated shipping option.

updateShippingOptions(selector, data, sharedContext?): Promise<ShippingOptionDTO[]>

This method updates existing shipping options matching the specified filters.

Example

const shippingOptions =
  await fulfillmentModuleService.updateShippingOptions(
    {
      id: ["so_123", "so_321"],
    },
    {
      name: "Express Shipping",
    }
  )

Parameters

selectorFilterableShippingOptionPropsRequired

The filters specifying which shipping options to update.

dataUpdateShippingOptionDTORequired

The attributes to update in the shipping option.

sharedContextContext

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

Returns

PromisePromise<ShippingOptionDTO[]>Required

The updated shipping options.