Gets the catalog.
1 min
GET
http://localhost:64424/episerverapi/commerce/catalogs/{catalogName}
Path Parameters
- catalogNamestringrequiredDescription
Responses
200
- EPiServer.ServiceApi.Commerce.Models.Catalog.CatalogDescription
- IsActivebooleanDescription
- LanguagesEPiServer.ServiceApi.Commerce.Models.Catalog.CatalogLanguage[]Description
- LanguageCodestringDescription
- CatalogstringDescription
- UriSegmentstringDescription
- NodesEPiServer.ServiceApi.Models.ResourceLink[]Description
- TitlestringDescription
- TypestringDescription
- HrefstringDescription
- PropertiesEPiServer.ServiceApi.Models.NameValue[]Description
- NamestringDescription
- ValuestringDescription
- EntriesEPiServer.ServiceApi.Models.ResourceLink[]Description
- TitlestringDescription
- TypestringDescription
- HrefstringDescription
- PropertiesEPiServer.ServiceApi.Models.NameValue[]Description
- NamestringDescription
- ValuestringDescription
- EndDatestring<date-time>DescriptionFormatdate-time
- StartDatestring<date-time>DescriptionFormatdate-time
- IsPrimarybooleanDescription
- OwnerstringDescription
- SortOrderinteger<int32>DescriptionFormatint32
- NamestringDescription
- DefaultCurrencystringDescription
- DefaultLanguagestringDescription
- WeightBasestringDescription
- LengthBasestringDescription
401
404
curl
curl --request GET \
--url http://localhost:64424/episerverapi/commerce/catalogs/{catalogName} \
--header 'accept: application/json'javascript
var myHeaders = new Headers();
myHeaders.append("accept", "application/json");
myHeaders.append("content-type", "application/json");
var requestOptions = {
method: 'GET',
headers: myHeaders,
redirect: 'follow'
};
fetch("http://localhost:64424/episerverapi/commerce/catalogs/{catalogName}", requestOptions)
.then(response => response.text())
.then(result => console.log(result))
.catch(error => console.log('error', error));ruby
require "uri"
require "json"
require "net/http"
url = URI("http://localhost:64424/episerverapi/commerce/catalogs/{catalogName}")
http = Net::HTTP.new(url.host, url.port);
request = Net::HTTP::Get.new(url)
request["accept"] = "application/json"
request["content-type"] = "application/json"
response = http.request(request)
puts response.read_body
python
import requests
import json
url = "http://localhost:64424/episerverapi/commerce/catalogs/{catalogName}"
payload = {}
headers = {
'accept': 'application/json',
'content-type': 'application/json'
}
response = requests.request("GET", url, headers=headers, data=payload)
print(response.text)
200
// Return the catalog.
{
"IsActive": false,
"Languages": [
{
"LanguageCode": "",
"Catalog": "",
"UriSegment": ""
}
],
"Nodes": [
{
"Title": "",
"Type": "",
"Href": "",
"Properties": [
{
"Name": "",
"Value": ""
}
]
}
],
"Entries": [
{
"Title": "",
"Type": "",
"Href": "",
"Properties": [
{
"Name": "",
"Value": ""
}
]
}
],
"EndDate": "",
"StartDate": "",
"IsPrimary": false,
"Owner": "",
"SortOrder": "",
"Name": "",
"DefaultCurrency": "",
"DefaultLanguage": "",
"WeightBase": "",
"LengthBase": ""
}401
// If user does not have enough permission for this request.
404
// If catalog does not exist.