3. Adjustments¶

Adjustment object represents an adjustment to the order’s or order item’s total.

Their amount can be positive (charges - taxes, shipping fees etc.) or negative (discounts etc.).

3.1. Adjustment Basics¶

Adjustments have the following properties:

Attribute	Description	Returned value
id	Unique id of the adjustment	mixed
adjustable	Reference to Order or OrderItem	OrderInterface\|OrderItemInterface
label	Type of the adjustment (e.g. “tax””)	string
description	e.g. “Clothing Tax 9%”	string
amount	Integer amount	integer
neutral	Boolean flag of neutrality	boolean
createdAt	Date when adjustment was created	DateTime
updatedAt	Date of last change	DateTime

3.2. Neutral Adjustments¶

In some cases, you may want to use Adjustment just for displaying purposes. For example, when your order items have the tax already included in the price.

Every Adjustment instance has the neutral property, which indicates if it should be counted against object total.

<?php

use Sylius\Component\Order\Order;
use Sylius\Component\Order\OrderItem;
use Sylius\Component\Order\Adjustment;

$order = new Order();
$tshirt = new OrderItem();
$tshirt
    ->setName('Awesome T-Shirt')
    ->setUnitPrice(4999)
;

$shippingFees = new Adjustment();
$shippingFees->setAmount(1000);

$tax = new Adjustment();
$tax
    ->setAmount(1150)
    ->setLabel
    ->setNeutral(true)
;

echo $order
    ->addItem($tshirt)
    ->addAdjustment($shippingFees)
    ->addAdjustment($tax)
    ->calculateTotal()
    ->getTotal()
;

// Output will be 5999.

3.3. Negative Adjustments¶

Adjustments can also have negative amounts, which means that they will decrease the order total by certain amount. Let’s add a 5$ discount to the previous example.

<?php

use Sylius\Component\Order\Order;
use Sylius\Component\Order\OrderItem;
use Sylius\Component\Order\Adjustment;

$order = new Order();
$tshirt = new OrderItem();
$tshirt
    ->setName('Awesome T-Shirt')
    ->setUnitPrice(4999)
;

$shippingFees = new Adjustment();
$shippingFees->setAmount(1000);

$tax = new Adjustment();
$tax
    ->setAmount(1150)
    ->setLabel
    ->setNeutral(true)
;

$discount = new Adjustment();
$discount->setAmount(500);

echo $order
    ->addItem($tshirt)
    ->addAdjustment($shippingFees)
    ->addAdjustment($tax)
    ->addAdjustment($discount)
    ->calculateTotal()
    ->getTotal()
;

// Output will be 5499.