API reference categories - WEBSALE Dokumentation

Creating, retrieving, and assigning categories. The categories/ endpoint provides you with an interface for managing category data in our shop system. With this interface, you can retrieve, create, and delete categories and assign products to categories.

Supported methods

List of all supported methods.

Command/info	Endpoints	GET	PUT	POST	DELETE
Categories	categories/
Product assignment

Data fields of a category (Category Resource)

The data fields of a category are managed in the configuration and stored internally as a JSON object.
A distinction is made between the following field types:

Standard fields: Predefined by the system and always present (e.g. id, name, descr, hidden)
User-defined fields: Can be created flexibly and are located in the custom section of the object
Technical fields for structure representation: Used to represent the category structure in the shop
These include:
- _parent – ID of the parent category
- _children – List of subordinate categories
- sortValue – technical sort value to determine the actual order in the shop

Name	Type	Meaning
id	String	Unique ID of the category
name	String	Display name of the category
descr	String	Description text (e.g. for display in the frontend)
active	String	Activity status (`"always"`, `"never"`, `"test"` (active only in test mode))
productAssignmentType	String	Type of product assignment (`"manual", "ruleBased"`)
productRules	String	Parsed object that contains rules for product assignment
hidden	Boolean	Indicates whether the category should be hidden in the frontend
timestampCreatedAt	String	Time at which the category was created (ISO 8601 format, UTC).
timestampUpdatedAt	String	Time of the last modification (ISO 8601 format, UTC).
custom	Object	Object for user-defined fields
custom.<technical field name>	User-defined	User-defined field, freely definable via the configuration (e.g. `image`, `seoName`, `robotsNoIndex`, etc.)

Additional fields

Name	Type	Meaning
_parent	String	ID of the parent category (empty for main category)
_children	Array of strings	List of IDs of subordinate categories
sortValue	Int	Position of the category in the shop

Example data record

{
    "_children": [
        "107-06636",
        "108-64674"
    ],
    "_parent": "",
    "active": "always",
    "custom": {
        "alternativeTemplate": "",
        "image": [],
        "robotsNoFollow": false,
        "robotsNoIndex": false,
        "seoName": ""
    },
    "descr": "Lorem ipsum dolor sit amet, consetetur sadipscing elitr, ...",
    "hidden": false,
    "id": "100-14213",
    "name": "Bekleidung",
    "productAssignmentType": "manual",
    "productRules": "[{\"field\":\"active\",\"mode\":\"eq\",\"value\":\"always\"},{\"field\":\"itemNumber\",\"mode\":\"contains\",\"value\":\"5\"}]",
    "sortValue": 62,
    "timestampCreatedAt": "2024-01-10T13:36:31.000Z",
    "timestampUpdatedAt": "2024-09-26T10:41:54.000Z"
}

Methods for categories

GET categories

This endpoint returns a list of categories from the shop system. Sorting, text search, or complex filtering is currently not possible. However, subcategories of a specific category can be filtered by using the filter[parent] parameter. If parent=root is set, all main top-level categories are returned. With the withExternData=yes parameter, the IDs of the parent category (_parent) and the child categories (_children) can additionally be loaded. With subshopId, the categories of a specific subshop can be queried. Read permissions for category data are required to use this endpoint.

Example

https://www.<your-shop>.de/admin/api/v1/categories/

Response

{
    "items": [
        {
            "_children": [],
            "_parent": "372-87532",
            "active": "never",
            "custom": {
                "alternativeTemplate": "",
                "image": [],
                "metaDescription": "",
                "metaDescriptionSetManually": false,
                "metaTitle": "",
                "metaTitleSetManually": false,
                "regger": "",
                "robotsNoFollow": false,
                "robotsNoIndex": false,
                "seoName": ""
            },
            "descr": "test",
            "hidden": false,
            "id": "245-10358",
            "name": "Neue Kategorie",
            "productAssignmentType": "manual",
            "productRules": "",
            "sortValue": 42,
            "timestampCreatedAt": "2024-09-17T07:44:56.000Z",
            "timestampUpdatedAt": "2024-12-16T14:14:42.000Z"
        },
        ...
    ],
    "endReached": true,
    "nextPageToken": "",
    "totalCount": 7
}

Filter fields

parent

Sort fields

Not supported

Error codes

Error	Type	Reason
401 Unauthorized		Not authorized: you are not logged in.
403 Forbidden		You do not have the required permissions to read category data.
400 Bad Request	”invalidValue”
400 Bad Request	”invalidCombination”	`pageToken` and `from` are set simultaneously.
400 Bad Request	”illegalOperation”	An attempt was made to filter categories by a field of type `List`, `Map`, `Image`, or `Video`. An invalid filter operation was applied to an enum field — only `=` or `≠` are allowed.
400 Bad Request	”unknownDataField”	A filter or sort field is invalid.
400 Bad Request	”unknownOperation”	A filter type is invalid.
400 Bad Request	”invalidCharacters”	`size` is not an integer. A filter value is invalid.
400 Bad Request	”syntaxError”	`sort` contains more than one or no ”:“.
404 Not Found		The parent category was not found.

GET categories/{categoryId}

This endpoint loads the complete data of a single category by its ID. Optionally, the withExternData=yes parameter can be used to additionally include the ID of the parent category (_parent) and the list of all directly subordinate categories (_children). Read permissions for category data are required to use the endpoint.

Example

https://www.<your-shop>.de/admin/api/v1/categories/942-53775

Response

{
    "_children": [],
    "_parent": "",
    "active": "always",
    "custom": {
        "alternativeTemplate": "",
        "image": [],
        "metaDescription": "",
        "metaDescriptionSetManually": false,
        "metaTitle": "",
        "metaTitleSetManually": false,
        "regger": "",
        "robotsNoFollow": false,
        "robotsNoIndex": false,
        "seoName": ""
    },
    "descr": "123",
    "hidden": false,
    "id": "942-53775",
    "name": "Neue Kategorie",
    "productAssignmentType": "manual",
    "productRules": "",
    "sortValue": 42,
    "timestampCreatedAt": "2024-09-25T15:03:15.000Z",
    "timestampUpdatedAt": "2024-12-16T14:14:43.000Z"
}

Error codes

Error	Type	Reason
401 Unauthorized		Not authorized: you are not logged in.
403 Forbidden		You do not have the required permissions to read category data.
400 Bad Request	”invalidValue"	"stage” is invalid.
404 Not Found		There is no category with `id`=`categoryId`.

PUT categories/{categoryId}

This endpoint can be used to update an existing category by its ID. The request body only needs to contain the fields that are actually to be changed — a complete category definition is not required. If the optional createMissing=yes parameter is set and no category with the specified ID exists, a new category with this ID is created instead. Write permissions for category data are required to use this endpoint.

Example

https://www.<your-shop>.de/admin/api/v1/categories/1081-68843

Request body

{
    "custom": {
        "robotsNoFollow": true
    },
    "active": "always",
    "descr": "My new description"
}

Response

{
    "active": "always",
    "custom": {
        "alternativeTemplate": "",
        "image": [],
        ...
    },
    "descr": "My new description",
    "hidden": false,
    "id": "1081-68843",
    "name": "Bekleidung",
    "productAssignmentType": "manual",
    "productRules": "",
    "timestampCreatedAt": "2024-01-10T13:36:31.000Z",
    "timestampUpdatedAt": "2025-05-02T14:22:10.000Z"
}

Error codes

Error	Type	Reason
401 Unauthorized		Not authorized: you are not logged in.
403 Forbidden		You do not have the required permissions to write category data.
400 Bad Request		Request body could not be loaded.
400 Bad Request	”invalidValue"	"stage” is invalid. A field of type `Enumeration` contains a value that is not in the set of possible values. An image has a format that is not supported.
400 Bad Request	”invalidFormat”	`custom` is not an object. A field contains the value `null`. A value has a type that does not match the type from the configuration. A price value cannot be parsed. A field of type `Map` has a key that is not a string. A field of type `List` is not an array of strings. A time value is not in ISO 8601 format. Image data of an image is not an array of objects. `id` of the format or `path` are not strings.
400 Bad Request	”unknownDataField”	An attempt was made to update an unknown field. Image data contains something other than `id` and `path`.
400 Bad Request	”notManualEditable”	Manual editing has been prohibited in the configuration.
404 Not Found		The category with `id`=`{categoryId}` was not found and the `createMissing` parameter is not set to `yes`.
503 Service Unavailable	”internalError”	The update failed.

PUT categories/{categoryId}/assign

This endpoint can be used to assign multiple subcategories to an existing category by its ID. The special value categoryId: “root” causes the categories to be placed at the top level as main categories. In the request body, an array of category IDs must be passed, which should be assigned as subordinate (_children) to the specified category. Write permissions for category data are required to use this endpoint.

Example

https://www.<your-shop>.de/admin/api/v1/categories/1081-68843/assign

Request body

{
    "categoryIds": [
        "1032-22182",
        "109-30589",
        "105-09206"
    ]
}

Response

{
    "success": true
}

Error codes

Error	Type	Reason
401 Unauthorized		Not authorized: you are not logged in.
403 Forbidden		You do not have the required permissions to write category data.
400 Bad Request		Request body could not be loaded.
400 Bad Request	”invalidValue"	"stage” is invalid.
404 Not Found		The category with `id`=`{categoryId}` was not found.
400 Bad Request	”unknownDataField”	Something other than `categoryIds` was passed.
400 Bad Request	”invalidFormat”	`categoryIds` is not an array of strings.

POST categories/{categoryId}/move

This endpoint can be used to move an existing category by its ID within the category structure. Positioning is done either by assigning as a subcategory (intoTarget) or by sorting on the same level (beforeTarget or afterTarget). Only one of these target parameters may be set. Write permissions for category data are required to use this endpoint.

Example

https://www.<your-shop>.de/admin/api/v1/categories/1081-68843/move

Request body

{
    "beforeTarget": "1080-40793"
}

Response

{
    "active": "never",
    "custom": {
        "alternativeTemplate": "",
        "defaultSort": "",
        "image": [],
        "metaDescription": "",
        "metaDescriptionSetManually": false,
        "metaTitle": "",
        "metaTitleSetManually": false,
        "robotsNoFollow": false,
        "robotsNoIndex": false,
        "seoName": "",
        "video": ""
    },
    "descr": "test",
    "hidden": false,
    "id": "1081-68843",
    "name": "Neue Kategorie",
    "productAssignmentType": "manual",
    "productRules": "",
    "timestampCreatedAt": "2025-05-02T13:59:38.000Z",
    "timestampUpdatedAt": "2025-05-02T13:59:38.000Z"
}

Error codes

Error	Type	Reason
401 Unauthorized		Not authorized: you are not logged in.
403 Forbidden		You do not have the required permissions to write category data.
400 Bad Request		Request body could not be loaded.
400 Bad Request	”invalidValue"	"stage” is invalid. The new position is in a subcategory of the category to be moved.
400 Bad Request	”missing”	A target parameter (`intoTarget`, `beforeTarget`, `afterTarget`) is missing.
400 Bad Request	”invalidFormat”	`intoTarget`, `beforeTarget`, or `afterTarget` are not strings.
400 Bad Request	”unknownDataField”	The request body contains something other than `intoTarget`, `beforeTarget`, `afterTarget`.
400 Bad Request	”invalidCombination”	Multiple target parameters (`intoTarget`, `beforeTarget`, `afterTarget`) cannot be set at the same time.
404 Not Found		The category with `id`=`{categoryId}` was not found. ”Target” does not contain a valid ID.

POST categories/{categoryId}/setRule

This endpoint can be used to assign multiple products to an existing category by its ID. In the request body, an array of rules serialized as JSON must be passed. Products that match the rules are assigned to the category. rebuilt in the response indicates whether the rule could be applied immediately. If the value is false, it will be retried later — the endpoint does not need to be triggered again. Write permissions for category data are required to use this endpoint.

Example

https://www.<your-shop>.de/admin/api/v1/categories/1081-68843/setRule

Request body

{
    "rule": "[{\"field\":\"name\",\"mode\":\"contains\",\"value\":\"h\"},{\"field\":\"price\",\"mode\":\"lt\",\"value\":\"100\"}]"
}

Response

{
    "count": 167,
    "rebuilt": true
}

Error codes

Error	Type	Reason
401 Unauthorized		Not authorized: you are not logged in.
403 Forbidden		You do not have the required permissions to write category data.
400 Bad Request		Request body could not be loaded. The rule does not work. This rule matches too many products.
400 Bad Request	”invalidValue"	"stage” is invalid.
404 Not Found		The category with `id`=`{categoryId}` was not found.
400 Bad Request	”invalidFormat”	`rule` is not a string.
400 Bad Request	”unknownDataField”	The request body contains something other than `rule`.

POST categories/rebuildRules

This endpoint updates products in categories with rule-based product assignment. Write permissions for category data are required to use this endpoint.

Example

https://www.<your-shop>.de/admin/api/v1/categories/rebuildRules

Request body

{}

Response

{
    "success": true
}

Error codes

Error	Type	Reason
401 Unauthorized		Not authorized: you are not logged in.
403 Forbidden		You do not have the required permissions to write category data.
503 Service Unavailable	”internalError”	The internal URL of the rebuilder program is not set. The rebuilder program could not be started.

POST categories

This endpoint can be used to create a new category in the shop system.
The optional parameters intoTarget, beforeTarget, or afterTarget can be used to specify where the new category should be placed in the category structure:

With intoTarget, it is created as a subcategory of an existing category.
The special value intoTarget: "root" causes the new category to be created as a main category at the top level.
With beforeTarget or afterTarget, it is placed on the same level before or after an existing category.

Only one target parameter may be set at a time. Create permissions for category data are required to use this endpoint.

Example

https://www.<your-shop>.de/admin/api/v1/categories/

Request body

{
    "name": "Neue Kategorie",
    "intoTarget": "root"
}

Response

{
    "active": "never",
    "custom": {
        "alternativeTemplate": "",
        "image": [],
        "metaDescription": "",
        "metaDescriptionSetManually": false,
        "metaTitle": "",
        "metaTitleSetManually": false,
        ...
    },
    "descr": "",
    "hidden": false,
    "id": "1080-40793",
    "name": "Neue Kategorie",
    "productAssignmentType": "manual",
    "productRules": "",
    "timestampCreatedAt": "",
    "timestampUpdatedAt": ""
}

Error codes

Error	Type	Reason
401 Unauthorized		Not authorized: you are not logged in.
403 Forbidden		You do not have the required permissions to create category data.
400 Bad Request		Request body could not be loaded.
400 Bad Request	”invalidValue"	"stage” is invalid. “Target” does not contain a valid ID. A field of type `Enumeration` contains a value that is not in the set of possible values. An image has a format that is not supported.
400 Bad Request	”invalidCombination”	Multiple target parameters (`intoTarget`, `beforeTarget`, `afterTarget`) cannot be set at the same time.
400 Bad Request	”invalidFormat”	`custom` is not an object. A field contains the value `null`. A value has a type that does not match the type from the configuration. A price value cannot be parsed. A field of type `Map` has a key that is not a string. A field of type `List` is not an array of strings. A time value is not in ISO 8601 format. Image data of an image is not an array of objects. `id` of the format or `path` are not strings.
400 Bad Request	”unknownDataField”	An attempt was made to update an unknown field. Image data contains something other than `id` and `path`.
400 Bad Request	”notManualEditable”	Manual editing has been prohibited in the configuration.

DELETE categories/{categoryId}

This endpoint can be used to delete an existing category by its ID.
This removes not only the selected category itself but also all associated subcategories from the system. Delete permissions for category data are required to use this endpoint.

Example

https://www.<your-shop>.de/admin/api/v1/categories/1081-68843

Response

{
    "success": true
}

Error codes

Error	Type	Reason
401 Unauthorized		Not authorized: you are not logged in.
403 Forbidden		You do not have the required permissions to delete category data.
400 Bad Request	”invalidValue"	"stage” is invalid.
404 Not Found		The category was not found.

Methods for product assignment

Technical limits

Products can be assigned to categories either manually or rule-based:

Manual assignment means that specific products are deliberately assigned to individual categories (e.g. “Product A belongs to Category B”).
Rule-based assignment allows categories to be automatically filled with products that meet certain criteria (e.g. “all reduced products” or “all products with stock > 0”).

For rule-based categories, the maximum number of assigned products is technically limited to 1,000 results, regardless of the number of products in the shop or the formulated rule.

GET categories/{categoryId}/products

This endpoint retrieves a list of all products that are assigned to a specific category by its ID. The parameters from and size are used to split large result sets into pages — so that the API does not have to transmit, for example, 10,000 products at once. from specifies how many entries are skipped at the beginning, size specifies the maximum number of products returned. Additionally, with the optional textSearch parameter, a text search can be performed within the assigned products. Read permissions for category data are required to use this endpoint.

Example

https://www.<your-shop>.de/admin/api/v1/categories/105-09206/products?from=0&size=50

Response

{
    "endReached": true,
    "items": [
        {
            "active": "never",
            "custom": {
                "brand": "",
                "commission": 0,
                "commissionTaxRate": "",
                ...
            },
            "descr": "SUPER COOL PRODUCT",
            "id": "100-41232",
            "itemNumber": "999999999",
            "name": "Something",
            "price": "0.000000",
            "taxRateId": "7",
            "timestampCreatedAt": "2024-09-11T09:01:15.000Z",
            "timestampUpdatedAt": "2024-12-16T14:20:41.000Z"
        },
        ...
    ],
    "totalCount": 8
}

Filter fields

not supported

Sort fields

productId (does not need to be specified explicitly. sort:asc or sort:desc is sufficient)

Error codes

Error	Type	Reason
401 Unauthorized		Not authorized: you are not logged in.
403 Forbidden		You do not have the required permissions to read category data.
400 Bad Request	”invalidValue”
400 Bad Request	”syntaxError”	`sort` contains more than one or no ”:”.

GET categories/products/unassigned

This endpoint retrieves a list of all products that are currently not assigned to any category. The parameters from and size are used to split large result sets into pages — so that the API does not have to transmit, for example, 10,000 products at once. from specifies how many entries are skipped at the beginning, size specifies the maximum number of products returned. The optional textSearch parameter enables a text search within the unassigned products. Read permissions for category data are required to use this endpoint.

Example

https://www.<your-shop>.de/admin/api/v1/categories/products/unassigned?from=0&size=50

Response

{
    "endReached": true,
    "items": [
        {
            "active": "never",
            "custom": {
                "brand": "",
                "commission": 0,
                "commissionTaxRate": "",
                ...
            },
            "descr": "",
            "id": "124-28218",
            "itemNumber": "",
            "name": "Neues Produkt",
            "price": "0.000000",
            "taxRateId": "",
            "timestampCreatedAt": "2024-09-26T10:50:23.000Z",
            "timestampUpdatedAt": "2024-12-16T14:14:42.000Z"
        },
        ...
    ],
    "totalCount": 15
}

Filter fields

not supported

Sort fields

productId (does not need to be specified explicitly.sort:ascorsort:desc is sufficient)

Error codes

Error	Type	Reason
401 Unauthorized		Not authorized: you are not logged in.
403 Forbidden		You do not have the required permissions to read category data.
400 Bad Request	”invalidValue”
400 Bad Request	”syntaxError”	`sort` contains more than one or no ”:”.

POST categories/{categoryId}/products/assign

This endpoint can be used to assign one or more products by their product IDs to a specific category by its category ID. The product IDs are passed in the prodId field — either as a string (a single product) or as an array of strings (multiple products). Optionally, with the parameters beforeTarget or afterTarget, you can specify the position within the category where the products should be placed. Both must not be set simultaneously. Write permissions for category data are required to use this endpoint.

Example

https://www.<your-shop>.de/admin/api/v1/categories/105-09206/products/assign

Request body

{
    "prodId": [
        "111-28077",
        "110-64564"
    ]
}

Response

{
    "success": true
}

Error codes

Error	Type	Reason
401 Unauthorized		Not authorized: you are not logged in.
403 Forbidden		You do not have the required permissions to write category data.
400 Bad Request		Request body could not be loaded.
400 Bad Request	”invalidValue"	"stage” is invalid.
400 Bad Request	”invalidFormat”	`prodId` is neither an array of strings nor a string. `beforeTarget` or `afterTarget` are not strings.
400 Bad Request	”unknownDataField”	A field other than `prodId`, `beforeTarget`, or `afterTarget` was passed.
400 Bad Request	”missing”	No product ID was passed.
404 Not Found	”missingCategory”	The category was not found.
404 Not Found	”missingTarget”	The position within the category is invalid.
409 Conflict	”multipleTargets”	`beforeTarget` and `afterTarget` were set at the same time.
409 Conflict	”entityNotFound”	An attempt was made to assign a product that does not exist.

POST categories/{categoryId}/products/swap

This endpoint makes it possible to swap the position of two products within a specific category. The product IDs are passed in the request body. The response indicates whether the swap could be performed successfully. Write permissions for category data are required to use this endpoint.

Example

https://www.<your-shop>.de/admin/api/v1/categories/105-09206/products/swap

Request body

{
    "productId1": "111-28077",
    "productId2": "110-64564"
}

Response

{
    "success": true
}

Error codes

Error	Type	Reason
401 Unauthorized		Not authorized: you are not logged in.
403 Forbidden		You do not have the required permissions to write category data.
400 Bad Request		Request body could not be loaded.
400 Bad Request	”invalidValue"	"stage” is invalid.
400 Bad Request	”invalidFormat”	`productId1` or `productId2` are not strings.
400 Bad Request	”missing”	`productId1` or `productId2` is missing.
400 Bad Request	”unknownDataField”	An unknown field was passed.
404 Not Found	”missingCategory”	The category was not found.

DELETE categories/{categoryId}/products/{productId}

This endpoint removes a product by its ID from a specific category by its ID. This removes the link between product and category — the product itself remains in the system but is no longer assigned to this category. Write permissions for category data are required to use this endpoint.

Example

https://www.<your-shop>.de/admin/api/v1/categories/105-09206/products/123456

Response

{
    "success": true
}

Error codes

Error	Type	Reason
401 Unauthorized		Not authorized: you are not logged in.
403 Forbidden		You do not have the required permissions to write category data.
400 Bad Request	”invalidValue"	"stage” is invalid.
404 Not Found	”missingCategory”	The category was not found.
404 Not Found	”missingProduct”	The product was not found.

DELETE categories/{categoryId}/products/

This endpoint can be used to remove multiple products at once from a specific category by its ID. The product IDs to be removed are passed as an array in the prodId field.
This removes the assignment of the products to the specified category — the products themselves remain in the system. Write permissions for category data are required to use this endpoint.

Example

https://www.<your-shop>.de/admin/api/v1/categories/105-09206/products/

Request body

{
    "prodId": [
        "111-28077",
        "110-64564"
    ]
}

Response

{
    "success": true
}

Error codes

Error	Type	Reason
401 Unauthorized		Not authorized: you are not logged in.
403 Forbidden		You do not have the required permissions to write category data.
400 Bad Request		Request body could not be loaded.
400 Bad Request	”invalidValue"	"stage” is invalid.
400 Bad Request	”invalidFormat”	A product index is not a string. `prodId` is not an array.
400 Bad Request	”unknownDataField”	A field other than `prodId` was passed.
400 Bad Request	”missing”	`prodId` is missing.
404 Not Found	”missingCategory”	The category was not found.

Note on category data fields

New category data fields (additional descriptions, images, etc.) cannot be created directly via the category API. The API serves exclusively for reading and maintaining existing fields. To define new fields, the configuration in the content.customCategoryField node must be used. → content - catalog (categories & products) Individual fields can be defined there. Once a field has been configured there, it is automatically available afterwards in the product API (e.g. in GET categories or POST categories).

Support

Bei technischen Fragen und Hilfestellungen ist unser Support-Team für Sie erreichbar: Zum Kundenportal Bitte senden Sie uns eine möglichst detaillierte Beschreibung sowie Screenshots, Requests/Antworten, damit wir Ihre Anfrage zeitnah und zielführend beantworten können.

​Supported methods

​Data fields of a category (Category Resource)

​Additional fields

​Example data record

​Methods for categories

​GET categories

​Example

​Response

​Filter fields

​Sort fields

​Error codes

​GET categories/{categoryId}

​Example

​Response

​Error codes

​PUT categories/{categoryId}

​Example

​Request body

​Response

​Error codes

​PUT categories/{categoryId}/assign

​Example

​Request body

​Response

​Error codes

​POST categories/{categoryId}/move

​Example

​Request body

​Response

​Error codes

​POST categories/{categoryId}/setRule

​Example

​Request body

​Response

​Error codes

​POST categories/rebuildRules

​Example

​Request body

​Response

​Error codes

​POST categories

​Example

​Request body

​Response

​Error codes

​DELETE categories/{categoryId}

​Example

​Response

​Error codes

​Methods for product assignment

​Technical limits

​GET categories/{categoryId}/products

​Example

​Response

​Filter fields

​Sort fields

​Error codes

​GET categories/products/unassigned

​Example

​Response

​Filter fields

​Sort fields

​Error codes

​POST categories/{categoryId}/products/assign

​Example

​Request body

​Response

​Error codes

​POST categories/{categoryId}/products/swap

​Example

​Request body

​Response

​Error codes

​DELETE categories/{categoryId}/products/{productId}

​Example

​Response

​Error codes

​DELETE categories/{categoryId}/products/

​Example

​Request body

Supported methods

Data fields of a category (Category Resource)

Additional fields

Example data record

Methods for categories

GET categories

Example

Response

Filter fields

Sort fields

Error codes

GET categories/{categoryId}

Example

Response

Error codes

PUT categories/{categoryId}

Example

Request body

Response

Error codes

PUT categories/{categoryId}/assign

Example

Request body

Response

Error codes

POST categories/{categoryId}/move

Example

Request body

Response

Error codes

POST categories/{categoryId}/setRule

Example

Request body

Response

Error codes

POST categories/rebuildRules

Example

Request body

Response

Error codes

POST categories

Example

Request body

Response

Error codes

DELETE categories/{categoryId}

Example

Response

Error codes

Methods for product assignment

Technical limits

GET categories/{categoryId}/products

Example

Response

Filter fields

Sort fields

Error codes

GET categories/products/unassigned

Example

Response

Filter fields

Sort fields

Error codes

POST categories/{categoryId}/products/assign

Example

Request body

Response

Error codes

POST categories/{categoryId}/products/swap

Example

Request body

Response

Error codes

DELETE categories/{categoryId}/products/{productId}

Example

Response

Error codes

DELETE categories/{categoryId}/products/

Example

Request body