Record business economics
Records the business numbers the user told you in chat for the active brand: average order value, gross margin rate, fulfilment cost per order and payment fee rate.
Tool name: record-business-economics.
Records the business numbers the user told you in chat for the active brand: average order value, gross margin rate, fulfilment cost per order and payment fee rate. Send only what the user said; the rest is kept. The result is not confirmed (status INFERRED) and Koast does not use it for targets until a person confirms it in Koast. It is refused when it would change a number the user already confirmed there. Returns the economics after the change and what is still missing.
When to use
When the user tells you their average order value, gross margin, fulfilment cost per order or payment fee in chat. Afterwards tell them to confirm the numbers in Koast.
Access
| Property | Value |
|---|---|
| Required scope | write |
| Publishes | No |
| Read-only | No |
| Destructive | Yes |
| Idempotent | Yes |
| Open world | No |
Input
| Field | Type | Required | Description |
|---|---|---|---|
averageOrderValue | number | No | Average order value in the brand's own currency, as the user said it, for example 85.5. Minimum 0. |
grossMarginRate | number | No | Gross margin as a fraction: 0.62 for 62%. Minimum 0, maximum 1. |
fulfilmentCostPerOrder | number | No | Fulfilment and shipping cost per order in the brand's own currency. Minimum 0. |
paymentFeeRate | number | No | Payment processing fee as a fraction of the order: 0.029 for 2.9%. Minimum 0, maximum 1. |
Output
| Field | Type | Required | Description |
|---|---|---|---|
currencyCode | string | null | Yes | The brand's currency, read from its ad accounts; null when they give none or more than one. |
economics | object | null | Yes | |
missingFields | string[] | Yes | One of averageOrderValue, grossMarginRate, fulfilmentCostPerOrder, paymentFeeRate. |
breakeven | object | Yes |
REST equivalent
MCP only. No REST operation does the same thing.