Choosing which shipping rates are passed through

Two settings on the shipping settings resource control which of the merchant's platform rates are passed through to your channel. Both are off by default, and both depend on the merchant having fallback methods defined.

Exclude external rates

exclude_external_methods replaces the platform's rates with the merchant's fallback methods. When at least one fallback method applies to the cart, every platform rate is dropped and only the applicable fallback methods reach your channel. When no fallback method applies, because none are defined or none match the cart's destination, amount, weight, or offers, the setting has no effect and the platform's rates pass through as usual.

Use this when the merchant's platform rates should never apply to orders placed through your channel, for example when you have negotiated flat-rate shipping with the merchant and represent it as fallback methods.

exclude_external_methods only removes platform rates when a fallback method applies to the cart. If your fallback methods' conditions don't cover a destination, order amount, or weight, shoppers in that case see the platform's rates, including ones you meant to exclude. Make sure at least one fallback method covers every destination you sell to.

Exclude free shipping

exclude_external_free_shipping stops the platform's free rates (any rate priced at 0) from being passed through. Paid platform rates still pass. The setting only takes effect for merchants with at least one fallback method defined; for a merchant with none, free platform rates still pass through.

Typical use: the merchant is running a free-shipping promotion on their own platform that should not apply to orders placed through your channel.

Updating the settings

Both settings live on the shipping settings resource and support partial updates, so you can change one without touching the other:

PATCH /merchants/{merchant_id}/shipping-settings
Content-Type: application/merge-patch+json

{
  "exclude_external_free_shipping": true
}

Field definitions and the read endpoint are in Merchant Configuration Resources.

Related

• How Violet shipping works with the merchant's platform explains where these rates come from in the first place.

• Fallback shipping methods covers the methods that remain when external rates are excluded.