WooCommerce

Test a WooCommerce store connection

Test the connection with a connected WooCommerce store; it reads the store's system status and writes nothing.

  • Returns 200 with reachable, credential_accepted and, on problems, a failure_code (e.g. woocommerce_credentials_rejected).
  • Requires Idempotency-Key; an unknown store returns 404 store_not_found.
post/companies/{company}/woocommerce/stores/{store}/connection-test

Request

  • Base URL: https://api.factuarea.com/v1
  • URL: https://api.factuarea.com/v1/companies/{company}/woocommerce/stores/{store}/connection-test
  • Auth: one of:
    • HTTP bearer
    • API key in header X-API-Key

Path parameters

companystring uuid required

Public identifier (UUID v7) of the company. Get it from GET /v1/me (data.scope[].id).

storestring uuid required

Public identifier (UUID v7) of the connected online store.

Headers

Idempotency-Keystring required
Example:01928f10-7c0e-7c4a-9b7d-2f8a6e3c1d4b

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 422 idempotency_key_reused; the values of secret fields (password, secret…) count as part of the body, so retrying with a corrected secret under the same key is a different request, never the replay of the earlier answer. 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.

Factuarea-Versionstring date
Example:2026-06-01

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.

Response

Example response

{
  "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": "woocommerce_rest_route_missing",
    "checked_at": "2026-09-02T09:00:00+00:00"
  }
}

Changes

No recorded changes to this operation across all 1 revision of this API.