Customer Documentation Portal
  • Docs

›Data Model

Getting Started

  • Welcome
  • Environments
  • Onboarding

Documentation

  • Introduction
  • Data Organisation
  • Authentication
  • Query Language
  • Data Model

    • Data Model
    • Entities
    • Price
    • Price Request
    • Product
    • Product Group
    • Reference
    • Site
    • Survey History
    • Volume
  • Import Endpoints

Tutorials

  • Welcome
  • Excel
  • Authenticating

Price Entities

Overview

The Price collection consists of all of the different types of prices that are generated or imported into the kalibrate pricing system.


Price Data Model

The following data model shows the Price entity and it's relational links. For the full model, see Data Model.


Data Model


Competitor Price

NameDescription
Entity DescriptionDetails related to a customer's competitor's prices
Source Schemadbo
Source TablePNCompetitorPrice
Destination Collection(Endpoint)Price
Entity TypePrice
Entity VariantCompetitor

Competitor Price Attribute Details

FieldReference EntityField DescriptionFormatMax Bytes
CheckedForPGEvaluated to determine if price generation occurredbit1
ProductProductunique identifier assigned to a product of a specific competitor (usually a long string of numbers)uniqueidentifier16
PriceIDUnique identifier assigned to a price for a product of a specific competitor (usually a number)int4
StatusIDPriceStatusunique identifier for status of specific competitor price mapped to own siteint4
DataChannelIDDataChannelUnique identifier assigned to a specific data channels to transport data to and from Kalibrateint4
EffectiveTimeCompetitor Price effective timedatetime8
OriginThe source identified in the market share report(ex. PNWeb, Kmobile, OPIS)nvarchar100
OriginalEffectiveTimePre price ammendament effective timedatetime8
SiteSiteUnique identifier for an Own Site location (used in mapping; usually long string of numbers)uniqueidentifier16
PriceCompetitor Price Valuemoney8
SourceThe source identified in the market share reportsource40
UserUsername of the user that entered a competitor price surveynvarchar100

Cost Price

NameDescription
Entity DescriptionDetails related to cost prices
Source Schemadbo
Source TablePNCostPrice
Destination Collection(Endpoint)Price
Entity TypePrice
Entity VariantCost

Cost Price Attribute Details

FieldReference EntityField DescriptionFormatMax Bytes
CheckedForPGEvaluated to determine if price generation occurredbit1
ProductProductUnique identifier for an Own Site product (used in mapping; usually long string of numbers)uniqueidentifier16
PriceIDUnique identifier specific to cost price assigned to a productint4
EffectiveTimeCost Price Effective Timedatetime8
PriceValue assigned to either own site price competitor price cost type cost value dealer price DTA pricemoney8
SourceThe source identified in the market share report.source40

Dealer Price

NameDescription
Entity DescriptionDetails related to dealer prices
Source Schemadbo
Source TablePNDealerPrice
Destination Collection(Endpoint)Price
Entity TypePrice
Entity VariantDTA

Dealer Price Attribute Details

FieldReference EntityField DescriptionFormatMax Bytes
DealerPriceIDunique identifier specifying price for a dealer site received from the Dealer Trade Areaint4
DealerSiteRelationDealerSiteRelationUnique Identifier for the Own Site/Dealer Site Relationuniqueidentifier16
ProductIDProductUnique identifier for an Own Site product (used in mapping; usually a number)int4
DealerMarginmargin share achieved for the dealer by the DTW price.decimal9
TVAAdjustmentValue is used in dealer pricing to adjust a dealer trade area level price at individual dealer sites.decimal9

Dealer Trade Area Price

NameDescription
Entity DescriptionDetails related to Dealer Trade Area prices
Source Schemadbo
Source TablePNDTAPrice
Destination Collection(Endpoint)Price
Entity TypePrice
Entity VariantDTA

Dealer Trade Area Price Attribute Details

FieldReference EntityField DescriptionFormatMax Bytes
DTAPriceIDUnique identifier for a price value assigned to a specific Dealer Trade Area (DTA)int4
OwnProductIDProductUnique identifier for an Own Site product (used in mapping; usually a number)int4
BaseCostPriceThe product cost configured by a formula for each product in a Dealer trade area.costprice9
AdditionalCostPriceValue assigned to the cost that is added to the Net DTW in order to make the Gross DTWcostprice9
CompanyMarginmargin share achieved for the company by the DTW price.decimal9
DealerMarginmargin share achieved for the dealer by the DTW price.decimal9
GrossDTWPriceCalculated as the NET DTW plus any additional costs such as local taxes or delivery costs.money8
NetDTWPriceThe price at which an independent dealer buys fuel from your company in order to sell on to the public. Calculated from the product cost (the base cost) and the margin that you want to make (the company margin).money8
NotionalStreetPriceA benchmark retail price used in dealer pricing to represent the typical street price in a dealer trade area.money8

Notional Street Price

NameDescription
Entity DescriptionDetails related to Notional Street prices
Source Schemadbo
Source TablePNNotionalStreetPrice
Destination Collection(Endpoint)Price
Entity TypePrice
Entity VariantNotionalStreet

Notional Street Price Attribute Details

FieldReference EntityField DescriptionFormatMax Bytes
NotionalStreetPriceIDUnique identifier assigned to a specific Notional Street Price calculated for the representative dealer trade area.int4
OwnProductUIDProductUnique identifier for an Own Site product (used in mapping; usually long string of numbers)uniqueidentifier16
PriceValue assigned to either own site price competitor price cost type cost value dealer price DTA pricemoney8
EffectiveTimeNotinal Street Price Effective Timedatetime8

OPIS Competitor Price

NameDescription
Entity DescriptionDetails related to a customer's competitor's prices source via OPIS
Source Schemadbo
Source TablePNOPISCompetitorPrice
Destination Collection(Endpoint)Price
Entity TypePrice
Entity VariantOPISCompetitor

OPIS Competitor Price Attribute Details

FieldReference EntityField DescriptionFormatMax Bytes
ProductProductunique identifier assigned to a product of a specific competitor (usually a long string of numbers)uniqueidentifier16
CopiedToHistoryModel item moved to History (such as cost price delivery volume plan data etc)bit1
PriceIDUnique identifier for OPIS competitor price; used in mapping.int4
EffectiveTimeEffective Time of OPIS Competitor Pricedatetime8
SiteSiteUnique identifier for an Own Site location (used in mapping; usually long string of numbers)uniqueidentifier16
PriceValue assigned to either own site price competitor price cost type cost value dealer price DTA pricemoney8
SourceThe source identified in the market share report.source40

OPIS Own Price

NameDescription
Entity DescriptionDetails related to a customer's own prices via OPIS feed
Source Schemadbo
Source TablePNOpisOwnPrice
Destination Collection(Endpoint)Price
Entity TypePrice
Entity VariantOPISOwn

OPIS Own Price Attribute Details

FieldReference EntityField DescriptionFormatMax Bytes
ProductProductUnique identifier for an Own Site product (used in mapping; usually long string of numbers)uniqueidentifier16
CopiedToHistoryModel item moved to History (such as cost price delivery volume plan data etc)bit1
PriceIDUnique identifier for OPIS own price for specific own siteint4
EffectiveTimeTime OPIS Own Price is Effectivedatetime8
PriceValue assigned to either own site price competitor price cost type cost value dealer price DTA pricemoney8
SourceThe source identified in the market share report.source40

Own Price

NameDescription
Entity DescriptionDetails related to a customer's own prices
Source Schemadbo
Source TablePNOwnPrice
Destination Collection(Endpoint)Price
Entity TypePrice
Entity VariantOwn

Own Price Attribute Details

FieldReference EntityField DescriptionFormatMax Bytes
ProductProductUnique identifier for an Own Site product (used in mapping; usually long string of numbers)uniqueidentifier16
PriceIDUnique identifier for an Own Site price (used in mapping; usually a number)int4
EffectiveTimeTime price was effectivedatetime8
OriginSource of price (CSV,XML or Survey Username)nvarchar100
OriginalEffectiveTimePre-Price Ammendment effective timedatetime8
PriceValue assigned to either own site price competitor price cost type cost value dealer price DTA pricemoney8
SourceThe source identified in the market share report(ex. PNWeb, Kmobile, OPIS)source40

Price Differentials

NameDescription
Entity DescriptionDetails related to proposed prices
Source Schemadbo
Source TablePNPriceDifferential
Destination Collection(Endpoint)Price
Entity TypePricedifferential
Entity VariantCommon

Price Differentials Attribute Details

FieldReference EntityField DescriptionFormatMax Bytes
OwnProductOwnproductUIDUnique identifier for the Own Proudct to which a price differential is applieduniqueidentifier16
diffOwnProductOwnproductUIDUnique Identifier for the Own Product used as the differential contraining productunique identifier16
diffCompetitorProductCompetitorproductUIDUnique Identifier for the Competitor Product used as the differential contraining productunique identifier16
undercutMinimum differential value used in rulemoney8
overrcutMaximum differential value used in rulemoney8
activeTrue or False value inidcating rule active/inactive statusbit1
typeBoolvalue indicating type of differential rule. Valid options are 1 and 2tinyint1

Proposed Price

NameDescription
Entity DescriptionDetails related to proposed prices
Source Schemadbo
Source TablePNProposedPrice
Destination Collection(Endpoint)Price
Entity TypePrice
Entity VariantProposed

Proposed Price Attribute Details

FieldReference EntityField DescriptionFormatMax Bytes
AutoImplementFailAuto Implementation rule failure based on product product group pricing settings. Moved to SFR.bit1
BattledRefers to when two sets of prices for the same product group become ready for export and are compared based on a set of rules where one is exported and one is cancelledbit1
OwnProductUIDProductUnique identifier for an Own Site product (used in mapping; usually long string of numbers)uniqueidentifier16
DealerRetailPriceRetail price set by dealer (not supplied by or delivered by client)money8
EffectiveTimeEffective time of proposed pricedatetime8
ExportedTimeTime at which the latest price was sent to the sitedatetime8
ExportIDUnique identifier for price export for product product group or siteint8
ExportTimeTime the price was sent to userdatetime8
ExportTimeDelayedamount of time added to initial export timebit1
InitialPriceInital Proposed Pricemoney8
PostProcessedTimeTime price was posteddatetime8
PriceValue assigned to either own site price competitor price cost type cost value dealer price DTA pricemoney8
PriceRequestPriceRequestUnique identifier for Price Request assigned to product product group or site (sql-long string of numbers)uniqueidentifier16
RuleUIDRuleUnique identifier for pricing rule assigned to product product group or site (sql-long string of numbers)uniqueidentifier16
SequenceIDSequential indicatorint4
Status.AmendedPrice request price export status ; price was adjustedbit1
Status.AppliedPrice request price export status ; price was appliedbit1
Status.ExportApprovedPrice request price export status ; price export was approvedtinyint1
Status.ExportedPrice request price export status ; price was exportedbit1
Status.GPCReviewPrice request price export status ; GPC price was sent to SFR for Reviewbit1
Status.ReadyToExportPrice request price export status ; price is waiting for exportbit1
Status.RejectedPrice request price export status ; price was rejectedbit1
Status.SFRPrice request price export status ; price was sent to SFRbit1
Status.SupersededPrice request price export status ; price was overwrittenbit1

SOE Price

NameDescription
Entity DescriptionDetails related to SOE prices
Source Schemadbo
Source TablePNSOEPrice
Destination Collection(Endpoint)Price
Entity TypePrice
Entity VariantSOE

SOE Price Attribute Details

FieldReference EntityField DescriptionFormatMax Bytes
EffectiveTimeSOE Price Effective Timedatetime8
NotionalStreetPriceIDUnique identifier assigned to a specific Notional Street Price calculated for the representative dealer trade area.int4
ProductProductUnique identifier for an Own Site product (used in mapping; usually long string of numbers)uniqueidentifier16
PriceValue assigned to either own site price competitor price cost type cost value dealer price DTA pricemoney8

← EntitiesPrice Request →
  • Overview
    • Price Data Model
  • Competitor Price
    • Competitor Price Attribute Details
  • Cost Price
    • Cost Price Attribute Details
  • Dealer Price
    • Dealer Price Attribute Details
  • Dealer Trade Area Price
    • Dealer Trade Area Price Attribute Details
  • Notional Street Price
    • Notional Street Price Attribute Details
  • OPIS Competitor Price
    • OPIS Competitor Price Attribute Details
  • OPIS Own Price
    • OPIS Own Price Attribute Details
  • Own Price
    • Own Price Attribute Details
  • Price Differentials
    • Price Differentials Attribute Details
  • Proposed Price
    • Proposed Price Attribute Details
  • SOE Price
    • SOE Price Attribute Details
Copyright © 2025 Kalibrate Technologies Limited