Test a Shopify store connection

Test the connection with one connected Shopify store and return the diagnosis.

The check asks the Admin GraphQL API for the shop with the stored access token and writes nothing, neither in the shop nor in Factuarea.
It answers 200 with reachable, credential_accepted, the plan the shop reports, the pinned Admin API version this connector speaks (api_version, ours and not something the shop reports), the date that version is supported until (supported_until), the instant of the check and, when something went wrong, a failure_code — shopify_store_unreachable (the shop did not answer, or the query cost budget was exhausted), shopify_credentials_rejected (the shop answered and refused the token), shopify_api_version_expired (the pinned version is no longer served) or store_url_not_allowed (your company has not authorised that destination).
Those are outcomes of a check that ran, not failures of the API, which is why they travel inside a 200 instead of as an error status.
Watch supported_until: when an Admin API version expires Shopify does not fail, it answers 200 with the fields of another version, so the breakage is silent.
The endpoint is a POST because it makes an outbound call to the merchant shop, so it consumes third-party resources and requires an Idempotency-Key header.
A missing store or one from another company returns 404 store_not_found.

Client-generated opaque key (up to 255 characters; UUID v7 recommended) that makes retries safe: the first response is cached and replayed for repeats without re-executing the mutation. Reusing a key with a different body returns 409 idempotency_key_reused. See the Idempotency guide. Required on this operation: repeating it delivers an effect that cannot be taken back (an email sent, a file generated, a third-party call, a charge), so a request without this header is rejected with 422 idempotency_key_required before any business logic runs.

Length1 <= length <= 255

Factuarea-Version?string

Pin the API version (YYYY-MM-DD, Stripe-style date versioning) for this request; omit to use the key's pinned version, or the latest if none. Unsupported version → 400 unsupported_api_version; malformed → 400 parameter_invalid_format. The effective version is echoed in the Factuarea-Version response header. See the Versioning guide.

Formatdate

X-Active-Profile?string

Operate on behalf of a child company (gestoría master key): pass its public id (UUID v7) and the request runs against that child's data without changing the key's scope, tier or environment (omit to use the key's own company). Invalid UUID → 400 parameter_invalid_uuid; unknown or non-owned id → 404 profile_not_found. See the Acting on behalf guide.

Formatuuid

Response Body

`application/json`

Request example

const apiKey = process.env.FACTUAREA_API_KEY;if (!apiKey) throw new Error("Set FACTUAREA_API_KEY");const response = await fetch("https://api.factuarea.com/v1/shopify/stores/01931b3e-7c4a-7f2e-9a8b-3c5d6e7f8a01/connection-test", {  method: "POST",  headers: { Authorization: `Bearer ${apiKey}`, ...{"Accept":"application/json","Idempotency-Key":"erp-2026-public-api-v1-shopify-stores-connection_test"} },});if (!response.ok) throw new Error(await response.text());if (response.status !== 204) console.log(await response.json());

Response example

POST /v1/shopify/stores/{store}/connection-test · 200

{
  "data": {
    "id": "0192e7c2-4d5e-7f3b-a012-3c4d5e6f7091",
    "object": "shopify_connection_check",
    "reachable": true,
    "credential_accepted": true,
    "store_version": "Basic",
    "api_version": "2026-01",
    "supported_until": "2027-01-01",
    "failure_code": null,
    "checked_at": "2026-09-03T09:00:00+00:00"
  }
}

POST /v1/shopify/stores/{store}/connection-test · 200 shopify_credentials_rejected

{
  "data": {
    "id": "0192e7c2-4d5e-7f3b-a012-3c4d5e6f7091",
    "object": "shopify_connection_check",
    "reachable": true,
    "credential_accepted": false,
    "store_version": null,
    "api_version": "2026-01",
    "supported_until": "2027-01-01",
    "failure_code": "shopify_credentials_rejected",
    "checked_at": "2026-09-03T09:00:00+00:00"
  }
}

POST /v1/shopify/stores/{store}/connection-test · 200 shopify_store_unreachable

{
  "data": {
    "id": "0192e7c2-4d5e-7f3b-a012-3c4d5e6f7091",
    "object": "shopify_connection_check",
    "reachable": false,
    "credential_accepted": false,
    "store_version": null,
    "api_version": "2026-01",
    "supported_until": "2027-01-01",
    "failure_code": "shopify_store_unreachable",
    "checked_at": "2026-09-03T09:00:00+00:00"
  }
}

POST /v1/shopify/stores/{store}/connection-test · 200 shopify_api_version_expired

{
  "data": {
    "id": "0192e7c2-4d5e-7f3b-a012-3c4d5e6f7091",
    "object": "shopify_connection_check",
    "reachable": true,
    "credential_accepted": false,
    "store_version": null,
    "api_version": "2026-01",
    "supported_until": "2027-01-01",
    "failure_code": "shopify_api_version_expired",
    "checked_at": "2026-09-03T09:00:00+00:00"
  }
}

{
  "error": {
    "type": "authentication_error",
    "code": "missing_api_key",
    "message": "Falta header Authorization o X-API-Key.",
    "doc_url": "https://docs.factuarea.com/guides/errors#missing_api_key",
    "request_id": "req_286056667a08c91e2debc5ebb4"
  }
}

{
  "error": {
    "type": "authorization_error",
    "code": "insufficient_scope",
    "message": "Esta operación requiere el scope 'shopify_store:write'. Tu API key solo tiene los scopes: ninguno.",
    "doc_url": "https://docs.factuarea.com/guides/errors#insufficient_scope",
    "request_id": "req_c909e77829136b14fc53c0a8a7"
  }
}

{
  "error": {
    "type": "not_found_error",
    "code": "store_not_found",
    "message": "La tienda indicada no existe. Comprueba el identificador en el listado de tiendas conectadas.",
    "doc_url": "https://docs.factuarea.com/guides/errors#store_not_found",
    "request_id": "req_11029ed5539d3866fdb6b09dc1"
  }
}

{
  "error": {
    "type": "idempotency_error",
    "code": "idempotency_key_reused",
    "message": "Esa `Idempotency-Key` ya se usó con un payload distinto. La clave identifica una operación concreta, así que reutilizarla para otra vaciaría de sentido el replay.",
    "doc_url": "https://docs.factuarea.com/guides/errors#idempotency_key_reused",
    "request_id": "req_13929402faf5cedf033aab12a1"
  }
}

{
  "error": {
    "type": "invalid_request_error",
    "code": "invalid_param_format",
    "message": "La Idempotency-Key debe tener entre 1 y 255 caracteres ASCII printable.",
    "param": "Idempotency-Key",
    "doc_url": "https://docs.factuarea.com/guides/errors#invalid_param_format",
    "request_id": "req_5ec05fe816d043b07167d35aed"
  }
}

{
  "error": {
    "type": "rate_limit_error",
    "code": "rate_limit_exceeded",
    "message": "Has excedido el límite de requests permitido. Reintenta más tarde.",
    "doc_url": "https://docs.factuarea.com/guides/errors#rate_limit_exceeded",
    "request_id": "req_549ddd377ae5957b618a0a532c"
  }
}

{
  "error": {
    "type": "api_error",
    "code": "internal_error",
    "message": "Algo se rompió en nuestro lado al procesar la petición. La condición no la provoca tu payload.",
    "doc_url": "https://docs.factuarea.com/guides/errors#internal_error",
    "request_id": "req_d83799804318165e2963692a16"
  }
}

Test a Shopify store connection

Authorization

Path Parameters

Headers

Response Body

`application/json`

`application/json`

`application/json`

`application/json`

`application/json`

`application/json`

`application/json`

`application/json`

Test a Shopify store connection

Authorization

Path Parameters

Headers

Response Body

200application/json

401application/json

403application/json

404application/json

409application/json

422application/json

429application/json

500application/json

`application/json`

`application/json`

`application/json`

`application/json`

`application/json`

`application/json`

`application/json`

`application/json`