www/apps/resources/references/fulfillment/IFulfillmentModuleService/methods/fulfillment.IFulfillmentModuleService.updateShippingProfiles/page.mdx
import { TypeList } from "docs-ui"
This documentation provides a reference to the updateShippingProfiles method. This belongs to the Fulfillment Module.
You should only use this methods when implementing complex customizations. For common cases, check out available workflows instead.
</Note>This method updates existing shipping profiles.
const shippingProfiles =
await fulfillmentModuleService.updateShippingProfiles([
{
id: "sp_123",
name: "Default",
},
{
id: "sp_321",
name: "Digital",
},
])
<TypeList types={[{"name":"selector","type":"FilterableShippingProfileProps","description":"The selector of shipping profiles to update","optional":false,"defaultValue":"","expandable":false,"children":[{"name":"$and","type":"(FilterableShippingProfileProps \| BaseFilterable<FilterableShippingProfileProps>)[]","description":"An array of filters to apply on the entity, where each item in the array is joined with an "and" condition.","optional":true,"defaultValue":"","expandable":false,"children":[{"name":"$and","type":"(FilterableShippingProfileProps \| BaseFilterable<FilterableShippingProfileProps>)[]","description":"An array of filters to apply on the entity, where each item in the array is joined with an "and" condition.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"$or","type":"(FilterableShippingProfileProps \| BaseFilterable<FilterableShippingProfileProps>)[]","description":"An array of filters to apply on the entity, where each item in the array is joined with an "or" condition.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"id","type":"string \| string[] \| OperatorMap<string \| string[]>","description":"The IDs to filter the shipping profiles by.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"name","type":"string \| string[] \| OperatorMap<string \| string[]>","description":"Filter the shipping profiles by their name.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"type","type":"string \| string[] \| OperatorMap<string \| string[]>","description":"Filter the shipping profiles by their type.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"shipping_options","type":"FilterableShippingOptionProps","description":"The filters to apply on the retrieved shipping options.","optional":true,"defaultValue":"","expandable":false,"children":[]}]},{"name":"$or","type":"(FilterableShippingProfileProps \| BaseFilterable<FilterableShippingProfileProps>)[]","description":"An array of filters to apply on the entity, where each item in the array is joined with an "or" condition.","optional":true,"defaultValue":"","expandable":false,"children":[{"name":"$and","type":"(FilterableShippingProfileProps \| BaseFilterable<FilterableShippingProfileProps>)[]","description":"An array of filters to apply on the entity, where each item in the array is joined with an "and" condition.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"$or","type":"(FilterableShippingProfileProps \| BaseFilterable<FilterableShippingProfileProps>)[]","description":"An array of filters to apply on the entity, where each item in the array is joined with an "or" condition.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"id","type":"string \| string[] \| OperatorMap<string \| string[]>","description":"The IDs to filter the shipping profiles by.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"name","type":"string \| string[] \| OperatorMap<string \| string[]>","description":"Filter the shipping profiles by their name.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"type","type":"string \| string[] \| OperatorMap<string \| string[]>","description":"Filter the shipping profiles by their type.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"shipping_options","type":"FilterableShippingOptionProps","description":"The filters to apply on the retrieved shipping options.","optional":true,"defaultValue":"","expandable":false,"children":[]}]},{"name":"id","type":"string \| string[] \| OperatorMap<string \| string[]>","description":"The IDs to filter the shipping profiles by.","optional":true,"defaultValue":"","expandable":false,"children":[{"name":"$and","type":"Query<T>[]","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"$or","type":"Query<T>[]","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"$eq","type":"ExpandScalar<T> \| ExpandScalar<T>[]","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"$ne","type":"ExpandScalar<T>","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"$in","type":"ExpandScalar<T>[]","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"$nin","type":"ExpandScalar<T>[]","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"$not","type":"Query<T>","description":"API wrapper around the remoteQuery","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"$gt","type":"ExpandScalar<T>","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"$gte","type":"ExpandScalar<T>","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"$lt","type":"ExpandScalar<T>","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"$lte","type":"ExpandScalar<T>","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"$like","type":"string","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"$re","type":"string","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"$ilike","type":"string","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"$fulltext","type":"string","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"$overlap","type":"string[]","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"$contains","type":"string[]","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"$contained","type":"string[]","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"$exists","type":"boolean","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]}]},{"name":"name","type":"string \| string[] \| OperatorMap<string \| string[]>","description":"Filter the shipping profiles by their name.","optional":true,"defaultValue":"","expandable":false,"children":[{"name":"$and","type":"Query<T>[]","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"$or","type":"Query<T>[]","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"$eq","type":"ExpandScalar<T> \| ExpandScalar<T>[]","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"$ne","type":"ExpandScalar<T>","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"$in","type":"ExpandScalar<T>[]","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"$nin","type":"ExpandScalar<T>[]","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"$not","type":"Query<T>","description":"API wrapper around the remoteQuery","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"$gt","type":"ExpandScalar<T>","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"$gte","type":"ExpandScalar<T>","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"$lt","type":"ExpandScalar<T>","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"$lte","type":"ExpandScalar<T>","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"$like","type":"string","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"$re","type":"string","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"$ilike","type":"string","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"$fulltext","type":"string","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"$overlap","type":"string[]","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"$contains","type":"string[]","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"$contained","type":"string[]","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"$exists","type":"boolean","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]}]},{"name":"type","type":"string \| string[] \| OperatorMap<string \| string[]>","description":"Filter the shipping profiles by their type.","optional":true,"defaultValue":"","expandable":false,"children":[{"name":"$and","type":"Query<T>[]","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"$or","type":"Query<T>[]","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"$eq","type":"ExpandScalar<T> \| ExpandScalar<T>[]","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"$ne","type":"ExpandScalar<T>","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"$in","type":"ExpandScalar<T>[]","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"$nin","type":"ExpandScalar<T>[]","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"$not","type":"Query<T>","description":"API wrapper around the remoteQuery","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"$gt","type":"ExpandScalar<T>","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"$gte","type":"ExpandScalar<T>","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"$lt","type":"ExpandScalar<T>","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"$lte","type":"ExpandScalar<T>","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"$like","type":"string","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"$re","type":"string","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"$ilike","type":"string","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"$fulltext","type":"string","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"$overlap","type":"string[]","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"$contains","type":"string[]","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"$contained","type":"string[]","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"$exists","type":"boolean","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]}]},{"name":"shipping_options","type":"FilterableShippingOptionProps","description":"The filters to apply on the retrieved shipping options.","optional":true,"defaultValue":"","expandable":false,"children":[{"name":"$and","type":"(FilterableShippingOptionProps \| BaseFilterable<FilterableShippingOptionProps>)[]","description":"An array of filters to apply on the entity, where each item in the array is joined with an "and" condition.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"$or","type":"(FilterableShippingOptionProps \| BaseFilterable<FilterableShippingOptionProps>)[]","description":"An array of filters to apply on the entity, where each item in the array is joined with an "or" condition.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"id","type":"string \| string[] \| OperatorMap<string \| string[]>","description":"The IDs to filter the shipping options by.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"name","type":"string \| string[] \| OperatorMap<string \| string[]>","description":"Filter the shipping options by their name.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"shipping_profile_id","type":"string \| string[] \| OperatorMap<string \| string[]>","description":"Filter the shipping options by the ID of their associated shipping profile.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"price_type","type":"ShippingOptionPriceType \| ShippingOptionPriceType[] \| OperatorMap<ShippingOptionPriceType | ShippingOptionPriceType[]>","description":"Filter the shipping options by their price type.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"service_zone","type":"FilterableServiceZoneProps","description":"The filters to apply on the retrieved service zones.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"shipping_option_type","type":"FilterableShippingOptionTypeProps","description":"The filters to apply on the retrieved shipping option types.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"rules","type":"FilterableShippingOptionRuleProps","description":"The filters to apply on the retrieved shipping option rules.","optional":true,"defaultValue":"","expandable":false,"children":[]}]}]},{"name":"data","type":"UpdateShippingProfileDTO","description":"The shipping profiles update data.","optional":false,"defaultValue":"","expandable":false,"children":[{"name":"name","type":"string","description":"The name of the shipping profile.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"type","type":"string","description":"The type of the shipping profile.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"metadata","type":"null \| Record<string, unknown>","description":"Holds custom data in key-value pairs.","optional":true,"defaultValue":"","expandable":false,"children":[]}]},{"name":"sharedContext","type":"Context","description":"A context used to share resources, such as transaction manager, between the application and the module.","optional":true,"defaultValue":"","expandable":false,"children":[{"name":"transactionManager","type":"TManager","description":"An instance of a transaction manager of type TManager, which is a typed parameter passed to the context to specify the type of the transactionManager.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"manager","type":"TManager","description":"An instance of a manager, typically an entity manager, of type TManager, which is a typed parameter passed to the context to specify the type of the manager.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"isolationLevel","type":"string","description":"A string indicating the isolation level of the context. Possible values are READ UNCOMMITTED, READ COMMITTED, REPEATABLE READ, or SERIALIZABLE.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"enableNestedTransactions","type":"boolean","description":"A boolean value indicating whether nested transactions are enabled.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"eventGroupId","type":"string","description":"A string indicating the ID of the group to aggregate the events to be emitted at a later point.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"transactionId","type":"string","description":"A string indicating the ID of the current transaction.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"runId","type":"string","description":"A string indicating the ID of the current run.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"messageAggregator","type":"IMessageAggregator","description":"An instance of a message aggregator, which is used to aggregate messages to be emitted at a later point.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"requestId","type":"string","description":"A string indicating the ID of the current request.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"idempotencyKey","type":"string","description":"A string indicating the idempotencyKey of the current workflow execution.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"parentStepIdempotencyKey","type":"string","description":"A string indicating the idempotencyKey of the parent workflow execution.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"preventReleaseEvents","type":"boolean","description":"preventReleaseEvents","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"isCancelling","type":"boolean","description":"A boolean value indicating whether the current workflow execution is being cancelled.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"cancelingFromParentStep","type":"boolean","description":"Weither or not a sub workflow cancellation is being triggered from a parent step.\nIf true, the parent step will not be triggered by the sub workflow.","optional":true,"defaultValue":"","expandable":false,"children":[]}]}]} expandUrl="https://docs.medusajs.com/learn/fundamentals/data-models/manage-relationships#retrieve-records-of-relation" sectionTitle="updateShippingProfiles"/>
<TypeList types={[{"name":"Promise","type":"Promise<ShippingProfileDTO[]>","optional":false,"defaultValue":"","description":"The updated shipping profiles.","expandable":false,"children":[{"name":"ShippingProfileDTO[]","type":"ShippingProfileDTO[]","optional":false,"defaultValue":"","description":"","expandable":false,"children":[{"name":"id","type":"string","description":"The ID of the shipping profile.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"name","type":"string","description":"The name of the shipping profile.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"type","type":"string","description":"The type of the shipping profile.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"metadata","type":"null \| Record<string, unknown>","description":"Holds custom data in key-value pairs.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"shipping_options","type":"ShippingOptionDTO[]","description":"The shipping options associated with the shipping profile.","optional":false,"defaultValue":"","expandable":false,"children":[{"name":"id","type":"string","description":"The ID of the shipping option.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"name","type":"string","description":"The name of the shipping option.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"price_type","type":"ShippingOptionPriceType","description":"The type of the shipping option's price.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"service_zone_id","type":"string","description":"The associated service zone's ID.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"shipping_profile_id","type":"string","description":"The associated shipping profile's ID.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"provider_id","type":"string","description":"The associated fulfillment provider's ID.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"shipping_option_type_id","type":"null \| string","description":"The associated shipping option type's ID.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"data","type":"null \| Record<string, unknown>","description":"The data necessary for the associated fulfillment provider to process the shipping option\nand, later, its associated fulfillments.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"metadata","type":"null \| Record<string, unknown>","description":"Holds custom data in key-value pairs.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"service_zone","type":"ServiceZoneDTO","description":"The associated service zone.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"shipping_profile","type":"ShippingProfileDTO","description":"The associated shipping profile.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"fulfillment_provider","type":"FulfillmentProviderDTO","description":"The associated fulfillment provider.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"type","type":"ShippingOptionTypeDTO","description":"The associated shipping option type.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"rules","type":"ShippingOptionRuleDTO[]","description":"The rules associated with the shipping option.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"fulfillments","type":"FulfillmentDTO[]","description":"The fulfillments associated with the shipping option.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"created_at","type":"Date","description":"The creation date of the shipping option.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"updated_at","type":"Date","description":"The update date of the shipping option.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"deleted_at","type":"null \| Date","description":"The deletion date of the shipping option.","optional":false,"defaultValue":"","expandable":false,"children":[]}]},{"name":"created_at","type":"Date","description":"The creation date of the shipping profile.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"updated_at","type":"Date","description":"The update date of the shipping profile.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"deleted_at","type":"null \| Date","description":"The deletion date of the shipping profile.","optional":false,"defaultValue":"","expandable":false,"children":[]}]}]}]} expandUrl="https://docs.medusajs.com/learn/fundamentals/data-models/manage-relationships#retrieve-records-of-relation" sectionTitle="updateShippingProfiles"/>
This method updates an existing shipping profiles.
const shippingProfiles =
await fulfillmentModuleService.updateShippingProfiles({
id: "sp_123",
name: "Default",
})
<TypeList types={[{"name":"id","type":"string","description":"The shipping profile to be updated.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"data","type":"UpdateShippingProfileDTO","description":"The shipping profile to be created.","optional":false,"defaultValue":"","expandable":false,"children":[{"name":"name","type":"string","description":"The name of the shipping profile.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"type","type":"string","description":"The type of the shipping profile.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"metadata","type":"null \| Record<string, unknown>","description":"Holds custom data in key-value pairs.","optional":true,"defaultValue":"","expandable":false,"children":[]}]},{"name":"sharedContext","type":"Context","description":"A context used to share resources, such as transaction manager, between the application and the module.","optional":true,"defaultValue":"","expandable":false,"children":[{"name":"transactionManager","type":"TManager","description":"An instance of a transaction manager of type TManager, which is a typed parameter passed to the context to specify the type of the transactionManager.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"manager","type":"TManager","description":"An instance of a manager, typically an entity manager, of type TManager, which is a typed parameter passed to the context to specify the type of the manager.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"isolationLevel","type":"string","description":"A string indicating the isolation level of the context. Possible values are READ UNCOMMITTED, READ COMMITTED, REPEATABLE READ, or SERIALIZABLE.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"enableNestedTransactions","type":"boolean","description":"A boolean value indicating whether nested transactions are enabled.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"eventGroupId","type":"string","description":"A string indicating the ID of the group to aggregate the events to be emitted at a later point.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"transactionId","type":"string","description":"A string indicating the ID of the current transaction.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"runId","type":"string","description":"A string indicating the ID of the current run.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"messageAggregator","type":"IMessageAggregator","description":"An instance of a message aggregator, which is used to aggregate messages to be emitted at a later point.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"requestId","type":"string","description":"A string indicating the ID of the current request.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"idempotencyKey","type":"string","description":"A string indicating the idempotencyKey of the current workflow execution.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"parentStepIdempotencyKey","type":"string","description":"A string indicating the idempotencyKey of the parent workflow execution.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"preventReleaseEvents","type":"boolean","description":"preventReleaseEvents","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"isCancelling","type":"boolean","description":"A boolean value indicating whether the current workflow execution is being cancelled.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"cancelingFromParentStep","type":"boolean","description":"Weither or not a sub workflow cancellation is being triggered from a parent step.\nIf true, the parent step will not be triggered by the sub workflow.","optional":true,"defaultValue":"","expandable":false,"children":[]}]}]} expandUrl="https://docs.medusajs.com/learn/fundamentals/data-models/manage-relationships#retrieve-records-of-relation" sectionTitle="updateShippingProfiles"/>
<TypeList types={[{"name":"Promise","type":"Promise<ShippingProfileDTO>","optional":false,"defaultValue":"","description":"The updated shipping profiles.","expandable":false,"children":[{"name":"id","type":"string","description":"The ID of the shipping profile.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"name","type":"string","description":"The name of the shipping profile.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"type","type":"string","description":"The type of the shipping profile.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"metadata","type":"null \| Record<string, unknown>","description":"Holds custom data in key-value pairs.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"shipping_options","type":"ShippingOptionDTO[]","description":"The shipping options associated with the shipping profile.","optional":false,"defaultValue":"","expandable":false,"children":[{"name":"id","type":"string","description":"The ID of the shipping option.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"name","type":"string","description":"The name of the shipping option.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"price_type","type":"ShippingOptionPriceType","description":"The type of the shipping option's price.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"service_zone_id","type":"string","description":"The associated service zone's ID.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"shipping_profile_id","type":"string","description":"The associated shipping profile's ID.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"provider_id","type":"string","description":"The associated fulfillment provider's ID.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"shipping_option_type_id","type":"null \| string","description":"The associated shipping option type's ID.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"data","type":"null \| Record<string, unknown>","description":"The data necessary for the associated fulfillment provider to process the shipping option\nand, later, its associated fulfillments.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"metadata","type":"null \| Record<string, unknown>","description":"Holds custom data in key-value pairs.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"service_zone","type":"ServiceZoneDTO","description":"The associated service zone.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"shipping_profile","type":"ShippingProfileDTO","description":"The associated shipping profile.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"fulfillment_provider","type":"FulfillmentProviderDTO","description":"The associated fulfillment provider.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"type","type":"ShippingOptionTypeDTO","description":"The associated shipping option type.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"rules","type":"ShippingOptionRuleDTO[]","description":"The rules associated with the shipping option.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"fulfillments","type":"FulfillmentDTO[]","description":"The fulfillments associated with the shipping option.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"created_at","type":"Date","description":"The creation date of the shipping option.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"updated_at","type":"Date","description":"The update date of the shipping option.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"deleted_at","type":"null \| Date","description":"The deletion date of the shipping option.","optional":false,"defaultValue":"","expandable":false,"children":[]}]},{"name":"created_at","type":"Date","description":"The creation date of the shipping profile.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"updated_at","type":"Date","description":"The update date of the shipping profile.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"deleted_at","type":"null \| Date","description":"The deletion date of the shipping profile.","optional":false,"defaultValue":"","expandable":false,"children":[]}]}]} expandUrl="https://docs.medusajs.com/learn/fundamentals/data-models/manage-relationships#retrieve-records-of-relation" sectionTitle="updateShippingProfiles"/>