costs.marginAlert
The shop's profit alert: the margin floor in percent, or null when off. Owner or office.
When to use it
The shop's profit alert: the margin floor in percent, or null when off. Owner or office.
What to tell the owner
Tell them what you found in plain words. Don't read back raw fields.
| Field | Type | Required |
|---|
shop_id | string (uuid) | yes |
Example
GET https://doingwork.work/v1/costs/margin-alert?shop_id=00000000-0000-4000-8000-000000000000
Output
| Field | Type | Always there |
|---|
shop_id | string (uuid) | yes |
below_percent | ['number', 'null'] | yes |
{
"shop_id": "00000000-0000-4000-8000-000000000000",
"below_percent": "..."
}
Errors
| Code | Status | What to do |
|---|
invalid_input, invalid_token, rate_limited | | Can happen on any call. See errors. |