GlobalCommandDto
Represents a global command in the system. Global commands are instructions that can be executed across a store's environment.
contentstringRequired
The actual command content to be executed.
created_atstringRequired
Timestamp when the command was created.
created_byActorDtoRequired
typeenumRequired
Possible enum values
anonymoususerapi_keycustomergame_serverinternaladminplatformglobal_customer
idFlakeIdOptional
execution_ruleenumRequired
Possible enum values
invalidonce_per_itemExecutes commands regularly, once per item (number of products * quantity times)
once_per_orderExecutes command only once per entire order
idFlakeIdRequired
online_onlybooleanRequired
Indicates whether the command should only be executed when the player is online.
override_execute_on_gameserver_idsFlakeId[]Required
List of specific game server IDs where this command should be executed, overriding default behavior.
stageenumRequired
Defines the stages at which product commands can be executed.
Possible enum values
invalidRepresents an invalid or unspecified command stage.
on_purchaseCommands that should be executed when a product is purchased.
on_expireCommands that should be executed when a product expires.
on_refundCommands that should be executed when a product is refunded.
on_renewCommands that should be executed when a subscription is renewed.
on_chargebackCommands that should be executed when an order is charged back.
on_trial_startCommands that should be executed when a trial is started.
on_trial_expireCommands that should be executed when a trial expires.
store_idFlakeIdRequired
updated_atstringOptional
Optional timestamp indicating when the command was last updated.
Null if the command has never been updated.
updated_byActorDtoOptional
typeenumRequired
Possible enum values
anonymoususerapi_keycustomergame_serverinternaladminplatformglobal_customer
idFlakeIdOptional
Example
{
"content": "string",
"created_at": "2024-01-01T00:00:00Z",
"created_by": {
"type": "anonymous",
"id": "411486491630370816"
},
"execution_rule": "invalid",
"id": "411486491630370816",
"online_only": true,
"override_execute_on_gameserver_ids": [
"411486491630370816"
],
"stage": "invalid",
"store_id": "411486491630370816",
"updated_at": "2024-01-01T00:00:00Z",
"updated_by": {
"type": "anonymous",
"id": "411486491630370816"
}
}