Prize Statuses

The PrizeStatus Object

The PrizeStatus object represents configurable workflow behaviour for prizes. Beyond a status name/colour, it includes operational flags that determine how a prize should behave (e.g. can be confirmed/collected, affects stock, archived, auto-fulfilled, etc.). This is effectively the ruleset behind prize state transitions.

ValueTypeDescription
uuidstringPrize status UUID.
namestringStatus name.
colorstringStatus color.
api_namestringAPI name.
statusstringStatus value.
remove_from_availablebooleanRemove-from-available flag.
remove_from_on_handbooleanRemove-from-on-hand flag.
can_confirmbooleanCan-confirm flag.
can_collectbooleanCan-collect flag.
archive_prizebooleanArchive-prize flag.
auto_fulfilbooleanAuto-fulfil flag.
lockedbooleanLocked flag.
prohibition_rules_ignorebooleanIgnore prohibition rules flag.
permit_values_ignorebooleanIgnore permit values flag.
budget_deductiblebooleanBudget-deductible flag.
requires_attentionbooleanRequires-attention flag.
delete_list_membershipbooleanDelete list-membership flag.
station_uuidstringStation UUID when station_id is present.
created_atstringRecord creation timestamp.
updated_atstringRecord update timestamp.