Skip to main content
Skip to main content

CustomShippingOption

Custom Shipping Options are overridden Shipping Options. Admins can attach a Custom Shipping Option to a cart in order to set a custom price for a particular Shipping Option.

Properties

idstringRequired
The custom shipping option's ID
created_atDateRequired
The date with timezone at which the resource was created.
updated_atDateRequired
The date with timezone at which the resource was updated.
deleted_atnull | DateRequired
The date with timezone at which the resource was deleted.
pricenumberRequired
The custom price set that will override the shipping option's original price
shipping_option_idstringRequired
The ID of the Shipping Option that the custom shipping option overrides
shipping_optionShippingOptionRequired
The details of the overridden shipping options.
cart_idstringRequired
The ID of the Cart that the custom shipping option is attached to
cartCartRequired
The details of the cart this shipping option belongs to.
metadataRecord<string, unknown>Required
An optional key-value map with additional details
Was this section helpful?