Categories
Categories are used in order to organize your product catalogue within your e-commerce platform. They work as hierarchical levels of product classification. There are no limits to the number of levels of categories, though it is recommended not to use too many levels. One product can belong to only one category. The same applies to categories, a category can have only one parent category.
Category Lookup keys
| Key | Type | Description |
|---|---|---|
id | integer | Propeller category id, auto-generated |
sourceId | string | External system unique id. sourceId should be combined with source |
Fields
| Name | Description | Type |
|---|---|---|
names | Category name | array[LocalizedString] |
descriptions | Category description | array[LocalizedString] |
shortDescriptions | Category short description | array[LocalizedString] |
language | Category default language. | string ISO 639-1 |
parent | Parent category. | JSON object that identifies the parent. id or sourceId in combination with source |
sourceId | External system unique id | string |
source | External system | string |
Category Errors
This section describes error codes specific for the Category resource.
| Code | Error Type | Status Code | Message | Reason |
|---|---|---|---|---|
30004 | CategoryExists | 400 | Category already exists | Category with such lookup key already exists |
30005 | CategoryMultipleFound | 400 | Multuple categories found. Please provide additional filters | Multiple categories with such lookup key exist |
30006 | CategoryNotFound | 404 | Category does not exist | Category with such lookup key not found |
30007 | ParentCategoryNotFound | 404 | Parent category not found | Parent category with such lookup key not found. This error is typical when working with category sub-resources (e.g. attributes) |
📄️ Create Category
Use this endpoint to create a single category. If a category is successfully created, the response will include the category `id`.
📄️ Get Category by lookup key
Use this endpoint to retrieve category details by lookup key. If multiple categories with the same lookup key exist, use additional filtering depending on the lookup key to uniquely identify the category (e.g. `source` and `language` for lookup key `source`).
📄️ Delete Category by lookup key
Use this endpoint to delete category by lookup key. If multiple categories with the same lookup key exist, use additional filtering depending on the lookup key to uniquely identify the category (e.g. `source` and `language` for lookup key `source`).
📄️ Update Category by lookup key
Use this endpoint to update category by lookup key. If multiple categories with the same lookup key exist, use additional filtering depending on the lookup key to uniquely identify the category (e.g. `source` and `language` for lookup key `source`).
📄️ Delete Category translation by lookup key
Use this endpoint to delete category translation by lookup key and the language for which the translation needs to be deleted. If multiple categories with the same lookup key exist, use additional filtering depending on the lookup key to uniquely identify the category (e.g. `source` and `language` for lookup key `source`).
📄️ Bulk Categories by sourceId
The bulk endpoints offer an efficient way of importing/updating large amounts of categories with just a single API call. When using the bulk `sourceId` endpoint, the categories are identified by `sourceId`, `source` and `language`. If a category doesn't already exist, it will be created. If it does exist, the category will be updated.
📄️ Bulk Categories by Id
The bulk endpoints offer an efficient way of importing/updating large amounts of categories with just a single API call. When using the bulk `id` endpoint, the categories are identified by Propeller category `id`. If a category with such `id` doesn't already exist, it will be created. If it does exist, the category will be updated.