Commercetools\Api\Models\Cart\CartAddCustomLineItemAction Interface Reference

Inherits Commercetools\Api\Models\Cart\CartUpdateAction.

Inherited by Commercetools\Api\Models\Cart\CartAddCustomLineItemActionModel.

Public Member Functions
	getMoney ()
	getName ()
	getKey ()
	getQuantity ()
	getSlug ()
	getTaxCategory ()
	getExternalTaxRate ()
	getShippingDetails ()
	getCustom ()
	getPriceMode ()
	getRecurrenceInfo ()
	setMoney (?Money $money)
	setName (?LocalizedString $name)
	setKey (?string $key)
	setQuantity (?int $quantity)
	setSlug (?string $slug)
	setTaxCategory (?TaxCategoryResourceIdentifier $taxCategory)
	setExternalTaxRate (?ExternalTaxRateDraft $externalTaxRate)
	setShippingDetails (?ItemShippingDetailsDraft $shippingDetails)
	setCustom (?CustomFieldsDraft $custom)
	setPriceMode (?string $priceMode)
	setRecurrenceInfo (?CustomLineItemRecurrenceInfoDraft $recurrenceInfo)
Public Member Functions inherited from Commercetools\Api\Models\Cart\CartUpdateAction
	getAction ()
Public Member Functions inherited from Commercetools\Base\JsonObject
	get (string $field)
	with (?callable $callable=null)

Public Attributes
const	FIELD_MONEY = 'money'
const	FIELD_NAME = 'name'
const	FIELD_KEY = 'key'
const	FIELD_QUANTITY = 'quantity'
const	FIELD_SLUG = 'slug'
const	FIELD_TAX_CATEGORY = 'taxCategory'
const	FIELD_EXTERNAL_TAX_RATE = 'externalTaxRate'
const	FIELD_SHIPPING_DETAILS = 'shippingDetails'
const	FIELD_CUSTOM = 'custom'
const	FIELD_PRICE_MODE = 'priceMode'
const	FIELD_RECURRENCE_INFO = 'recurrenceInfo'
Public Attributes inherited from Commercetools\Api\Models\Cart\CartUpdateAction
const	DISCRIMINATOR_FIELD = 'action'
const	FIELD_ACTION = 'action'

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 19 of file CartAddCustomLineItemAction.php.

Member Function Documentation

getCustom()

Commercetools\Api\Models\Cart\CartAddCustomLineItemAction::getCustom

(

)

Custom Fields for the Custom Line Item.

Returns

null|CustomFieldsDraft

Implemented in Commercetools\Api\Models\Cart\CartAddCustomLineItemActionModel.

getExternalTaxRate()

Commercetools\Api\Models\Cart\CartAddCustomLineItemAction::getExternalTaxRate

(

)

An external Tax Rate can be set if the Cart has External TaxMode.

Returns

null|ExternalTaxRateDraft

Implemented in Commercetools\Api\Models\Cart\CartAddCustomLineItemActionModel.

getKey()

Commercetools\Api\Models\Cart\CartAddCustomLineItemAction::getKey

(

)

User-defined unique identifier of the Custom Line Item.

Returns

null|string

Implemented in Commercetools\Api\Models\Cart\CartAddCustomLineItemActionModel.

getMoney()

Commercetools\Api\Models\Cart\CartAddCustomLineItemAction::getMoney

(

)

Money value of the Custom Line Item. The value can be negative.

To set the money value in high precision, use HighPrecisionMoneyDraft.

Returns

null|Money

Implemented in Commercetools\Api\Models\Cart\CartAddCustomLineItemActionModel.

getName()

Commercetools\Api\Models\Cart\CartAddCustomLineItemAction::getName

(

)

Name of the Custom Line Item.

Returns

null|LocalizedString

Implemented in Commercetools\Api\Models\Cart\CartAddCustomLineItemActionModel.

getPriceMode()

Commercetools\Api\Models\Cart\CartAddCustomLineItemAction::getPriceMode

(

)

• If Standard, Cart Discounts with a matching CartDiscountCustomLineItemsTarget, MultiBuyCustomLineItemsTarget, or CartDiscountPatternTarget are applied to the Custom Line Item.
• If External, Cart Discounts are not considered on the Custom Line Item.

Returns

null|string

Implemented in Commercetools\Api\Models\Cart\CartAddCustomLineItemActionModel.

getQuantity()

Commercetools\Api\Models\Cart\CartAddCustomLineItemAction::getQuantity

(

)

Number of Custom Line Items to add to the Cart.

Returns

null|int

Implemented in Commercetools\Api\Models\Cart\CartAddCustomLineItemActionModel.

getRecurrenceInfo()

Commercetools\Api\Models\Cart\CartAddCustomLineItemAction::getRecurrenceInfo

(

)

Recurring Order and frequency data.

Returns

null|CustomLineItemRecurrenceInfoDraft

Implemented in Commercetools\Api\Models\Cart\CartAddCustomLineItemActionModel.

getShippingDetails()

Commercetools\Api\Models\Cart\CartAddCustomLineItemAction::getShippingDetails

(

)

Container for Custom Line Item-specific addresses.

Returns

null|ItemShippingDetailsDraft

Implemented in Commercetools\Api\Models\Cart\CartAddCustomLineItemActionModel.

getSlug()

Commercetools\Api\Models\Cart\CartAddCustomLineItemAction::getSlug

(

)

User-defined identifier used in a deep-link URL for the Custom Line Item. It must match the pattern [a-zA-Z0-9_-]{2,256}.

Returns

null|string

Implemented in Commercetools\Api\Models\Cart\CartAddCustomLineItemActionModel.

getTaxCategory()

Commercetools\Api\Models\Cart\CartAddCustomLineItemAction::getTaxCategory

(

)

Used to select a Tax Rate when a Cart has the Platform TaxMode.

If TaxMode is Platform, this field must not be empty.

Returns

null|TaxCategoryResourceIdentifier

Implemented in Commercetools\Api\Models\Cart\CartAddCustomLineItemActionModel.

setCustom()

Commercetools\Api\Models\Cart\CartAddCustomLineItemAction::setCustom

(

?CustomFieldsDraft

$custom

)

Parameters

?CustomFieldsDraft

$custom

Implemented in Commercetools\Api\Models\Cart\CartAddCustomLineItemActionModel.

setExternalTaxRate()

Commercetools\Api\Models\Cart\CartAddCustomLineItemAction::setExternalTaxRate

(

?ExternalTaxRateDraft

$externalTaxRate

)

Parameters

?ExternalTaxRateDraft

$externalTaxRate

Implemented in Commercetools\Api\Models\Cart\CartAddCustomLineItemActionModel.

setKey()

Commercetools\Api\Models\Cart\CartAddCustomLineItemAction::setKey

(

?string

$key

)

Parameters

?string

$key

Implemented in Commercetools\Api\Models\Cart\CartAddCustomLineItemActionModel.

setMoney()

Commercetools\Api\Models\Cart\CartAddCustomLineItemAction::setMoney

(

?Money

$money

)

Parameters

?Money

$money

Implemented in Commercetools\Api\Models\Cart\CartAddCustomLineItemActionModel.

setName()

Commercetools\Api\Models\Cart\CartAddCustomLineItemAction::setName

(

?LocalizedString

$name

)

Parameters

?LocalizedString

$name

Implemented in Commercetools\Api\Models\Cart\CartAddCustomLineItemActionModel.

setPriceMode()

Commercetools\Api\Models\Cart\CartAddCustomLineItemAction::setPriceMode

(

?string

$priceMode

)

Parameters

?string

$priceMode

Implemented in Commercetools\Api\Models\Cart\CartAddCustomLineItemActionModel.

setQuantity()

Commercetools\Api\Models\Cart\CartAddCustomLineItemAction::setQuantity

(

?int

$quantity

)

Parameters

?int

$quantity

Implemented in Commercetools\Api\Models\Cart\CartAddCustomLineItemActionModel.

setRecurrenceInfo()

Commercetools\Api\Models\Cart\CartAddCustomLineItemAction::setRecurrenceInfo

(

?CustomLineItemRecurrenceInfoDraft

$recurrenceInfo

)

Parameters

?CustomLineItemRecurrenceInfoDraft

$recurrenceInfo

Implemented in Commercetools\Api\Models\Cart\CartAddCustomLineItemActionModel.

setShippingDetails()

Commercetools\Api\Models\Cart\CartAddCustomLineItemAction::setShippingDetails

(

?ItemShippingDetailsDraft

$shippingDetails

)

Parameters

?ItemShippingDetailsDraft

$shippingDetails

Implemented in Commercetools\Api\Models\Cart\CartAddCustomLineItemActionModel.

setSlug()

Commercetools\Api\Models\Cart\CartAddCustomLineItemAction::setSlug

(

?string

$slug

)

Parameters

?string

$slug

Implemented in Commercetools\Api\Models\Cart\CartAddCustomLineItemActionModel.

setTaxCategory()

Commercetools\Api\Models\Cart\CartAddCustomLineItemAction::setTaxCategory

(

?TaxCategoryResourceIdentifier

$taxCategory

)

Parameters

?TaxCategoryResourceIdentifier

$taxCategory

Implemented in Commercetools\Api\Models\Cart\CartAddCustomLineItemActionModel.

Member Data Documentation

FIELD_CUSTOM

const Commercetools\Api\Models\Cart\CartAddCustomLineItemAction::FIELD_CUSTOM = 'custom'

Definition at line 29 of file CartAddCustomLineItemAction.php.

FIELD_EXTERNAL_TAX_RATE

const Commercetools\Api\Models\Cart\CartAddCustomLineItemAction::FIELD_EXTERNAL_TAX_RATE = 'externalTaxRate'

Definition at line 27 of file CartAddCustomLineItemAction.php.

FIELD_KEY

const Commercetools\Api\Models\Cart\CartAddCustomLineItemAction::FIELD_KEY = 'key'

Definition at line 23 of file CartAddCustomLineItemAction.php.

FIELD_MONEY

const Commercetools\Api\Models\Cart\CartAddCustomLineItemAction::FIELD_MONEY = 'money'

Definition at line 21 of file CartAddCustomLineItemAction.php.

FIELD_NAME

const Commercetools\Api\Models\Cart\CartAddCustomLineItemAction::FIELD_NAME = 'name'

Definition at line 22 of file CartAddCustomLineItemAction.php.

FIELD_PRICE_MODE

const Commercetools\Api\Models\Cart\CartAddCustomLineItemAction::FIELD_PRICE_MODE = 'priceMode'

Definition at line 30 of file CartAddCustomLineItemAction.php.

FIELD_QUANTITY

const Commercetools\Api\Models\Cart\CartAddCustomLineItemAction::FIELD_QUANTITY = 'quantity'

Definition at line 24 of file CartAddCustomLineItemAction.php.

FIELD_RECURRENCE_INFO

const Commercetools\Api\Models\Cart\CartAddCustomLineItemAction::FIELD_RECURRENCE_INFO = 'recurrenceInfo'

Definition at line 31 of file CartAddCustomLineItemAction.php.

FIELD_SHIPPING_DETAILS

const Commercetools\Api\Models\Cart\CartAddCustomLineItemAction::FIELD_SHIPPING_DETAILS = 'shippingDetails'

Definition at line 28 of file CartAddCustomLineItemAction.php.

FIELD_SLUG

const Commercetools\Api\Models\Cart\CartAddCustomLineItemAction::FIELD_SLUG = 'slug'

Definition at line 25 of file CartAddCustomLineItemAction.php.

FIELD_TAX_CATEGORY

const Commercetools\Api\Models\Cart\CartAddCustomLineItemAction::FIELD_TAX_CATEGORY = 'taxCategory'

Definition at line 26 of file CartAddCustomLineItemAction.php.

---

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

• lib/commercetools-api/src/Models/Cart/CartAddCustomLineItemAction.php