Menu
  • Get Started
  • Product
  • Resources
  • Tools & SDKs
  • Framework
  • Reference

ShippingOptionDTO

The shipping option details.

idstring
The ID of the shipping option.
namestring
The name of the shipping option.
price_typeShippingOptionPriceType
The type of the shipping option's price.
service_zone_idstring
The associated service zone's ID.
shipping_profile_idstring
The associated shipping profile's ID.
provider_idstring
The associated fulfillment provider's ID.
shipping_option_type_idnull | string
The associated shipping option type's ID.
datanull | Record<string, unknown>
The data necessary for the associated fulfillment provider to process the shipping option and, later, its associated fulfillments.
metadatanull | Record<string, unknown>
Holds custom data in key-value pairs.
service_zoneServiceZoneDTO
The associated service zone.
shipping_profileShippingProfileDTO
The associated shipping profile.
fulfillment_providerFulfillmentProviderDTO
The associated fulfillment provider.
typeShippingOptionTypeDTO
The associated shipping option type.
rulesShippingOptionRuleDTO[]
The rules associated with the shipping option.
fulfillmentsFulfillmentDTO[]
The fulfillments associated with the shipping option.
created_atDate
The creation date of the shipping option.
updated_atDate
The update date of the shipping option.
deleted_atnull | Date
The deletion date of the shipping option.
Was this page helpful?
Edit this page