RefundItem

Inheritance diagram for RefundItem:

Description

A refunded item.

See also

https://help.shopify.com/en/api/reference/orders/refund

Public Properties
const	MAP
const	RESTOCK_CANCEL = 'cancel'
const	RESTOCK_LEGACY = 'legacy_restock'
const	RESTOCK_NONE = 'no_restock'
const	RESTOCK_RETURN = 'return'
Public Properties inherited from Data
const	MAP = []
const	PATCH = []

Public Methods
magic string	getId ()
magic null OrderItem	getLineItem ()
magic string	getLineItemId ()
magic string	getLocationId ()
magic int	getQuantity ()
magic string	getRestockType ()
magic number	getSubtotal ()
magic Funds	getSubtotalSet ()
magic number	getTotalTax ()
magic Funds	getTotalTaxSet ()
magic bool	isAlreadyStocked ()
	@when new More...
magic $this	setAlreadyStocked (bool $stocked)
	@when new More...
magic $this	setLineItemId (string $id)
	@when new More...
magic $this	setLocationId (string $id)
	@when new More...
magic $this	setQuantity (int $quantity)
	@when new More...
magic $this	setRestockType (string $type)
	@when new More...
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:

= [
        'line_item' => OrderItem::class,
        'subtotal_set' => Funds::class,
        'total_tax_set' => Funds::class
    ]

Methods

getId()

magic string getId

(

)

Returns

string

getLineItem()

magic null OrderItem getLineItem

(

)

Returns

null|OrderItem

getLineItemId()

magic string getLineItemId

(

)

Returns

string

getLocationId()

magic string getLocationId

(

)

Returns

string

getQuantity()

magic int getQuantity

(

)

Returns

int

getRestockType()

magic string getRestockType

(

)

Returns

string

getSubtotal()

magic number getSubtotal

(

)

Returns

number

getSubtotalSet()

magic Funds getSubtotalSet

(

)

Returns

Funds

getTotalTax()

magic number getTotalTax

(

)

Returns

number

getTotalTaxSet()

magic Funds getTotalTaxSet

(

)

Returns

Funds

isAlreadyStocked()

magic bool isAlreadyStocked

(

)

@when new

Returns

bool

setAlreadyStocked()

magic $this setAlreadyStocked

(

bool

$stocked

)

@when new

Returns

$this

setLineItemId()

magic $this setLineItemId

(

string

$id

)

@when new

Returns

$this

setLocationId()

magic $this setLocationId

(

string

$id

)

@when new

Returns

$this

setQuantity()

magic $this setQuantity

(

int

$quantity

)

@when new

Returns

$this

setRestockType()

magic $this setRestockType

(

string

$type

)

@when new

Returns

$this