Skip to main content
Skip to main content

ShippingOptionDTO

The shipping option details.

idstringRequired
The ID of the shipping option.
namestringRequired
The name of the shipping option.
price_typeShippingOptionPriceTypeRequired
The type of the shipping option's price.
service_zone_idstringRequired
The associated service zone's ID.
shipping_profile_idstringRequired
The associated shipping profile's ID.
provider_idstringRequired
The associated fulfillment provider's ID.
shipping_option_type_idnull | stringRequired
The associated shipping option type's ID.
datanull | Record<string, unknown>Required
The data necessary for the associated fulfillment provider to process the shipping option and, later, its associated fulfillments.
metadatanull | Record<string, unknown>Required
Holds custom data in key-value pairs.
service_zoneServiceZoneDTORequired
The associated service zone.
shipping_profileShippingProfileDTORequired
The associated shipping profile.
fulfillment_providerFulfillmentProviderDTORequired
The associated fulfillment provider.
The associated shipping option type.
rulesShippingOptionRuleDTO[]Required
The rules associated with the shipping option.
fulfillmentsFulfillmentDTO[]Required
The fulfillments associated with the shipping option.
created_atDateRequired
The creation date of the shipping option.
updated_atDateRequired
The update date of the shipping option.
deleted_atnull | DateRequired
The deletion date of the shipping option.
Was this section helpful?