Commercetools\Import\Models\Prices\PriceImportBuilder Class Reference

Inherits Commercetools\Base\Builder, and Commercetools\Base\Builder.

Public Member Functions
	getKey ()
	getValue ()
	getCountry ()
	getValidFrom ()
	getValidUntil ()
	getCustomerGroup ()
	getChannel ()
	getDiscounted ()
	getStaged ()
	getTiers ()
	getCustom ()
	getProductVariant ()
	getProduct ()
	withKey (?string $key)
	withValue (?TypedMoney $value)
	withCountry (?string $country)
	withValidFrom (?DateTimeImmutable $validFrom)
	withValidUntil (?DateTimeImmutable $validUntil)
	withCustomerGroup (?CustomerGroupKeyReference $customerGroup)
	withChannel (?ChannelKeyReference $channel)
	withDiscounted (?DiscountedPrice $discounted)
	withStaged (?bool $staged)
	withTiers (?PriceTierCollection $tiers)
	withCustom (?Custom $custom)
	withProductVariant (?ProductVariantKeyReference $productVariant)
	withProduct (?ProductKeyReference $product)
	withValueBuilder (?TypedMoneyBuilder $value)
	withCustomerGroupBuilder (?CustomerGroupKeyReferenceBuilder $customerGroup)
	withChannelBuilder (?ChannelKeyReferenceBuilder $channel)
	withDiscountedBuilder (?DiscountedPriceBuilder $discounted)
	withCustomBuilder (?CustomBuilder $custom)
	withProductVariantBuilder (?ProductVariantKeyReferenceBuilder $productVariant)
	withProductBuilder (?ProductKeyReferenceBuilder $product)
	build ()

Static Public Member Functions
static	of ()

Detailed Description

<PriceImport>

Definition at line 39 of file PriceImportBuilder.php.

Member Function Documentation

build()

Commercetools\Import\Models\Prices\PriceImportBuilder::build

(

)

@psalm-return T

Implements Commercetools\Base\Builder.

Definition at line 485 of file PriceImportBuilder.php.

getChannel()

Commercetools\Import\Models\Prices\PriceImportBuilder::getChannel

(

)

Maps to Price.channel. If the referenced Channel does not exist, the state of the ImportOperation will be set to unresolved until the referenced Channel is created.

Returns

null|ChannelKeyReference

Definition at line 191 of file PriceImportBuilder.php.

getCountry()

Commercetools\Import\Models\Prices\PriceImportBuilder::getCountry

(

)

Maps to Price.county.

Returns

null|string

Definition at line 147 of file PriceImportBuilder.php.

getCustom()

Commercetools\Import\Models\Prices\PriceImportBuilder::getCustom

(

)

Maps to Price.custom.

Returns

null|Custom

Definition at line 238 of file PriceImportBuilder.php.

getCustomerGroup()

Commercetools\Import\Models\Prices\PriceImportBuilder::getCustomerGroup

(

)

Maps to Price.customerGroup. If the referenced CustomerGroup does not exist, the state of the ImportOperation will be set to unresolved until the referenced CustomerGroup is created.

Returns

null|CustomerGroupKeyReference

Definition at line 180 of file PriceImportBuilder.php.

getDiscounted()

Commercetools\Import\Models\Prices\PriceImportBuilder::getDiscounted

(

)

Sets a discounted price from an external service.

Returns

null|DiscountedPrice

Definition at line 202 of file PriceImportBuilder.php.

getKey()

Commercetools\Import\Models\Prices\PriceImportBuilder::getKey

(

)

User-defined unique identifier for the Embedded Price. If a Price with this key exists on the specified productVariant, it is updated with the imported data.

Returns

null|string

Definition at line 125 of file PriceImportBuilder.php.

getProduct()

Commercetools\Import\Models\Prices\PriceImportBuilder::getProduct

(

)

The Product which contains the productVariant. If the referenced Product does not exist, the state of the ImportOperation will be set to unresolved until the referenced Product is created.

Returns

null|ProductKeyReference

Definition at line 260 of file PriceImportBuilder.php.

getProductVariant()

Commercetools\Import\Models\Prices\PriceImportBuilder::getProductVariant

(

)

The ProductVariant which contains this Embedded Price. If the referenced ProductVariant does not exist, the state of the ImportOperation will be set to unresolved until the referenced ProductVariant is created.

Returns

null|ProductVariantKeyReference

Definition at line 249 of file PriceImportBuilder.php.

getStaged()

Commercetools\Import\Models\Prices\PriceImportBuilder::getStaged

(

)

• Set to false to update both the current and staged projections of the Product with the new Price data.
• Leave empty or set to true to only update the staged projection.

Returns

null|bool

Definition at line 216 of file PriceImportBuilder.php.

getTiers()

Commercetools\Import\Models\Prices\PriceImportBuilder::getTiers

(

)

The tiered prices for this price.

Returns

null|PriceTierCollection

Definition at line 227 of file PriceImportBuilder.php.

getValidFrom()

Commercetools\Import\Models\Prices\PriceImportBuilder::getValidFrom

(

)

Maps to Price.validFrom.

Returns

null|DateTimeImmutable

Definition at line 158 of file PriceImportBuilder.php.

getValidUntil()

Commercetools\Import\Models\Prices\PriceImportBuilder::getValidUntil

(

)

Maps to Price.validUntil.

Returns

null|DateTimeImmutable

Definition at line 169 of file PriceImportBuilder.php.

getValue()

Commercetools\Import\Models\Prices\PriceImportBuilder::getValue

(

)

Maps to Price.value.

Returns

null|TypedMoney

Definition at line 136 of file PriceImportBuilder.php.

of()

static Commercetools\Import\Models\Prices\PriceImportBuilder::of ( )

static

Definition at line 504 of file PriceImportBuilder.php.

withChannel()

Commercetools\Import\Models\Prices\PriceImportBuilder::withChannel

(

?ChannelKeyReference

$channel

)

Parameters

?ChannelKeyReference

$channel

Returns

$this

Definition at line 335 of file PriceImportBuilder.php.

withChannelBuilder()

Commercetools\Import\Models\Prices\PriceImportBuilder::withChannelBuilder

(

?ChannelKeyReferenceBuilder

$channel

)

Deprecated:

use withChannel() instead

Returns

$this

Definition at line 434 of file PriceImportBuilder.php.

withCountry()

Commercetools\Import\Models\Prices\PriceImportBuilder::withCountry

(

?string

$country

)

Parameters

?string

$country

Returns

$this

Definition at line 291 of file PriceImportBuilder.php.

withCustom()

Commercetools\Import\Models\Prices\PriceImportBuilder::withCustom

(

?Custom

$custom

)

Parameters

?Custom

$custom

Returns

$this

Definition at line 379 of file PriceImportBuilder.php.

withCustomBuilder()

Commercetools\Import\Models\Prices\PriceImportBuilder::withCustomBuilder

(

?CustomBuilder

$custom

)

Deprecated:

use withCustom() instead

Returns

$this

Definition at line 456 of file PriceImportBuilder.php.

withCustomerGroup()

Commercetools\Import\Models\Prices\PriceImportBuilder::withCustomerGroup

(

?CustomerGroupKeyReference

$customerGroup

)

Parameters

?CustomerGroupKeyReference

$customerGroup

Returns

$this

Definition at line 324 of file PriceImportBuilder.php.

withCustomerGroupBuilder()

Commercetools\Import\Models\Prices\PriceImportBuilder::withCustomerGroupBuilder

(

?CustomerGroupKeyReferenceBuilder

$customerGroup

)

Deprecated:

use withCustomerGroup() instead

Returns

$this

Definition at line 423 of file PriceImportBuilder.php.

withDiscounted()

Commercetools\Import\Models\Prices\PriceImportBuilder::withDiscounted

(

?DiscountedPrice

$discounted

)

Parameters

?DiscountedPrice

$discounted

Returns

$this

Definition at line 346 of file PriceImportBuilder.php.

withDiscountedBuilder()

Commercetools\Import\Models\Prices\PriceImportBuilder::withDiscountedBuilder

(

?DiscountedPriceBuilder

$discounted

)

Deprecated:

use withDiscounted() instead

Returns

$this

Definition at line 445 of file PriceImportBuilder.php.

withKey()

Commercetools\Import\Models\Prices\PriceImportBuilder::withKey

(

?string

$key

)

Parameters

?string

$key

Returns

$this

Definition at line 269 of file PriceImportBuilder.php.

withProduct()

Commercetools\Import\Models\Prices\PriceImportBuilder::withProduct

(

?ProductKeyReference

$product

)

Parameters

?ProductKeyReference

$product

Returns

$this

Definition at line 401 of file PriceImportBuilder.php.

withProductBuilder()

Commercetools\Import\Models\Prices\PriceImportBuilder::withProductBuilder

(

?ProductKeyReferenceBuilder

$product

)

Deprecated:

use withProduct() instead

Returns

$this

Definition at line 478 of file PriceImportBuilder.php.

withProductVariant()

Commercetools\Import\Models\Prices\PriceImportBuilder::withProductVariant

(

?ProductVariantKeyReference

$productVariant

)

Parameters

?ProductVariantKeyReference

$productVariant

Returns

$this

Definition at line 390 of file PriceImportBuilder.php.

withProductVariantBuilder()

Commercetools\Import\Models\Prices\PriceImportBuilder::withProductVariantBuilder

(

?ProductVariantKeyReferenceBuilder

$productVariant

)

Deprecated:

use withProductVariant() instead

Returns

$this

Definition at line 467 of file PriceImportBuilder.php.

withStaged()

Commercetools\Import\Models\Prices\PriceImportBuilder::withStaged

(

?bool

$staged

)

Parameters

?bool

$staged

Returns

$this

Definition at line 357 of file PriceImportBuilder.php.

withTiers()

Commercetools\Import\Models\Prices\PriceImportBuilder::withTiers

(

?PriceTierCollection

$tiers

)

Parameters

?PriceTierCollection

$tiers

Returns

$this

Definition at line 368 of file PriceImportBuilder.php.

withValidFrom()

Commercetools\Import\Models\Prices\PriceImportBuilder::withValidFrom

(

?DateTimeImmutable

$validFrom

)

Parameters

?DateTimeImmutable

$validFrom

Returns

$this

Definition at line 302 of file PriceImportBuilder.php.

withValidUntil()

Commercetools\Import\Models\Prices\PriceImportBuilder::withValidUntil

(

?DateTimeImmutable

$validUntil

)

Parameters

?DateTimeImmutable

$validUntil

Returns

$this

Definition at line 313 of file PriceImportBuilder.php.

withValue()

Commercetools\Import\Models\Prices\PriceImportBuilder::withValue

(

?TypedMoney

$value

)

Parameters

?TypedMoney

$value

Returns

$this

Definition at line 280 of file PriceImportBuilder.php.

withValueBuilder()

Commercetools\Import\Models\Prices\PriceImportBuilder::withValueBuilder

(

?TypedMoneyBuilder

$value

)

Deprecated:

use withValue() instead

Returns

$this

Definition at line 412 of file PriceImportBuilder.php.

---

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

• lib/commercetools-import/src/Models/Prices/PriceImportBuilder.php