diff --git a/static/rest/data-ingestion-schema-v1.yaml b/static/rest/data-ingestion-schema-v1.yaml index 8259610e..06d4c2dd 100644 --- a/static/rest/data-ingestion-schema-v1.yaml +++ b/static/rest/data-ingestion-schema-v1.yaml @@ -410,11 +410,14 @@ paths: When creating categories: - Each category requires a unique `slug` and `source`. - - Use the `slug` field in a hierarchical format like men/clothing/pants' to create parent-child relationships - - The category `slug` string can contain only lowercase letters, numbers, and hyphens. + - To create parent-child relationships, create the `slug` field in a hierarchical format, for example `men/clothing/pants'. + - A category `slug` string can contain only lowercase letters, numbers, and hyphens with `/` used as a separator for hierarchy. + - Create each category as a separate entity. - Use the `name` field to define the display name for the category. - Use the optional `families` field to associate categories with product families for enhanced organization. + After you create categories, link a product to a category using the `path` value for the [routes](#operation/createProducts!path=routes&t=request) field. When you create or update products. The value of `path` in the route must match the `slug` value for the category. + To update existing categories, use the update operation. operationId: createCategories @@ -533,7 +536,7 @@ paths: If a category is deleted by mistake: * **Time Window**: You have up to one week to restore deleted categories - * **Restoration Method**: Recreate the top-level deleted category using the [update operation](#operation/createCategories) + * **Restoration Method**: Recreate the top-level deleted category using the [Create category operation](#operation/createCategories) * **State Recovery**: Categories are restored to their exact state from the time of deletion, including all metadata, family associations, and hierarchy relationships * **Hierarchy Reconstruction**: The entire hierarchy is rebuilt from the restoration payload @@ -591,6 +594,9 @@ paths: - Use the `links` field to define relationships between products, such as linking a product variant to its parent configurable product. - You can create multiple products in a single request, and also create product variants for configurable products in the same request. + - Use the `routes` field to set category paths. The `path` value must match an existing category slug, for example `men/clothing`. + - Create a route for each category path. For example to include a product in each of the following categories `men`, `men/clothing`, and `men/clothing/pants`, specify three `path` values, one for each category. +

Simple products

Create products or replace existing products with specified `sku` and `source` values. @@ -746,8 +752,9 @@ paths: ], "routes": [ - { "path": "red-pants" }, - { "path": "pants/red-pants", "position": 1 } + { "path": "men" }, + { "path": "men/clothing/", "position": 1 }, + { "path": "men/clothing/pants", "position": 1} ] } ]