Shop

Inheritance diagram for Shop:

Description

The shop.

Immutable:

Cannot be modified via the API.

See also

https://shopify.dev/docs/admin-api/rest/reference/store-properties/shop

Public Properties
const	TYPE = 'shop'
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
string	__toString ()
AbandonedCheckout[]	getAbandonedCheckouts (array $query=[])
int	getAbandonedCheckoutsCount ()
magic string	getAddress1 ()
magic string	getAddress2 ()
magic string	getCity ()
magic string	getCountry ()
magic string	getCountryCode ()
magic string	getCountryName ()
magic string	getCountyTaxes ()
magic string	getCreatedAt ()
magic string	getCurrency ()
magic string	getCustomerEmail ()
magic string	getDomain ()
magic string	getEmail ()
magic string	getEnabledPresentmentCurrencies ()
magic string	getGoogleAppsDomain ()
magic bool	getHasDiscounts ()
magic bool	getHasGiftCards ()
magic bool	getHasStorefront ()
magic string	getIanaTimezone ()
magic string	getLatitude ()
magic string	getLongitude ()
magic string	getMoneyFormat ()
magic string	getMoneyInEmailsFormat ()
magic string	getMoneyWithCurrencyFormat ()
magic string	getMoneyWithCurrencyInEmailsFormat ()
magic string	getMyshopifyDomain ()
magic string	getName ()
magic string	getPhone ()
magic string	getPlanDisplayName ()
magic string	getPrimaryLocale ()
magic string	getProvince ()
magic string	getProvinceCode ()
magic bool	getRequiresExtraPaymentsAgreement ()
magic string	getShopOwner ()
magic string	getSource ()
magic bool	getTaxesIncluded ()
magic bool	getTaxShipping ()
magic string	getTimezone ()
magic string	getUpdatedAt ()
magic string	getWeightUnit ()
magic string	getZip ()
magic bool	isCheckoutApiSupported ()
magic bool	isEligibleForCardReaderGiveaway ()
magic bool	isEligibleForPayments ()
magic bool	isForceSsl ()
magic bool	isGoogleAppsLoginEnabled ()
magic bool	isMultiLocationEnabled ()
magic bool	isPasswordEnabled ()
magic bool	isSetupRequired ()
Country	newCountry (string $code)
Customer	newCustomer ()
Public Methods inherited from AbstractEntity
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
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 ()

Methods

__toString()

string __toString ( )

final

Returns

string

Reimplemented from AbstractEntity.

getAbandonedCheckouts()

AbandonedCheckout [] getAbandonedCheckouts

(

array

$query = []

)

Parameters

array

$query

Returns

AbandonedCheckout[]

getAbandonedCheckoutsCount()

int getAbandonedCheckoutsCount

(

)

Returns

int

getAddress1()

magic string getAddress1

(

)

Returns

string

getAddress2()

magic string getAddress2

(

)

Returns

string

getCity()

magic string getCity

(

)

Returns

string

getCountry()

magic string getCountry

(

)

Returns

string

getCountryCode()

magic string getCountryCode

(

)

Returns

string

getCountryName()

magic string getCountryName

(

)

Returns

string

getCountyTaxes()

magic string getCountyTaxes

(

)

Returns

string

getCreatedAt()

magic string getCreatedAt

(

)

Returns

string

getCurrency()

magic string getCurrency

(

)

Returns

string

getCustomerEmail()

magic string getCustomerEmail

(

)

Returns

string

getDomain()

magic string getDomain

(

)

Returns

string

getEmail()

magic string getEmail

(

)

Returns

string

getEnabledPresentmentCurrencies()

magic string getEnabledPresentmentCurrencies

(

)

Returns

string

getGoogleAppsDomain()

magic string getGoogleAppsDomain

(

)

Returns

string

getHasDiscounts()

magic bool getHasDiscounts

(

)

Returns

bool

getHasGiftCards()

magic bool getHasGiftCards

(

)

Returns

bool

getHasStorefront()

magic bool getHasStorefront

(

)

Returns

bool

getIanaTimezone()

magic string getIanaTimezone

(

)

Returns

string

getLatitude()

magic string getLatitude

(

)

Returns

string

getLongitude()

magic string getLongitude

(

)

Returns

string

getMoneyFormat()

magic string getMoneyFormat

(

)

Returns

string

getMoneyInEmailsFormat()

magic string getMoneyInEmailsFormat

(

)

Returns

string

getMoneyWithCurrencyFormat()

magic string getMoneyWithCurrencyFormat

(

)

Returns

string

getMoneyWithCurrencyInEmailsFormat()

magic string getMoneyWithCurrencyInEmailsFormat

(

)

Returns

string

getMyshopifyDomain()

magic string getMyshopifyDomain

(

)

Returns

string

getName()

magic string getName

(

)

Returns

string

getPhone()

magic string getPhone

(

)

Returns

string

getPlanDisplayName()

magic string getPlanDisplayName

(

)

Returns

string

getPrimaryLocale()

magic string getPrimaryLocale

(

)

Returns

string

getProvince()

magic string getProvince

(

)

Returns

string

getProvinceCode()

magic string getProvinceCode

(

)

Returns

string

getRequiresExtraPaymentsAgreement()

magic bool getRequiresExtraPaymentsAgreement

(

)

Returns

bool

getShopOwner()

magic string getShopOwner

(

)

Returns

string

getSource()

magic string getSource

(

)

Returns

string

getTaxesIncluded()

magic bool getTaxesIncluded

(

)

Returns

bool

getTaxShipping()

magic bool getTaxShipping

(

)

Returns

bool

getTimezone()

magic string getTimezone

(

)

Returns

string

getUpdatedAt()

magic string getUpdatedAt

(

)

Returns

string

getWeightUnit()

magic string getWeightUnit

(

)

Returns

string

getZip()

magic string getZip

(

)

Returns

string

isCheckoutApiSupported()

magic bool isCheckoutApiSupported

(

)

Returns

bool

isEligibleForCardReaderGiveaway()

magic bool isEligibleForCardReaderGiveaway

(

)

Returns

bool

isEligibleForPayments()

magic bool isEligibleForPayments

(

)

Returns

bool

isForceSsl()

magic bool isForceSsl

(

)

Returns

bool

isGoogleAppsLoginEnabled()

magic bool isGoogleAppsLoginEnabled

(

)

Returns

bool

isMultiLocationEnabled()

magic bool isMultiLocationEnabled

(

)

Returns

bool

isPasswordEnabled()

magic bool isPasswordEnabled

(

)

Returns

bool

isSetupRequired()

magic bool isSetupRequired

(

)

Returns

bool

newCountry()

Country newCountry

(

string

$code

)

Parameters

string

$code

Returns

Country

newCustomer()

Customer newCustomer

(

)

Returns

Customer