Inheritance diagram for DraftOrder:

Description

A draft order.

See also: https://shopify.dev/docs/admin-api/rest/reference/orders/draftorder

Public Properties
const	DIR = 'draft_orders'

const	MAP

const	SEARCH_STATUS_COMPLETE = 'completed'

const	SEARCH_STATUS_INVOICED = 'invoice_sent'

const	SEARCH_STATUS_OPEN = 'open'

const	STATUS_COMPLETE = 'completed'

const	STATUS_INVOICED = 'invoice_sent'

const	STATUS_OPEN = 'open'

const	TYPE = 'draft_order'

Public Properties inherited from AbstractOrder
const	MAP

Public Properties inherited from AbstractEntity
const	DIR = ''
	All subclasses must redeclare this to match their REST directory (without container). More...

const	TYPE = ''
	All subclasses must redeclare this to match their types. More...

Public Properties inherited from Data
const	MAP = []

const	PATCH = []

Public Methods
$this	complete (bool $paymentPending=false)

magic null Discount	getAppliedDiscount ()

magic string	getCompletedAt ()

magic string	getCustomerId ()
	injected More...

magic string	getInvoiceSentAt ()

magic string	getInvoiceUrl ()

magic string	getOrderId ()

magic null Shipping	getShippingLine ()

magic string	getStatus ()

magic bool	isTaxExempt ()

$this	sendInvoice (Invoice $invoice=null)

magic $this	setInvoiceSentAt (string $iso8601)

magic $this	setLineItems (OrderItem[] $items)

magic $this	setShippingLine (?Shipping $shipping)

magic $this	setTaxExempt (bool $exempt)

magic $this	setUseCustomerDefaultAddress (bool $flag)

Public Methods inherited from AbstractOrder
magic null Address	getBillingAddress ()

magic string	getCreatedAt ()

magic string	getCurrency ()

magic null Customer	getCustomer ()

magic string	getEmail ()

magic OrderItem[]	getLineItems ()

magic string	getName ()

magic string	getNote ()

magic array[]	getNoteAttributes ()
	name-value "hash" More...

magic null Address	getShippingAddress ()

magic string	getSubtotalPrice ()

magic string	getTags ()

magic Tax[]	getTaxLines ()

magic string	getTotalPrice ()

magic string	getTotalTax ()

magic string	getUpdatedAt ()

magic bool	hasTaxesIncluded ()

magic $this	setBillingAddress (?Address $address)

magic $this	setCurrency (string $iso4217)

magic $this	setCustomer (?Customer $customer)

magic $this	setEmail (string $email)

magic $this	setName (string $name)

magic $this	setNote (string $note)

magic $this	setNoteAttributes (array[] $hash)

magic $this	setShippingAddress (?Address $address)

magic $this	setSubtotalPrice (string $price)

magic $this	setTags (string $csv)

magic $this	setTaxesIncluded (bool $included)

magic $this	setTaxLines (Tax[] $taxes)

magic $this	setTotalPrice (string $price)

magic $this	setTotalTax (string $amount)

Public Methods inherited from AbstractEntity
string	__toString ()

null string	getId ()

string[]	getPoolKeys ()

bool	hasId ()

$this	reload ()
	Fully reloads the entity from Shopify. 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)

Public Methods inherited from MetafieldTrait
Metafield[]	getMetafields ()

Metafield	newMetafield ()
	Factory. More...

Additional Inherited Members
Protected Properties inherited from Data
Api	$api

Pool	$pool

Public Static Methods inherited from AbstractEntity
static null self	load ($caller, string $id, array $query=[])

static self[]	loadAll ($caller, string $path, array $query=[])

Protected Methods inherited from AbstractEntity
null AbstractEntity	_container ()
	The container/owner object, if any. More...

mixed	_get (string $field)
	Lazy-loads missing fields. More...

void	_onDelete ()

void	_onSave ()

void	_reload (string $field)

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...

Protected Methods inherited from MetafieldTrait
string	_metafieldType ()

Properties

◆ MAP

const MAP

Initial value:

= parent::MAP + [
        'applied_discount' => Discount::class,
        'discount' => Discount::class,
        'shipping_line' => Shipping::class,
    ]

Methods

◆ complete()

$this complete ( bool $paymentPending = false )

Parameters

bool $paymentPending

Returns: $this

◆ getAppliedDiscount()

magic null Discount getAppliedDiscount ( )

Returns: null|Discount

◆ getCompletedAt()

magic string getCompletedAt ( )

Returns: string

◆ getCustomerId()

magic string getCustomerId ( )

injected

Returns: string

◆ getInvoiceSentAt()

magic string getInvoiceSentAt ( )

Returns: string

◆ getInvoiceUrl()

magic string getInvoiceUrl ( )

Returns: string

◆ getOrderId()

magic string getOrderId ( )

Returns: string

◆ getShippingLine()

magic null Shipping getShippingLine ( )

Returns: null|Shipping

◆ getStatus()

magic string getStatus ( )

Returns: string

◆ isTaxExempt()

magic bool isTaxExempt ( )

Returns: bool

◆ sendInvoice()

$this sendInvoice ( Invoice $invoice = null )

Parameters

Invoice | null $invoice

Returns: $this

◆ setInvoiceSentAt()

magic $this setInvoiceSentAt ( string $iso8601 )

Returns: $this

◆ setLineItems()

magic $this setLineItems ( OrderItem[] $items )

Returns: $this

◆ setShippingLine()

magic $this setShippingLine ( ?Shipping $shipping )

Returns: $this

◆ setTaxExempt()

magic $this setTaxExempt ( bool $exempt )

Returns: $this

◆ setUseCustomerDefaultAddress()

magic $this setUseCustomerDefaultAddress ( bool $flag )

Depends:: create-only

Returns: $this