Listar todas las ofertas

Lista las ofertas de la empresa con paginación por cursor, de la más antigua a la más reciente, cada una con sus elementos. - Filtra por status (scheduled, active, ended o cancelled), channel (documents o web), starts_at[gte|lte], ends_at[gte|lte] y updated[gte]. - Las fechas son ISO 8601. Un día sin hora se lee en la zona horaria de la empresa. - GET /promotions?status=active&channel=web devuelve lo que una tienda web muestra hoy.

Authorization

AuthorizationBearer <token>

Tu API key como token Bearer: fact_live_… en producción, fact_test_… en sandbox. Consulta la guía de autenticación.

En: header

Parámetros de ruta

company*string

Identificador público (UUID v7) de la empresa. Obtenlo de GET /v1/me (data.scope[].id).

Formatouuid

Parámetros de consulta

limit?integer

Número de objetos a devolver, entre 1 y 100 (25 por defecto).

Predeterminado25

Rango1 <= value <= 100

starting_after?string

Cursor de paginación hacia delante: pasa el id del último objeto de la página anterior (el next_cursor de la respuesta anterior).

Formatouuid

ending_before?string

Cursor de paginación hacia atrás: pasa el id del primer objeto de la página actual.

Formatouuid

status?string

Estado de la oferta hoy: scheduled, active, ended (por fecha) o cancelled. Coincidencia exacta con status.

Valor en"scheduled" | "active" | "ended" | "cancelled"

channel?string

Canal de venta al que se aplica la oferta: documents o web. Coincidencia exacta con channel.

Valor en"documents" | "web"

starts_at[gte]?string

Primer instante de la oferta (ISO 8601). Un día sin hora se lee en la zona horaria de la empresa. Mayor o igual que el valor indicado.

Formatodate-time

starts_at[lte]?string

Primer instante de la oferta (ISO 8601). Un día sin hora se lee en la zona horaria de la empresa. Menor o igual que el valor indicado.

Formatodate-time

ends_at[gte]?string

Último instante incluido de la oferta (ISO 8601). Un día sin hora se lee en la zona horaria de la empresa. Mayor o igual que el valor indicado.

Formatodate-time

ends_at[lte]?string

Último instante incluido de la oferta (ISO 8601). Un día sin hora se lee en la zona horaria de la empresa. Menor o igual que el valor indicado.

Formatodate-time

updated[gte]?string

Fecha de última actualización (ISO 8601). Mayor o igual que el valor indicado.

Formatodate-time

Headers

Factuarea-Version?string

Fija la versión de la API (YYYY-MM-DD, versionado por fecha estilo Stripe) para esta petición; omítelo para usar la versión fijada de la clave, o la última si no hay ninguna. Versión no soportada → 400 unsupported_api_version; malformada → 400 parameter_invalid_format. La versión efectiva se refleja en la cabecera de respuesta Factuarea-Version. Consulta la guía de Versioning.

Formatodate

Cuerpo de la respuesta

`application/json`

Ejemplo de petición

const apiKey = process.env.FACTUAREA_API_KEY;if (!apiKey) throw new Error("Set FACTUAREA_API_KEY");const response = await fetch("https://api.factuarea.com/v1/companies/01931b3e-7c4a-7f2e-9a8b-3c5d6e7f8a01/promotions?limit=25", {  method: "GET",  headers: { Authorization: `Bearer ${apiKey}`, ...{"Accept":"application/json"} },});if (!response.ok) throw new Error(await response.text());if (response.status !== 204) console.log(await response.json());

Ejemplo de respuesta

{
  "data": [
    {
      "id": "01931b3e-7c4a-7f2e-9a8b-3c5d6e7fa001",
      "object": "promotion",
      "name": "Semana del jardín",
      "label": "Oferta",
      "status": "active",
      "currency": "EUR",
      "starts_on": "2026-10-26",
      "ends_on": "2026-11-02",
      "original_ends_on": "2026-11-02",
      "starts_at": "2026-10-26T00:00:00+01:00",
      "ends_at": "2026-11-02T23:59:59+01:00",
      "is_extension": false,
      "channels": {
        "documents": true,
        "web": true
      },
      "include_price_list_customers": false,
      "perishable": false,
      "history_complete": true,
      "history_complete_until": null,
      "items": [
        {
          "target_type": "product",
          "target_id": "01931b3e-7c4a-7f2e-9a8b-3c5d6e7fb001",
          "name": "Olivo en maceta",
          "selection_label": null,
          "sku": "OLIVO-60",
          "kind": "product",
          "tax_rate": 10,
          "mode": "percent_off",
          "value": "15.00",
          "basis": null,
          "regular_price": {
            "net": "39.00",
            "tax": "3.90",
            "gross": "42.90"
          },
          "price": {
            "net": "33.15",
            "tax": "3.32",
            "gross": "36.47"
          },
          "previous_price": {
            "net": "39.00",
            "tax": "3.90",
            "gross": "42.90"
          },
          "reduction_percent": 14.99,
          "announce_reduction": true
        },
        {
          "target_type": "variant",
          "target_id": "01931b3e-7c4a-7f2e-9a8b-3c5d6e7fb002",
          "name": "Maceta de terracota",
          "selection_label": "10,5 cm",
          "sku": "MACETA-TER-105",
          "kind": "product",
          "tax_rate": 21,
          "mode": "fixed",
          "value": "7.50",
          "basis": "gross",
          "regular_price": {
            "net": "8.00",
            "tax": "1.68",
            "gross": "9.68"
          },
          "price": {
            "net": "6.20",
            "tax": "1.30",
            "gross": "7.50"
          },
          "previous_price": {
            "net": "8.00",
            "tax": "1.68",
            "gross": "9.68"
          },
          "reduction_percent": 22.52,
          "announce_reduction": true
        }
      ],
      "created_at": "2026-10-20T09:15:00+02:00",
      "updated_at": "2026-10-20T09:15:00+02:00"
    },
    {
      "id": "01931b3e-7c4a-7f2e-9a8b-3c5d6e7fa002",
      "object": "promotion",
      "name": "Precio especial Pack Huerto",
      "label": "Oferta",
      "status": "scheduled",
      "currency": "EUR",
      "starts_on": "2026-11-14",
      "ends_on": "2026-11-30",
      "original_ends_on": "2026-11-30",
      "starts_at": "2026-11-14T00:00:00+01:00",
      "ends_at": "2026-11-30T23:59:59+01:00",
      "is_extension": false,
      "channels": {
        "documents": false,
        "web": true
      },
      "include_price_list_customers": false,
      "perishable": false,
      "history_complete": true,
      "history_complete_until": null,
      "items": [
        {
          "target_type": "pack",
          "target_id": "01931b3e-7c4a-7f2e-9a8b-3c5d6e7f9b01",
          "name": "Pack Huerto urbano",
          "selection_label": null,
          "sku": "PACK-HUERTO",
          "kind": "pack",
          "tax_rate": 10,
          "mode": "fixed",
          "value": "54.90",
          "basis": "gross",
          "regular_price": {
            "net": "54.45",
            "tax": "5.45",
            "gross": "59.90"
          },
          "price": {
            "net": "49.91",
            "tax": "4.99",
            "gross": "54.90"
          },
          "previous_price": {
            "net": "54.45",
            "tax": "5.45",
            "gross": "59.90"
          },
          "reduction_percent": 8.35,
          "announce_reduction": true
        }
      ],
      "created_at": "2026-10-22T11:40:00+02:00",
      "updated_at": "2026-10-22T11:40:00+02:00"
    }
  ],
  "has_more": false,
  "next_cursor": null
}

Query param desconocido

{
  "error": {
    "type": "invalid_request_error",
    "code": "parameter_unknown",
    "message": "El parámetro 'per_page' no está reconocido por este endpoint.",
    "param": "per_page",
    "doc_url": "https://docs.factuarea.com/guides/errors#parameter_unknown",
    "request_id": "req_01HKQS5N7UR6PWJ8K2T5BWPMZ9"
  }
}

El parámetro tiene un formato no válido

{
  "error": {
    "type": "invalid_request_error",
    "code": "parameter_invalid_format",
    "message": "El parámetro 'created' debe seguir el formato ISO-8601 (YYYY-MM-DDTHH:mm:ssZ).",
    "param": "created",
    "doc_url": "https://docs.factuarea.com/guides/errors#parameter_invalid_format",
    "request_id": "req_01HKQS5N7UR6PWJ8K2T5BWPMZA"
  }
}

El valor del parámetro está fuera de rango

{
  "error": {
    "type": "invalid_request_error",
    "code": "parameter_invalid_range",
    "message": "El parámetro 'limit' debe estar entre 1 y 100, recibido: 500.",
    "param": "limit",
    "doc_url": "https://docs.factuarea.com/guides/errors#parameter_invalid_range",
    "request_id": "req_01HKQS5N7UR6PWJ8K2T5BWPMZB"
  }
}

Se envió la cabecera X-Active-Profile retirada

{
  "error": {
    "type": "invalid_request_error",
    "code": "parameter_unknown",
    "subcode": "retired_active_profile_header",
    "message": "La cabecera 'X-Active-Profile' fue retirada de la API v1: la empresa efectiva se indica en el segmento de empresa de la ruta.",
    "param": "X-Active-Profile",
    "doc_url": "https://docs.factuarea.com/guides/errors#parameter_unknown",
    "request_id": "req_01J8Y3M2Q40000000000000001"
  }
}

Cabecera Factuarea-Version malformada

{
  "error": {
    "type": "invalid_request_error",
    "code": "parameter_invalid_format",
    "message": "El header 'Factuarea-Version' debe tener formato YYYY-MM-DD.",
    "param": "Factuarea-Version",
    "doc_url": "https://docs.factuarea.com/guides/errors#parameter_invalid_format",
    "request_id": "req_01J8Y3M2Q40000000000000002"
  }
}

Factuarea-Version no admitida

{
  "error": {
    "type": "invalid_request_error",
    "code": "unsupported_api_version",
    "message": "La versión de API '2020-01-01' no está soportada.",
    "param": "Factuarea-Version",
    "doc_url": "https://docs.factuarea.com/guides/errors#unsupported_api_version",
    "request_id": "req_01J8Y3M2Q40000000000000003"
  }
}

Falta la API key

{
  "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"
  }
}

Formato de API key no válido

{
  "error": {
    "type": "authentication_error",
    "code": "invalid_api_key",
    "message": "La API key no tiene el formato esperado (debe empezar por fact_live_ o fact_test_).",
    "param": null,
    "doc_url": "https://docs.factuarea.com/guides/errors#invalid_api_key",
    "request_id": "req_01HKQS5N9JTQM7HVTQP3FBN5XB"
  }
}

API key revocada

{
  "error": {
    "type": "authentication_error",
    "code": "api_key_revoked",
    "message": "Esta API key ha sido revocada y ya no es válida.",
    "param": null,
    "doc_url": "https://docs.factuarea.com/guides/errors#api_key_revoked",
    "request_id": "req_01HKQS5NA8K7E2V9YDZWMT6RJC"
  }
}

API key caducada

{
  "error": {
    "type": "authentication_error",
    "code": "api_key_expired",
    "message": "Esta API key ha caducado.",
    "param": null,
    "doc_url": "https://docs.factuarea.com/guides/errors#api_key_expired",
    "request_id": "req_01HKQS5NAPIKEYEXPIRED00008"
  }
}

IP de la petición fuera de la lista de acceso de la API key

{
  "error": {
    "type": "authentication_error",
    "code": "ip_not_allowed",
    "message": "La IP 203.0.113.10 no está autorizada para esta API key.",
    "param": null,
    "doc_url": "https://docs.factuarea.com/guides/errors#ip_not_allowed",
    "request_id": "req_01HKQS5NIPNOTALLOWED000009"
  }
}

La API key carece del scope requerido

{
  "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"
  }
}

Se requiere mejorar el plan

{
  "error": {
    "type": "authorization_error",
    "code": "feature_not_available_in_plan",
    "message": "Esta funcionalidad requiere el plan empresario o superior. Actualiza tu suscripción para acceder.",
    "param": null,
    "doc_url": "https://docs.factuarea.com/guides/errors#feature_not_available_in_plan",
    "request_id": "req_01HKQS5NCK4V9N2L7Y8X3WPMRE"
  }
}

Plan sin acceso a la API pública

{
  "error": {
    "type": "authorization_error",
    "code": "addon_not_active",
    "message": "Tu plan actual no incluye acceso a la API pública. Contrata o renueva un plan de Factuarea para usar la API.",
    "param": null,
    "doc_url": "https://docs.factuarea.com/guides/errors#addon_not_active",
    "request_id": "req_01HKQS5NDP5W0Q3M8Z9A4BVSNF"
  }
}

Módulo no disponible con una clave de prueba

{
  "error": {
    "type": "authorization_error",
    "code": "module_not_available_in_sandbox",
    "message": "El módulo \"verifactu\" no está disponible en modo de pruebas. Usa una clave fact_live_ para operar sobre este recurso.",
    "param": null,
    "doc_url": "https://docs.factuarea.com/guides/errors#module_not_available_in_sandbox",
    "request_id": "req_01HKQS5NMODULESANDBOX00010"
  }
}

Privilegio de proveedor de cuentas no concedido

{
  "error": {
    "type": "authorization_error",
    "code": "privileged_scope_required",
    "message": "Esta operación exige el privilegio de proveedor de cuentas (accounts:*) y la persona que emitió la clave debe ser propietaria o administradora de la cuenta",
    "param": null,
    "doc_url": "https://docs.factuarea.com/guides/errors#privileged_scope_required",
    "request_id": "req_01HKQS5NPRIVILEGEDSCOPE001"
  }
}

Operación de la cuenta propietaria sobre un NIF al que se llega por una relación

{
  "error": {
    "type": "authorization_error",
    "code": "forbidden_action",
    "message": "Esta operación solo la puede hacer la cuenta dueña del NIF: con un acceso por relación entre cuentas no está disponible.",
    "param": null,
    "doc_url": "https://docs.factuarea.com/guides/errors#forbidden_action",
    "request_id": "req_01HKQS5NRELATIONNIFOWNER01"
  }
}

Empresa desactivada

{
  "error": {
    "type": "authorization_error",
    "code": "company_inactive",
    "message": "Esta empresa está desactivada. Actívala para operar.",
    "param": "company",
    "doc_url": "https://docs.factuarea.com/guides/errors#company_inactive",
    "request_id": "req_01J8Y3M2Q40000000000000005"
  }
}

Recurso no encontrado

{
  "error": {
    "type": "not_found_error",
    "code": "resource_not_found",
    "message": "El recurso solicitado no existe o pertenece a otra empresa.",
    "param": null,
    "doc_url": "https://docs.factuarea.com/guides/errors#resource_not_found",
    "request_id": "req_01HKQS5NEQ6X1R4N9B0C5DWTPG"
  }
}

Empresa no encontrada o fuera del alcance de la API key

{
  "error": {
    "type": "not_found_error",
    "code": "profile_not_found",
    "message": "La empresa indicada no existe o no está en el ámbito de tu credencial.",
    "param": "company",
    "doc_url": "https://docs.factuarea.com/guides/errors#profile_not_found",
    "request_id": "req_01J8Y3M2Q40000000000000004"
  }
}

{
  "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"
  }
}

Límite de peticiones superado

{
  "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"
  }
}

Demasiados fallos de autenticación (bloqueo temporal)

{
  "error": {
    "type": "authentication_error",
    "code": "too_many_auth_failures",
    "message": "Has alcanzado el número máximo de intentos de autenticación fallidos. La API key queda bloqueada temporalmente. Reintenta tras el tiempo indicado en `Retry-After`.",
    "param": null,
    "doc_url": "https://docs.factuarea.com/guides/errors#too_many_auth_failures",
    "request_id": "req_01HKQS5NKW1C6W9T4G5H0JBZVM"
  }
}

Demasiadas subidas simultáneas en curso

{
  "error": {
    "type": "rate_limit_error",
    "code": "upload_in_flight_budget_exceeded",
    "message": "Tu empresa tiene demasiadas subidas en curso a la vez: este archivo ocupa 10 MB y el margen simultáneo es de 120 MB. Espera a que terminen las subidas en marcha y vuelve a intentarlo dentro de 45 segundos.",
    "param": null,
    "doc_url": "https://docs.factuarea.com/guides/errors#upload_in_flight_budget_exceeded",
    "request_id": "req_01HKQS5NUPLOADINFLIGHT005"
  }
}

Límite de peticiones de toda la empresa superado (todas las claves combinadas)

{
  "error": {
    "type": "rate_limit_error",
    "code": "company_rate_limit_exceeded",
    "message": "Tu empresa ha superado su límite conjunto de 900 peticiones por minuto, contando a la vez todas sus credenciales. Es un techo de la empresa, así que repartir el tráfico no lo eleva. Reintenta en 12 segundos, o solicita una ampliación de plan si necesitas más capacidad.",
    "param": null,
    "doc_url": "https://docs.factuarea.com/guides/errors#company_rate_limit_exceeded",
    "request_id": "req_01HKQS5NCOMPANYRATELIMIT06"
  }
}

Cuota mensual de toda la empresa agotada (todas las claves combinadas)

{
  "error": {
    "type": "rate_limit_error",
    "code": "company_monthly_quota_exceeded",
    "message": "Tu empresa ha agotado su cuota conjunta de 150000 peticiones de este mes, contando a la vez todas sus credenciales. Es un techo de la empresa, así que repartir el tráfico no lo eleva. El contador se reinicia el día 1 del mes siguiente; solicita una ampliación de plan si necesitas más volumen antes.",
    "param": null,
    "doc_url": "https://docs.factuarea.com/guides/errors#company_monthly_quota_exceeded",
    "request_id": "req_01HKQS5NCOMPANYMONTHLY0007"
  }
}

Cuota mensual de la API key agotada

{
  "error": {
    "type": "rate_limit_error",
    "code": "monthly_quota_exceeded",
    "message": "Has agotado tu cuota mensual de 100000 requests. Mejora tu plan para obtener una cuota superior.",
    "param": null,
    "doc_url": "https://docs.factuarea.com/guides/errors#monthly_quota_exceeded",
    "request_id": "req_01HKQS5NMONTHLYQUOTA000011"
  }
}

Límite de peticiones de la cartera superado (todos los NIF de la cuenta juntos)

{
  "error": {
    "type": "rate_limit_error",
    "code": "portfolio_rate_limit_exceeded",
    "message": "La cartera de tu cuenta ha superado su límite conjunto de 1800 peticiones por minuto, contando a la vez todos sus NIF. Es un techo de la cartera, así que repartir el tráfico entre NIF no lo eleva. Reintenta en 12 segundos, o solicita una ampliación de plan si necesitas más capacidad.",
    "param": null,
    "doc_url": "https://docs.factuarea.com/guides/errors#portfolio_rate_limit_exceeded",
    "request_id": "req_01HKQS5NPORTFOLIORATE00012"
  }
}

Cuota mensual de la cartera agotada (todos los NIF de la cuenta juntos)

{
  "error": {
    "type": "rate_limit_error",
    "code": "portfolio_monthly_quota_exceeded",
    "message": "La cartera de tu cuenta ha agotado su cuota conjunta de 300000 peticiones de este mes, contando a la vez todos sus NIF. Es un techo de la cartera, así que repartir el tráfico entre NIF no lo eleva. El contador se reinicia el día 1 del mes siguiente; solicita una ampliación de plan si necesitas más volumen antes.",
    "param": null,
    "doc_url": "https://docs.factuarea.com/guides/errors#portfolio_monthly_quota_exceeded",
    "request_id": "req_01HKQS5NPORTFOLIOMONTH0013"
  }
}

{
  "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"
  }
}

Listar todas las ofertas

Authorization

Parámetros de ruta

Parámetros de consulta

Headers

Cuerpo de la respuesta

200application/json

400application/json

401application/json

403application/json

404application/json

422application/json

429application/json

500application/json

`application/json`

`application/json`

`application/json`

`application/json`

`application/json`

`application/json`

`application/json`

`application/json`