Stores

Connect a store

Connects an e-commerce store to the company; auto-invoicing stays OFF until you enable it.

  • external_store_id is unique per provider (store_already_connected).
  • remote_base_url must pass the outbound policy (store_url_not_allowed).
post/companies/{company}/stores

Request

  • Base URL: https://api.factuarea.com/v1
  • URL: https://api.factuarea.com/v1/companies/{company}/stores
  • 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).

Headers

Idempotency-Keystring
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.

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.

Request body

integration_idstring uuid required

Identifier (UUID v7) of the provider connection that backs the store.

provider'woocommerce' | 'shopify' | 'prestashop' required

E-commerce provider of the store: woocommerce, shopify or prestashop.

external_store_idstring required

Identifier the provider gives to the shop; unique per provider within your company.

namestring required

Display name of the store, editable at any time.

series_idstring uuid nullable

Series (UUID v7, type invoice) the store numbers into; omit to follow the default series of your company.

simplified_thresholdnumber nullable

Order total, in euros, up to which the store issues a simplified invoice. Maximum 3000.00.

require_tax_idboolean nullable

Whether the buyer tax ID is required for the order to be invoiced.

prices_include_taxboolean nullable

Whether the prices of the store already include taxes.

autoinvoicing_enabledboolean nullable

Whether paid orders are invoiced automatically. Off unless you turn it on.

autosend_enabledboolean nullable

Whether the invoice is emailed to the buyer automatically. Off unless you turn it on.

remote_base_urlstring uri nullable

Base address of the remote shop, checked against the outbound policy of your company.

environment'live' | 'test' | 'null' nullable

Environment the store reports as: live invoices for real, test discards with a typed reason.

authorize_remote_hostboolean nullable

Authorize the host of remote_base_url as an outbound destination in the same call.

Response

Online store connected. The Location header contains the canonical URL of the new store connection.

Example response

{
  "data": {
    "id": "0192e7c2-4d5e-7f3b-a012-3c4d5e6f7090",
    "object": "store",
    "integration_id": "0192e7b1-3c4d-7e2a-9f01-2b3c4d5e6f71",
    "provider": "woocommerce",
    "external_store_id": "wc-tienda-es",
    "name": "Tienda ES",
    "simplified_threshold": "400.00",
    "prices_include_tax": true,
    "remote_base_url": "https://tienda.example.com",
    "environment": "test",
    "status": "active",
    "connected_at": "2026-08-29T09:00:00+00:00",
    "invoice_note": "Pedido pagado en la tienda online. Gracias por su compra."
  }
}

Changes

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