Factuarea API
Productes

Cercar un producte per external ID

Cerca un únic producte pel seu `external_id` (enviat al body JSON), la clau d'integració que el mapeja a un registre en un sistema de tercers (ERP/CRM/e-commerce). Ortogonal al `sku` del catàleg. Retorna el producte coincident o 404 si cap producte fa servir aquest external_id dins de la teva empresa.

POST
/products/find-by-external-id
AuthorizationBearer <token>

A: header

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

{
  "data": {
    "id": "01931b3e-7c4a-7f2e-9a8b-3c5d6e7f8a09",
    "object": "product",
    "name": "Teclado mecánico RGB",
    "sku": "KEY-RGB-01",
    "price": "1234.56",
    "currency": "EUR",
    "tax_rate": {
      "id": "01931b3e-7c4a-7f2e-9a8b-3c5d6e7f8a0f",
      "rate": 21
    },
    "stock": 120,
    "gallery": [
      {
        "index": 0,
        "url": "https://files.factuarea.com/products/key-rgb-01-front.jpg",
        "content_type": "image/jpeg"
      }
    ],
    "video": {
      "url": "https://files.factuarea.com/products/key-rgb-01-demo.mp4",
      "content_type": "video/mp4"
    },
    "is_active": true,
    "description": "Teclado mecánico retroiluminado RGB con switches Cherry MX Red y carcasa de aluminio.",
    "tags": [
      "periféricos",
      "gaming"
    ],
    "low_stock_threshold": 10,
    "is_low_stock": false,
    "is_in_stock": true,
    "specifications": {
      "switch": "Cherry MX Red",
      "layout": "ES",
      "conexion": "USB-C"
    },
    "metadata": {
      "erp_code": "IVA-GEN",
      "ledger_account": "477000"
    },
    "external_id": "SHOP-42",
    "created_at": "2026-01-02T08:30:00Z",
    "updated_at": "2026-01-02T08:30:00Z"
  }
}

{
  "error": {
    "type": "authentication_error",
    "code": "missing_api_key",
    "message": "No se ha proporcionado una API key válida en el header Authorization.",
    "param": null,
    "doc_url": "https://docs.factuarea.com/guides/errors#missing_api_key",
    "request_id": "req_01HKQS5N8VR7QXJ9K3T6BWPMZA"
  }
}

{
  "error": {
    "type": "authorization_error",
    "code": "insufficient_scope",
    "message": "Esta API key no tiene el scope requerido para esta operación.",
    "param": null,
    "doc_url": "https://docs.factuarea.com/guides/errors#insufficient_scope",
    "request_id": "req_01HKQS5NBC3P8M1KX4V7SLNHQD"
  }
}

{
  "error": {
    "type": "idempotency_error",
    "code": "idempotency_key_reused",
    "message": "La cabecera `Idempotency-Key` ya se usó con un body distinto. Usa una clave nueva o reenvía exactamente el mismo body.",
    "param": null,
    "doc_url": "https://docs.factuarea.com/guides/errors#idempotency_key_reused",
    "request_id": "req_01HKQS5NHT9A4U7R2E3F8GZWTJ"
  }
}

{
  "error": {
    "type": "invalid_request_error",
    "code": "parameter_invalid",
    "message": "El campo `name` es obligatorio y no puede estar vacío.",
    "param": "name",
    "doc_url": "https://docs.factuarea.com/guides/errors#parameter_invalid",
    "request_id": "req_01HKQS5NGS8Z3T6Q1D2E7FYVSI"
  }
}

{
  "error": {
    "type": "rate_limit_error",
    "code": "rate_limit_exceeded",
    "message": "Has excedido el rate limit de 60 peticiones por minuto. Reintenta tras 30 segundos.",
    "param": null,
    "doc_url": "https://docs.factuarea.com/guides/errors#rate_limit_exceeded",
    "request_id": "req_01HKQS5NKW1C6W9T4G5H0JBZVL"
  }
}

{
  "error": {
    "type": "api_error",
    "code": "internal_error",
    "message": "Ha ocurrido un error inesperado. Si persiste, contacta con soporte adjuntando el request_id.",
    "param": null,
    "doc_url": "https://docs.factuarea.com/guides/errors#internal_error",
    "request_id": "req_01HKQS5NLX2D7X0U5H6J1KCAWM"
  }
}