docs: update details on retrieving nested categories (#10317)
This commit is contained in:
1 parent
d9574f734e
commit
263dbf7872
6 files changed
+35
-25
No files matched your search
@@ -114,20 +114,20 @@
|
||||
* description: A product category's ID.
|
||||
* - name: include_ancestors_tree
|
||||
* in: query
|
||||
* description: Whether to retrieve the category's parent. When enabled, the parent category is set in the `parent_category` property.
|
||||
* description: Whether to retrieve the category's parent. If you enable this, add to the `fields` query parameter `parent_category` to set the parent of a category in this field. You can either pass `*parent_category` to retreieve the fields of all parent categories, or select specific fields to make the response size smaller. For example, `fields=parent_category.id,parent_category.name`.
|
||||
* required: false
|
||||
* schema:
|
||||
* type: boolean
|
||||
* title: include_ancestors_tree
|
||||
* description: Whether to retrieve the category's parent. When enabled, the parent category is set in the `parent_category` property.
|
||||
* description: Whether to retrieve the category's parent. If you enable this, add to the `fields` query parameter `parent_category` to set the parent of a category in this field. You can either pass `*parent_category` to retreieve the fields of all parent categories, or select specific fields to make the response size smaller. For example, `fields=parent_category.id,parent_category.name`.
|
||||
* - name: include_descendants_tree
|
||||
* in: query
|
||||
* description: Whether to retrieve a list of child categories. When enabled, the parent categories are added to the `category_children` property.
|
||||
* description: Whether to retrieve a list of child categories. If you enable this, add to the `fields` query parameter `category_children` to set the child of a category in this field. You can either pass `*category_children` to retreieve the fields of all child categories, or select specific fields to make the response size smaller. For example, `fields=category_children.id,category_children.name`.
|
||||
* required: false
|
||||
* schema:
|
||||
* type: boolean
|
||||
* title: include_descendants_tree
|
||||
* description: Whether to retrieve a list of child categories. When enabled, the parent categories are added to the `category_children` property.
|
||||
* description: Whether to retrieve a list of child categories. If you enable this, add to the `fields` query parameter `category_children` to set the child of a category in this field. You can either pass `*category_children` to retreieve the fields of all child categories, or select specific fields to make the response size smaller. For example, `fields=category_children.id,category_children.name`.
|
||||
* - name: created_at
|
||||
* in: query
|
||||
* description: Filter by the category's creation date.
|
||||
|
||||
+4
-4
@@ -28,20 +28,20 @@
|
||||
* url: "#select-fields-and-relations"
|
||||
* - name: include_ancestors_tree
|
||||
* in: query
|
||||
* description: Whether to retrieve the category's parent. When enabled, the parent category is set in the `parent_category` property.
|
||||
* description: Whether to retrieve the category's parent. If you enable this, add to the `fields` query parameter `parent_category` to set the parent of a category in this field. You can either pass `*parent_category` to retreieve the fields of all parent categories, or select specific fields to make the response size smaller. For example, `fields=parent_category.id,parent_category.name`.
|
||||
* required: false
|
||||
* schema:
|
||||
* type: boolean
|
||||
* title: include_ancestors_tree
|
||||
* description: Whether to retrieve the category's parent. When enabled, the parent category is set in the `parent_category` property.
|
||||
* description: Whether to retrieve the category's parent. If you enable this, add to the `fields` query parameter `parent_category` to set the parent of a category in this field. You can either pass `*parent_category` to retreieve the fields of all parent categories, or select specific fields to make the response size smaller. For example, `fields=parent_category.id,parent_category.name`.
|
||||
* - name: include_descendants_tree
|
||||
* in: query
|
||||
* description: Whether to retrieve a list of child categories. When enabled, the parent categories are added to the `category_children` property.
|
||||
* description: Whether to retrieve a list of child categories. If you enable this, add to the `fields` query parameter `category_children` to set the children of a category in this field. You can either pass `*category_children` to retreieve the fields of all child categories, or select specific fields to make the response size smaller. For example, `fields=category_children.id,category_children.name`.
|
||||
* required: false
|
||||
* schema:
|
||||
* type: boolean
|
||||
* title: include_descendants_tree
|
||||
* description: Whether to retrieve a list of child categories. When enabled, the parent categories are added to the `category_children` property.
|
||||
* description: Whether to retrieve a list of child categories. If you enable this, add to the `fields` query parameter `category_children` to set the children of a category in this field. You can either pass `*category_children` to retreieve the fields of all child categories, or select specific fields to make the response size smaller. For example, `fields=category_children.id,category_children.name`.
|
||||
* x-codeSamples:
|
||||
* - lang: Shell
|
||||
* label: cURL
|
||||
|
||||
Reference in new issue
Block a user