Comprovar la connexió d'una botiga WooCommerce

Comprova la connexió amb una botiga WooCommerce connectada i retorna el diagnòstic.

Llegeix l'estat del sistema de WooCommerce amb la credencial desada i no escriu a la botiga ni a Factuarea.
Respon 200 amb reachable, credential_accepted, les versions de WooCommerce i WordPress comunicades per la botiga (la versió de REST utilitzada pel connector està fixada per nosaltres), l'instant de la comprovació i, si alguna cosa falla, un failure_code: woocommerce_store_unreachable (sense resposta), woocommerce_credentials_rejected (la botiga ha respost i ha rebutjat la clau) o woocommerce_rest_route_missing (la botiga ha respost, però no publica la seva API REST).
Són resultats d'una comprovació executada i viatgen dins d'un 200. L'endpoint utilitza POST perquè fa una crida de sortida a una adreça que has triat, consumeix recursos de tercers i exigeix Idempotency-Key.
Una botiga inexistent o d'una altra empresa retorna 404 store_not_found.

Clau opaca generada pel client (fins a 255 caràcters; es recomana UUID v7) que permet reintents segurs: la primera resposta s'emmagatzema i es reprodueix en les repeticions sense tornar a executar la mutació. Reutilitzar una clau amb un cos diferent retorna 409 idempotency_key_reused. Consulta la guia d'idempotència. Obligatòria en aquesta operació: repetir-la produeix un efecte irreversible (un correu enviat, un fitxer generat, una crida a un tercer o un càrrec), per la qual cosa una petició sense aquesta capçalera es rebutja amb 422 idempotency_key_required abans d'executar lògica de negoci.

Longitud1 <= length <= 255

Factuarea-Version?string

Fixa la versió de l'API (YYYY-MM-DD, versionat per data estil Stripe) per a aquesta petició; omet-lo per usar la versió fixada de la clau, o l'última si no n'hi ha cap. Versió no suportada → 400 unsupported_api_version; mal formada → 400 parameter_invalid_format. La versió efectiva es reflecteix a la capçalera de resposta Factuarea-Version. Consulta la guia de Versioning.

Formatdate

X-Active-Profile?string

Opera en nom d'una empresa filla (API key mestra de gestoria): passa el seu id públic (UUID v7) i la petició s'executa contra les dades d'aquella filla sense canviar l'scope, el tier ni l'environment de la clau (omet-lo per usar la pròpia empresa de la clau). UUID no vàlid → 400 parameter_invalid_uuid; id desconegut o no propi → 404 profile_not_found. Consulta la guia d'Acting on behalf.

Formatuuid

Cos de la resposta

`application/json`

Exemple de petició

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/woocommerce/stores/01931b3e-7c4a-7f2e-9a8b-3c5d6e7f8a01/connection-test", {  method: "POST",  headers: { Authorization: `Bearer ${apiKey}`, ...{"Accept":"application/json","Idempotency-Key":"erp-2026-public-api-v1-woocommerce-stores-connection_test"} },});if (!response.ok) throw new Error(await response.text());if (response.status !== 204) console.log(await response.json());

Exemple de resposta

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

{
  "data": {
    "id": "0192e7c2-4d5e-7f3b-a012-3c4d5e6f7090",
    "object": "woocommerce_connection_check",
    "reachable": true,
    "credential_accepted": true,
    "store_version": "9.4.2",
    "api_version": "6.7.1",
    "failure_code": null,
    "checked_at": "2026-09-02T09:00:00+00:00"
  }
}

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

{
  "data": {
    "id": "0192e7c2-4d5e-7f3b-a012-3c4d5e6f7090",
    "object": "woocommerce_connection_check",
    "reachable": true,
    "credential_accepted": false,
    "store_version": null,
    "api_version": null,
    "failure_code": "woocommerce_credentials_rejected",
    "checked_at": "2026-09-02T09:00:00+00:00"
  }
}

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

{
  "data": {
    "id": "0192e7c2-4d5e-7f3b-a012-3c4d5e6f7090",
    "object": "woocommerce_connection_check",
    "reachable": false,
    "credential_accepted": false,
    "store_version": null,
    "api_version": null,
    "failure_code": "woocommerce_store_unreachable",
    "checked_at": "2026-09-02T09:00:00+00:00"
  }
}

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

{
  "data": {
    "id": "0192e7c2-4d5e-7f3b-a012-3c4d5e6f7090",
    "object": "woocommerce_connection_check",
    "reachable": true,
    "credential_accepted": false,
    "store_version": null,
    "api_version": null,
    "failure_code": "woocommerce_rest_route_missing",
    "checked_at": "2026-09-02T09: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_8d50edd0007d466443e12ebd4e"
  }
}

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

{
  "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_23153a93b894fd2cfb310c388c"
  }
}

{
  "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_5c9fa57d80d958a782fe759b5f"
  }
}

{
  "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_6388425e6ef4fca24c116c3e9c"
  }
}

{
  "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_17a0191b943c70a997d7756540"
  }
}

{
  "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_3cc4cc021991ccb952b411e183"
  }
}

Comprovar la connexió d'una botiga WooCommerce

Authorization

Paràmetres de ruta

Headers

Cos de la resposta

`application/json`

`application/json`

`application/json`

`application/json`

`application/json`

`application/json`

`application/json`

`application/json`

Comprovar la connexió d'una botiga WooCommerce

Authorization

Paràmetres de ruta

Headers

Cos de la resposta

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`