Skip to content

Detect the app proxy path

API v2 is in public beta: endpoints and fields can change before general availability. See the changelog

GET/back_in_stock/app_proxy/detect

Costs 1 rate-limit point · Rate limits

Find which app proxy path the storefront answers, from the paths STOQ installs with. detected is that path, or null when none answers (or the storefront password hides it).

Read-only: it tries each candidate path on the shop's myshopify.com storefront and saves nothing. To use the path it finds, send it as optin.app_proxy_path_prefix in PATCH /back_in_stock/settings/widget. A storefront password page or a store that doesn't answer also gives detected: null, so null does not prove the proxy is missing. To test a path of your own, call GET /back_in_stock/app_proxy/verify. Each try waits up to 5 seconds.

Also searched asdetect app proxyfind app proxy path

Returns

  • detectedstring, nullable
    Example: string

Errors

422
validation_failed

The request failed validation.

Any request can also fail with auth_invalid (401) or rate_limited (429).

Every error has the same shape: see Errors and the list of error codes.

GET/back_in_stock/app_proxy/detect
curl "https://app.stoqapp.com/api/v2/external/back_in_stock/app_proxy/detect" \
  -H "X-Auth-Token: $STOQ_API_KEY"
Response
{
  "detected": "string"
}