Saltar al contenido
docs
EN
CatálogoNotificaciones

Listar plantillas de notificación

Devuelve plantillas paginadas por page y pageSize; exige groups, filtra por canal e idioma.

GET/v1/notifications/templates
Requiere un token de acceso con el permiso notification:read.

Parámetros de consulta

page?integer

Número de página, empezando en uno.

Formatoint32
pageSize?integer
Formatoint32
search?string

Búsqueda de texto libre.

sortBy?string

Campo por el que se ordena.

sortDirection?string

Dirección del ordenamiento: asc o desc.

Valor en

  • "asc"
  • "desc"
channel?string

Canal de la notificación, como email o whatsApp.

Valor en

  • "email"
  • "sms"
  • "push"
  • "whatsApp"
  • "inApp"
  • "webhook"
groups*array<string>
statuses?array<>

Solo elementos en estos estados.

Valor en

  • "draft"
  • "active"
  • "archived"
key?string
locale?string

Código de idioma del contenido localizado.

scope?string

store para las plantillas propias de tu tienda, system para las predeterminadas.

Valor en

  • "system"
  • "store"

Parámetros de cabecera

x-Store-Id?string

Tienda sobre la que actúa la solicitud. No hace falta cuando el token ya está vinculado a una tienda.

Authorization*string

Token bearer OAuth 2.0.

Cuerpo de la respuesta

application/json

application/problem+json

application/problem+json

application/problem+json

application/problem+json

application/problem+json

curl -X GET "https://api.ecomiq.pe/api/v1/notifications/templates?groups=Confirmaci%C3%B3n+de+pedido" \  -H "x-Store-Id: <store-id>" \  -H "Authorization: Bearer <token>"
{  "pageIndex": 1,  "pageSize": 25,  "count": 24,  "data": [    {      "id": "7204558912004326810",      "group": "Confirmación de pedido",      "name": "Confirmación de pedido",      "key": "color",      "notification": "email",      "version": 3,      "status": "draft",      "storeId": "7204558912004327977"    }  ],  "totalPages": 1,  "hasPreviousPage": false,  "hasNextPage": true}