Categories | API reference

Basic information

GET /{shopId}/categories

Returns the product categories of the shop. This usually is the default root category “Categories”, but can also include additional root categories, if supported by the shop.

Authorisation

OAuth 2.0 Token required with scopes:

products_read

URI parameters

Name	Type	Description
`shopId`	string	The unique identifier of the shop. Required: `true` Example: `DemoShop`

Query parameters

Name	Type	Description
`locale`	string	Represents the language code according to ISO 639-1 and the country code according to ISO 3166-1. If not provided, the shop’s default language is used. We recommend to always send this parameter with your request. If the default language had been changed in the administration, it might take up to 1 day until this change affects the shop. Required: `false` Example: `en_US`
`productId`	string	Filters categories by product ID. Required: `false`
`includeInvisible`	boolean	Includes invisible categories. Only available with `products_write` authorisation. Required: `false`

Response attributes

Name	Type	Description
	array of category

Response

HTTP 200

Media type application/json

[
  {
    "categoryId": "5171DD85-C092-46EB-2BEC-AC14145F9094",
    "alias": "Categories",
    "name": "Home page",
    "visible": true,
    "visibleInNavigation": true,
    "pageTitle": "Technic365 ePages Demoshop",
    "navigationCaption": "Categories",
    "description": "Welcome to the Technic365 shop. Always the first for technique trends.",
    "specialOffer": false,
    "facetedSearchShowFacetsOnCategory": true ,
    "facetedSearchCategoryStartDepth": 3,
    "subCategories": [
      {
        "rel": "child",
        "href": "https://pm.epages.com/rs/shops/apidocu/categories/54E7301B-A6B4-567A-8AE0-0A0C05E6922D",
        "title": "Audio Products"
      },
      {
        "rel": "child",
        "href": "https://pm.epages.com/rs/shops/apidocu/categories/54E72ECB-649E-6CA4-0421-0A0C05E692DF",
        "title": "Accessories"
      },
      {
        "rel": "child",
        "href": "https://pm.epages.com/rs/shops/apidocu/categories/54E73066-5469-7A15-465A-0A0C05E692E8",
        "title": "EBooks and Audio Samples"
      },
      {
        "rel": "child",
        "href": "https://pm.epages.com/rs/shops/apidocu/categories/546E0245-0233-E571-31B7-0A0C05E64B1E",
        "title": "Reviews"
      },
      {
        "rel": "child",
        "href": "https://pm.epages.com/rs/shops/apidocu/categories/546E024B-3A83-DE34-70CB-0A0C05E64BE6",
        "title": "About us"
      },
      {
        "rel": "child",
        "href": "https://pm.epages.com/rs/shops/apidocu/categories/5171DD87-85DF-A7B0-F632-AC14145F9090",
        "title": "Promotional products"
      }
    ],
    "sfUrl": "http://pm.epages.com/epages/apidocu.sf/?ObjectPath=/Shops/apidocu/Categories"
  }
]