Commercetools\Api\Models\Store\StoreDraft Interface Reference

Inheritance diagram for Commercetools\Api\Models\Store\StoreDraft:

Public Member Functions
	getKey ()
	getName ()
	getLanguages ()
	getCountries ()
	getDistributionChannels ()
	getSupplyChannels ()
	getProductSelections ()
	getCustom ()
	setKey (?string $key)
	setName (?LocalizedString $name)
	setLanguages (?array $languages)
	setCountries (?StoreCountryCollection $countries)
	setDistributionChannels (?ChannelResourceIdentifierCollection $distributionChannels)
	setSupplyChannels (?ChannelResourceIdentifierCollection $supplyChannels)
	setProductSelections (?ProductSelectionSettingDraftCollection $productSelections)
	setCustom (?CustomFieldsDraft $custom)
Public Member Functions inherited from Commercetools\Base\JsonObject
	get (string $field)
	with (callable $callable=null)

Public Attributes
const	FIELD_KEY = 'key'
const	FIELD_NAME = 'name'
const	FIELD_LANGUAGES = 'languages'
const	FIELD_COUNTRIES = 'countries'
const	FIELD_DISTRIBUTION_CHANNELS = 'distributionChannels'
const	FIELD_SUPPLY_CHANNELS = 'supplyChannels'
const	FIELD_PRODUCT_SELECTIONS = 'productSelections'
const	FIELD_CUSTOM = 'custom'

Additional Inherited Members
Static Public Member Functions inherited from Commercetools\Base\JsonObject
static	of ($data=null)
static	fromArray (array $data=[])
static	fromStdClass (stdClass $data=null)

Detailed Description

Definition at line 18 of file StoreDraft.php.

Member Function Documentation

getCountries()

Commercetools\Api\Models\Store\StoreDraft::getCountries

(

)

Countries defined for the Store.

Returns

null|StoreCountryCollection

Implemented in Commercetools\Api\Models\Store\StoreDraftModel.

getCustom()

Commercetools\Api\Models\Store\StoreDraft::getCustom

(

)

Custom fields for the Store.

Returns

null|CustomFieldsDraft

Implemented in Commercetools\Api\Models\Store\StoreDraftModel.

getDistributionChannels()

Commercetools\Api\Models\Store\StoreDraft::getDistributionChannels

(

)

ResourceIdentifier of a Channel with ProductDistribution ChannelRoleEnum.

Returns

null|ChannelResourceIdentifierCollection

Implemented in Commercetools\Api\Models\Store\StoreDraftModel.

getKey()

Commercetools\Api\Models\Store\StoreDraft::getKey

(

)

User-defined unique and immutable identifier for the Store. Keys can only contain alphanumeric characters, underscores, and hyphens.

Returns

null|string

Implemented in Commercetools\Api\Models\Store\StoreDraftModel.

getLanguages()

Commercetools\Api\Models\Store\StoreDraft::getLanguages

(

)

Languages defined in Project. Only languages defined in the Project can be used.

Returns

null|array

Implemented in Commercetools\Api\Models\Store\StoreDraftModel.

getName()

Commercetools\Api\Models\Store\StoreDraft::getName

(

)

Name of the Store.

Returns

null|LocalizedString

Implemented in Commercetools\Api\Models\Store\StoreDraftModel.

getProductSelections()

Commercetools\Api\Models\Store\StoreDraft::getProductSelections

(

)

Controls availability of Products for this Store via active/inactive Product Selections:

• Leave empty if all Products in the Project should be available in this Store.
• If only inactive Product Selections with IndividualExclusion ProductSelectionMode are provided, all the Products are available in this Store.
• If all the Product Selections provided are inactive and there's at least a Product Selection of mode Individual, no Product is available in this Store.
• If at least an active Product Selection is provided, only active Product Selections are considered to compute the availability in this Store.

Returns

null|ProductSelectionSettingDraftCollection

Implemented in Commercetools\Api\Models\Store\StoreDraftModel.

getSupplyChannels()

Commercetools\Api\Models\Store\StoreDraft::getSupplyChannels

(

)

ResourceIdentifier of a Channel with InventorySupply ChannelRoleEnum.

Returns

null|ChannelResourceIdentifierCollection

Implemented in Commercetools\Api\Models\Store\StoreDraftModel.

setCountries()

Commercetools\Api\Models\Store\StoreDraft::setCountries

(

?StoreCountryCollection

$countries

)

Parameters

?StoreCountryCollection

$countries

Implemented in Commercetools\Api\Models\Store\StoreDraftModel.

setCustom()

Commercetools\Api\Models\Store\StoreDraft::setCustom

(

?CustomFieldsDraft

$custom

)

Parameters

?CustomFieldsDraft

$custom

Implemented in Commercetools\Api\Models\Store\StoreDraftModel.

setDistributionChannels()

Commercetools\Api\Models\Store\StoreDraft::setDistributionChannels

(

?ChannelResourceIdentifierCollection

$distributionChannels

)

Parameters

?ChannelResourceIdentifierCollection

$distributionChannels

Implemented in Commercetools\Api\Models\Store\StoreDraftModel.

setKey()

Commercetools\Api\Models\Store\StoreDraft::setKey

(

?string

$key

)

Parameters

?string

$key

Implemented in Commercetools\Api\Models\Store\StoreDraftModel.

setLanguages()

Commercetools\Api\Models\Store\StoreDraft::setLanguages

(

?array

$languages

)

Parameters

?array

$languages

Implemented in Commercetools\Api\Models\Store\StoreDraftModel.

setName()

Commercetools\Api\Models\Store\StoreDraft::setName

(

?LocalizedString

$name

)

Parameters

?LocalizedString

$name

Implemented in Commercetools\Api\Models\Store\StoreDraftModel.

setProductSelections()

Commercetools\Api\Models\Store\StoreDraft::setProductSelections

(

?ProductSelectionSettingDraftCollection

$productSelections

)

Parameters

?ProductSelectionSettingDraftCollection

$productSelections

Implemented in Commercetools\Api\Models\Store\StoreDraftModel.

setSupplyChannels()

Commercetools\Api\Models\Store\StoreDraft::setSupplyChannels

(

?ChannelResourceIdentifierCollection

$supplyChannels

)

Parameters

?ChannelResourceIdentifierCollection

$supplyChannels

Implemented in Commercetools\Api\Models\Store\StoreDraftModel.

Member Data Documentation

FIELD_COUNTRIES

const Commercetools\Api\Models\Store\StoreDraft::FIELD_COUNTRIES = 'countries'

Definition at line 23 of file StoreDraft.php.

FIELD_CUSTOM

const Commercetools\Api\Models\Store\StoreDraft::FIELD_CUSTOM = 'custom'

Definition at line 27 of file StoreDraft.php.

FIELD_DISTRIBUTION_CHANNELS

const Commercetools\Api\Models\Store\StoreDraft::FIELD_DISTRIBUTION_CHANNELS = 'distributionChannels'

Definition at line 24 of file StoreDraft.php.

FIELD_KEY

const Commercetools\Api\Models\Store\StoreDraft::FIELD_KEY = 'key'

Definition at line 20 of file StoreDraft.php.

FIELD_LANGUAGES

const Commercetools\Api\Models\Store\StoreDraft::FIELD_LANGUAGES = 'languages'

Definition at line 22 of file StoreDraft.php.

FIELD_NAME

const Commercetools\Api\Models\Store\StoreDraft::FIELD_NAME = 'name'

Definition at line 21 of file StoreDraft.php.

FIELD_PRODUCT_SELECTIONS

const Commercetools\Api\Models\Store\StoreDraft::FIELD_PRODUCT_SELECTIONS = 'productSelections'

Definition at line 26 of file StoreDraft.php.

FIELD_SUPPLY_CHANNELS

const Commercetools\Api\Models\Store\StoreDraft::FIELD_SUPPLY_CHANNELS = 'supplyChannels'

Definition at line 25 of file StoreDraft.php.

---

The documentation for this interface was generated from the following file:

• lib/commercetools-api/src/Models/Store/StoreDraft.php