Catálogo de productos

Descripción

Devuelve los productos que tu organización tiene habilitados y que tu API Key tiene permiso de vender. Cada elemento es un producto vendible; su id es el carrier_id que envías en Realizar venta.

El catálogo es personal: dos claves con permisos distintos pueden ver catálogos distintos. Por ejemplo, una clave con solo sales.tae verá únicamente productos del grupo TAE.

URL API

BASE URLhttps://api.faxil.mx/api/v1

Autenticación

Header	Requerido	Permiso de la API Key
`x-api-key`	Sí	Al menos uno de `sales.tae`, `sales.services`, `sales.pins` (sin ninguno, la lista vuelve vacía).

Ejemplo de uso

Endpoint:

GETapi.faxil.mx/api/v1/tae/products

curl -s "$ORION_API/api/v1/tae/products" \
  -H "x-api-key: $ORION_API_KEY"

Body: No aplica

Respuestas

200 — Productos habilitados Success

{
  "error": false,
  "message": "Productos habilitados",
  "data": [
    {
      "id": 1,
      "name": "Telcel",
      "carrier_group": "TAE",
      "category_id": 1,
      "input_type": "PHONE",
      "is_active": true,
      "createdAt": "2026-07-15T18:20:11.000Z",
      "updatedAt": "2026-07-15T18:20:11.000Z"
    },
    {
      "id": 57,
      "name": "CFE",
      "carrier_group": "SERVICIO",
      "category_id": 6,
      "input_type": "REFERENCE",
      "is_active": true,
      "createdAt": "2026-08-02T16:04:52.000Z",
      "updatedAt": "2026-08-02T16:04:52.000Z",
      "fee_amount": 10,
      "fee_earning": 4
    },
    {
      "id": 88,
      "name": "Google Play",
      "carrier_group": "PIN",
      "category_id": 9,
      "input_type": "PHONE",
      "is_active": true,
      "createdAt": "2026-08-20T19:41:03.000Z",
      "updatedAt": "2026-08-20T19:41:03.000Z",
      "fee_amount": 0,
      "fee_earning": 0
    }
  ],
  "results": 3
}

401 / 403 — Autenticación Client Error

Ver Autenticación (API Key).

Parámetros de salida

Campo	Tipo	Descripción
`id`	number	Identificador del producto. Se envía como `carrier_id` al vender.
`name`	string	Nombre comercial del producto u operadora.
`carrier_group`	string	Grupo del producto. Define el permiso, la bolsa y las reglas del monto (ver tabla abajo).
`category_id`	number \| null	Categoría para agrupar productos en tu interfaz. Solo es de presentación.
`input_type`	string \| null	Qué dato se envía en `dn` al vender (ver tabla abajo).
`is_active`	boolean	Siempre `true` en esta lista.
`fee_amount`	number	Solo `SERVICIO` y `PIN`. Comisión que se cobra al cliente final además del monto.
`fee_earning`	number	Solo `SERVICIO` y `PIN`. Parte de esa comisión que gana tu organización.
`createdAt` / `updatedAt`	string (ISO 8601)	Fechas de alta y última modificación.

`carrier_group`

Valor	Qué vende	Bolsa	Permiso	Monto (`amount`)
`TAE`	Recargas de tiempo aire	`TAE`	`sales.tae`	Entero, uno de los montos autorizados para la operadora.
`SERVICIO`	Pago de servicios (luz, agua, TV, etc.)	`SERVICIOS`	`sales.services`	Libre, positivo, hasta 2 decimales (el importe del recibo).
`PIN`	Pines y tarjetas de regalo	`SERVICIOS`	`sales.pins`	Entero, una de las denominaciones autorizadas.

`input_type`

Valor	Qué enviar en `dn`
`PHONE`	Número celular a 10 dígitos.
`REFERENCE`	Referencia del servicio: número de contrato, de servicio, código de barras, etc.
`CREDIT`	Referencia del crédito a pagar.
`ESIM`	Teléfono de contacto a 10 dígitos del cliente. Además requiere `customer_name` y `customer_email` (ver Realizar venta).
`null`	Sin declarar: `TAE` y `PIN` usan `PHONE`; `SERVICIO` usa `REFERENCE`.

Probar endpoint

GEThttps://api.faxil.mx/api/v1/tae/products
Lista los productos que tu API Key puede vender.
Headers