--- updatedAt: 2026-06-30T16:05:21.000Z agentTools: projectIndex: https://docs.pelcro.com/llms.txt --- # List e-commerce products Retrieve a paginated list of e-commerce products. ## Overview Retrieve a paginated list of e-commerce products (type `good`) for your account. # OpenAPI definition ```json { "openapi": "3.1.0", "info": { "title": "core-api", "version": "1.88" }, "servers": [ { "url": "https://www.pelcro.com/api/v1/core" } ], "components": { "securitySchemes": { "sec0": { "type": "apiKey", "in": "header", "name": "Authorization", "x-bearer-format": "bearer" }, "sec1": { "type": "apiKey", "in": "query", "name": "site_id" } } }, "security": [ { "sec0": [], "sec1": [] } ], "paths": { "/ecommerce/products": { "get": { "summary": "List e-commerce products", "description": "Retrieve a paginated list of e-commerce products.", "operationId": "list-e-commerce-products", "parameters": [ { "name": "site_id", "in": "query", "description": "The unique identifier of the site associated with your account.", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "Authorization", "in": "header", "required": true, "schema": { "type": "string", "default": "Bearer eyJ***" } }, { "name": "limit", "in": "query", "description": "The maximum number of objects you want returned per result set. For instance, if you set limit=10, the API will return a maximum of 10 objects in the response. (max: 100)", "schema": { "type": "integer", "format": "int32", "default": 10 } }, { "name": "page", "in": "query", "description": "The specific page of the result set you want to retrieve, typically used in conjunction with limit. For example, if you set page=2 and limit=10, the API will return the second page of results, containing a maximum of 10 objects starting from the 11th object.", "schema": { "type": "integer", "format": "int32", "default": 1 } } ], "responses": { "200": { "description": "Success.", "content": { "application/json": { "examples": { "Result": { "value": "{\n\t\"data\": [\n\t\t{\n\t\t\t\"id\": 23,\n\t\t\t\"name\": \"Electronics\",\n\t\t\t\"caption\": null,\n\t\t\t\"description\": null,\n\t\t\t\"shippable\": true,\n\t\t\t\"countries\": null,\n\t\t\t\"image\": null,\n\t\t\t\"sites\": [\n\t\t\t\t14\n\t\t\t]\n\t\t},\n\t\t{\n\t\t\t\"id\": 85,\n\t\t\t\"name\": \"Accessories\",\n\t\t\t\"caption\": null,\n\t\t\t\"description\": null,\n\t\t\t\"shippable\": true,\n\t\t\t\"countries\": null,\n\t\t\t\"image\": null,\n\t\t\t\"sites\": [\n\t\t\t\t14,\n\t\t\t\t60\n\t\t\t]\n\t\t}\n\t],\n\t\"links\": {\n\t\t\"first\": \"https:\\/\\/ecssandbox.pelcro.com\\/api\\/v1\\/core\\/ecommerce\\/products?page=1\",\n\t\t\"last\": \"https:\\/\\/ecssandbox.pelcro.com\\/api\\/v1\\/core\\/ecommerce\\/products?page=12\",\n\t\t\"prev\": null,\n\t\t\"next\": \"https:\\/\\/ecssandbox.pelcro.com\\/api\\/v1\\/core\\/ecommerce\\/products?page=2\"\n\t},\n\t\"meta\": {\n\t\t\"current_page\": 1,\n\t\t\"from\": 1,\n\t\t\"last_page\": 12,\n\t\t\"links\": [\n\t\t\t{\n\t\t\t\t\"url\": null,\n\t\t\t\t\"label\": \"« Previous\",\n\t\t\t\t\"active\": false\n\t\t\t},\n\t\t\t{\n\t\t\t\t\"url\": \"https:\\/\\/ecssandbox.pelcro.com\\/api\\/v1\\/core\\/ecommerce\\/products?page=1\",\n\t\t\t\t\"label\": \"1\",\n\t\t\t\t\"active\": true\n\t\t\t},\n\t\t\t{\n\t\t\t\t\"url\": \"https:\\/\\/ecssandbox.pelcro.com\\/api\\/v1\\/core\\/ecommerce\\/products?page=2\",\n\t\t\t\t\"label\": \"2\",\n\t\t\t\t\"active\": false\n\t\t\t},\n\t\t\t{\n\t\t\t\t\"url\": \"https:\\/\\/ecssandbox.pelcro.com\\/api\\/v1\\/core\\/ecommerce\\/products?page=3\",\n\t\t\t\t\"label\": \"3\",\n\t\t\t\t\"active\": false\n\t\t\t},\n\t\t\t{\n\t\t\t\t\"url\": \"https:\\/\\/ecssandbox.pelcro.com\\/api\\/v1\\/core\\/ecommerce\\/products?page=4\",\n\t\t\t\t\"label\": \"4\",\n\t\t\t\t\"active\": false\n\t\t\t},\n\t\t\t{\n\t\t\t\t\"url\": \"https:\\/\\/ecssandbox.pelcro.com\\/api\\/v1\\/core\\/ecommerce\\/products?page=5\",\n\t\t\t\t\"label\": \"5\",\n\t\t\t\t\"active\": false\n\t\t\t},\n\t\t\t{\n\t\t\t\t\"url\": \"https:\\/\\/ecssandbox.pelcro.com\\/api\\/v1\\/core\\/ecommerce\\/products?page=6\",\n\t\t\t\t\"label\": \"6\",\n\t\t\t\t\"active\": false\n\t\t\t},\n\t\t\t{\n\t\t\t\t\"url\": \"https:\\/\\/ecssandbox.pelcro.com\\/api\\/v1\\/core\\/ecommerce\\/products?page=7\",\n\t\t\t\t\"label\": \"7\",\n\t\t\t\t\"active\": false\n\t\t\t},\n\t\t\t{\n\t\t\t\t\"url\": \"https:\\/\\/ecssandbox.pelcro.com\\/api\\/v1\\/core\\/ecommerce\\/products?page=8\",\n\t\t\t\t\"label\": \"8\",\n\t\t\t\t\"active\": false\n\t\t\t},\n\t\t\t{\n\t\t\t\t\"url\": \"https:\\/\\/ecssandbox.pelcro.com\\/api\\/v1\\/core\\/ecommerce\\/products?page=9\",\n\t\t\t\t\"label\": \"9\",\n\t\t\t\t\"active\": false\n\t\t\t},\n\t\t\t{\n\t\t\t\t\"url\": \"https:\\/\\/ecssandbox.pelcro.com\\/api\\/v1\\/core\\/ecommerce\\/products?page=10\",\n\t\t\t\t\"label\": \"10\",\n\t\t\t\t\"active\": false\n\t\t\t},\n\t\t\t{\n\t\t\t\t\"url\": \"https:\\/\\/ecssandbox.pelcro.com\\/api\\/v1\\/core\\/ecommerce\\/products?page=11\",\n\t\t\t\t\"label\": \"11\",\n\t\t\t\t\"active\": false\n\t\t\t},\n\t\t\t{\n\t\t\t\t\"url\": \"https:\\/\\/ecssandbox.pelcro.com\\/api\\/v1\\/core\\/ecommerce\\/products?page=12\",\n\t\t\t\t\"label\": \"12\",\n\t\t\t\t\"active\": false\n\t\t\t},\n\t\t\t{\n\t\t\t\t\"url\": \"https:\\/\\/ecssandbox.pelcro.com\\/api\\/v1\\/core\\/ecommerce\\/products?page=2\",\n\t\t\t\t\"label\": \"Next »\",\n\t\t\t\t\"active\": false\n\t\t\t}\n\t\t],\n\t\t\"path\": \"https:\\/\\/ecssandbox.pelcro.com\\/api\\/v1\\/core\\/ecommerce\\/products\",\n\t\t\"per_page\": 2,\n\t\t\"to\": 2,\n\t\t\"total\": 23\n\t}\n}" } }, "schema": { "type": "object", "properties": { "data": { "type": "array", "items": { "type": "object", "properties": { "id": { "type": "integer", "example": 23, "default": 0 }, "name": { "type": "string", "example": "Electronics" }, "caption": {}, "description": {}, "shippable": { "type": "boolean", "example": true, "default": true }, "countries": {}, "image": {}, "sites": { "type": "array", "items": { "type": "integer", "example": 14, "default": 0 } } } } }, "links": { "type": "object", "properties": { "first": { "type": "string", "example": "https://ecssandbox.pelcro.com/api/v1/core/ecommerce/products?page=1" }, "last": { "type": "string", "example": "https://ecssandbox.pelcro.com/api/v1/core/ecommerce/products?page=12" }, "prev": {}, "next": { "type": "string", "example": "https://ecssandbox.pelcro.com/api/v1/core/ecommerce/products?page=2" } } }, "meta": { "type": "object", "properties": { "current_page": { "type": "integer", "example": 1, "default": 0 }, "from": { "type": "integer", "example": 1, "default": 0 }, "last_page": { "type": "integer", "example": 12, "default": 0 }, "links": { "type": "array", "items": { "type": "object", "properties": { "url": {}, "label": { "type": "string", "example": "« Previous" }, "active": { "type": "boolean", "example": false, "default": true } } } }, "path": { "type": "string", "example": "https://ecssandbox.pelcro.com/api/v1/core/ecommerce/products" }, "per_page": { "type": "integer", "example": 2, "default": 0 }, "to": { "type": "integer", "example": 2, "default": 0 }, "total": { "type": "integer", "example": 23, "default": 0 } } } } } } } }, "401": { "description": "Unauthenticated.", "content": { "application/json": { "examples": { "Result": { "value": { "error": "Unauthenticated." } } } } } } }, "deprecated": false } } }, "x-readme": { "headers": [], "explorer-enabled": true, "proxy-enabled": true }, "x-readme-fauxas": true } ``` # Sibling pages * [/ecommerce/products/{id}](https://docs.pelcro.com/reference/api-core-get-ecommerce-product.md) * [Create e-commerce product](https://docs.pelcro.com/reference/api-core-create-ecommerce-product.md) * [Update e-commerce product](https://docs.pelcro.com/reference/api-core-update-ecommerce-product.md) * [Delete e-commerce product](https://docs.pelcro.com/reference/api-core-delete-ecommerce-product.md)