Factuarea APIDevelopers

Connectar una botiga

Connecta una botiga de comerç electrònic a la teva empresa.

  • integration_id identifica la connexió amb el proveïdor de què depèn la botiga, i external_store_id és l'identificador que el proveïdor assigna a la botiga.
  • És únic per proveïdor dins de la teva empresa: una segona botiga amb el mateix proveïdor i identificador es rebutja amb store_already_connected.
  • La facturació automàtica està desactivada fins que l'activis; connectar una botiga no comença a emetre factures.
  • Si envies remote_base_url, es comprova amb la política de destinacions de sortida de la teva empresa i es rebutja amb store_url_not_allowed si no està permesa.
POST
/stores
AuthorizationBearer <token>

A: header

Headers

Idempotency-Key?string

Clau opaca generada pel client (fins a 255 caràcters; es recomana UUID v7) que fa segurs els reintents: la primera resposta es cacheja i es reprodueix a les repeticions sense tornar a executar la mutació. Reutilitzar una clau amb un cos diferent retorna 409 idempotency_key_reused. Consulta la guia d'Idempotency.

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 petició

application/json

Definicions de TypeScript

Usa el tipus request body a TypeScript.

Cos de la resposta

application/json

application/json

application/json

application/json

application/json

application/json

application/json