Saltar al contenido
CatálogoProductos

Listar productos

Devuelve una lista paginada de productos según los filtros de catálogo enviados.

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"
searchNameAndSkuOnly?boolean

Busca solo en el nombre del producto, su SKU y los SKU de sus variantes, no en la descripción ni en los códigos de barras. El valor predeterminado es false.

productIds?array<ResourceId>

Solo estos productos.

status?array<>

Solo elementos en estos estados.

Valor en

  • "draft"
  • "active"
  • "inactive"
  • "outOfStock"
  • "discontinued"
  • "archived"
excludeStatus?array<>

Excluye los elementos en estos estados.

Valor en

  • "draft"
  • "active"
  • "inactive"
  • "outOfStock"
  • "discontinued"
  • "archived"
includeArchived?boolean

Incluye los elementos archivados.

categoryIds?array<ResourceId>

Solo elementos en estas categorías.

includeSubcategories?boolean

Incluye también los productos de las subcategorías de categoryIds, a cualquier profundidad. El valor predeterminado es false.

excludeCategoryIds?array<ResourceId>

Excluye los elementos en estas categorías.

brandIds?array<ResourceId>

Solo elementos de estas marcas.

excludeBrandIds?array<ResourceId>

Excluye los elementos de estas marcas.

storeIds?array<ResourceId>

Solo elementos de estas tiendas.

sellerIds?array<ResourceId>

Solo elementos de estos vendedores.

excludeSellerIds?array<ResourceId>

Excluye los elementos de estos vendedores.

skuIds?array<ResourceId>

Filtra por identificadores de variante.

skus?array<string>

Filtra por códigos SKU.

types?array<>

Solo estos tipos de producto.

Valor en

  • "product"
  • "service"
  • "bundle"
excludeTypes?array<>

Excluye estos tipos de producto.

Valor en

  • "product"
  • "service"
  • "bundle"
isFeatured?boolean

Solo elementos destacados.

ean?string

Filtra por código de barras EAN.

minPrice?number

Precio mínimo a incluir, en la moneda de la tienda.

Formatodouble
maxPrice?number

Precio máximo a incluir, en la moneda de la tienda.

Formatodouble
minDiscountPercent?number

Deja los productos cuyo precio está al menos este porcentaje por debajo de su precio de comparación, los dos de la variante activa más barata. Mayor que 0 y como máximo 100.

Formatodouble
minOnHand?integer

Existencias mínimas en almacén.

Formatoint32
maxOnHand?integer

Existencias máximas en almacén.

Formatoint32
minAvailable?integer

Existencias mínimas disponibles para vender.

Formatoint32
tags?array<string>

Solo elementos con alguna de estas etiquetas.

excludeTags?array<string>

Excluye los elementos con alguna de estas etiquetas.

includeVariants?boolean

Incluye las variantes de cada producto en la respuesta.

includeTotalCount?boolean

Incluye el total de coincidencias. Es más lento en catálogos grandes.

projection?string

Cuánto de cada elemento se devuelve.

Valor en

  • "summary"
  • "full"
channelIds?array<ResourceId>

Solo elementos de estos canales de venta.

sourceIds?array<ResourceId>

Solo elementos importados desde estos orígenes.

modifierGroupIds?array<ResourceId>

Solo elementos que usan estas personalizaciones.

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/products" \  -H "x-Store-Id: <store-id>" \  -H "Authorization: Bearer <token>"
{  "data": [    {      "id": "7204558912004322039",      "sku": "POL-001-AZ-M",      "storeId": "7204558912004327977",      "sellerId": "7204558912004323447",      "type": "product",      "name": "Polo de algodón",      "description": "Polo de algodón pima para uso diario.",      "slug": "polo-de-algodon",      "currency": "PEN",      "taxRate": 18,      "brand": "Andina",      "price": 89,      "compareAtPrice": 99,      "costPrice": 40,      "totalOnHand": 24,      "available": 24,      "committed": 1,      "totalVariants": 24,      "activeVariants": 1,      "tracksInventory": true,      "vendor": "Polo de algodón",      "tags": [        "algodón"      ],      "specifications": [        {          "name": "Polo de algodón",          "key": "color",          "value": "Polo de algodón",          "fromSeller": false        }      ],      "images": [        {          "id": "7204558912004322039",          "url": "https://mi-tienda.ecomiq.app/products/polo-de-algodon",          "name": "Polo de algodón",          "width": 30,          "height": 30,          "isPrimary": true,          "order": 1,          "type": "Polo de algodón"        }      ],      "category": "Polos",      "packageId": "7204558912004325646",      "shippingProfileId": "7204558912004329819",      "status": "draft",      "metaTitle": "Polo de algodón",      "metaDescription": "Polo de algodón pima para uso diario.",      "metaKeywords": [        "Polo de algodón"      ],      "featuredUntil": "2026-09-28T15:30:00Z",      "isFeatured": false,      "minOrderQuantity": 2,      "maxOrderQuantity": 2,      "isDigital": false,      "hasVariants": false,      "hasActivity": false,      "hasPriceLists": false,      "hasReviews": false,      "hasSizeGuide": false,      "hasModifiers": false,      "variants": [        {          "id": "7204558912004323197",          "storeId": "7204558912004327977",          "productId": "7204558912004322039",          "version": 3,          "packageId": "7204558912004325646",          "name": "Polo de algodón Azul / M",          "sku": "POL-001-AZ-M",          "barcode": "7751234567892",          "countryOfOrigin": "Polo de algodón Azul / M",          "hsCode": "POL-001",          "order": 1,          "isDefault": true,          "price": 89,          "compareAtPrice": 99,          "costPrice": 40,          "currency": "PEN",          "isDigital": false,          "trackInventory": true,          "allowBackorders": false,          "lowStockThreshold": 24,          "weight": 0.3,          "width": 30,          "height": 30,          "length": 30,          "unitOfMeasure": "kilogram",          "onHand": 24,          "committed": 1,          "available": 24,          "options": [            {              "name": "Polo de algodón Azul / M",              "key": "color",              "value": "Polo de algodón Azul / M"            }          ],          "images": [            {              "imageId": "7204558912004329435",              "order": 1,              "isPrimary": true            }          ],          "inventories": [            {              "id": "7204558912004326619",              "locationId": "7204558912004328277",              "onHand": 24,              "committed": 1,              "available": 24,              "incoming": 1,              "unavailable": 24,              "version": 3,              "createdOn": "2026-09-28T15:30:00Z",              "updatedOn": "2026-09-28T15:30:00Z"            }          ],          "status": "outOfStock",          "createdOn": "2026-09-28T15:30:00Z",          "updatedOn": "2026-09-28T15:30:00Z"        }      ],      "views": 1,      "salesCount": 24,      "reviewsCount": 24,      "createdOn": "2026-09-28T15:30:00Z",      "updatedOn": "2026-09-28T15:30:00Z",      "lastActivityOn": "2026-09-28T15:30:00Z"    }  ],  "hasNextPage": true,  "nextCursor": "eyJpZCI6IjcyMDQ1NTg5MTIwMDQzMjUzMDEifQ",  "totalCount": 24}