Reclassify a store as dormant

Overview

Takes one store out of service by moving it to the dormant tier. This is the only way to stop a store — there is no separate pause action. The endpoint cancels the current plan and the dormant plan starts immediately.

Prerequisites

• A bearer token in the Authorization header.
• The storeId of the record you are targeting.

Base URL

Endpoint

POST /api/v1/partner/provisioning/store/{storeId}/dormant

Authentication

• Requires a bearer token in the Authorization: Bearer <bearer-token> header.

• Bearer — partner token. The store must belong to an account underneath your own partner account.

Rate limit

• No rate limit.

Path parameters

Request

• None.

How it works

• 200 with { store_id, tier: "dormant", plan_id, plan_start }.
• 403 store out of scope / partner unresolvable · 404 store not found.

Response

200 OK · 200

{
  "data": {
    "store_id": 26,
    "tier": "dormant",
    "plan_id": 10,
    "plan_start": "2026-07-09T10:00:00.000000Z"
  }
}

403 Forbidden · 403

{
  "message": "This store is outside your partner scope.",
  "status": "error",
  "errors": {}
}

404 Not Found · 404

{
  "message": "Store not found.",
  "status": "error",
  "errors": {}
}

Errors

Example request

curl --request POST \
  --url "https://production-api.shoutaboutus.com/api/v1/partner/provisioning/store/123/dormant" \
  --header 'Authorization: Bearer <bearer-token>' \
  --header 'Accept: application/json'