Category | API reference

Basic information

GET /{shopId}/categories/{categoryId}

Returns the category identified by the provided category ID.

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`
`categoryId`	string	Required: `true`

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`
`includeInvisible`	boolean	Includes invisible categories. Only available with `products_write` authorisation. Required: `false`

Response attributes

Name	Type	Description
	object of category

Response

HTTP 200

Media type application/json

{
  "categoryId": "54E7301B-A6B4-567A-8AE0-0A0C05E6922D",
  "alias": "Audio_products",
  "name": "Audio Products",
  "visible": true,
  "visibleInNavigation": true,
  "pageTitle": "Audio Products",
  "navigationCaption": "Audio Products",
  "description": null,
  "specialOffer": false,
  "facetedSearchShowFacetsOnCategory": true ,
  "facetedSearchCategoryStartDepth": 3,
  "images": [
    {
      "url": "https://pm.epages.com/WebRoot/Store/Shops/apidocu/54E7/301B/A6B4/567A/8AE0/0A0C/05E6/922D/epages-e_copysmall_m.png",
      "classifier": "Medium",
      "isZoomEnabled": false,
      "width": 0,
      "height": 0,
      "fileSize": 0
    },
    {
      "url": "https://pm.epages.com/WebRoot/Store/Shops/apidocu/54E7/301B/A6B4/567A/8AE0/0A0C/05E6/922D/epages-e_copysmall_s.png",
      "classifier": "Small",
      "isZoomEnabled": false,
      "width": 0,
      "height": 0,
      "fileSize": 0
    }
  ],
  "parent": {
    "rel": "parent",
    "href": "https://pm.epages.com/api/categories/5171DD85-C092-46EB-2BEC-AC14145F9094",
    "title": "Categories"
  },
  "subCategories": [
    {
      "rel": "child",
      "href": "https://pm.epages.com/rs/shops/apidocu/categories/546E01DD-B253-4384-8432-0A0C05E64BE2",
      "title": "Headphones"
    },
    {
      "rel": "child",
      "href": "https://pm.epages.com/rs/shops/apidocu/categories/54E73036-E385-5AFD-F14E-0A0C05E692CB",
      "title": "Headsets"
    },
    {
      "rel": "child",
      "href": "https://pm.epages.com/rs/shops/apidocu/categories/54E7303C-B8CC-FE92-CFF3-0A0C05E6922C",
      "title": "In-Ear"
    },
    {
      "rel": "child",
      "href": "https://pm.epages.com/rs/shops/apidocu/categories/54EF3D25-49A5-881D-3EC9-0A0C05E6A7E7",
      "title": "Your own design!"
    }
  ],
  "sfUrl": "http://pm.epages.com/epages/apidocu.sf/?ObjectPath=/Shops/apidocu/Categories/Audio_products",
  "links": [
    {
      "rel": "products",
      "href": "https://pm.epages.com/rs/shops/apidocu/products?categoryId=54E7301B-A6B4-567A-8AE0-0A0C05E6922D"
    }
  ]
}