Skip to main content

Offers

ai_core.entities.OfferEntity lists the columns every OEM's consolidated offers asset must have. One row is one offer on one model.

Every offer applies to a model. model_id is a required column. Each OEM's consolidated config resolves it through a models foreign key on its own model key fields, as consolidated inventory does. An offer whose model key matches no consolidated model has a null model_id. The unresolved_refs check counts each such offer. The model key fields stay as columns, because they are part of the offer's key_fields.

Where an OEM's feed lists several models for one offer, or publishes an offer for every model of a brand, the OEM's transformed component writes one row per model. Each row of a brand offer has scope set to brand.

Schema​

FieldNull allowedMeaning
offer_codenoThe OEM's identifier for the offer. Where the feed publishes none, the OEM's component builds one that is stable for the offer's lifetime
offer_typeyesThe transaction the offer applies to: lease, finance or cash. Null when the feed does not say
discount_typenoThe form of the offer's discount. One of amount, percent_off_msrp, rate (a special APR) or payment (a lease or finance payment offer)
scopenobrand means the OEM published the offer for every model of a brand. model means every vehicle of the model gets the offer. targeted means only part of the model's stock gets it. insufficient means too few of the model's vehicles were seen to tell which applies
model_idnoThe model the offer applies to. A null is a model key that matched no model, which the unresolved_refs check reports
valid_fromnoWhen the offer started. Where the feed publishes no start date, the OEM's consolidated config derives it from the source group's <group>_first_seen in derived_fields
valid_tonoWhen the offer ends
brandyesThe brand the offer belongs to
nameyesThe OEM's name for the offer
amountyesDollars off
percent_off_msrpyesPercent below MSRP
apryesAnnual percentage rate
term_monthsyesFinance or lease term
monthly_paymentyesLease or finance payment
due_at_signingyesAmount due when a lease is signed
standaloneyesTrue when the offer cannot be combined with other offers. Null when the feed does not say

discount_type decides which value columns must be set:

discount_typeRequired columns
amountamount
percent_off_msrppercent_off_msrp
rateapr, term_months
paymentmonthly_payment, term_months

OfferEntity rejects a record that has no value in a column its discount_type requires. The consolidated asset checks that every column above exists with its declared dtype. It does not check row values.

Offers the buyer must qualify for, such as military or loyalty cash, do not belong in this entity. Each OEM's transformed tier drops them.

OEM sources​