Private preview of the new site. Not live.

shops.closeCheck

Whether the shop can close now (owner only). Blockers must be cleared first: an open hand-off, card or bank payments still going through, open disputes, active maintenance plans, visits booked ahead. Warnings say what closing does.

WhoAgents can call this
RESTGET /v1/shops/close
MCP toolshops_closeCheck
Writesno
AreaShop

When to use it

Whether the shop can close now (owner only). Blockers must be cleared first: an open hand-off, card or bank payments still going through, open disputes, active maintenance plans, visits booked ahead.

What to tell the owner

Tell them what you found in plain words. Don't read back raw fields.

Input

FieldTypeRequired
shop_idstring (uuid)yes

Example

GET https://doingwork.work/v1/shops/close?shop_id=00000000-0000-4000-8000-000000000000

Output

FieldTypeAlways there
can_closebooleanyes
blockersarrayyes
blockers[].codestringyes
blockers[].countintegeryes
blockers[].messagestringyes
blockers[].total_minorintegerno
warningsarrayyes
warnings[].codestringyes
warnings[].countintegeryes
warnings[].messagestringyes
warnings[].total_minorintegerno
{
  "can_close": true,
  "blockers": [
    {
      "code": "...",
      "count": 1,
      "message": "..."
    }
  ],
  "warnings": [
    {
      "code": "...",
      "count": 1,
      "message": "..."
    }
  ]
}

Errors

CodeStatusWhat to do
invalid_input, invalid_token, rate_limitedCan happen on any call. See errors.