Skip to main content
POST
Apply manual discount (admin only)

Authorizations

Authorization
string
header
required

Bearer token authentication

Path Parameters

cart_token
string
required

Cart token

Body

application/json
reason
string
required

Explanation for the manual discount (required)

Example:

"VIP customer courtesy"

price_discount_type
enum<string>
required

Discount type

Available options:
flat,
percentage
Example:

"flat"

flat_value
number<float>

Dollar amount (required when price_discount_type is flat)

Example:

10

percentage_value
number<float>

Percentage 0-100 (required when price_discount_type is percentage)

Example:

15

applicable_for
enum<string>

Product targeting scope

Available options:
everything,
specific_products,
specific_collections,
except_specific_products
apply_to_subscriptions
boolean
default:false

Whether the discount applies to subscription line items in the current cart

apply_to_recurring_subscription_orders
boolean

Whether the discount carries forward to recurring orders spawned from the cart. Requires apply_to_subscriptions to be true. When omitted, defaults to the value of apply_to_subscriptions.

apply_to_volume
boolean
default:false

Whether the discount reduces QV/CV totals

Response

Discount created and applied

Cart response wrapper (CartBlueprinter with_associations view). Scalar totals, flags, and points are strictly typed; genuinely dynamic fields (metadata, processor-specific payment payloads) and nested associations (items, addresses, country, company) are typed as open pockets and tightened in follow-up work.

cart
object
required
meta
object
required