RetailHardHat Developer docs

REST API documentation

Bid Comparisons

AI-generated bid comparison analyses for an RFP

Supported operations

This resource provides field metadata only. No dedicated CRUD endpoint is advertised.

Field reference

Required means required by the underlying data model, not necessarily caller-supplied. The server derives protected identity and ownership fields; endpoint validation controls which fields are accepted. Sensitive credential fields are omitted here.

FieldTypeModel requirementDescription
idstringOptionalUnique identifier (auto-generated)
siteIduuidOptionalsite Id
selectionSignaturestringRequiredselection Signature
bidIdsjsonRequiredbid Ids
modelVersionstringOptionalmodel Version
comparisonResultjsonRequiredcomparison Result
generatedAtdatetimeOptionalgenerated At
createdAtdatetimeOptionalCreation timestamp (auto)