Adjustments

​

Overview

• Adjustment modifies prices on orders, line items, or shipments
• Source is where the adjustment comes from (Tax Rate or Promotion Action)
• Adjustable is what’s being adjusted (Order, LineItem, or Shipment)
• Positive amounts are charges, negative amounts are credits

​

Adjustment Types

​

Included vs Additional

• Included adjustments are part of the item’s displayed price (e.g., VAT in European stores)
• Additional adjustments are added on top of the item’s price (e.g., US sales tax)

​

Sources

​

Adjustment Attributes

​

Adjustment Lifecycle

• Open adjustments are recalculated whenever the order is updated (e.g., items added/removed, address changed)
• Closed adjustments are locked and will not be automatically recalculated
• When a promotion becomes ineligible (e.g., item removed from cart), its adjustments are automatically removed

​

Store API

const order = await client.orders.get('or_abc123', { expand: ['items', 'fulfillments'] }, {
  spreeToken: '<token>',
})

// Line item adjustments (promotions, taxes)
order.items?.forEach(item => {
  item.adjustment_total  // total adjustments on this item
  item.additional_tax_total
  item.included_tax_total
})

// Order-level totals
order.adjustment_total       // total of all adjustments
order.discount_total         // total promotional discounts
order.display_discount_total // formatted promotional discounts
order.additional_tax_total
order.included_tax_total

const order = await adminClient.orders.get('or_abc123')

curl 'https://api.mystore.com/api/v3/store/orders/or_abc123?expand=items,fulfillments' \
  -H 'X-Spree-API-Key: pk_xxx' \
  -H 'X-Spree-Token: <token>'

​

Related Documentation

• Promotions — Promotion-based adjustments
• Taxes — Tax adjustments
• Shipments — Shipping adjustments
• Orders — How adjustments affect order totals
• Calculators — How tax rate and promotion action amounts are computed