ShippingMethod document (Shop API 18.3)

(supports custom properties)

Document representing a shipping method.

Property Type Constraints Description
description Localized<String>   The localized description of the shipping method.
external_shipping_method String   The external shipping method.
id String mandatory=true, maxLength=256, nullable=false The shipping method id.
name Localized<String>   The localized name of the shipping method.
price Decimal   The shipping cost total, including shipment level costs and product level fix and surcharge costs.
shipping_promotions [ShippingPromotion]   The array of active customer shipping promotions for this shipping method. This array can be empty.

Infocenter Retirement: On June 30, 2023, the Infocenter was retired, and documentation currently hosted on the Infocenter will be published to Salesforce Help, Commerce Cloud Developer Center, and Salesforce B2C Commerce Developer Documentation Resources. For more information, see the release note.

X OCAPI versions 15.x and 16.x will be retired on March 31, 2021. For dates and more information, see the OCAPI versioning and deprecation policy and this Knowledge Article.