Listar productos
Devuelve una lista paginada de productos según los filtros de catálogo enviados.
/v1/catalog/productsDevuelve una lista paginada de productos según los filtros de catálogo enviados.
Autorización
bearerAuth Token de acceso OAuth 2.0 emitido por Ecomiq Auth.
Ubicación: header
Parámetros de consulta
Cantidad máxima de resultados por devolver.
int32Cursor opaco de la respuesta anterior. Omítelo en la primera página.
Filtro de texto libre. Los campos consultados dependen del recurso.
Campo de ordenamiento. Los valores admitidos dependen del recurso.
Dirección del ordenamiento: asc o desc.
Valor en
- "asc"
- "desc"
Solo estos productos.
Solo elementos en estos estados.
Excluye los elementos en estos estados.
Incluye los elementos archivados.
Solo elementos en estas categorías.
Excluye los elementos en estas categorías.
Solo elementos de estas marcas.
Excluye los elementos de estas marcas.
Solo elementos de estas tiendas.
Solo elementos de estos vendedores.
Excluye los elementos de estos vendedores.
Filtra por identificadores de variante.
Filtra por códigos SKU.
Solo estos tipos de producto.
Excluye estos tipos de producto.
Solo elementos destacados.
Filtra por código de barras EAN.
Precio mínimo a incluir, en la moneda de la tienda.
doublePrecio máximo a incluir, en la moneda de la tienda.
doubleExistencias mínimas en almacén.
int32Existencias máximas en almacén.
int32Incluye las variantes de cada producto en la respuesta.
Incluye el total de coincidencias. Es más lento en catálogos grandes.
Cuánto de cada elemento se devuelve.
Valor en
- "summary"
- "full"
- "spreadsheet"
Identificador del canal de venta.
Solo elementos importados desde estos orígenes.
Parámetros de cabecera
Tienda sobre la que actúa la solicitud. No hace falta cuando el token ya está vinculado a una tienda.
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/catalog/products" \ -H "x-Store-Id: <store-id>" \ -H "Authorization: Bearer <token>"{ "data": [ { "id": "7204558912004325301", "sku": "SKU-001", "storeId": "7204558912004325301", "sellerId": "7204558912004325301", "type": "product", "name": "Example resource", "description": "Example description.", "slug": "example-resource", "currency": "PEN", "taxRate": 1, "taxIncluded": false, "brand": "example", "price": 1, "compareAtPrice": 1, "costPrice": 1, "totalOnHand": 1, "available": 1, "committed": 1, "totalVariants": 1, "activeVariants": 1, "tracksInventory": false, "vendor": "example", "tags": [ "example" ], "specifications": [ { "name": "Example resource", "key": "example", "value": "example" } ], "images": [ { "id": "7204558912004325301", "url": "https://example.com/resource", "name": "Example resource", "width": 1, "height": 1, "isPrimary": false, "order": 1 } ], "category": "example", "packageId": "7204558912004325301", "shippingProfileId": "7204558912004325301", "status": "draft", "metaTitle": "Example title", "metaDescription": "Example description.", "metaKeywords": [ "example" ], "featuredUntil": "2026-08-01T15:30:00Z", "isFeatured": false, "minOrderQuantity": 1, "maxOrderQuantity": 1, "isDigital": false, "hasVariants": false, "hasActivity": false, "hasPriceLists": false, "hasReviews": false, "hasSizeGuide": false, "variants": [ { "id": "7204558912004325301", "storeId": "7204558912004325301", "productId": "7204558912004325301", "version": 1, "packageId": "7204558912004325301", "name": "Example resource", "sku": "SKU-001", "barcode": "7751234567890", "countryOfOrigin": "example", "hsCode": "example_code", "order": 1, "isDefault": false, "price": 1, "compareAtPrice": 1, "costPrice": 1, "currency": "PEN", "isDigital": false, "trackInventory": false, "allowBackorders": false, "lowStockThreshold": 1, "weight": 1, "width": 1, "height": 1, "length": 1, "unitOfMeasure": "kilogram", "onHand": 1, "committed": 1, "available": 1, "options": [ { "name": "Example resource", "key": "example", "value": "example" } ], "images": [ { "imageId": "7204558912004325301", "order": 1, "isPrimary": false } ], "inventories": [ { "id": "7204558912004325301", "locationId": "7204558912004325301", "onHand": 1, "committed": 1, "available": 1, "incoming": 1, "unavailable": 1, "version": 1, "createdOn": "2026-08-01T15:30:00Z", "updatedOn": "2026-08-01T15:30:00Z" } ], "status": "outOfStock", "createdOn": "2026-08-01T15:30:00Z", "updatedOn": "2026-08-01T15:30:00Z" } ], "views": 1, "salesCount": 1, "reviewsCount": 1, "createdOn": "2026-08-01T15:30:00Z", "updatedOn": "2026-08-01T15:30:00Z", "lastActivityOn": "2026-08-01T15:30:00Z" } ], "hasNextPage": false, "nextCursor": "example", "totalCount": 1}