RetailHardHat Developer docs

REST API documentation

Deal Criteria Matches

Matching scores between deals and criteria profiles

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)
dealIduuidRequireddeal Id

Related resource: deals

profileIduuidRequiredprofile Id

Related resource: criteriaProfiles

isQualifiedbooleanOptionalis Qualified
matchScorenumberOptionalmatch Score
matchPercentagestringOptionalmatch Percentage
requiredMatchesjsonOptionalrequired Matches
preferredMatchesjsonOptionalpreferred Matches
failedRequirementsjsonOptionalfailed Requirements
partialMatchesjsonOptionalpartial Matches
matchSummarystringOptionalmatch Summary
recommendationstringOptionalrecommendation
calculatedAtdatetimeOptionalcalculated At
profileVersionnumberOptionalprofile Version
dealVersionnumberOptionaldeal Version
isStalebooleanOptionalis Stale