Saltar al contenido
docs
Guías
EN
CatálogoNotificaciones
notification:read

Listar plantillas de notificación

GET/v1/notifications/templates

Listar plantillas de notificación. Una solicitud exitosa devuelve HTTP 200 con el cuerpo de respuesta documentado.

Autorización

bearerAuth
AutorizaciónBearer <token>

Token de acceso OAuth 2.0 emitido por Ecomiq Auth.

Ubicación: header

Parámetros de consulta

page?integer

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

Formatoint32
pageSize?integer
Formatoint32
search?string

Filtro de texto libre. Los campos consultados dependen del recurso.

sortBy?string

Campo de ordenamiento. Los valores admitidos dependen del recurso.

sortDirection?string

Dirección del ordenamiento: asc o desc.

Valor en

  • "asc"
  • "desc"
channel?string

Código del canal de venta.

Valor en

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

Solo elementos en estos estados.

key?string
locale?string

Código de idioma del contenido localizado.

scope?string

Alcance de la operación.

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://example.com/v1/notifications/templates?groups=example" \  -H "x-Store-Id: <store-id>" \  -H "Authorization: Bearer <token>"
{  "pageIndex": 1,  "pageSize": 1,  "count": 1,  "data": [    {      "id": "7204558912004325301",      "group": "example",      "name": "Example resource",      "key": "example",      "notification": "email",      "version": 1,      "status": "draft",      "storeId": "7204558912004325301"    }  ],  "totalPages": 1,  "hasPreviousPage": false,  "hasNextPage": false}