Skip to content
Merged
Changes from all commits
Commits
Show all changes
27 commits
Select commit Hold shift + click to select a range
5194a28
Revise category slug format and hierarchy instructions
meker12 Oct 8, 2025
422be5b
Merge branch 'main' into update-rest-categories-examples
meker12 Oct 8, 2025
46a44a6
Apply suggestion from @meker12
meker12 Oct 8, 2025
8844bfb
Apply suggestion from @meker12
meker12 Oct 8, 2025
c9c7446
Apply suggestion from @meker12
meker12 Oct 8, 2025
972e4aa
Apply suggestion from @meker12
meker12 Oct 8, 2025
32f6397
Apply suggestion from @meker12
meker12 Oct 8, 2025
c62dc00
Apply suggestion from @meker12
meker12 Oct 8, 2025
9d44311
Apply suggestion from @meker12
meker12 Oct 8, 2025
f304381
Fix link in recovery options for category restoration
meker12 Oct 8, 2025
7143e74
Apply suggestion from @meker12
meker12 Oct 9, 2025
d98d933
Apply suggestion from @meker12
meker12 Oct 9, 2025
85aded3
Apply suggestion from @meker12
meker12 Oct 9, 2025
c42bbad
Apply suggestion from @meker12
meker12 Oct 9, 2025
492f6c4
Apply suggestion from @meker12
meker12 Oct 9, 2025
94b3008
Apply suggestion from @meker12
meker12 Oct 9, 2025
a560760
Apply suggestion from @meker12
meker12 Oct 10, 2025
be8791e
Apply suggestion from @meker12
meker12 Oct 10, 2025
f82c846
Apply suggestion from @meker12
meker12 Oct 10, 2025
8a912cd
Apply suggestion from @meker12
meker12 Oct 10, 2025
1f92635
Apply suggestion from @meker12
meker12 Oct 10, 2025
4691855
Apply suggestion from @meker12
meker12 Oct 10, 2025
005e765
Apply suggestion from @meker12
meker12 Oct 10, 2025
a364ba7
Apply suggestion from @meker12
meker12 Oct 10, 2025
c56b0be
Apply suggestion from @meker12
meker12 Oct 10, 2025
487d9dc
Apply suggestion from @meker12
meker12 Oct 10, 2025
3c7374f
Apply suggestion from @meker12
meker12 Oct 10, 2025
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
17 changes: 12 additions & 5 deletions static/rest/data-ingestion-schema-v1.yaml
Original file line number Diff line number Diff line change
Expand Up @@ -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
Expand Down Expand Up @@ -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

Expand Down Expand Up @@ -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.


<h3 id="simpleProducts">Simple products</h3>
Create products or replace existing products with specified `sku` and `source` values.
Expand Down Expand Up @@ -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}
]
}
]
Expand Down