Back to Medusa

UpdateShippingOptionDTO

www/apps/resources/references/fulfillment/interfaces/fulfillment.UpdateShippingOptionDTO/page.mdx

2.14.23.3 KB
Original Source

import { TypeList } from "docs-ui"

UpdateShippingOptionDTO

The attributes to update in the shipping option.

<TypeList types={[{"name":"id","type":"string","description":"The ID of the shipping option.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"name","type":"string","description":"The name of the shipping option.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"price_type","type":"ShippingOptionPriceType","description":"The type of the shipping option's price.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"service_zone_id","type":"string","description":"The associated service zone's ID.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"shipping_profile_id","type":"string","description":"The associated shipping profile's ID.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"provider_id","type":"string","description":"The associated provider's ID.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"shipping_option_type_id","type":"string","description":"The ID of the shipping option type.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"type_id","type":"string","description":"The ID of the type of shipping option.\nColumn doesn't exist on the entity -> normalized to shipping_option_type_id","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"type","type":"string \| CreateShippingOptionTypeDTO \| object","description":"The shipping option type associated with the shipping option.","optional":true,"defaultValue":"","expandable":false,"children":[{"name":"label","type":"string","description":"The label of the shipping option type.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"code","type":"string","description":"The code of the shipping option type.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"id","type":"string","description":"The ID of the shipping option type.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"description","type":"string","description":"The description of the shipping option type.","optional":true,"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 its associated fulfillments.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"rules","type":"(Omit<CreateShippingOptionRuleDTO, "shipping_option_id"> \| object)[]","description":"The shipping option rules associated with the shipping option.","optional":true,"defaultValue":"","expandable":false,"children":[{"name":"id","type":"string","description":"The ID of the shipping option rule.","optional":false,"defaultValue":"","expandable":false,"children":[]}]}]} expandUrl="https://docs.medusajs.com/learn/fundamentals/data-models/manage-relationships#retrieve-records-of-relation" sectionTitle="UpdateShippingOptionDTO"/>