--- title: Gets the catalog. slug: commerce-connect-15/service-api/0N4p-gets-the-catalog docTags: createdAt: 2026-10-09T17:33:31.176Z --- { "id": "4MyRBzIlcTY13cHdmV5zn", "type": "api-oas-v2", "data": { "method": "GET", "url": "/episerverapi/commerce/catalogs/{catalogName}", "servers": [], "name": "Gets the catalog.", "description": "", "contentType": "application/json", "request": { "pathParameters": [ { "kind": "required", "name": "catalogName", "type": "string", "description": "The catalog name." } ], "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.", "jsonExample": "", "isExpanded": true, "schema": [ { "kind": "optional", "type": "object", "description": "The catalog model.", "customType": "Catalog", "schema": [ { "name": "endDate", "kind": "optional", "type": "string", "description": "Gets or sets the end date.", "format": "date-time" }, { "name": "startDate", "kind": "optional", "type": "string", "description": "Gets or sets the start date.", "format": "date-time" }, { "name": "isPrimary", "kind": "optional", "type": "boolean", "description": "Gets or sets a value indicating whether this instance is primary." }, { "name": "owner", "kind": "optional", "type": "string", "nullable": true, "description": "Gets or sets the owner." }, { "name": "sortOrder", "kind": "optional", "type": "integer", "description": "Gets or sets the sort order.", "format": "int32" }, { "name": "name", "kind": "optional", "type": "string", "nullable": true, "description": "Gets or sets the name." }, { "name": "defaultCurrency", "kind": "optional", "type": "string", "nullable": true, "description": "Gets or sets the default currency." }, { "name": "defaultLanguage", "kind": "optional", "type": "string", "nullable": true, "description": "Gets or sets the default language." }, { "name": "weightBase", "kind": "optional", "type": "string", "nullable": true, "description": "Gets or sets the weight base." }, { "name": "lengthBase", "kind": "optional", "type": "string", "nullable": true, "description": "Gets or sets the length base." }, { "name": "isActive", "kind": "optional", "type": "boolean", "description": "Gets or sets a value indicating whether this instance is active." }, { "name": "languages", "kind": "optional", "type": "array", "nullable": true, "description": "Gets or sets the languages.", "modelRef": "#/components/schemas/CatalogLanguage", "customType": "CatalogLanguage[]", "schema": [ { "name": "languageCode", "kind": "optional", "type": "string", "nullable": true, "description": "Gets or sets the language code." }, { "name": "catalog", "kind": "optional", "type": "string", "nullable": true, "description": "Gets or sets the catalog." }, { "name": "uriSegment", "kind": "optional", "type": "string", "nullable": true, "description": "Gets or sets the URI segment." } ] }, { "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": "entries", "kind": "optional", "type": "array", "nullable": true, "description": "Gets or sets the 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." } ] } ] } ], "modelRef": "#/components/schemas/Catalog", "isExpanded": true } ] }, { "statusCode": "401", "description": "If user does not have enough permission for this request.", "jsonExample": "", "isExpanded": true }, { "statusCode": "404", "description": "If catalog does not exist.", "jsonExample": "", "isExpanded": true } ], "hasXCodeSamples": false, "examples": { "languages": [ { "id": "v2_Akc8mWGSIdZNDwW4VO", "language": "curl", "label": "cURL", "code": "curl --request GET \\\n --url /episerverapi/commerce/catalogs/{catalogName} \\\n --header 'accept: text/plain'" }, { "id": "-lrcSf8pSMqhN544q95Op", "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/catalogs/{catalogName}\", requestOptions)\n .then(response => response.text())\n .then(result => console.log(result))\n .catch(error => console.log('error', error));" }, { "id": "nG74B2cPf3UuAfazQ0wGH", "language": "ruby", "label": "Ruby", "code": "require \"uri\"\nrequire \"json\"\nrequire \"net/http\"\n\nurl = URI(\"/episerverapi/commerce/catalogs/{catalogName}\")\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": "xfD-1IK09eBIcraCexaRY", "language": "python", "label": "Python", "code": "import requests\nimport json\n\nurl = \"/episerverapi/commerce/catalogs/{catalogName}\"\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": "v2_Akc8mWGSIdZNDwW4VO" }, "results": { "languages": [ { "id": "response-0-200", "language": "200", "code": "// Return the catalog.\n{\n \"endDate\": \"\",\n \"startDate\": \"\",\n \"isPrimary\": false,\n \"owner\": \"\",\n \"sortOrder\": \"\",\n \"name\": \"\",\n \"defaultCurrency\": \"\",\n \"defaultLanguage\": \"\",\n \"weightBase\": \"\",\n \"lengthBase\": \"\",\n \"isActive\": false,\n \"languages\": [\n {\n \"languageCode\": \"\",\n \"catalog\": \"\",\n \"uriSegment\": \"\"\n }\n ],\n \"nodes\": [\n {\n \"title\": \"\",\n \"type\": \"\",\n \"href\": \"\",\n \"properties\": [\n {\n \"name\": \"\",\n \"value\": \"\"\n }\n ]\n }\n ],\n \"entries\": [\n {\n \"title\": \"\",\n \"type\": \"\",\n \"href\": \"\",\n \"properties\": [\n {\n \"name\": \"\",\n \"value\": \"\"\n }\n ]\n }\n ]\n}" }, { "id": "response-1-401", "language": "401", "code": "// If user does not have enough permission for this request.\n" }, { "id": "response-2-404", "language": "404", "code": "// If catalog does not exist.\n" } ], "selectedLanguageId": "response-0-200" } }, "children": [ { "text": "" } ] }