Skip to content

Verify 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/verify

Costs 1 rate-limit point · Rate limits

Check that the storefront answers the app proxy path the store-domain opt-in link uses. valid is true or false; it is null with password_protected true while the storefront password hides the answer.

Read-only: nothing is saved. path_prefix must look like /apps/<suffix> or /a/<suffix>, as set in the app proxy settings in Shopify, or the call fails with 422 invalid_params. Check a path here before saving it as optin.app_proxy_path_prefix in PATCH /back_in_stock/settings/widget: while optin.custom_domain_enabled is on, the double opt-in confirmation link is built from it. A store that doesn't answer within 5 seconds also gives valid: false. If you don't know the path, call GET /back_in_stock/app_proxy/detect.

Also searched asverify app proxycheck app proxy pathtest the app proxy

Query parameters

  • path_prefixstringRequired

    App proxy path to check, "/apps/<suffix>" or "/a/<suffix>", as set in the Shopify app proxy settings.

Returns

  • validboolean, nullable
    Example: true
  • password_protectedboolean
    Example: true

Errors

422
invalid_params

One or more fields failed the action's schema.

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/verify
curl "https://app.stoqapp.com/api/v2/external/back_in_stock/app_proxy/verify?path_prefix=string" \
  -H "X-Auth-Token: $STOQ_API_KEY"
Response
{
  "valid": true,
  "password_protected": true
}