Menu
  • Get Started
  • Product
  • Resources
  • Tools & SDKs
  • Framework
  • Reference

PriceList - Pricing Module Data Models Reference

This documentation provides a reference to the PriceList data model. It belongs to the Pricing Module.

idPrimaryKeyModifier<IdProperty>
The ID of the price list.
titleTextProperty
The title of the price list.
descriptionTextProperty
The description of the price list.
statusEnumProperty<typeof PriceListStatus>
The status of the price list.
typeEnumProperty<typeof PriceListType>
The type of the price list.
pricesHasMany<Price>
The associated Price records.
price_list_rulesHasMany<PriceListRule>
The associated PriceListRule records.
starts_atDateTimePropertyOptional
The date the price list starts.
ends_atDateTimePropertyOptional
The date the price list ends.
rules_countNumberPropertyOptional
The total number of rules of the price list.
Was this page helpful?