Support cases in the Store API

Let your app’s backend read and open support cases about your app on the stores it is installed on.

An app can work with support cases about itself on a store through the Store API, with the store access token it already has. Request the scope in your app’s configuration; merchants approve it when they install or update the app.

The full reference, with request and response examples and every error, is Support cases in the Store API docs.

Scope

Allows

read_support_cases

See the cases about this app on this store.

write_support_cases

Also open cases and reply as the developer. Implies read_support_cases.

Merchants see the scope as “See and open support cases about this app on your store”.

Endpoints#

Method and path

Scope

Body

GET /api/{version}/support/cases

read_support_cases

Cases about this app on this store.

GET /api/{version}/support/cases/{id}

read_support_cases

One case with its messages (no notes).

POST /api/{version}/support/cases

write_support_cases

{ "subject", "body_text", "requester_account_id"? }

POST /api/{version}/support/cases/{id}/messages

write_support_cases

{ "body_text" }: shown to the merchant as your organization.

A case opened by an app needs a merchant to own it: requester_account_id must be a current member of the store, and defaults to the store owner. It is shared with the store’s team members who have the Support permission, like any case, with entry_point app_api and a snapshot whose errors follow your share_errors_default setting. Opening cases from your app stops when you turn off From inside your app in your support settings (SUPPORT_FORBIDDEN).

bash
curl -X POST "https://api.tringify.com/api/2025-01/support/cases" \
  -H "Authorization: Bearer $STORE_ACCESS_TOKEN" \
  -H "Content-Type: application/json" \
  -d '{"subject":"Carrier account needs re-linking","body_text":"Your carrier login expired on 19 Nov. Reconnect it in the app to resume label printing."}'

Limits#

Reads use your app’s existing Store API rate limit. An installation can open up to 5 cases an hour, and a store up to 10 an hour and 50 a day across all its apps; a store can have 5 open cases about the same app. Over a limit the API answers 429 SUPPORT_RATE_LIMITED with Retry-After.