Factuarea APIDevelopers
Support
Open app

Retrieve a connected store

Retrieve a connected store by its id (UUID v7).

  • Returns the provider connection it hangs from, the identifier the provider gave the shop and its full invoicing configuration.
  • Returns 404 if the store does not exist or belongs to another company — the two answers are identical on purpose, so the endpoint never reveals whether a store of another company exists.
GET
/stores/{store}

Authorization

AuthorizationBearer <token>

In: header

Path Parameters

store*string

Headers

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

application/json

application/json

application/json

application/json

application/json

Previous/v1/stores
POST

Connect a store

Connect an e-commerce store to your company. integration_id names the provider connection the store hangs from, and external_store_id is the identifier the provider gives the shop — unique per provider within your company, so a second store of the same provider and identifier is rejected with store_already_connected. Auto-invoicing is OFF unless you turn it on: connecting a store never starts issuing invoices by itself. remote_base_url, if given, is checked against the outbound policy of your company and rejected with store_url_not_allowed when it is not permitted.

Next/v1/stores/{store}
PUT

Update store settings

Update the settings of a connected store: its name, the series it numbers into (series_id; null falls back to the default series of your company), the simplified-invoice threshold, whether the buyer tax ID is required, whether prices already include taxes, whether paid orders are invoiced and emailed automatically, its remote_base_url and its environment. All fields are optional; omitted ones keep their value. Neither the provider nor the external_store_id can be changed: they are the identity of the store.