Saltar al contenido
docs
EN
CatálogoColecciones

Listar colecciones

Devuelve colecciones paginadas por cursor, filtrables por tipo, estado, texto e IDs.

GET/v1/catalog/collections
Requiere un token de acceso con el permiso catalog:read.

Parámetros de consulta

limit?integer

Cantidad máxima de resultados por devolver.

Formatoint32
cursor?string

Cursor de la respuesta anterior. Omítelo en la primera página.

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"
type?string

Solo este tipo.

Valor en

  • "static"
  • "dynamic"
status?string

Solo elementos en estos estados.

Valor en

  • "draft"
  • "active"
types?array<>

Solo estos tipos de producto.

Valor en

  • "static"
  • "dynamic"
statuses?array<>

Solo elementos en estos estados.

Valor en

  • "draft"
  • "active"
excludeTypes?array<>

Excluye estos tipos de producto.

Valor en

  • "static"
  • "dynamic"
excludeStatuses?array<>

Valor en

  • "draft"
  • "active"
ids?array<ResourceId>

Solo estos identificadores.

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/catalog/collections" \  -H "x-Store-Id: <store-id>" \  -H "Authorization: Bearer <token>"
{  "data": [    {      "id": "7204558912004326958",      "storeId": "7204558912004327977",      "name": "Nueva temporada",      "slug": "nueva-temporada",      "status": "draft",      "image": {        "id": "7204558912004326958",        "url": "https://mi-tienda.ecomiq.app/collections/nueva-temporada"      },      "type": "static",      "dynamicOperator": "and",      "validFrom": "2026-09-28T15:30:00Z",      "validTo": "2026-09-28T15:30:00Z",      "ruleCount": 24,      "overrideCount": 24,      "productCount": 24,      "createdOn": "2026-09-28T15:30:00Z",      "updatedOn": "2026-09-28T15:30:00Z"    }  ],  "hasNextPage": true,  "nextCursor": "eyJpZCI6IjcyMDQ1NTg5MTIwMDQzMjUzMDEifQ",  "totalCount": 24}