Gets all the catalog entries.

1 min

GET

http://localhost:64424/episerverapi/commerce/entries/{startPage}/{pageSize}

Path Parameters

startPageinteger<int32>required
Description
The start page.
Format
int32
pageSizeinteger<int32>required
Description
Size of the page.
Format
int32

Responses

200Return the catalog entries.

EPiServer.ServiceApi.Commerce.Models.Catalog.Entries
- EntryResultsEPiServer.ServiceApi.Commerce.Models.Catalog.Entry[]
  Description
  Gets or sets the entries.
  - IsActiveboolean
    Description
    Gets or sets a value indicating whether this instance is active.
  - MetaFieldsEPiServer.ServiceApi.Commerce.Models.Catalog.MetaFieldProperty[]
    Description
    Gets or sets the item attributes.
    - DataEPiServer.ServiceApi.Commerce.Models.Catalog.MetaFieldData[]
      Description
      Gets or sets the data.
      - Languagestring
        Description
        Gets or sets the language.
      - Valuestring
        Description
        Gets or sets the value.
    - Namestring
      Description
      Gets or sets the name.
    - Typestring
      Description
      Gets or sets the type.
  - SeoInformationEPiServer.ServiceApi.Commerce.Models.Catalog.SeoInfo[]
    Description
    Gets or sets the SEO information.
    - LanguageCodestring
      Description
      Gets or sets the language code.
    - Titlestring
      Description
      Gets or sets the title.
    - Uristring
      Description
      Gets or sets the URI.
    - UriSegmentstring
      Description
      Gets or sets the uri segment.
    - Descriptionstring
      Description
      Gets or sets the description.
    - Keywordsstring
      Description
      Gets or sets the keywords.
  - PublishStatusesEPiServer.ServiceApi.Commerce.Models.Catalog.PublishStatus[]
    Description
    Gets or sets the publish statuses for language versions of this entry.
    - Languagestring
      Description
      Gets or sets language version.
    - IsPublishedboolean
      Description
      Gets or sets the publish status.
    - StartPublishstring<date-time>
      Description
      Gets or sets the start publish time, in UTC.
      Format
      date-time
    - StopPublishstring<date-time>
      Description
      Gets or sets the stop publish time, in UTC.
      Format
      date-time
  - Codestring
    Description
    Gets or sets the Catalog Entry Code.
  - Namestring
    Description
    Gets or sets the name.
  - StartDatestring<date-time>
    Description
    Gets or sets the start date.
    Format
    date-time
  - EndDatestring<date-time>
    Description
    Gets or sets the end date.
    Format
    date-time
  - MetaClassstring
    Description
    Gets or sets the MetaClass.
  - Catalogstring
    Description
    Gets or sets the Catalog.
  - PricesEPiServer.ServiceApi.Models.ResourceLink[]
    Description
    Gets or sets the price values.
    - Titlestring
      Description
      Gets or sets the title.
    - Typestring
      Description
      Gets or sets the type.
    - Hrefstring
      Description
      Gets or sets the uri.
    - PropertiesEPiServer.ServiceApi.Models.NameValue[]
      Description
      Gets or sets the properties.
      - Namestring
        Description
        Gets or sets the name.
      - Valuestring
        Description
        Gets or sets the type.
  - EntryTypestring
    Description
    Gets or sets the type of the entry.
  - ChildCatalogEntriesEPiServer.ServiceApi.Models.ResourceLink[]
    Description
    Gets or sets the child catalog entries.
    - Titlestring
      Description
      Gets or sets the title.
    - Typestring
      Description
      Gets or sets the type.
    - Hrefstring
      Description
      Gets or sets the uri.
    - PropertiesEPiServer.ServiceApi.Models.NameValue[]
      Description
      Gets or sets the properties.
      - Namestring
        Description
        Gets or sets the name.
      - Valuestring
        Description
        Gets or sets the type.
  - InventoryStatusstring
    Description
    Gets or sets the flag indicating how inventory amounts are handled.
  - WarehouseInventoriesEPiServer.ServiceApi.Models.ResourceLink[]
    Description
    Gets or sets the warehouse inventories.
    - Titlestring
      Description
      Gets or sets the title.
    - Typestring
      Description
      Gets or sets the type.
    - Hrefstring
      Description
      Gets or sets the uri.
    - PropertiesEPiServer.ServiceApi.Models.NameValue[]
      Description
      Gets or sets the properties.
      - Namestring
        Description
        Gets or sets the name.
      - Valuestring
        Description
        Gets or sets the type.
  - AssociationsEPiServer.ServiceApi.Models.ResourceLink[]
    Description
    Gets or sets the associations.
    - Titlestring
      Description
      Gets or sets the title.
    - Typestring
      Description
      Gets or sets the type.
    - Hrefstring
      Description
      Gets or sets the uri.
    - PropertiesEPiServer.ServiceApi.Models.NameValue[]
      Description
      Gets or sets the properties.
      - Namestring
        Description
        Gets or sets the name.
      - Valuestring
        Description
        Gets or sets the type.
  - AssetsEPiServer.ServiceApi.Models.ResourceLink[]
    Description
    Gets or sets the assets.
    - Titlestring
      Description
      Gets or sets the title.
    - Typestring
      Description
      Gets or sets the type.
    - Hrefstring
      Description
      Gets or sets the uri.
    - PropertiesEPiServer.ServiceApi.Models.NameValue[]
      Description
      Gets or sets the properties.
      - Namestring
        Description
        Gets or sets the name.
      - Valuestring
        Description
        Gets or sets the type.
  - NodesEPiServer.ServiceApi.Models.ResourceLink[]
    Description
    Gets or sets the nodes.
    - Titlestring
      Description
      Gets or sets the title.
    - Typestring
      Description
      Gets or sets the type.
    - Hrefstring
      Description
      Gets or sets the uri.
    - PropertiesEPiServer.ServiceApi.Models.NameValue[]
      Description
      Gets or sets the properties.
      - Namestring
        Description
        Gets or sets the name.
      - Valuestring
        Description
        Gets or sets the type.
  - VariationEPiServer.ServiceApi.Commerce.Models.Catalog.VariationProperties
    - MinQuantitynumber<double>
      Description
      Gets or sets the min quantity.
      Format
      double
    - MaxQuantitynumber<double>
      Description
      Gets or sets the max quantity.
      Format
      double
    - Weightnumber<double>
      Description
      Gets or sets the weight.
      Format
      double
    - TaxCategorystring
      Description
      Gets or sets the tax category.
  - DimensionEPiServer.ServiceApi.Commerce.Models.Catalog.DimensionProperties
    Description
    Model to indicate that an variation/package has shipment dimension properties.
    - Lengthnumber<double>
      Description
      Gets or sets the length.
      Format
      double
    - Heightnumber<double>
      Description
      Gets or sets the height.
      Format
      double
    - Widthnumber<double>
      Description
      Gets or sets the width.
      Format
      double
- TotalCountinteger<int32>
  Description
  Gets or sets the total count.
  Format
  int32
- TotalPagesinteger<int32>
  Description
  Gets or sets the total pages.
  Format
  int32

401If user does not have enough permission for this request.

curl

curl --request GET \
     --url http://localhost:64424/episerverapi/commerce/entries/{startPage}/{pageSize} \
     --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/entries/{startPage}/{pageSize}", 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/entries/{startPage}/{pageSize}")

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/entries/{startPage}/{pageSize}"

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 entries.
{
  "EntryResults": [
    {
      "IsActive": false,
      "MetaFields": [
        {
          "Data": [
            {
              "Language": "",
              "Value": ""
            }
          ],
          "Name": "",
          "Type": ""
        }
      ],
      "SeoInformation": [
        {
          "LanguageCode": "",
          "Title": "",
          "Uri": "",
          "UriSegment": "",
          "Description": "",
          "Keywords": ""
        }
      ],
      "PublishStatuses": [
        {
          "Language": "",
          "IsPublished": false,
          "StartPublish": "",
          "StopPublish": ""
        }
      ],
      "Code": "",
      "Name": "",
      "StartDate": "",
      "EndDate": "",
      "MetaClass": "",
      "Catalog": "",
      "Prices": [
        {
          "Title": "",
          "Type": "",
          "Href": "",
          "Properties": [
            {
              "Name": "",
              "Value": ""
            }
          ]
        }
      ],
      "EntryType": "",
      "ChildCatalogEntries": [
        {
          "Title": "",
          "Type": "",
          "Href": "",
          "Properties": [
            {
              "Name": "",
              "Value": ""
            }
          ]
        }
      ],
      "InventoryStatus": "",
      "WarehouseInventories": [
        {
          "Title": "",
          "Type": "",
          "Href": "",
          "Properties": [
            {
              "Name": "",
              "Value": ""
            }
          ]
        }
      ],
      "Associations": [
        {
          "Title": "",
          "Type": "",
          "Href": "",
          "Properties": [
            {
              "Name": "",
              "Value": ""
            }
          ]
        }
      ],
      "Assets": [
        {
          "Title": "",
          "Type": "",
          "Href": "",
          "Properties": [
            {
              "Name": "",
              "Value": ""
            }
          ]
        }
      ],
      "Nodes": [
        {
          "Title": "",
          "Type": "",
          "Href": "",
          "Properties": [
            {
              "Name": "",
              "Value": ""
            }
          ]
        }
      ],
      "Variation": {
        "MinQuantity": "",
        "MaxQuantity": "",
        "Weight": "",
        "TaxCategory": ""
      },
      "Dimension": {
        "Length": "",
        "Height": "",
        "Width": ""
      }
    }
  ],
  "TotalCount": "",
  "TotalPages": ""
}

401

// If user does not have enough permission for this request.