Get business economics
Returns the active brand's business economics: average order value, gross margin rate, fulfilment cost per order and payment fee rate, in the brand's currency, whether a person confirmed them in Koast, which of the four are still missing, and the breakeven cost per order and ROAS they give, or why none can be computed.
Tool name: get-business-economics.
Returns the active brand's business economics: average order value, gross margin rate, fulfilment cost per order and payment fee rate, in the brand's currency, whether a person confirmed them in Koast, which of the four are still missing, and the breakeven cost per order and ROAS they give, or why none can be computed. Read-only.
When to use
Before talking about profit or breakeven, and to learn which of average order value, gross margin, fulfilment cost and payment fee you still need to ask the user for.
Access
| Property | Value |
|---|---|
| Required scope | read |
| Publishes | No |
| Read-only | Yes |
| Destructive | No |
| Idempotent | Yes |
| Open world | No |
Input
This tool takes no input.
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 | |
shows | boolean | Yes | Whether Business numbers fit this brand. When false, do not ask for them or record them. |
REST equivalent
MCP only. No REST operation does the same thing.
Create notification
Create a notification in the user's Home inbox, a sign-off request, a to-do, or a deferred-work item.
Get KPI targets
Returns the active brand's KPI targets: for each metric, the value the brand aims for, whether a person confirmed it in Koast or it is still a proposal, where it is measured, the day it applies from, and the breakeven when the brand's economics give one.