GET /V1/categories/{categoryId}

Get info about category by category id

Path parameters

  • categoryId integer Required

Query parameters

  • storeId integer

Responses

  • 200 Success.

    Hide response attributes Show response attributes object
    • id integer

      Category id.

    • parent_id integer

      Parent category ID

    • name string

      Category name

    • is_active boolean

      Whether category is active

    • position integer

      Category position

    • level integer

      Category level

    • children string

      Children ids comma separated.

    • created_at string

      Category creation date and time.

    • updated_at string

      Category last update date and time.

    • path string

      Category full path.

    • available_sort_by array[string]

      Available sort by for category.

    • include_in_menu boolean

      Category is included in menu.

    • extension_attributes object

      ExtensionInterface class for @see \Magento\Catalog\Api\Data\CategoryInterface

    • custom_attributes array[object]

      Custom attributes values.

      Hide custom_attributes attributes Show custom_attributes attributes object

      Interface for custom attribute value.

      • attribute_code string Required

        Attribute code

      • value string Required

        Attribute value

    Hide response attributes Show response attributes object
    • id integer

      Category id.

    • parent_id integer

      Parent category ID

    • name string

      Category name

    • is_active boolean

      Whether category is active

    • position integer

      Category position

    • level integer

      Category level

    • children string

      Children ids comma separated.

    • created_at string

      Category creation date and time.

    • updated_at string

      Category last update date and time.

    • path string

      Category full path.

    • available_sort_by array[string]

      Available sort by for category.

    • include_in_menu boolean

      Category is included in menu.

    • extension_attributes object

      ExtensionInterface class for @see \Magento\Catalog\Api\Data\CategoryInterface

    • custom_attributes array[object]

      Custom attributes values.

      Hide custom_attributes attributes Show custom_attributes attributes object

      Interface for custom attribute value.

      • attribute_code string Required

        Attribute code

      • value string Required

        Attribute value

  • 400 Bad Request

    Hide response attributes Show response attributes object
    • message string Required

      Error message

    • errors array[object]

      Errors list

      Hide errors attributes Show errors attributes object

      Error details

      • message string

        Error message

      • parameters array[object]

        Error parameters list

        Hide parameters attributes Show parameters attributes object

        Error parameters item

        • resources string

          ACL resource

        • fieldName string

          Missing or invalid field name

        • fieldValue string

          Incorrect field value

    • code integer

      Error code

    • parameters array[object]

      Error parameters list

      Hide parameters attributes Show parameters attributes object

      Error parameters item

      • resources string

        ACL resource

      • fieldName string

        Missing or invalid field name

      • fieldValue string

        Incorrect field value

    • trace string

      Stack trace

    Hide response attributes Show response attributes object
    • message string Required

      Error message

    • errors array[object]

      Errors list

      Hide errors attributes Show errors attributes object

      Error details

      • message string

        Error message

      • parameters array[object]

        Error parameters list

        Hide parameters attributes Show parameters attributes object

        Error parameters item

        • resources string

          ACL resource

        • fieldName string

          Missing or invalid field name

        • fieldValue string

          Incorrect field value

    • code integer

      Error code

    • parameters array[object]

      Error parameters list

      Hide parameters attributes Show parameters attributes object

      Error parameters item

      • resources string

        ACL resource

      • fieldName string

        Missing or invalid field name

      • fieldValue string

        Incorrect field value

    • trace string

      Stack trace

  • Unexpected error

    Hide response attributes Show response attributes object
    • message string Required

      Error message

    • errors array[object]

      Errors list

      Hide errors attributes Show errors attributes object

      Error details

      • message string

        Error message

      • parameters array[object]

        Error parameters list

        Hide parameters attributes Show parameters attributes object

        Error parameters item

        • resources string

          ACL resource

        • fieldName string

          Missing or invalid field name

        • fieldValue string

          Incorrect field value

    • code integer

      Error code

    • parameters array[object]

      Error parameters list

      Hide parameters attributes Show parameters attributes object

      Error parameters item

      • resources string

        ACL resource

      • fieldName string

        Missing or invalid field name

      • fieldValue string

        Incorrect field value

    • trace string

      Stack trace

    Hide response attributes Show response attributes object
    • message string Required

      Error message

    • errors array[object]

      Errors list

      Hide errors attributes Show errors attributes object

      Error details

      • message string

        Error message

      • parameters array[object]

        Error parameters list

        Hide parameters attributes Show parameters attributes object

        Error parameters item

        • resources string

          ACL resource

        • fieldName string

          Missing or invalid field name

        • fieldValue string

          Incorrect field value

    • code integer

      Error code

    • parameters array[object]

      Error parameters list

      Hide parameters attributes Show parameters attributes object

      Error parameters item

      • resources string

        ACL resource

      • fieldName string

        Missing or invalid field name

      • fieldValue string

        Incorrect field value

    • trace string

      Stack trace

GET /V1/categories/{categoryId}
curl \
 --request GET 'https://magento2.winkelstraat.mac/rest/all/V1/categories/{categoryId}'
Response examples (200)
{
  "id": 42,
  "parent_id": 42,
  "name": "string",
  "is_active": true,
  "position": 42,
  "level": 42,
  "children": "string",
  "created_at": "string",
  "updated_at": "string",
  "path": "string",
  "available_sort_by": [
    "string"
  ],
  "include_in_menu": true,
  "extension_attributes": {},
  "custom_attributes": [
    {
      "attribute_code": "string",
      "value": "string"
    }
  ]
}
Response examples (200)
<?xml version="1.0" encoding="UTF-8"?>
<root>
  <id type="integer">42</id>
  <parent-id type="integer">42</parent-id>
  <name>string</name>
  <is-active type="boolean">true</is-active>
  <position type="integer">42</position>
  <level type="integer">42</level>
  <children>string</children>
  <created-at>string</created-at>
  <updated-at>string</updated-at>
  <path>string</path>
  <available-sort-by type="array">
    <available-sort-by>string</available-sort-by>
  </available-sort-by>
  <include-in-menu type="boolean">true</include-in-menu>
  <extension-attributes>
  </extension-attributes>
  <custom-attributes type="array">
    <custom-attribute>
      <attribute-code>string</attribute-code>
      <value>string</value>
    </custom-attribute>
  </custom-attributes>
</root>
Response examples (400)
{
  "message": "string",
  "errors": [
    {
      "message": "string",
      "parameters": [
        {
          "resources": "string",
          "fieldName": "string",
          "fieldValue": "string"
        }
      ]
    }
  ],
  "code": 42,
  "parameters": [
    {
      "resources": "string",
      "fieldName": "string",
      "fieldValue": "string"
    }
  ],
  "trace": "string"
}
Response examples (400)
<?xml version="1.0" encoding="UTF-8"?>
<root>
  <message>string</message>
  <errors type="array">
    <error>
      <message>string</message>
      <parameters type="array">
        <parameter>
          <resources>string</resources>
          <fieldName>string</fieldName>
          <fieldValue>string</fieldValue>
        </parameter>
      </parameters>
    </error>
  </errors>
  <code type="integer">42</code>
  <parameters type="array">
    <parameter>
      <resources>string</resources>
      <fieldName>string</fieldName>
      <fieldValue>string</fieldValue>
    </parameter>
  </parameters>
  <trace>string</trace>
</root>
Response examples (default)
{
  "message": "string",
  "errors": [
    {
      "message": "string",
      "parameters": [
        {
          "resources": "string",
          "fieldName": "string",
          "fieldValue": "string"
        }
      ]
    }
  ],
  "code": 42,
  "parameters": [
    {
      "resources": "string",
      "fieldName": "string",
      "fieldValue": "string"
    }
  ],
  "trace": "string"
}
Response examples (default)
<?xml version="1.0" encoding="UTF-8"?>
<root>
  <message>string</message>
  <errors type="array">
    <error>
      <message>string</message>
      <parameters type="array">
        <parameter>
          <resources>string</resources>
          <fieldName>string</fieldName>
          <fieldValue>string</fieldValue>
        </parameter>
      </parameters>
    </error>
  </errors>
  <code type="integer">42</code>
  <parameters type="array">
    <parameter>
      <resources>string</resources>
      <fieldName>string</fieldName>
      <fieldValue>string</fieldValue>
    </parameter>
  </parameters>
  <trace>string</trace>
</root>