--- title: Gets all the catalog entries. slug: commerce-connect-15/service-api/gets-all-the-catalog-entries docTags: createdAt: 2026-10-09T17:33:31.176Z --- { "id": "dpvJlMMBAAKB20jE0PA9T", "type": "api-oas-v2", "data": { "method": "GET", "url": "http://localhost:64424/episerverapi/commerce/entries/{startPage}/{pageSize}", "servers": [ { "url": "http://localhost:64424/episerverapi/commerce/entries/{startPage}/{pageSize}" }, { "url": "https://localhost:64424/episerverapi/commerce/entries/{startPage}/{pageSize}" } ], "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": [ "application/json" ], "default": "application/json" } ], "queryParameters": [], "bodyDataParameters": [], "formDataParameters": [], "oAuthParameters": [], "cookieParameters": [] }, "responses": [ { "statusCode": "200", "description": "Return the catalog entries.", "jsonExample": "", "isExpanded": true, "schema": [ { "kind": "optional", "type": "object", "description": "", "customType": "EPiServer.ServiceApi.Commerce.Models.Catalog.Entries", "schema": [ { "name": "EntryResults", "kind": "optional", "type": "array", "description": "Gets or sets the entries.", "modelRef": "#/components/schemas/EPiServer.ServiceApi.Commerce.Models.Catalog.Entry", "customType": "EPiServer.ServiceApi.Commerce.Models.Catalog.Entry[]", "schema": [ { "name": "IsActive", "kind": "optional", "type": "boolean", "description": "Gets or sets a value indicating whether this instance is active." }, { "name": "MetaFields", "kind": "optional", "type": "array", "description": "Gets or sets the item attributes.", "modelRef": "#/components/schemas/EPiServer.ServiceApi.Commerce.Models.Catalog.MetaFieldProperty", "customType": "EPiServer.ServiceApi.Commerce.Models.Catalog.MetaFieldProperty[]", "schema": [ { "name": "Data", "kind": "optional", "type": "array", "description": "Gets or sets the data.", "modelRef": "#/components/schemas/EPiServer.ServiceApi.Commerce.Models.Catalog.MetaFieldData", "customType": "EPiServer.ServiceApi.Commerce.Models.Catalog.MetaFieldData[]", "schema": [ { "name": "Language", "kind": "optional", "type": "string", "description": "Gets or sets the language." }, { "name": "Value", "kind": "optional", "type": "string", "description": "Gets or sets the value." } ] }, { "name": "Name", "kind": "optional", "type": "string", "description": "Gets or sets the name." }, { "name": "Type", "kind": "optional", "type": "string", "description": "Gets or sets the type." } ] }, { "name": "SeoInformation", "kind": "optional", "type": "array", "description": "Gets or sets the SEO information.", "modelRef": "#/components/schemas/EPiServer.ServiceApi.Commerce.Models.Catalog.SeoInfo", "customType": "EPiServer.ServiceApi.Commerce.Models.Catalog.SeoInfo[]", "schema": [ { "name": "LanguageCode", "kind": "optional", "type": "string", "description": "Gets or sets the language code." }, { "name": "Title", "kind": "optional", "type": "string", "description": "Gets or sets the title." }, { "name": "Uri", "kind": "optional", "type": "string", "description": "Gets or sets the URI." }, { "name": "UriSegment", "kind": "optional", "type": "string", "description": "Gets or sets the uri segment." }, { "name": "Description", "kind": "optional", "type": "string", "description": "Gets or sets the description." }, { "name": "Keywords", "kind": "optional", "type": "string", "description": "Gets or sets the keywords." } ] }, { "name": "PublishStatuses", "kind": "optional", "type": "array", "description": "Gets or sets the publish statuses for language versions of this entry.", "modelRef": "#/components/schemas/EPiServer.ServiceApi.Commerce.Models.Catalog.PublishStatus", "customType": "EPiServer.ServiceApi.Commerce.Models.Catalog.PublishStatus[]", "schema": [ { "name": "Language", "kind": "optional", "type": "string", "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", "description": "

Gets or sets the start publish time, in UTC.

", "format": "date-time" }, { "name": "StopPublish", "kind": "optional", "type": "string", "description": "

Gets or sets the stop publish time, in UTC.

", "format": "date-time" } ] }, { "name": "Code", "kind": "optional", "type": "string", "description": "Gets or sets the Catalog Entry Code." }, { "name": "Name", "kind": "optional", "type": "string", "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", "description": "Gets or sets the MetaClass." }, { "name": "Catalog", "kind": "optional", "type": "string", "description": "Gets or sets the Catalog." }, { "name": "Prices", "kind": "optional", "type": "array", "description": "Gets or sets the price values.", "modelRef": "#/components/schemas/EPiServer.ServiceApi.Models.ResourceLink", "customType": "EPiServer.ServiceApi.Models.ResourceLink[]", "schema": [ { "name": "Title", "kind": "optional", "type": "string", "description": "Gets or sets the title." }, { "name": "Type", "kind": "optional", "type": "string", "description": "Gets or sets the type." }, { "name": "Href", "kind": "optional", "type": "string", "description": "Gets or sets the uri." }, { "name": "Properties", "kind": "optional", "type": "array", "description": "Gets or sets the properties.", "modelRef": "#/components/schemas/EPiServer.ServiceApi.Models.NameValue", "customType": "EPiServer.ServiceApi.Models.NameValue[]", "schema": [ { "name": "Name", "kind": "optional", "type": "string", "description": "Gets or sets the name." }, { "name": "Value", "kind": "optional", "type": "string", "description": "Gets or sets the type." } ] } ] }, { "name": "EntryType", "kind": "optional", "type": "string", "description": "Gets or sets the type of the entry." }, { "name": "ChildCatalogEntries", "kind": "optional", "type": "array", "description": "Gets or sets the child catalog entries.", "modelRef": "#/components/schemas/EPiServer.ServiceApi.Models.ResourceLink", "customType": "EPiServer.ServiceApi.Models.ResourceLink[]", "schema": [ { "name": "Title", "kind": "optional", "type": "string", "description": "Gets or sets the title." }, { "name": "Type", "kind": "optional", "type": "string", "description": "Gets or sets the type." }, { "name": "Href", "kind": "optional", "type": "string", "description": "Gets or sets the uri." }, { "name": "Properties", "kind": "optional", "type": "array", "description": "Gets or sets the properties.", "modelRef": "#/components/schemas/EPiServer.ServiceApi.Models.NameValue", "customType": "EPiServer.ServiceApi.Models.NameValue[]", "schema": [ { "name": "Name", "kind": "optional", "type": "string", "description": "Gets or sets the name." }, { "name": "Value", "kind": "optional", "type": "string", "description": "Gets or sets the type." } ] } ] }, { "name": "InventoryStatus", "kind": "optional", "type": "string", "description": "Gets or sets the flag indicating how inventory amounts are handled." }, { "name": "WarehouseInventories", "kind": "optional", "type": "array", "description": "Gets or sets the warehouse inventories.", "modelRef": "#/components/schemas/EPiServer.ServiceApi.Models.ResourceLink", "customType": "EPiServer.ServiceApi.Models.ResourceLink[]", "schema": [ { "name": "Title", "kind": "optional", "type": "string", "description": "Gets or sets the title." }, { "name": "Type", "kind": "optional", "type": "string", "description": "Gets or sets the type." }, { "name": "Href", "kind": "optional", "type": "string", "description": "Gets or sets the uri." }, { "name": "Properties", "kind": "optional", "type": "array", "description": "Gets or sets the properties.", "modelRef": "#/components/schemas/EPiServer.ServiceApi.Models.NameValue", "customType": "EPiServer.ServiceApi.Models.NameValue[]", "schema": [ { "name": "Name", "kind": "optional", "type": "string", "description": "Gets or sets the name." }, { "name": "Value", "kind": "optional", "type": "string", "description": "Gets or sets the type." } ] } ] }, { "name": "Associations", "kind": "optional", "type": "array", "description": "Gets or sets the associations.", "modelRef": "#/components/schemas/EPiServer.ServiceApi.Models.ResourceLink", "customType": "EPiServer.ServiceApi.Models.ResourceLink[]", "schema": [ { "name": "Title", "kind": "optional", "type": "string", "description": "Gets or sets the title." }, { "name": "Type", "kind": "optional", "type": "string", "description": "Gets or sets the type." }, { "name": "Href", "kind": "optional", "type": "string", "description": "Gets or sets the uri." }, { "name": "Properties", "kind": "optional", "type": "array", "description": "Gets or sets the properties.", "modelRef": "#/components/schemas/EPiServer.ServiceApi.Models.NameValue", "customType": "EPiServer.ServiceApi.Models.NameValue[]", "schema": [ { "name": "Name", "kind": "optional", "type": "string", "description": "Gets or sets the name." }, { "name": "Value", "kind": "optional", "type": "string", "description": "Gets or sets the type." } ] } ] }, { "name": "Assets", "kind": "optional", "type": "array", "description": "Gets or sets the assets.", "modelRef": "#/components/schemas/EPiServer.ServiceApi.Models.ResourceLink", "customType": "EPiServer.ServiceApi.Models.ResourceLink[]", "schema": [ { "name": "Title", "kind": "optional", "type": "string", "description": "Gets or sets the title." }, { "name": "Type", "kind": "optional", "type": "string", "description": "Gets or sets the type." }, { "name": "Href", "kind": "optional", "type": "string", "description": "Gets or sets the uri." }, { "name": "Properties", "kind": "optional", "type": "array", "description": "Gets or sets the properties.", "modelRef": "#/components/schemas/EPiServer.ServiceApi.Models.NameValue", "customType": "EPiServer.ServiceApi.Models.NameValue[]", "schema": [ { "name": "Name", "kind": "optional", "type": "string", "description": "Gets or sets the name." }, { "name": "Value", "kind": "optional", "type": "string", "description": "Gets or sets the type." } ] } ] }, { "name": "Nodes", "kind": "optional", "type": "array", "description": "Gets or sets the nodes.", "modelRef": "#/components/schemas/EPiServer.ServiceApi.Models.ResourceLink", "customType": "EPiServer.ServiceApi.Models.ResourceLink[]", "schema": [ { "name": "Title", "kind": "optional", "type": "string", "description": "Gets or sets the title." }, { "name": "Type", "kind": "optional", "type": "string", "description": "Gets or sets the type." }, { "name": "Href", "kind": "optional", "type": "string", "description": "Gets or sets the uri." }, { "name": "Properties", "kind": "optional", "type": "array", "description": "Gets or sets the properties.", "modelRef": "#/components/schemas/EPiServer.ServiceApi.Models.NameValue", "customType": "EPiServer.ServiceApi.Models.NameValue[]", "schema": [ { "name": "Name", "kind": "optional", "type": "string", "description": "Gets or sets the name." }, { "name": "Value", "kind": "optional", "type": "string", "description": "Gets or sets the type." } ] } ] }, { "name": "Variation", "kind": "optional", "type": "object", "description": "", "modelRef": "#/components/schemas/EPiServer.ServiceApi.Commerce.Models.Catalog.VariationProperties", "customType": "EPiServer.ServiceApi.Commerce.Models.Catalog.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", "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/EPiServer.ServiceApi.Commerce.Models.Catalog.DimensionProperties", "customType": "EPiServer.ServiceApi.Commerce.Models.Catalog.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": "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/EPiServer.ServiceApi.Commerce.Models.Catalog.Entries", "isExpanded": true } ] }, { "statusCode": "401", "description": "If user does not have enough permission for this request.", "jsonExample": "", "isExpanded": true } ], "hasXCodeSamples": false, "examples": { "languages": [ { "id": "4eGgZHBP2GpOKZ_yaWVMF", "language": "curl", "label": "cURL", "code": "curl --request GET \\\n --url http://localhost:64424/episerverapi/commerce/entries/{startPage}/{pageSize} \\\n --header 'accept: application/json'" }, { "id": "loqD8r4UlEpFBGySnmOUf", "language": "javascript", "label": "javascript", "code": "var myHeaders = new Headers();\nmyHeaders.append(\"accept\", \"application/json\");\nmyHeaders.append(\"content-type\", \"application/json\");\n\nvar requestOptions = {\n method: 'GET',\n headers: myHeaders,\n redirect: 'follow'\n};\n\nfetch(\"http://localhost:64424/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": "Sn7bTsbdUGoD0AqAZl7nT", "language": "ruby", "label": "Ruby", "code": "require \"uri\"\nrequire \"json\"\nrequire \"net/http\"\n\nurl = URI(\"http://localhost:64424/episerverapi/commerce/entries/{startPage}/{pageSize}\")\n\nhttp = Net::HTTP.new(url.host, url.port);\nrequest = Net::HTTP::Get.new(url)\nrequest[\"accept\"] = \"application/json\"\nrequest[\"content-type\"] = \"application/json\"\n\nresponse = http.request(request)\nputs response.read_body\n" }, { "id": "8RWwYEpuFFCl-gC5JCQvg", "language": "python", "label": "Python", "code": "import requests\nimport json\n\nurl = \"http://localhost:64424/episerverapi/commerce/entries/{startPage}/{pageSize}\"\n\npayload = {}\nheaders = {\n 'accept': 'application/json',\n 'content-type': 'application/json'\n}\n\nresponse = requests.request(\"GET\", url, headers=headers, data=payload)\n\nprint(response.text)\n" } ], "selectedLanguageId": "4eGgZHBP2GpOKZ_yaWVMF" }, "results": { "languages": [ { "id": "response-0-200", "language": "200", "code": "// Return the catalog entries.\n{\n \"EntryResults\": [\n {\n \"IsActive\": false,\n \"MetaFields\": [\n {\n \"Data\": [\n {\n \"Language\": \"\",\n \"Value\": \"\"\n }\n ],\n \"Name\": \"\",\n \"Type\": \"\"\n }\n ],\n \"SeoInformation\": [\n {\n \"LanguageCode\": \"\",\n \"Title\": \"\",\n \"Uri\": \"\",\n \"UriSegment\": \"\",\n \"Description\": \"\",\n \"Keywords\": \"\"\n }\n ],\n \"PublishStatuses\": [\n {\n \"Language\": \"\",\n \"IsPublished\": false,\n \"StartPublish\": \"\",\n \"StopPublish\": \"\"\n }\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 }\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": "" } ] }