--- title: Gets all the catalog entries. slug: commerce-connect-15/service-api/x4AC-gets-all-the-catalog-entries docTags: createdAt: 2026-10-09T17:33:32.660Z --- { "id": "RnDvfmDPVQ6Iyc5mZpP-0", "type": "api-oas-v2", "data": { "method": "GET", "url": "/episerverapi/commerce/entries/{startPage}/{pageSize}", "servers": [], "name": "Gets all the catalog entries.", "description": "", "contentType": "application/json", "request": { "pathParameters": [ { "kind": "required", "name": "startPage", "type": "integer", "description": "The start page.", "format": "int32" }, { "kind": "required", "name": "pageSize", "type": "integer", "description": "Size of the page.", "format": "int32" } ], "headerParameters": [ { "name": "accept", "type": "string", "kind": "optional", "description": "Generated from available response content types", "enum": [ "text/plain", "application/json", "text/json" ], "default": "text/plain" } ], "queryParameters": [], "bodyDataParameters": [], "formDataParameters": [], "oAuthParameters": [], "cookieParameters": [] }, "responses": [ { "statusCode": "200", "description": "Return the catalog entries.", "jsonExample": "", "isExpanded": true, "schema": [ { "kind": "optional", "type": "object", "description": "", "customType": "Entries", "schema": [ { "name": "entryResults", "kind": "optional", "type": "array", "nullable": true, "description": "Gets or sets the entries.", "modelRef": "#/components/schemas/Entry", "customType": "Entry[]", "schema": [ { "name": "code", "kind": "optional", "type": "string", "nullable": true, "description": "Gets or sets the Catalog Entry Code." }, { "name": "name", "kind": "optional", "type": "string", "nullable": true, "description": "Gets or sets the name." }, { "name": "startDate", "kind": "optional", "type": "string", "description": "Gets or sets the start date.", "format": "date-time" }, { "name": "endDate", "kind": "optional", "type": "string", "description": "Gets or sets the end date.", "format": "date-time" }, { "name": "metaClass", "kind": "optional", "type": "string", "nullable": true, "description": "Gets or sets the MetaClass." }, { "name": "catalog", "kind": "optional", "type": "string", "nullable": true, "description": "Gets or sets the Catalog." }, { "name": "prices", "kind": "optional", "type": "array", "nullable": true, "description": "Gets or sets the price values.", "modelRef": "#/components/schemas/ResourceLink", "customType": "ResourceLink[]", "schema": [ { "name": "title", "kind": "optional", "type": "string", "nullable": true, "description": "Gets or sets the title." }, { "name": "type", "kind": "optional", "type": "string", "nullable": true, "description": "Gets or sets the type." }, { "name": "href", "kind": "optional", "type": "string", "nullable": true, "description": "Gets or sets the uri." }, { "name": "properties", "kind": "optional", "type": "array", "nullable": true, "description": "Gets or sets the properties.", "modelRef": "#/components/schemas/NameValue", "customType": "NameValue[]", "schema": [ { "name": "name", "kind": "optional", "type": "string", "nullable": true, "description": "Gets or sets the name." }, { "name": "value", "kind": "optional", "type": "string", "nullable": true, "description": "Gets or sets the type." } ] } ] }, { "name": "entryType", "kind": "optional", "type": "string", "nullable": true, "description": "Gets or sets the type of the entry." }, { "name": "childCatalogEntries", "kind": "optional", "type": "array", "nullable": true, "description": "Gets or sets the child catalog entries.", "modelRef": "#/components/schemas/ResourceLink", "customType": "ResourceLink[]", "schema": [ { "name": "title", "kind": "optional", "type": "string", "nullable": true, "description": "Gets or sets the title." }, { "name": "type", "kind": "optional", "type": "string", "nullable": true, "description": "Gets or sets the type." }, { "name": "href", "kind": "optional", "type": "string", "nullable": true, "description": "Gets or sets the uri." }, { "name": "properties", "kind": "optional", "type": "array", "nullable": true, "description": "Gets or sets the properties.", "modelRef": "#/components/schemas/NameValue", "customType": "NameValue[]", "schema": [ { "name": "name", "kind": "optional", "type": "string", "nullable": true, "description": "Gets or sets the name." }, { "name": "value", "kind": "optional", "type": "string", "nullable": true, "description": "Gets or sets the type." } ] } ] }, { "name": "inventoryStatus", "kind": "optional", "type": "string", "nullable": true, "description": "Gets or sets the flag indicating how inventory amounts are handled." }, { "name": "warehouseInventories", "kind": "optional", "type": "array", "nullable": true, "description": "Gets or sets the warehouse inventories.", "modelRef": "#/components/schemas/ResourceLink", "customType": "ResourceLink[]", "schema": [ { "name": "title", "kind": "optional", "type": "string", "nullable": true, "description": "Gets or sets the title." }, { "name": "type", "kind": "optional", "type": "string", "nullable": true, "description": "Gets or sets the type." }, { "name": "href", "kind": "optional", "type": "string", "nullable": true, "description": "Gets or sets the uri." }, { "name": "properties", "kind": "optional", "type": "array", "nullable": true, "description": "Gets or sets the properties.", "modelRef": "#/components/schemas/NameValue", "customType": "NameValue[]", "schema": [ { "name": "name", "kind": "optional", "type": "string", "nullable": true, "description": "Gets or sets the name." }, { "name": "value", "kind": "optional", "type": "string", "nullable": true, "description": "Gets or sets the type." } ] } ] }, { "name": "associations", "kind": "optional", "type": "array", "nullable": true, "description": "Gets or sets the associations.", "modelRef": "#/components/schemas/ResourceLink", "customType": "ResourceLink[]", "schema": [ { "name": "title", "kind": "optional", "type": "string", "nullable": true, "description": "Gets or sets the title." }, { "name": "type", "kind": "optional", "type": "string", "nullable": true, "description": "Gets or sets the type." }, { "name": "href", "kind": "optional", "type": "string", "nullable": true, "description": "Gets or sets the uri." }, { "name": "properties", "kind": "optional", "type": "array", "nullable": true, "description": "Gets or sets the properties.", "modelRef": "#/components/schemas/NameValue", "customType": "NameValue[]", "schema": [ { "name": "name", "kind": "optional", "type": "string", "nullable": true, "description": "Gets or sets the name." }, { "name": "value", "kind": "optional", "type": "string", "nullable": true, "description": "Gets or sets the type." } ] } ] }, { "name": "assets", "kind": "optional", "type": "array", "nullable": true, "description": "Gets or sets the assets.", "modelRef": "#/components/schemas/ResourceLink", "customType": "ResourceLink[]", "schema": [ { "name": "title", "kind": "optional", "type": "string", "nullable": true, "description": "Gets or sets the title." }, { "name": "type", "kind": "optional", "type": "string", "nullable": true, "description": "Gets or sets the type." }, { "name": "href", "kind": "optional", "type": "string", "nullable": true, "description": "Gets or sets the uri." }, { "name": "properties", "kind": "optional", "type": "array", "nullable": true, "description": "Gets or sets the properties.", "modelRef": "#/components/schemas/NameValue", "customType": "NameValue[]", "schema": [ { "name": "name", "kind": "optional", "type": "string", "nullable": true, "description": "Gets or sets the name." }, { "name": "value", "kind": "optional", "type": "string", "nullable": true, "description": "Gets or sets the type." } ] } ] }, { "name": "nodes", "kind": "optional", "type": "array", "nullable": true, "description": "Gets or sets the nodes.", "modelRef": "#/components/schemas/ResourceLink", "customType": "ResourceLink[]", "schema": [ { "name": "title", "kind": "optional", "type": "string", "nullable": true, "description": "Gets or sets the title." }, { "name": "type", "kind": "optional", "type": "string", "nullable": true, "description": "Gets or sets the type." }, { "name": "href", "kind": "optional", "type": "string", "nullable": true, "description": "Gets or sets the uri." }, { "name": "properties", "kind": "optional", "type": "array", "nullable": true, "description": "Gets or sets the properties.", "modelRef": "#/components/schemas/NameValue", "customType": "NameValue[]", "schema": [ { "name": "name", "kind": "optional", "type": "string", "nullable": true, "description": "Gets or sets the name." }, { "name": "value", "kind": "optional", "type": "string", "nullable": true, "description": "Gets or sets the type." } ] } ] }, { "name": "variation", "kind": "optional", "type": "object", "description": "", "modelRef": "#/components/schemas/VariationProperties", "customType": "VariationProperties", "schema": [ { "name": "minQuantity", "kind": "optional", "type": "number", "description": "Gets or sets the min quantity.", "format": "double" }, { "name": "maxQuantity", "kind": "optional", "type": "number", "description": "Gets or sets the max quantity.", "format": "double" }, { "name": "weight", "kind": "optional", "type": "number", "description": "Gets or sets the weight.", "format": "double" }, { "name": "taxCategory", "kind": "optional", "type": "string", "nullable": true, "description": "Gets or sets the tax category." } ] }, { "name": "dimension", "kind": "optional", "type": "object", "description": "

Model to indicate that an variation/package has shipment dimension properties.

", "modelRef": "#/components/schemas/DimensionProperties", "customType": "DimensionProperties", "schema": [ { "name": "length", "kind": "optional", "type": "number", "description": "Gets or sets the length.", "format": "double" }, { "name": "height", "kind": "optional", "type": "number", "description": "Gets or sets the height.", "format": "double" }, { "name": "width", "kind": "optional", "type": "number", "description": "Gets or sets the width.", "format": "double" } ] }, { "name": "isActive", "kind": "optional", "type": "boolean", "description": "Gets or sets a value indicating whether this instance is active." }, { "name": "metaFields", "kind": "optional", "type": "array", "nullable": true, "description": "Gets or sets the item attributes.", "modelRef": "#/components/schemas/MetaFieldProperty", "customType": "MetaFieldProperty[]", "schema": [ { "name": "name", "kind": "optional", "type": "string", "nullable": true, "description": "Gets or sets the name." }, { "name": "type", "kind": "optional", "type": "string", "nullable": true, "description": "Gets or sets the type." }, { "name": "data", "kind": "optional", "type": "array", "nullable": true, "description": "Gets or sets the data.", "modelRef": "#/components/schemas/MetaFieldData", "customType": "MetaFieldData[]", "schema": [ { "name": "language", "kind": "optional", "type": "string", "nullable": true, "description": "Gets or sets the language." }, { "name": "value", "kind": "optional", "type": "string", "nullable": true, "description": "Gets or sets the value." } ] } ] }, { "name": "seoInformation", "kind": "optional", "type": "array", "nullable": true, "description": "Gets or sets the SEO information.", "modelRef": "#/components/schemas/SeoInfo", "customType": "SeoInfo[]", "schema": [ { "name": "title", "kind": "optional", "type": "string", "nullable": true, "description": "Gets or sets the title." }, { "name": "uri", "kind": "optional", "type": "string", "nullable": true, "description": "Gets or sets the URI." }, { "name": "uriSegment", "kind": "optional", "type": "string", "nullable": true, "description": "Gets or sets the uri segment." }, { "name": "description", "kind": "optional", "type": "string", "nullable": true, "description": "Gets or sets the description." }, { "name": "keywords", "kind": "optional", "type": "string", "nullable": true, "description": "Gets or sets the keywords." }, { "name": "languageCode", "kind": "optional", "type": "string", "nullable": true, "description": "Gets or sets the language code." } ] }, { "name": "publishStatuses", "kind": "optional", "type": "array", "nullable": true, "description": "Gets or sets the publish statuses for language versions of this entry.", "modelRef": "#/components/schemas/PublishStatus", "customType": "PublishStatus[]", "schema": [ { "name": "language", "kind": "optional", "type": "string", "nullable": true, "description": "Gets or sets language version." }, { "name": "isPublished", "kind": "optional", "type": "boolean", "description": "Gets or sets the publish status." }, { "name": "startPublish", "kind": "optional", "type": "string", "nullable": true, "description": "

Gets or sets the start publish time, in UTC.

", "format": "date-time" }, { "name": "stopPublish", "kind": "optional", "type": "string", "nullable": true, "description": "

Gets or sets the stop publish time, in UTC.

", "format": "date-time" } ] } ] }, { "name": "totalCount", "kind": "optional", "type": "integer", "description": "Gets or sets the total count.", "format": "int32" }, { "name": "totalPages", "kind": "optional", "type": "integer", "description": "Gets or sets the total pages.", "format": "int32" } ], "modelRef": "#/components/schemas/Entries", "isExpanded": true } ] }, { "statusCode": "401", "description": "If user does not have enough permission for this request.", "jsonExample": "", "isExpanded": true } ], "hasXCodeSamples": false, "examples": { "languages": [ { "id": "D3atYIAC-T_k9mDmPetJC", "language": "curl", "label": "cURL", "code": "curl --request GET \\\n --url /episerverapi/commerce/entries/{startPage}/{pageSize} \\\n --header 'accept: text/plain'" }, { "id": "gfHq9JhzXXuih0RFmUVyL", "language": "javascript", "label": "javascript", "code": "var myHeaders = new Headers();\nmyHeaders.append(\"accept\", \"text/plain\");\nmyHeaders.append(\"content-type\", \"application/json\");\n\nvar requestOptions = {\n method: 'GET',\n headers: myHeaders,\n redirect: 'follow'\n};\n\nfetch(\"/episerverapi/commerce/entries/{startPage}/{pageSize}\", requestOptions)\n .then(response => response.text())\n .then(result => console.log(result))\n .catch(error => console.log('error', error));" }, { "id": "lucQRopQC8lNh_HiiXZZH", "language": "ruby", "label": "Ruby", "code": "require \"uri\"\nrequire \"json\"\nrequire \"net/http\"\n\nurl = URI(\"/episerverapi/commerce/entries/{startPage}/{pageSize}\")\n\nhttp = Net::HTTP.new(url.host, url.port);\nrequest = Net::HTTP::Get.new(url)\nrequest[\"accept\"] = \"text/plain\"\nrequest[\"content-type\"] = \"application/json\"\n\nresponse = http.request(request)\nputs response.read_body\n" }, { "id": "KZ6W2GKiSLJlCHB-iMmxQ", "language": "python", "label": "Python", "code": "import requests\nimport json\n\nurl = \"/episerverapi/commerce/entries/{startPage}/{pageSize}\"\n\npayload = {}\nheaders = {\n 'accept': 'text/plain',\n 'content-type': 'application/json'\n}\n\nresponse = requests.request(\"GET\", url, headers=headers, data=payload)\n\nprint(response.text)\n" } ], "selectedLanguageId": "D3atYIAC-T_k9mDmPetJC" }, "results": { "languages": [ { "id": "response-0-200", "language": "200", "code": "// Return the catalog entries.\n{\n \"entryResults\": [\n {\n \"code\": \"\",\n \"name\": \"\",\n \"startDate\": \"\",\n \"endDate\": \"\",\n \"metaClass\": \"\",\n \"catalog\": \"\",\n \"prices\": [\n {\n \"title\": \"\",\n \"type\": \"\",\n \"href\": \"\",\n \"properties\": [\n {\n \"name\": \"\",\n \"value\": \"\"\n }\n ]\n }\n ],\n \"entryType\": \"\",\n \"childCatalogEntries\": [\n {\n \"title\": \"\",\n \"type\": \"\",\n \"href\": \"\",\n \"properties\": [\n {\n \"name\": \"\",\n \"value\": \"\"\n }\n ]\n }\n ],\n \"inventoryStatus\": \"\",\n \"warehouseInventories\": [\n {\n \"title\": \"\",\n \"type\": \"\",\n \"href\": \"\",\n \"properties\": [\n {\n \"name\": \"\",\n \"value\": \"\"\n }\n ]\n }\n ],\n \"associations\": [\n {\n \"title\": \"\",\n \"type\": \"\",\n \"href\": \"\",\n \"properties\": [\n {\n \"name\": \"\",\n \"value\": \"\"\n }\n ]\n }\n ],\n \"assets\": [\n {\n \"title\": \"\",\n \"type\": \"\",\n \"href\": \"\",\n \"properties\": [\n {\n \"name\": \"\",\n \"value\": \"\"\n }\n ]\n }\n ],\n \"nodes\": [\n {\n \"title\": \"\",\n \"type\": \"\",\n \"href\": \"\",\n \"properties\": [\n {\n \"name\": \"\",\n \"value\": \"\"\n }\n ]\n }\n ],\n \"variation\": {\n \"minQuantity\": \"\",\n \"maxQuantity\": \"\",\n \"weight\": \"\",\n \"taxCategory\": \"\"\n },\n \"dimension\": {\n \"length\": \"\",\n \"height\": \"\",\n \"width\": \"\"\n },\n \"isActive\": false,\n \"metaFields\": [\n {\n \"name\": \"\",\n \"type\": \"\",\n \"data\": [\n {\n \"language\": \"\",\n \"value\": \"\"\n }\n ]\n }\n ],\n \"seoInformation\": [\n {\n \"title\": \"\",\n \"uri\": \"\",\n \"uriSegment\": \"\",\n \"description\": \"\",\n \"keywords\": \"\",\n \"languageCode\": \"\"\n }\n ],\n \"publishStatuses\": [\n {\n \"language\": \"\",\n \"isPublished\": false,\n \"startPublish\": \"\",\n \"stopPublish\": \"\"\n }\n ]\n }\n ],\n \"totalCount\": \"\",\n \"totalPages\": \"\"\n}" }, { "id": "response-1-401", "language": "401", "code": "// If user does not have enough permission for this request.\n" } ], "selectedLanguageId": "response-0-200" } }, "children": [ { "text": "" } ] }