Support cases

Read, open and answer support cases about your app on the stores it is installed on.

Merchants open support cases with the developer of an app they use, and your organization answers them in the Developer Portal, the CLI or its help desk (Merchant support). These endpoints let your app work with the cases about itself on the store that installed it, with its store access token. Reads need read_support_cases; opening a case and replying need write_support_cases, which includes reading. An app sees only cases about itself on this store, never your team's internal notes, and never a merchant's email address.

A case your app opens is filed for requester_account_id (a current member of the store, the store owner by default), shared with the store's team members who hold Support, and carries the same snapshot as any case. Opening cases stops while your organization has turned off cases from inside the app. An installation can open 5 cases an hour, and a store can have 5 open cases about your app at once.

Endpoints#

List support cases

GET read_support_cases

List support cases about your app on this store.

Returns the cases merchants of this store opened about your app, newest change first, in the same shape your organization sees in the Developer Portal: display_number (C-), subject, display_status, about, store, requester.name (first name only; never an email), created_at and updated_at. Answer them here, in the Developer Portal, the CLI or your help desk through the Support API.

Query parameters

Name Type Description
status string

needs_reply, waiting_for_merchant, with_tringify, solved, closed, active (the first three) or all. Defaults to all.

Example: active
updated_since string

Only cases changed at or after this RFC 3339 time.

Example: 2026-11-20T00:00:00Z
page integer

Page number, from 1.

Example: 1
limit integer

25, 50 or 100. Defaults to 25.

Example: 25

Headers

Name Type Description
Authorization required string

Bearer Store API token.

Errors

  • 401 UNAUTHORIZED

    Authorization header missing, malformed, or token invalid/expired.

  • 402 SUBSCRIPTION_REQUIRED

    The store does not have an active or trialing subscription.

  • 403 STORE_API_SCOPE_REQUIRED

    Token is valid but lacks the required scope for this call.

  • 429 RATE_LIMITED

    The token's request allowance is exhausted. Retry after the Retry-After header.

  • 404 SUPPORT_NOT_FOUND

    No case with this id is about your app on this store.

  • 503 SUPPORT_UNAVAILABLE

    Support is unavailable right now. Try again shortly.

  • 400 STORE_API_QUERY_PARAMETER_UNKNOWN

    The query string has a parameter this request does not accept. The message and error.details.allowed_parameters list the ones it does.

Get a support case

GET read_support_cases

Read one support case about your app, with its replies.

Returns the case and its replies (messages[]; your organization's internal notes are not included). Merchant messages have author customer, your organization's developer, Tringify's staff.

Path parameters

Name Type Description
id required string

The case id.

Example: 3f1c2a90-7d4e-4b8a-9c1e-5a2f0e6b7c11

Headers

Name Type Description
Authorization required string

Bearer Store API token.

Errors

  • 401 UNAUTHORIZED

    Authorization header missing, malformed, or token invalid/expired.

  • 402 SUBSCRIPTION_REQUIRED

    The store does not have an active or trialing subscription.

  • 403 STORE_API_SCOPE_REQUIRED

    Token is valid but lacks the required scope for this call.

  • 429 RATE_LIMITED

    The token's request allowance is exhausted. Retry after the Retry-After header.

  • 404 SUPPORT_NOT_FOUND

    No case with this id is about your app on this store.

  • 503 SUPPORT_UNAVAILABLE

    Support is unavailable right now. Try again shortly.

Open a support case

POST write_support_cases

Open a support case about your app for a merchant of this store.

Use this when your app finds a problem the merchant should follow up with you. The case is filed for requester_account_id (a current member of the store; defaults to the store owner), shared with the store's team who hold Support, and routed to your organization. The shared snapshot (store name, plan, region, your app's version and the last 7 days of app errors when your organization shares them by default) is attached as for any case. Allowed only while your organization takes cases from inside the app.

Headers

Name Type Description
Authorization required string

Bearer Store API token.

Body parameters

Name Type Description
subject required string

What the case is about, 3–200 characters.

Example: Shipping labels fail for COD orders
body_text required string

The first message, up to 20,000 characters.

Example: We could not create labels for 3 COD orders since 10:00 UTC.
requester_account_id string

The store member the case is filed for. Defaults to the store owner.

Errors

  • 401 UNAUTHORIZED

    Authorization header missing, malformed, or token invalid/expired.

  • 402 SUBSCRIPTION_REQUIRED

    The store does not have an active or trialing subscription.

  • 403 STORE_API_SCOPE_REQUIRED

    Token is valid but lacks the required scope for this call.

  • 429 RATE_LIMITED

    The token's request allowance is exhausted. Retry after the Retry-After header.

  • 404 SUPPORT_NOT_FOUND

    No case with this id is about your app on this store.

  • 503 SUPPORT_UNAVAILABLE

    Support is unavailable right now. Try again shortly.

  • 400 SUPPORT_INVALID_INPUT

    subject (3–200 characters) or body_text (1–20,000 characters) is missing or too long, or requester_account_id is not a member of the store. details.field names the field.

  • 403 SUPPORT_FORBIDDEN

    Your organization switched off cases from inside your app (Developer Portal › Settings › Support).

  • 409 SUPPORT_CONFLICT

    details.reason is too_many_open: the store already has 5 open cases about your app; details.open_cases lists them.

  • 429 SUPPORT_RATE_LIMITED

    Your app opened 5 cases on this installation in the last hour, or the store reached its case limit. Retry after Retry-After seconds.

  • 400 STORE_API_BODY_PROPERTY_UNKNOWN

    The body has a property this request does not accept. The message and error.details.properties list the allowed and required properties (nested for each object or list of objects).

  • 400 STORE_API_BODY_PROPERTY_INVALID

    A body property has the wrong type (error.details.expected_type). The message and error.details.properties list the allowed and required properties.

Reply to a support case

POST write_support_cases

Reply to a support case about your app as your organization.

The reply is signed with your organization's name and emailed to the merchant. A closed case can't take replies.

Path parameters

Name Type Description
id required string

The case id.

Example: 3f1c2a90-7d4e-4b8a-9c1e-5a2f0e6b7c11

Headers

Name Type Description
Authorization required string

Bearer Store API token.

Body parameters

Name Type Description
body_text required string

The reply, up to 20,000 characters.

Example: Fixed: labels are created again. Please retry the 3 orders.

Errors

  • 401 UNAUTHORIZED

    Authorization header missing, malformed, or token invalid/expired.

  • 402 SUBSCRIPTION_REQUIRED

    The store does not have an active or trialing subscription.

  • 403 STORE_API_SCOPE_REQUIRED

    Token is valid but lacks the required scope for this call.

  • 429 RATE_LIMITED

    The token's request allowance is exhausted. Retry after the Retry-After header.

  • 404 SUPPORT_NOT_FOUND

    No case with this id is about your app on this store.

  • 503 SUPPORT_UNAVAILABLE

    Support is unavailable right now. Try again shortly.

  • 400 SUPPORT_INVALID_INPUT

    body_text is missing or longer than 20,000 characters.

  • 403 SUPPORT_READ_ONLY

    The case is closed (details.reason closed). Open a new case instead.

  • 400 STORE_API_BODY_PROPERTY_UNKNOWN

    The body has a property this request does not accept. The message and error.details.properties list the allowed and required properties (nested for each object or list of objects).

  • 400 STORE_API_BODY_PROPERTY_INVALID

    A body property has the wrong type (error.details.expected_type). The message and error.details.properties list the allowed and required properties.