Command: order.createStaticShippingDiscount
Creates a static discount on a delivery's native shipping charge
Body
deliveryId | uuid (optional) Deprecated: use fulfillmentId. The ID of the Delivery to set the shipping discount to |
fulfillmentId | uuid (optional) The ID of the Fulfillment to set the shipping discount to |
discountId | uuid (optional) Optional Id. Must be unique. |
isPercentage | boolean (optional) Whether the Value should be treated as a percentage. If true, Value should be a factor (e.g. 0.1 = 10%). |
value | number The value of the discount. If IsPercentage is true, this should be a factor (e.g. 0.1 = 10%). For non-percentage discounts, this will be treated as including Tax or not depending on the Order's TaxIncluded setting. |
dynamic | map of string to any value (optional) |
description | string (optional) Description/Name of discount. Should be meaningful to the customer as it's used on invoices and customer communication. |
Exactly one of.
deliveryIdandfulfillmentIdare alternatives — supply exactly one of them. Supplying both, or neither, is anINVALID_COMMANDerror.