Fulfillment

Inheritance diagram for Fulfillment:

Description

A fulfillment.

See also

https://help.shopify.com/en/api/reference/shipping-and-fulfillment/fulfillment

Public Properties
const	DIR = 'fulfillments'
const	MAP
const	SHIPMENT_COMPLETE = 'delivered'
const	SHIPMENT_DELIVERING = 'out_for_delivery'
const	SHIPMENT_FAILURE = 'failure'
const	SHIPMENT_FREIGHTING = 'in_transit'
const	SHIPMENT_LABEL_PRINTED = 'label_printed'
const	SHIPMENT_LABEL_PURCHASED = 'label_purchased'
const	SHIPMENT_PICKUP = 'ready_for_pickup'
const	SHIPMENT_READY = 'confirmed'
const	SHIPMENT_UNDELIVERED = 'attempted_delivery'
const	STATUS_CANCELLED = 'cancelled'
const	STATUS_ERROR = 'error'
const	STATUS_FAILURE = 'failure'
const	STATUS_OPEN = 'open'
const	STATUS_PENDING = 'pending'
const	STATUS_SUCCESS = 'success'
const	TYPE = 'fulfillment'
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	cancel ()
$this	complete ()
magic string	getCreatedAt ()
magic OrderItem[]	getLineItems ()
magic string	getLocationId ()
magic string	getName ()
Order	getOrder ()
magic string	getOrderId ()
	injected More...
magic null Receipt	getReceipt ()
magic string	getService ()
magic string	getShipmentStatus ()
magic string	getStatus ()
magic string	getTrackingCompany ()
magic string[]	getTrackingNumbers ()
magic string[]	getTrackingUrls ()
magic string	getUpdatedAt ()
magic string	getVariantInventoryManagement ()
magic bool	isNotifyCustomer ()
OrderItem	newItem (string $orderItemId)
$this	open ()
magic $this	setNotifyCustomer (bool $notify)
magic $this	setTrackingCompany (string $company)
magic $this	setTrackingNumbers (string[] $numbers)
magic $this	setTrackingUrls (string[] $urls)
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 CreateTrait
$this	create ()

Protected Methods
	_container ()
	The container/owner object, if any. More...
Protected Methods inherited from AbstractEntity
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 CreateTrait
string	_dir ()
	The POST directory. 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=[])

Properties

MAP

const MAP

Initial value:

= [
        'line_items' => [OrderItem::class],
        'receipt' => Receipt::class
    ]

Methods

_container()

_container ( )

protected

The container/owner object, if any.

Returns

null|AbstractEntity

Reimplemented from AbstractEntity.

cancel()

$this cancel

(

)

Returns

$this

complete()

$this complete

(

)

Returns

$this

getCreatedAt()

magic string getCreatedAt

(

)

Returns

string

getLineItems()

magic OrderItem [] getLineItems

(

)

Returns

OrderItem[]

getLocationId()

magic string getLocationId

(

)

Returns

string

getName()

magic string getName

(

)

Returns

string

getOrder()

Order getOrder

(

)

Returns

Order

getOrderId()

magic string getOrderId

(

)

injected

Returns

string

getReceipt()

magic null Receipt getReceipt

(

)

Returns

null|Receipt

getService()

magic string getService

(

)

Returns

string

getShipmentStatus()

magic string getShipmentStatus

(

)

Returns

string

getStatus()

magic string getStatus

(

)

Returns

string

getTrackingCompany()

magic string getTrackingCompany

(

)

Returns

string

getTrackingNumbers()

magic string [] getTrackingNumbers

(

)

Returns

string[]

getTrackingUrls()

magic string [] getTrackingUrls

(

)

Returns

string[]

getUpdatedAt()

magic string getUpdatedAt

(

)

Returns

string

getVariantInventoryManagement()

magic string getVariantInventoryManagement

(

)

Returns

string

isNotifyCustomer()

magic bool isNotifyCustomer

(

)

Returns

bool

newItem()

OrderItem newItem

(

string

$orderItemId

)

Parameters

string

$orderItemId

Returns

OrderItem

open()

$this open

(

)

Returns

$this

setNotifyCustomer()

magic $this setNotifyCustomer

(

bool

$notify

)

Returns

$this

setTrackingCompany()

magic $this setTrackingCompany

(

string

$company

)

Returns

$this

setTrackingNumbers()

magic $this setTrackingNumbers

(

string[]

$numbers

)

Returns

$this

setTrackingUrls()

magic $this setTrackingUrls

(

string[]

$urls

)

Returns

$this