Boolean
Add landed costs (duties and import fees) to this method’s price, overriding the experience-level setting.
Dynamic methods only. The carrier services to quote live rates from. Required unless
serviceLevel is set.Redo coverage bundled into this shipping method.
String!
required
Shopper-facing description shown next to the method at checkout. Like
name, it may contain customer-name template variables.Dynamic methods only. Carriers excluded from this method’s candidate set.
String
Shopper-facing description used in place of
description under the same condition as fallbackName.String
Shopper-facing name used in place of
name when name contains customer-name template variables and the shopper’s name is not available at quote time. Ignored when name has no variables.Int
Dynamic methods only. Days Redo assumes an order takes to ship when it estimates delivery dates for this method, overriding the experience’s
fulfillmentDelayDaysOverride. Omit it to use the experience’s value. A whole number of days, zero or more.Dynamic methods only. Markup applied to every live carrier rate on this method.
String!
required
Shopper-facing name of the shipping method as it appears at checkout, e.g. ‘Standard’. May contain customer-name template variables — ‘{customer_name}’, ‘{customer_name:first}’, ‘{customer_name:last}’ — which are substituted per shopper. Send them back verbatim when you are not deliberately changing them, or you will silently strip the merchant’s personalization.
[String!]
Tags applied to the order when this method is bought.
Dynamic methods only. Hard clamp applied after markup and rounding.
Bounds the final price this method may be sold at, after every other pricing rule has run. Omit to leave the method’s existing constraint untouched; send one to replace it outright. There is no way to clear a constraint through this API.
Dynamic methods only. Which of the eligible live rates to show the shopper. Values are CHEAPEST, FASTEST, and CUSTOM.
Fixed methods only, and required for them. One entry per price. A single entry with no
conditions is a flat price; multiple entries express weight or cart-value ranges and free-shipping thresholds.Dynamic methods only. How to round the marked-up price before showing it.
String
Identifier the storefront platform uses for this shipping option at checkout.
Dynamic methods only. Quote the cheapest carrier service delivering within this service level’s window instead of pinning carrier services.
required
How the price is produced. FIXED is a merchant-set price served by Redo with no carrier involved and requires
rates. DYNAMIC quotes live carrier rates through Redo and requires either carrierServices or serviceLevel. Custom (script-priced) methods cannot be created or edited here.