Commercetools\Api\Models\ShippingMethod\ShippingMethodDraft Interface Reference

Inheritance diagram for Commercetools\Api\Models\ShippingMethod\ShippingMethodDraft:

Public Member Functions
	getKey ()
	getName ()
	getLocalizedName ()
	getDescription ()
	getLocalizedDescription ()
	getTaxCategory ()
	getZoneRates ()
	getIsDefault ()
	getPredicate ()
	getCustom ()
	setKey (?string $key)
	setName (?string $name)
	setLocalizedName (?LocalizedString $localizedName)
	setDescription (?string $description)
	setLocalizedDescription (?LocalizedString $localizedDescription)
	setTaxCategory (?TaxCategoryResourceIdentifier $taxCategory)
	setZoneRates (?ZoneRateDraftCollection $zoneRates)
	setIsDefault (?bool $isDefault)
	setPredicate (?string $predicate)
	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_LOCALIZED_NAME = 'localizedName'
const	FIELD_DESCRIPTION = 'description'
const	FIELD_LOCALIZED_DESCRIPTION = 'localizedDescription'
const	FIELD_TAX_CATEGORY = 'taxCategory'
const	FIELD_ZONE_RATES = 'zoneRates'
const	FIELD_IS_DEFAULT = 'isDefault'
const	FIELD_PREDICATE = 'predicate'
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 17 of file ShippingMethodDraft.php.

Member Function Documentation

getCustom()

Commercetools\Api\Models\ShippingMethod\ShippingMethodDraft::getCustom

(

)

Custom Fields for the ShippingMethod.

Returns

null|CustomFieldsDraft

Implemented in Commercetools\Api\Models\ShippingMethod\ShippingMethodDraftModel.

getDescription()

Commercetools\Api\Models\ShippingMethod\ShippingMethodDraft::getDescription

(

)

Description of the ShippingMethod.

Deprecated:

Returns

null|string

Implemented in Commercetools\Api\Models\ShippingMethod\ShippingMethodDraftModel.

getIsDefault()

Commercetools\Api\Models\ShippingMethod\ShippingMethodDraft::getIsDefault

(

)

If true the ShippingMethod will be the Project's default ShippingMethod.

Returns

null|bool

Implemented in Commercetools\Api\Models\ShippingMethod\ShippingMethodDraftModel.

getKey()

Commercetools\Api\Models\ShippingMethod\ShippingMethodDraft::getKey

(

)

User-defined unique identifier for the ShippingMethod.

Returns

null|string

Implemented in Commercetools\Api\Models\ShippingMethod\ShippingMethodDraftModel.

getLocalizedDescription()

Commercetools\Api\Models\ShippingMethod\ShippingMethodDraft::getLocalizedDescription

(

)

Localized description of the ShippingMethod.

Returns

null|LocalizedString

Implemented in Commercetools\Api\Models\ShippingMethod\ShippingMethodDraftModel.

getLocalizedName()

Commercetools\Api\Models\ShippingMethod\ShippingMethodDraft::getLocalizedName

(

)

Localized name of the ShippingMethod.

Returns

null|LocalizedString

Implemented in Commercetools\Api\Models\ShippingMethod\ShippingMethodDraftModel.

getName()

Commercetools\Api\Models\ShippingMethod\ShippingMethodDraft::getName

(

)

Unique name for the ShippingMethod within a Project.

Returns

null|string

Implemented in Commercetools\Api\Models\ShippingMethod\ShippingMethodDraftModel.

getPredicate()

Commercetools\Api\Models\ShippingMethod\ShippingMethodDraft::getPredicate

(

)

Valid Cart predicate to select a ShippingMethod for a Cart.

Returns

null|string

Implemented in Commercetools\Api\Models\ShippingMethod\ShippingMethodDraftModel.

getTaxCategory()

Commercetools\Api\Models\ShippingMethod\ShippingMethodDraft::getTaxCategory

(

)

TaxCategory for all ZoneRates of the ShippingMethod.

Returns

null|TaxCategoryResourceIdentifier

Implemented in Commercetools\Api\Models\ShippingMethod\ShippingMethodDraftModel.

getZoneRates()

Commercetools\Api\Models\ShippingMethod\ShippingMethodDraft::getZoneRates

(

)

Defines ShippingRates (prices) for specific zones.

Returns

null|ZoneRateDraftCollection

Implemented in Commercetools\Api\Models\ShippingMethod\ShippingMethodDraftModel.

setCustom()

Commercetools\Api\Models\ShippingMethod\ShippingMethodDraft::setCustom

(

?CustomFieldsDraft

$custom

)

Parameters

?CustomFieldsDraft

$custom

Implemented in Commercetools\Api\Models\ShippingMethod\ShippingMethodDraftModel.

setDescription()

Commercetools\Api\Models\ShippingMethod\ShippingMethodDraft::setDescription

(

?string

$description

)

Parameters

?string

$description

Implemented in Commercetools\Api\Models\ShippingMethod\ShippingMethodDraftModel.

setIsDefault()

Commercetools\Api\Models\ShippingMethod\ShippingMethodDraft::setIsDefault

(

?bool

$isDefault

)

Parameters

?bool

$isDefault

Implemented in Commercetools\Api\Models\ShippingMethod\ShippingMethodDraftModel.

setKey()

Commercetools\Api\Models\ShippingMethod\ShippingMethodDraft::setKey

(

?string

$key

)

Parameters

?string

$key

Implemented in Commercetools\Api\Models\ShippingMethod\ShippingMethodDraftModel.

setLocalizedDescription()

Commercetools\Api\Models\ShippingMethod\ShippingMethodDraft::setLocalizedDescription

(

?LocalizedString

$localizedDescription

)

Parameters

?LocalizedString

$localizedDescription

Implemented in Commercetools\Api\Models\ShippingMethod\ShippingMethodDraftModel.

setLocalizedName()

Commercetools\Api\Models\ShippingMethod\ShippingMethodDraft::setLocalizedName

(

?LocalizedString

$localizedName

)

Parameters

?LocalizedString

$localizedName

Implemented in Commercetools\Api\Models\ShippingMethod\ShippingMethodDraftModel.

setName()

Commercetools\Api\Models\ShippingMethod\ShippingMethodDraft::setName

(

?string

$name

)

Parameters

?string

$name

Implemented in Commercetools\Api\Models\ShippingMethod\ShippingMethodDraftModel.

setPredicate()

Commercetools\Api\Models\ShippingMethod\ShippingMethodDraft::setPredicate

(

?string

$predicate

)

Parameters

?string

$predicate

Implemented in Commercetools\Api\Models\ShippingMethod\ShippingMethodDraftModel.

setTaxCategory()

Commercetools\Api\Models\ShippingMethod\ShippingMethodDraft::setTaxCategory

(

?TaxCategoryResourceIdentifier

$taxCategory

)

Parameters

?TaxCategoryResourceIdentifier

$taxCategory

Implemented in Commercetools\Api\Models\ShippingMethod\ShippingMethodDraftModel.

setZoneRates()

Commercetools\Api\Models\ShippingMethod\ShippingMethodDraft::setZoneRates

(

?ZoneRateDraftCollection

$zoneRates

)

Parameters

?ZoneRateDraftCollection

$zoneRates

Implemented in Commercetools\Api\Models\ShippingMethod\ShippingMethodDraftModel.

Member Data Documentation

FIELD_CUSTOM

const Commercetools\Api\Models\ShippingMethod\ShippingMethodDraft::FIELD_CUSTOM = 'custom'

Definition at line 28 of file ShippingMethodDraft.php.

FIELD_DESCRIPTION

const Commercetools\Api\Models\ShippingMethod\ShippingMethodDraft::FIELD_DESCRIPTION = 'description'

Definition at line 22 of file ShippingMethodDraft.php.

FIELD_IS_DEFAULT

const Commercetools\Api\Models\ShippingMethod\ShippingMethodDraft::FIELD_IS_DEFAULT = 'isDefault'

Definition at line 26 of file ShippingMethodDraft.php.

FIELD_KEY

const Commercetools\Api\Models\ShippingMethod\ShippingMethodDraft::FIELD_KEY = 'key'

Definition at line 19 of file ShippingMethodDraft.php.

FIELD_LOCALIZED_DESCRIPTION

const Commercetools\Api\Models\ShippingMethod\ShippingMethodDraft::FIELD_LOCALIZED_DESCRIPTION = 'localizedDescription'

Definition at line 23 of file ShippingMethodDraft.php.

FIELD_LOCALIZED_NAME

const Commercetools\Api\Models\ShippingMethod\ShippingMethodDraft::FIELD_LOCALIZED_NAME = 'localizedName'

Definition at line 21 of file ShippingMethodDraft.php.

FIELD_NAME

const Commercetools\Api\Models\ShippingMethod\ShippingMethodDraft::FIELD_NAME = 'name'

Definition at line 20 of file ShippingMethodDraft.php.

FIELD_PREDICATE

const Commercetools\Api\Models\ShippingMethod\ShippingMethodDraft::FIELD_PREDICATE = 'predicate'

Definition at line 27 of file ShippingMethodDraft.php.

FIELD_TAX_CATEGORY

const Commercetools\Api\Models\ShippingMethod\ShippingMethodDraft::FIELD_TAX_CATEGORY = 'taxCategory'

Definition at line 24 of file ShippingMethodDraft.php.

FIELD_ZONE_RATES

const Commercetools\Api\Models\ShippingMethod\ShippingMethodDraft::FIELD_ZONE_RATES = 'zoneRates'

Definition at line 25 of file ShippingMethodDraft.php.

---

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

• lib/commercetools-api/src/Models/ShippingMethod/ShippingMethodDraft.php