OrderItem

Inheritance diagram for OrderItem:

Description

An order item.

See also

https://shopify.dev/docs/admin-api/rest/reference/orders/order

Order::getLineItems()

DraftOrder::getLineItems()

Fulfillment::getLineItems()

Todo:

dookies

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

Public Methods
magic DiscountAllocation[]	getDiscountAllocations ()
magic int	getFulfillableQuantity ()
magic string	getFulfillmentService ()
magic string	getFulfillmentStatus ()
magic string	getGiftCard ()
magic string	getGrams ()
magic string	getId ()
magic string	getName ()
magic Funds	getPriceSet ()
magic string	getProductId ()
magic array[]	getProperties ()
	"hash" More...
magic int	getQuantity ()
magic string	getRequiresShipping ()
magic string	getSku ()
magic string	getTaxable ()
magic Tax[]	getTaxLines ()
magic string	getTitle ()
magic string	getTotalDiscount ()
magic Funds	getTotalDiscountSet ()
magic string	getVariantId ()
magic string	getVariantTitle ()
magic string	getVendor ()
magic bool	hasDiscountAllocations ()
magic bool	hasDuties ()
magic bool	hasProperties ()
magic bool	hasTaxLines ()
magic $this	setDiscountAllocations (DiscountAllocation[] $allocations)
magic $this	setFulfillableQuantity (int $qty)
magic $this	setFulfillmentService (string $service)
magic $this	setFulfillmentStatus (string $status)
magic $this	setGiftCard (string $card)
magic $this	setGrams (string $grams)
magic $this	setId (string $id)
magic $this	setName (string $name)
magic $this	setPriceSet (Funds $set)
magic $this	setProductId (string $id)
magic $this	setProperties (array[] $hash)
magic $this	setQuantity (int $qty)
magic $this	setRequiresShipping (string $shipping)
magic $this	setSku (string $sku)
magic $this	setTaxable (string $taxable)
magic $this	setTaxLines (Tax[] $lines)
magic $this	setTitle (string $title)
magic $this	setTotalDiscount (string $discount)
magic $this	setTotalDiscountSet (Funds $set)
magic $this	setVariantId (string $id)
magic $this	setVariantTitle (string $title)
magic $this	setVendor (string $vendor)
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:

= [
        'discount_allocations' => [DiscountAllocation::class],
        'price_set' => Funds::class,
        'properties' => [self::class],
        'tax_lines' => [Tax::class],
        'total_discount_set' => Funds::class
    ]

Methods

getDiscountAllocations()

magic DiscountAllocation [] getDiscountAllocations

(

)

Returns

DiscountAllocation[]

getFulfillableQuantity()

magic int getFulfillableQuantity

(

)

Returns

int

getFulfillmentService()

magic string getFulfillmentService

(

)

Returns

string

getFulfillmentStatus()

magic string getFulfillmentStatus

(

)

Returns

string

getGiftCard()

magic string getGiftCard

(

)

Returns

string

getGrams()

magic string getGrams

(

)

Returns

string

getId()

magic string getId

(

)

Returns

string

getName()

magic string getName

(

)

Returns

string

getPriceSet()

magic Funds getPriceSet

(

)

Returns

Funds

getProductId()

magic string getProductId

(

)

Returns

string

getProperties()

magic array [] getProperties

(

)

"hash"

Returns

array[]

getQuantity()

magic int getQuantity

(

)

Returns

int

getRequiresShipping()

magic string getRequiresShipping

(

)

Returns

string

getSku()

magic string getSku

(

)

Returns

string

getTaxable()

magic string getTaxable

(

)

Returns

string

getTaxLines()

magic Tax [] getTaxLines

(

)

Returns

Tax[]

getTitle()

magic string getTitle

(

)

Returns

string

getTotalDiscount()

magic string getTotalDiscount

(

)

Returns

string

getTotalDiscountSet()

magic Funds getTotalDiscountSet

(

)

Returns

Funds

getVariantId()

magic string getVariantId

(

)

Returns

string

getVariantTitle()

magic string getVariantTitle

(

)

Returns

string

getVendor()

magic string getVendor

(

)

Returns

string

hasDiscountAllocations()

magic bool hasDiscountAllocations

(

)

Returns

bool

hasDuties()

magic bool hasDuties

(

)

Returns

bool

hasProperties()

magic bool hasProperties

(

)

Returns

bool

hasTaxLines()

magic bool hasTaxLines

(

)

Returns

bool

setDiscountAllocations()

magic $this setDiscountAllocations

(

DiscountAllocation[]

$allocations

)

Returns

$this

setFulfillableQuantity()

magic $this setFulfillableQuantity

(

int

$qty

)

Returns

$this

setFulfillmentService()

magic $this setFulfillmentService

(

string

$service

)

Returns

$this

setFulfillmentStatus()

magic $this setFulfillmentStatus

(

string

$status

)

Returns

$this

setGiftCard()

magic $this setGiftCard

(

string

$card

)

Returns

$this

setGrams()

magic $this setGrams

(

string

$grams

)

Returns

$this

setId()

magic $this setId

(

string

$id

)

Returns

$this

setName()

magic $this setName

(

string

$name

)

Returns

$this

setPriceSet()

magic $this setPriceSet

(

Funds

$set

)

Returns

$this

setProductId()

magic $this setProductId

(

string

$id

)

Returns

$this

setProperties()

magic $this setProperties

(

array[]

$hash

)

Returns

$this

setQuantity()

magic $this setQuantity

(

int

$qty

)

Returns

$this

setRequiresShipping()

magic $this setRequiresShipping

(

string

$shipping

)

Returns

$this

setSku()

magic $this setSku

(

string

$sku

)

Returns

$this

setTaxable()

magic $this setTaxable

(

string

$taxable

)

Returns

$this

setTaxLines()

magic $this setTaxLines

(

Tax[]

$lines

)

Returns

$this

setTitle()

magic $this setTitle

(

string

$title

)

Returns

$this

setTotalDiscount()

magic $this setTotalDiscount

(

string

$discount

)

Returns

$this

setTotalDiscountSet()

magic $this setTotalDiscountSet

(

Funds

$set

)

Returns

$this

setVariantId()

magic $this setVariantId

(

string

$id

)

Returns

$this

setVariantTitle()

magic $this setVariantTitle

(

string

$title

)

Returns

$this

setVendor()

magic $this setVendor

(

string

$vendor

)

Returns

$this