Skip to main content

This container defines a discount profile schema for combined shipping, including rule IDs, names, and applicable weight or amount reductions.

Note: This field is not applicable for the create rule use case.

Types that use CombinedShippingRule

CalculatedShippingRuleTypeFlatShippingRuleType

Calls that use CombinedShippingRule

POST
/combined_shipping_rules/create_calculated_shipping_rules
POST
/combined_shipping_rules/create_flat_shipping_rules
GET
/combined_shipping_rules
POST
/combined_shipping_rules/update_calculated_shipping_rules
POST
/combined_shipping_rules/update_flat_shipping_rules

Fields

Field
Type
Description
combinedShippingRuleId
string
This field represents the unique identifier for the combined-shipping discount profile,

used to reference or update a specific rule configuration.
combinedShippingRuleName
string
This field specifies the unique name identifying the combined shipping discount profile within the seller’s account. This name is configured by the seller and can have a maximum of XX characters.
eachAdditionalAmount
Amount
This containter defines the additional monetary charge applied for each extra item when multiple items are shipped together.
eachAdditionalAmountOffShippingCost
Amount
This container defines the fixed discount amount deducted from the total shipping cost for each additional item.
eachAdditionalPercentOffShippingCost
number
This integer specifies the percentage discount applied to the total shipping cost for each additional item in the combined order.
mappedCombinedShippingRuleId
string
This field specifies the unique ID that links this combined-shipping rule to another related rule in the seller’s account.
weightOffTotalWeight
MeasureType
This container specifies the total weight reduction applied when combining multiple items into one shipment.