Adjustment
+ Inheritance diagram for Adjustment:

Description

A refund adjustment.

See also
https://help.shopify.com/en/api/reference/orders/refund
Immutable:
Each instance has a permanent state.

Public Properties

const MAP
 
- Public Properties inherited from Data
const MAP = []
 
const PATCH = []
 

Public Methods

magic string getAmount ()
 
magic Funds getAmountSet ()
 
magic string getId ()
 
magic string getKind ()
 
magic string getOrderId ()
 
magic string getReason ()
 
magic string getRefundId ()
 
magic string getTaxAmount ()
 
magic Funds getTaxAmountSet ()
 
- Public Methods inherited from Data
mixed __call (string $method, array $args)
 
 __construct ($caller, array $data=[])
 
string serialize ()
 Dehydrated JSON encode. More...
 
array toArray ()
 
void unserialize ($serialized)
 

Additional Inherited Members

- Protected Properties inherited from Data
Api $api
 
Pool $pool
 
- Protected Methods inherited from Data
mixed _hydrate (string $class, $item)
 A factory that also hydrates / caches entities. More...
 
array _select ($subject, callable $filter,... $args)
 Magic method: selectField(callable $filter) More...
 
$this _setData (array $data)
 Clears all diffs and sets all data, hydrating mapped fields. More...
 
$this _setField (string $field, $value)
 Sets a value, hydrating if mapped, and clears the diff. More...
 

Properties

◆ MAP

const MAP
Initial value:
= [
'amount_set' => Funds::class,
'tax_amount_set' => Funds::class
]

Methods

◆ getAmount()

magic string getAmount ( )
Returns
string

◆ getAmountSet()

magic Funds getAmountSet ( )
Returns
Funds

◆ getId()

magic string getId ( )
Returns
string

◆ getKind()

magic string getKind ( )
Returns
string

◆ getOrderId()

magic string getOrderId ( )
Returns
string

◆ getReason()

magic string getReason ( )
Returns
string

◆ getRefundId()

magic string getRefundId ( )
Returns
string

◆ getTaxAmount()

magic string getTaxAmount ( )
Returns
string

◆ getTaxAmountSet()

magic Funds getTaxAmountSet ( )
Returns
Funds