household_biz.get_purchase_desire
Overview
- Returns a customer's current purchase desire gauge value.
Metadata
| Field | Value |
|---|---|
| Display | Get Purchase Desire |
| Category | household_biz |
| Access | Public |
| Scope | B2Authority |
| Tags | — |
| Aliases | — |
Parameters
| Name | Type | Required | Default | Description |
|---|---|---|---|---|
| customer_id | entityId | yes | — | Customer entity id |
| household_biz_id | entityId | no | — | Target HouseholdBiz entity id (default: possessed) |
Usage
await inzoi.cli.execute('household_biz.get_purchase_desire', {
customer_id: 0,
household_biz_id: 0, // optional
});