ModelProducts module

ProductPricing

A model in the Products module, with 13 members for templates, 10 API properties and 13 members for admin templates.

Products\Models\Frontend\ProductPricing Products\Models\Api\ProductPricing Products\Models\Backend\ProductPricing Also in Products: BaseProduct Category CategoryCustomFieldValue CategoryDescription CategoryDescriptionArea CategoryDescriptionRevision CategoryElement Product ProductCustomFieldValue ProductDescription ProductDescriptionArea ProductDescriptionRevision ProductInterest ProductVariant Wishlist
View
What Smarty and Twig templates receive. Properties in REST API responses and job payloads. What admin screen templates receive when you override them.

Templates view

Properties 13

Take no arguments.

# getId()
?int
# getBasePrice()
?string
Base price of the product. The fallback price: if there is no other price or any other price cannot be applied, this base price is used. It could be 0.00 and the item with such price could be added to the cart.
# getSpecialPrice()
?string
Special price of hte product. When it is 0.00, it is ignored during adding to the cart, the *base price* is used instead.
# getRrp()
?string
# getCostPrice()
?string
# getCreated()
?DateTime
Date the record was created.
# getModified()
?DateTime
Last modification date for the record.
# getCurrency()
?Currency
# getProduct()
?BaseProduct
# isDefault()
bool
Checks if the current pricing is the default pricing of its product.
# isNewRecord() Not in API & Jobs
bool
Check if the record is a new record
# isHierarchicalModel() Not in API & Jobs
bool
Check whether a model is a hierarchical model, i.e. can have children
# isVersionedModel() Not in API & Jobs
bool
Check whether a model is versioned

API & Jobs view

API & JobsEach property is a key in REST API responses and job payloads. Its name is the template getter without get, is or has. Methods that need arguments are not available here.

Properties 10

Read-only values on the record.

# id
?int
# basePrice
?string
Base price of the product. The fallback price: if there is no other price or any other price cannot be applied, this base price is used. It could be 0.00 and the item with such price could be added to the cart.
# specialPrice
?string
Special price of hte product. When it is 0.00, it is ignored during adding to the cart, the *base price* is used instead.
# rrp
?string
# costPrice
?string
# created
?DateTime
Date the record was created.
# modified
?DateTime
Last modification date for the record.
# currency
?Currency
# product
?BaseProduct
# default
bool
Checks if the current pricing is the default pricing of its product.

Admin view

AdminAvailable in cdna-admin templates. Copy an admin template into your site repository to change how this record is edited.

Properties 13

Take no arguments.

# getId()
?int
# getBasePrice()
?string
Base price of the product. The fallback price: if there is no other price or any other price cannot be applied, this base price is used. It could be 0.00 and the item with such price could be added to the cart.
# getSpecialPrice()
?string
Special price of hte product. When it is 0.00, it is ignored during adding to the cart, the *base price* is used instead.
# getRrp()
?string
# getCostPrice()
?string
# getCreated()
?DateTime
Date the record was created.
# getModified()
?DateTime
Last modification date for the record.
# getCurrency()
?Currency
# getProduct()
?BaseProduct
# isDefault()
bool
Checks if the current pricing is the default pricing of its product.
# isNewRecord() Not in API & Jobs
bool
Check if the record is a new record
# isHierarchicalModel() Not in API & Jobs
bool
Check whether a model is a hierarchical model, i.e. can have children
# isVersionedModel() Not in API & Jobs
bool
Check whether a model is versioned