Spryker Documentation

Backend API: Update translations of a glossary key

Wed, 09 Sep 2026 13:56:24 +0000

The glossary-keys resource of the Backend API lets Back Office integrations manage the translations of existing glossary keys. This document describes how to add, change, and remove translations of a glossary key.

Installation

The endpoints are provided by the Glossary module. For details on installing it, see Install the Spryker Core feature.

Update translations of a glossary key

To update the translations of a glossary key, send the request:

PATCH /glossary-keys/{{key}}

PATH PARAMETER	DESCRIPTION
{{key}}	Glossary key to update. The key is matched case-insensitively. To get it, retrieve glossary keys.

Request

HEADER KEY	HEADER VALUE	REQUIRED	DESCRIPTION
Authorization	string	✓	Alphanumeric string that authorizes the Back Office user to send requests to protected resources. Get it by authenticating as a Back Office user.

The update is partial and works per locale. translations entries are merged by localeName: locales you omit stay untouched, and each entry you send is applied as follows:

A non-empty value creates the translation of the locale, or overwrites the existing one. A previously removed translation becomes active again.
value: null removes the translation of the locale. The translation is unpublished from the Storefront and is returned as value: null afterwards. The glossary key itself is kept.
An empty string is rejected.

You can send one or several locales in one request, and combine additions and removals.

Request sample: change the German translation and remove the English one

PATCH https://glue-backend.mysprykershop.com/glossary-keys/general.newsletter.hint

{
    "data": {
        "type": "glossary-keys",
        "id": "general.newsletter.hint",
        "attributes": {
            "translations": [
                {
                    "localeName": "de_DE",
                    "value": "Jetzt Newsletter abonnieren"
                },
                {
                    "localeName": "en_US",
                    "value": null
                }
            ]
        }
    }
}

ATTRIBUTE	TYPE	REQUIRED	DESCRIPTION
translations	Array	✓	Translations to apply, merged by `localeName`. Each `localeName` can appear once.
translations.localeName	String	✓	Name of a configured locale—for example, `en_US`.
translations.value	String	✓	New translated text in the locale, or `null` to remove the translation. Must not be an empty string.

key cannot be changed.

Response

The response contains the updated glossary key with one translations entry per configured locale, including the locales you didn’t send.

Response sample: update translations of a glossary key

{
    "data": {
        "id": "general.newsletter.hint",
        "type": "glossary-keys",
        "attributes": {
            "key": "general.newsletter.hint",
            "translations": [
                {
                    "localeName": "de_DE",
                    "value": "Jetzt Newsletter abonnieren"
                },
                {
                    "localeName": "en_US",
                    "value": null
                }
            ]
        },
        "links": {
            "self": "https://glue-backend.mysprykershop.com/glossary-keys/general.newsletter.hint"
        }
    }
}

ATTRIBUTE	TYPE	DESCRIPTION
key	String	Unique key of the glossary entry. It is also the resource `id`.
translations	Array	Translations of the key, one entry per configured locale, ordered by `localeName`. The list is always complete: a locale without an active translation is included with `value: null`.
translations.localeName	String	Locale name—for example, `en_US`.
translations.value	String	Translated text in the locale. `null` when the key has no active translation in the locale.

Possible errors

The request is validated as a whole: if any check fails, nothing is updated and all failed checks are returned in the errors array.

STATUS	CODE	REASON
404	N/A	The glossary key with the specified key doesn’t exist.
422	901	An attribute has a wrong type, or a `value` is an empty string—for example, `translations.0.value => This value is too short. It should have 1 character or more.`
422	N/A	`key` differs from the key of the glossary key. The key cannot be changed.
422	N/A	A locale specified in `translations` is not configured, or an entry has no `localeName`.
422	N/A	A `localeName` appears more than once in `translations`.

| 401 | N/A | The Authorization header is missing, or the access token is invalid or expired. | | 403 | N/A | The authenticated Back Office user is not allowed to access the glossary-keys resource. |

To view generic errors and status codes of the Backend API, see Backend API request and response reference.

Backend API: Retrieve glossary keys

Wed, 09 Sep 2026 13:56:24 +0000

The glossary-keys resource of the Backend API lets Back Office integrations read glossary keys and their translations. This document describes how to retrieve a paginated glossary key collection and a single glossary key.

Installation

The endpoints are provided by the Glossary module. For details on installing it, see Install the Spryker Core feature.

Retrieve glossary keys

To retrieve a paginated collection of glossary keys, send the request:

GET /glossary-keys

Request

HEADER KEY	HEADER VALUE	REQUIRED	DESCRIPTION
Authorization	string	✓	Alphanumeric string that authorizes the Back Office user to send requests to protected resources. Get it by authenticating as a Back Office user.

QUERY PARAMETER	DESCRIPTION	EXEMPLARY VALUES
page[limit]	Number of glossary keys per page. Default: `10`, maximum: `100`. A higher value is reduced to the maximum.	`page[limit]=20`
page[offset]	Number of glossary keys to skip. Default: `0`.	`page[offset]=20`
sort	Sorts the collection by a field. Prefix the field with `-` for descending order. The only supported field is `key`; the collection is sorted by `key` in ascending order by default. Any other field returns a `400` error.	`sort=key` `sort=-key`
filter[glossary-keys.key]	Returns only the glossary keys that contain the specified fragment. The fragment is matched case-insensitively.	`filter[glossary-keys.key]=general.`
filter[glossary-keys.value]	Returns only the glossary keys that have at least one active translation, in any locale, containing the specified fragment. The fragment is matched case-insensitively. Removed translations are not matched.	`filter[glossary-keys.value]=Weiter`

When both filters are provided, a glossary key has to match both of them.

REQUEST	USAGE
`GET https://glue-backend.mysprykershop.com/glossary-keys`	Retrieve the first page of the glossary key collection.
`GET https://glue-backend.mysprykershop.com/glossary-keys?page[limit]=2&page[offset]=2`	Retrieve the second page of the collection with two glossary keys per page.
`GET https://glue-backend.mysprykershop.com/glossary-keys?sort=-key`	Retrieve glossary keys sorted by key in descending order.
`GET https://glue-backend.mysprykershop.com/glossary-keys?filter[glossary-keys.key]=general.`	Retrieve glossary keys containing `general.`.
`GET https://glue-backend.mysprykershop.com/glossary-keys?filter[glossary-keys.value]=Weiter`	Retrieve glossary keys with an active translation containing `Weiter` in any locale.
`GET https://glue-backend.mysprykershop.com/glossary-keys?filter[glossary-keys.key]=button&filter[glossary-keys.value]=Next`	Retrieve glossary keys containing `button` that have an active translation containing `Next`.

Response

The pagination summary is returned in the top-level meta.pagination object, and the pagination links in the top-level links object. Collection members do not carry pagination data.

Every glossary key carries one translations entry per configured locale, even when a filter matched the key by one of its translations only.

Response sample: retrieve glossary keys

{
    "links": {
        "self": "https://glue-backend.mysprykershop.com/glossary-keys?filter[glossary-keys.key]=general.",
        "first": "https://glue-backend.mysprykershop.com/glossary-keys?filter[glossary-keys.key]=general.&page[limit]=2&page[offset]=0",
        "last": "https://glue-backend.mysprykershop.com/glossary-keys?filter[glossary-keys.key]=general.&page[limit]=2&page[offset]=60",
        "next": "https://glue-backend.mysprykershop.com/glossary-keys?filter[glossary-keys.key]=general.&page[limit]=2&page[offset]=2"
    },
    "meta": {
        "pagination": {
            "numFound": 61,
            "currentPage": 1,
            "maxPage": 31,
            "currentItemsPerPage": 2
        }
    },
    "data": [
        {
            "id": "general.back",
            "type": "glossary-keys",
            "attributes": {
                "key": "general.back",
                "translations": [
                    {
                        "localeName": "de_DE",
                        "value": "Zurück"
                    },
                    {
                        "localeName": "en_US",
                        "value": "Back"
                    }
                ]
            },
            "links": {
                "self": "https://glue-backend.mysprykershop.com/glossary-keys/general.back"
            }
        },
        {
            "id": "general.next.button",
            "type": "glossary-keys",
            "attributes": {
                "key": "general.next.button",
                "translations": [
                    {
                        "localeName": "de_DE",
                        "value": "Weiter"
                    },
                    {
                        "localeName": "en_US",
                        "value": "Next"
                    }
                ]
            },
            "links": {
                "self": "https://glue-backend.mysprykershop.com/glossary-keys/general.next.button"
            }
        }
    ]
}

META ATTRIBUTE	TYPE	DESCRIPTION
pagination.numFound	Integer	Total number of glossary keys in the collection.
pagination.currentPage	Integer	Number of the current page.
pagination.maxPage	Integer	Total number of pages.
pagination.currentItemsPerPage	Integer	Number of glossary keys per page.

ATTRIBUTE	TYPE	DESCRIPTION
key	String	Unique key of the glossary entry. It is also the resource `id`.
translations	Array	Translations of the key, one entry per configured locale, ordered by `localeName`. The list is always complete: a locale without an active translation is included with `value: null`.
translations.localeName	String	Locale name—for example, `en_US`.
translations.value	String	Translated text in the locale. `null` when the key has no active translation in the locale.

Retrieve a glossary key

To retrieve a single glossary key with its translations, send the request:

GET /glossary-keys/{{key}}

PATH PARAMETER	DESCRIPTION
{{key}}	Glossary key to retrieve. The key is matched case-insensitively; the response contains the stored key. To get it, retrieve glossary keys.

Request

HEADER KEY	HEADER VALUE	REQUIRED	DESCRIPTION
Authorization	string	✓	Alphanumeric string that authorizes the Back Office user to send requests to protected resources. Get it by authenticating as a Back Office user.

Request sample: retrieve a glossary key

GET https://glue-backend.mysprykershop.com/glossary-keys/general.next.button

Response

Response sample: retrieve a glossary key

{
    "data": {
        "id": "general.next.button",
        "type": "glossary-keys",
        "attributes": {
            "key": "general.next.button",
            "translations": [
                {
                    "localeName": "de_DE",
                    "value": "Weiter"
                },
                {
                    "localeName": "en_US",
                    "value": "Next"
                }
            ]
        },
        "links": {
            "self": "https://glue-backend.mysprykershop.com/glossary-keys/general.next.button"
        }
    }
}

ATTRIBUTE	TYPE	DESCRIPTION
key	String	Unique key of the glossary entry. It is also the resource `id`.
translations	Array	Translations of the key, one entry per configured locale, ordered by `localeName`. The list is always complete: a locale without an active translation is included with `value: null`.
translations.localeName	String	Locale name—for example, `en_US`.
translations.value	String	Translated text in the locale. `null` when the key has no active translation in the locale.

Possible errors

STATUS	CODE	REASON
400	400	The `sort` parameter references an unsupported field. The supported fields are listed in the error details.
404	N/A	The glossary key with the specified key doesn’t exist.

To view generic errors and status codes of the Backend API, see Backend API request and response reference.

Backend API: Create a glossary key

Wed, 09 Sep 2026 13:56:24 +0000

The glossary-keys resource of the Backend API lets Back Office integrations create glossary keys together with their translations. This document describes how to create a glossary key and which validations the request has to pass.

Installation

The endpoints are provided by the Glossary module. For details on installing it, see Install the Spryker Core feature.

Create a glossary key

To create a glossary key, send the request:

POST /glossary-keys

Request

HEADER KEY	HEADER VALUE	REQUIRED	DESCRIPTION
Authorization	string	✓	Alphanumeric string that authorizes the Back Office user to send requests to protected resources. Get it by authenticating as a Back Office user.

Request sample: create a glossary key with translations in two locales

POST https://glue-backend.mysprykershop.com/glossary-keys

{
    "data": {
        "type": "glossary-keys",
        "attributes": {
            "key": "general.newsletter.hint",
            "translations": [
                {
                    "localeName": "en_US",
                    "value": "Subscribe to our newsletter"
                },
                {
                    "localeName": "de_DE",
                    "value": "Abonnieren Sie unseren Newsletter"
                }
            ]
        }
    }
}

ATTRIBUTE	TYPE	REQUIRED	DESCRIPTION
key	String	✓	Unique glossary key, up to 255 characters. It becomes the resource `id` and cannot be changed later. Keys are matched case-insensitively, so a key that differs from an existing one only by case is rejected as a duplicate.
translations	Array		Translations of the key. Provide any subset of the configured locales; each `localeName` can appear once. Omit the attribute or send an empty array to create the key without translations.
translations.localeName	String	✓	Name of a configured locale—for example, `en_US`.
translations.value	String	✓	Translated text in the locale. Must be a non-empty string.

Locales without a translation

You can create a key with translations in a subset of the configured locales. The locales you omit are returned with value: null, and the key is not translated in those locales until you add the translations.

Response

The response contains the created glossary key with one translations entry per configured locale.

Response sample: create a glossary key

{
    "data": {
        "id": "general.newsletter.hint",
        "type": "glossary-keys",
        "attributes": {
            "key": "general.newsletter.hint",
            "translations": [
                {
                    "localeName": "de_DE",
                    "value": "Abonnieren Sie unseren Newsletter"
                },
                {
                    "localeName": "en_US",
                    "value": "Subscribe to our newsletter"
                }
            ]
        },
        "links": {
            "self": "https://glue-backend.mysprykershop.com/glossary-keys/general.newsletter.hint"
        }
    }
}

ATTRIBUTE	TYPE	DESCRIPTION
key	String	Unique key of the glossary entry. It is also the resource `id`.
translations	Array	Translations of the key, one entry per configured locale, ordered by `localeName`. The list is always complete: a locale without an active translation is included with `value: null`.
translations.localeName	String	Locale name—for example, `en_US`.
translations.value	String	Translated text in the locale. `null` when the key has no active translation in the locale.

Possible errors

The request is validated as a whole: if any check fails, nothing is created and all failed checks are returned in the errors array.

STATUS	CODE	REASON
422	901	A required attribute is missing, is blank, or has a wrong type—for example, `key => This value should not be blank.` or `translations.0.value => This value should not be blank.`
422	N/A	A glossary key with the specified `key` already exists. Keys are compared case-insensitively.
422	N/A	A locale specified in `translations` is not configured, or an entry has no `localeName`.
422	N/A	A `localeName` appears more than once in `translations`.
422	N/A	A `value` in `translations` is `null`. When creating a key, every listed locale needs a translated text; to create the key without a translation in a locale, omit that locale.

To view generic errors and status codes of the Backend API, see Backend API request and response reference.

Integrate warehouse address ACL for the Merchant Portal

Tue, 08 Sep 2026 09:41:00 +0000

In the Merchant Portal, Propel queries are scoped by ACL entity rules, and an entity that is absent from the composed ACL entity metadata configuration is not readable for merchant users. `Orm\Zed\StockAddress\Persistence\SpyStockAddress` is such an entity unless you register it explicitly. When the entity is missing from the configuration, merchant users cannot read warehouse addresses: `StockTransfer.address` stays empty even though the `spy_stock_address` record exists. Features that depend on the warehouse address can then fail further downstream, far from the actual cause. `StockAddressAclEntityConfigurationExpanderPlugin` registers `SpyStockAddress` as a sub-entity of `SpyStock`. The address then inherits the ACL scope of its stock, so a merchant user who can read a warehouse can also read that warehouse's address. ## Prerequisites Before you start, make sure that the following prerequisites are met: - Your project uses the Merchant Portal with ACL entity restrictions enabled. - Your project uses `spryker/stock-address` 1.5.0 or later. `StockAddressAclEntityConfigurationExpanderPlugin` was introduced in version 1.5.0. Minimum required versions of the packages: | Package | Minimum version | | --- | --- | | spryker/stock-address | 1.5.0 | If your project uses an earlier version, upgrade the package to version 1.5.0 or later: ```bash composer require spryker/stock-address:"^1.5.0" --update-with-dependencies ``` ## Register the ACL entity configuration plugin Add `StockAddressAclEntityConfigurationExpanderPlugin` to the `getAclEntityConfigurationExpanderPlugins()` method:

src/Pyz/Zed/AclMerchantPortal/AclMerchantPortalDependencyProvider.php

```php */ protected function getAclEntityConfigurationExpanderPlugins(): array { return [ // ... other ACL entity configuration expander plugins new StockAddressAclEntityConfigurationExpanderPlugin(), ]; } } ```

The plugin registers the following entity: | Entity | Relationship | Reason | |---|---|---| | `Orm\Zed\StockAddress\Persistence\SpyStockAddress` | Sub-entity of `Orm\Zed\Stock\Persistence\SpyStock` | The address belongs to a single warehouse, so it inherits the ACL scope of that warehouse instead of defining its own permissions. | Because you changed a dependency provider, clear the application cache by running: ```bash vendor/bin/console cache:empty-all ``` ## Verify the integration First, validate the ACL entity metadata configuration: ```bash vendor/bin/console acl-entity:metadata:validate ``` When the warehouse address metadata is registered correctly, the output is `ACL entity metadata configuration is valid.` To verify that merchant users can read warehouse addresses: 1. Make sure that the warehouse assigned to one of the merchant's product offers has an address. In the database, the `spy_stock_address` table must contain a record whose `fk_stock` points to that warehouse. 2. Log in to the Merchant Portal as a user of that merchant. 3. Open an order that contains a product offer from that warehouse and trigger an operation that reads the warehouse address, such as a refund. 4. Make sure that the operation completes and that the order moves to the expected state. 5. Make sure that no `NullValueException` for a missing address is logged for the request.

Migration status - Glue API to API Platform

Mon, 07 Sep 2026 15:12:46 +0000

This document tracks Spryker's migration of API-providing modules to the **API Platform** (built on Symfony and the API Platform library). Use it to plan upgrades and check the current status of every module. {% info_block infoBox "Looking for the migration steps?" %} This page only tracks **which** modules are available on API Platform and their status. The end-to-end migration steps—upgrade the modules, confirm configuration, flip routing, verify, and clean up—are owned by the [API Platform migration overview](/docs/integrations/spryker-api/migrate-from-glue-to-api-platform/migrate-to-api-platform-overview.html). See also: - [Migrate to API Platform](/docs/integrations/spryker-api/migrate-from-glue-to-api-platform/migrate-to-api-platform.html) (per module) - [Integrate API Platform](/docs/integrations/spryker-api/migrate-from-glue-to-api-platform/integrate-api-platform.html) - [Integrate API Platform security](/docs/integrations/spryker-api/authenticating-and-authorization/integrate-api-platform-security.html) - [API Platform architecture](/docs/integrations/spryker-api/api-platform/api-platform.html) {% endinfo_block %} ## Status legend | Status | Meaning | |---|---| | Migrated | Module is available on API Platform and production-ready. | | Reimplemented | The legacy module's endpoints are superseded by a new API Platform implementation delivered by other modules. Not backward compatible: payloads, identifiers, validation and the set of available operations differ — see the linked documentation. | | Planned | Module is scheduled or queued for migration to API Platform. | ## Storefront API modules All StorefrontAPI and Extension-only StorefrontAPI modules. Migrated modules are listed first. | Module | Category | Status | Released In | Requires | Key endpoints | |---|---|---|---|---|---| | ContentProductAbstractListsRestApi | StorefrontAPI | Migrated | 1.4.0 | ProductsRestApi | GET /content-product-abstract-lists/{id}
GET /content-product-abstract-lists/{id}/abstract-products | | MerchantOpeningHoursRestApi | StorefrontAPI | Migrated | 1.2.0 | — | GET /merchants/{id}/merchant-opening-hours | | MerchantCategoriesRestApi | Extension-only StorefrontAPI | Migrated | 1.2.0 | MerchantsRestApi | (extension-only) | | MerchantProductOffersRestApi | StorefrontAPI | Migrated | 2.2.0 | — | GET /concrete-products/{id}/product-offers
GET /product-offers/{id} | | MerchantProductOfferServicePointAvailabilitiesRestApi | Extension-only StorefrontAPI | Migrated | 0.4.0 | ProductOfferServicePointAvailabilitiesRestApi | (extension-only) | | MerchantsRestApi | StorefrontAPI | Migrated | 1.2.0 | — | GET /merchants
GET /merchants/{id}
GET /merchants/{id}/merchant-addresses | | OrderPaymentsRestApi | StorefrontAPI | Migrated | 1.2.0 | — | POST /order-payments | | PaymentsRestApi | StorefrontAPI | Migrated | 1.7.0 | — | POST /payments
POST /payment-cancellations
POST /payment-customers | | ProductAvailabilitiesRestApi | StorefrontAPI | Migrated | 4.4.0 | ProductsRestApi | GET /abstract-products/{id}/abstract-product-availabilities
GET /concrete-products/{id}/concrete-product-availabilities | | ProductOfferAvailabilitiesRestApi | StorefrontAPI | Migrated | 1.3.0 | — | GET /product-offers/{id}/product-offer-availabilities | | ProductOfferServicePointAvailabilitiesRestApi | StorefrontAPI | Migrated | 1.2.0 | — | POST /product-offer-service-point-availabilities | | ProductOfferPricesRestApi | StorefrontAPI | Migrated | 2.5.0 | — | GET /product-offers/{id}/product-offer-prices | | ProductPricesRestApi | StorefrontAPI | Migrated | 1.12.0 | ProductsRestApi | GET /abstract-products/{id}/abstract-product-prices
GET /concrete-products/{id}/concrete-product-prices | | ProductTaxSetsRestApi | StorefrontAPI | Migrated | 2.3.0 | — | GET /abstract-products/{id}/product-tax-sets | | ProductsRestApi | StorefrontAPI | Migrated | 2.17.0 | — | GET /abstract-products/{id}
GET /concrete-products/{id} | | ShipmentTypeProductOfferServicePointAvailabilitiesRestApi | Extension-only StorefrontAPI | Migrated | 1.2.0 | ProductOfferServicePointAvailabilitiesRestApi | (extension-only) | | StoresApi | StorefrontAPI | Migrated | 1.3.0 | — | GET /stores | | AgentAuthRestApi | StorefrontAPI | Migrated | 1.3.0 | — | POST /agent-access-tokens
POST /agent-customer-impersonation-access-tokens
GET /agent-customer-search | | AlternativeProductsRestApi | StorefrontAPI | Migrated | 1.3.0 | ProductsRestApi | GET /abstract-products/{id}/related-products
GET /concrete-products/{id}/abstract-alternative-products
GET /concrete-products/{id}/concrete-alternative-products | | AuthRestApi | StorefrontAPI | Migrated | 2.17.0 | — | POST /token
POST /access-tokens
POST /refresh-tokens
DELETE /refresh-tokens/{id} | | AvailabilityNotificationsRestApi | StorefrontAPI | Migrated | 1.4.0 | — | POST /availability-notifications
DELETE /availability-notifications/{id}
GET /my-availability-notifications
GET /customers/{id}/availability-notifications | | CartCodesRestApi | StorefrontAPI | Migrated | 1.7.0 | CartsRestApi | POST /carts/{id}/cart-codes
DELETE /carts/{id}/cart-codes/{id}
POST /guest-carts/{id}/cart-codes
DELETE /guest-carts/{id}/cart-codes/{id} | | CartPermissionGroupsRestApi | StorefrontAPI | Migrated | 1.4.0 | — | GET /cart-permission-groups
GET /cart-permission-groups/{id} | | CartReorderRestApi | StorefrontAPI | Migrated | 1.3.0 | CartsRestApi | POST /cart-reorder | | CartsRestApi | StorefrontAPI | Migrated | 5.25.0 | — | GET,POST /carts
GET,PATCH,DELETE /carts/{id}
POST /carts/{id}/items
PATCH,DELETE /carts/{id}/items/{id}
GET /guest-carts
GET,PATCH /guest-carts/{id}
POST /guest-carts/{id}/guest-cart-items
PATCH,DELETE /guest-carts/{id}/guest-cart-items/{id}
GET /customers/{id}/carts | | CatalogSearchRestApi | StorefrontAPI | Migrated | 2.13.0 | — | GET /catalog-search
GET /catalog-search-suggestions | | CategoriesRestApi | StorefrontAPI | Migrated | 1.9.0 | — | GET /category-trees
GET /category-nodes/{id} | | CheckoutRestApi | StorefrontAPI | Migrated | 3.14.0 | CartsRestApi | POST /checkout-data
POST /checkout | | CmsPagesRestApi | StorefrontAPI | Migrated | 1.2.0 | — | GET /cms-pages
GET /cms-pages/{id} | | CompaniesRestApi | StorefrontAPI | Migrated | 1.5.0 | — | GET /companies
GET /companies/{id} | | CompanyBusinessUnitAddressesRestApi | StorefrontAPI | Migrated | 1.4.0 | — | GET /company-business-unit-addresses
GET /company-business-unit-addresses/{id} | | CompanyBusinessUnitsRestApi | StorefrontAPI | Migrated | 1.6.0 | — | GET /company-business-units
GET /company-business-units/{id} | | CompanyRolesRestApi | StorefrontAPI | Migrated | 1.3.0 | — | GET /company-roles
GET /company-roles/{id} | | CompanyUserAuthRestApi | StorefrontAPI | Migrated | 2.3.0 | — | POST /company-user-access-tokens | | CompanyUsersRestApi | StorefrontAPI | Migrated | 2.11.0 | — | GET /company-users
GET /company-users/{id} | | ConfigurableBundleCartsRestApi | StorefrontAPI | Migrated | 1.2.0 | CartsRestApi | POST /carts/{id}/configured-bundles
PATCH,DELETE /carts/{id}/configured-bundles/{id}
POST,PATCH,DELETE /guest-carts/{id}/guest-configured-bundles/{id} | | ConfigurableBundlesRestApi | StorefrontAPI | Migrated | 1.3.0 | — | GET /configurable-bundle-templates
GET /configurable-bundle-templates/{id} | | ContentBannersRestApi | StorefrontAPI | Migrated | 2.4.0 | — | GET /content-banners/{id} | | CustomerAccessRestApi | StorefrontAPI | Migrated | 1.3.0 | — | GET /customer-access | | CustomersRestApi | StorefrontAPI | Migrated | 1.28.0 | — | GET,POST /customers
GET,PATCH,DELETE /customers/{id}
GET,POST /customers/{id}/addresses
GET,PATCH,DELETE /customers/{id}/addresses/{id}
POST /customer-forgotten-password
PATCH /customer-restore-password/{id}
PATCH /customer-password/{id}
POST /customer-confirmation | | DiscountPromotionsRestApi | Extension-Only-StorefrontAPI | Migrated | 1.6.0 | CartCodesRestApi, CartsRestApi | (extension-only) | | EntityTagsRestApi | Extension-only StorefrontAPI | Migrated | 1.1.0 | — | (extension-only) | | GiftCardsRestApi | Extension-only StorefrontAPI | Migrated | 1.2.0 | — | (extension-only) | | HealthCheck | StorefrontAPI | Migrated | 1.1.0 | — | GET /health-check | | MerchantProductOfferShoppingListsRestApi | Extension-only StorefrontAPI | Migrated | 1.2.0 | — | (extension-only) | | MerchantProductOfferWishlistRestApi | Extension-only StorefrontAPI | Migrated | 1.3.0 | WishlistsRestApi | (extension-only) | | MerchantProductShoppingListsRestApi | Extension-only StorefrontAPI | Migrated | 1.2.0 | — | (extension-only) | | MerchantProductsRestApi | Extension-only StorefrontAPI | Migrated | 1.1.0 | CartsRestApi | (extension-only) | | MerchantSalesReturnsRestApi | Extension-only StorefrontAPI | Migrated | 1.1.0 | — | (extension-only) | | MerchantShipmentsRestApi | Extension-only StorefrontAPI | Migrated | 0.1.1 | ShipmentsRestApi | (extension-only) | | MultiCartsRestApi | Extension-only StorefrontAPI | Migrated | 1.1.0 | CartsRestApi | (extension-only) | | MultiFactorAuth | StorefrontAPI | Migrated | 2.5.0 | — | GET /multi-factor-auth-types, POST /multi-factor-auth-trigger, POST /multi-factor-auth-type-activate, POST /multi-factor-auth-type-verify, POST /multi-factor-auth-type-deactivate | | NavigationsRestApi | StorefrontAPI | Migrated | 2.3.0 | — | GET /navigations/{id} | | OauthApi | StorefrontAPI | Migrated | 1.4.1 | — | POST /token | | OrderAmendmentsRestApi | Extension-only StorefrontAPI | Migrated | 1.2.0 | CartReorderRestApi, CartsRestApi, OrdersRestApi | (extension-only) | | OrdersRestApi | StorefrontAPI | Migrated | 4.14.0 | — | GET /orders
GET /orders/{orderReference}
GET /orders/{orderReference}/order-items/{uuid}
GET /customers/{customerReference}/orders | | PriceProductOfferVolumesRestApi | Extension-only StorefrontAPI | Migrated | 1.1.1 | ProductOfferPricesRestApi | (extension-only) | | PriceProductVolumesRestApi | Extension-only StorefrontAPI | Migrated | 1.2.0 | ProductPricesRestApi | (extension-only) | | ProductAttributesRestApi | StorefrontAPI | Migrated | 1.3.0 | — | GET /product-management-attributes
GET /product-management-attributes/{id} | | ProductBundleCartsRestApi | Extension-only StorefrontAPI | Migrated | 1.4.0 | CartsRestApi, ShipmentsRestApi | (extension-only) | | ProductBundlesRestApi | StorefrontAPI | Migrated | 1.2.0 | OrdersRestApi | GET /concrete-products/{id}/bundled-products | | ProductConfigurationShoppingListsRestApi | Extension-only StorefrontAPI | Migrated | 1.2.0 | ShoppingListsRestApi | (extension-only) | | ProductConfigurationWishlistsRestApi | Extension-only StorefrontAPI | Migrated | 1.3.0 | WishlistsRestApi | (extension-only) | | ProductConfigurationsPriceProductVolumesRestApi | Extension-only StorefrontAPI | Migrated | 1.1.0 | ProductConfigurationShoppingListsRestApi, ProductConfigurationWishlistsRestApi, ProductConfigurationsRestApi | (extension-only) | | ProductConfigurationsRestApi | Extension-only StorefrontAPI | Migrated | 1.2.0 | CartsRestApi, OrdersRestApi, ProductsRestApi | (extension-only) | | ProductDiscontinuedRestApi | Extension-only StorefrontAPI | Migrated | 1.1.1 | ProductsRestApi | (extension-only) | | ProductImageSetsRestApi | StorefrontAPI | Migrated | 1.3.0 | ProductsRestApi | GET /abstract-products/{id}/abstract-product-image-sets
GET /concrete-products/{id}/concrete-product-image-sets | | ProductLabelsRestApi | StorefrontAPI | Migrated | 1.5.0 | — | GET /product-labels/{id} | | ProductMeasurementUnitsRestApi | StorefrontAPI | Migrated | 1.3.0 | — | GET /product-measurement-units/{id}
GET /concrete-products/{id}/sales-units | | ProductOfferSalesRestApi | Extension-only StorefrontAPI | Migrated | 1.2.0 | — | (extension-only) | | ProductOfferShoppingListsRestApi | Extension-only StorefrontAPI | Migrated | 1.2.0 | — | (extension-only) | | ProductOffersRestApi | Extension-only StorefrontAPI | Migrated | 1.1.0 | ProductsRestApi | (extension-only) | | ProductOptionsRestApi | Extension-only StorefrontAPI | Migrated | 1.5.0 | CartsRestApi, OrdersRestApi, ProductsRestApi, QuoteRequestsRestApi | (extension-only) | | ProductReviewsRestApi | StorefrontAPI | Migrated | 1.3.0 | — | GET,POST /abstract-products/{id}/product-reviews
GET /abstract-products/{id}/product-reviews/{id} | | QuoteRequestAgentsRestApi | StorefrontAPI | Migrated | 0.4.2 | QuoteRequestsRestApi | GET,POST /agent-quote-requests
GET,PATCH /agent-quote-requests/{id}
POST /agent-quote-requests/{id}/agent-quote-request-cancel
POST /agent-quote-requests/{id}/agent-quote-request-revise
POST /agent-quote-requests/{id}/agent-quote-request-send-to-customer | | QuoteRequestsRestApi | StorefrontAPI | Migrated | 0.2.2 | CartsRestApi | GET,POST /quote-requests
GET,PATCH /quote-requests/{id}
POST /quote-requests/{id}/quote-request-cancel
POST /quote-requests/{id}/quote-request-revise
POST /quote-requests/{id}/quote-request-send-to-user
POST /quote-requests/{id}/quote-request-convert-to-quote | | RelatedProductsRestApi | StorefrontAPI | Migrated | 1.5.0 | ProductsRestApi | GET /abstract-products/{id}/related-products | | SalesOrderThresholdsRestApi | Extension-only StorefrontAPI | Migrated | 1.1.0 | CartsRestApi, CheckoutRestApi | (extension-only) | | SalesReturnsRestApi | StorefrontAPI | Migrated | 1.3.0 | — | GET /return-reasons
GET,POST /returns
GET /returns/{id} | | SecurityBlockerRestApi | Extension-only StorefrontAPI | Migrated | 1.1.0 | — | (extension-only) | | ServicePointCartsRestApi | Extension-only StorefrontAPI | Migrated | 1.1.0 | CheckoutRestApi | (extension-only) | | ServicePointsRestApi | StorefrontAPI | Migrated | 1.2.0 | — | GET /service-points
GET /service-points/{id}
GET /service-points/{id}/service-point-addresses/{id} | | SharedCartsRestApi | StorefrontAPI | Migrated | 1.4.0 | — | POST /carts/{id}/shared-carts
PATCH,DELETE /shared-carts/{id} | | ShipmentTypeServicePointsRestApi | Extension-only StorefrontAPI | Migrated | 1.1.0 | CheckoutRestApi, ServicePointsRestApi, ShipmentTypesRestApi, ShipmentsRestApi | (extension-only) | | ShipmentTypesRestApi | StorefrontAPI | Migrated | 1.2.0 | — | GET /shipment-types
GET /shipment-types/{id} | | ShipmentsRestApi | Extension-only StorefrontAPI | Migrated | 1.16.0 | CheckoutRestApi, OrdersRestApi, QuoteRequestsRestApi | (extension-only) | | ShoppingListsRestApi | StorefrontAPI | Migrated | 1.5.0 | — | GET,POST /shopping-lists
GET,PATCH,DELETE /shopping-lists/{id}
POST /shopping-lists/{id}/shopping-list-items
PATCH,DELETE /shopping-lists/{id}/shopping-list-items/{id} | | UpSellingProductsRestApi | StorefrontAPI | Migrated | 1.4.0 | CartsRestApi, ProductsRestApi | GET /carts/{id}/up-selling-products
GET /guest-carts/{id}/up-selling-products | | UrlsRestApi | StorefrontAPI | Migrated | 1.2.0 | — | GET /url-resolver | | Vertex | StorefrontAPI | Migrated | 1.2.0 | — | POST /tax-id-validate | | WishlistsRestApi | StorefrontAPI | Migrated | 1.8.0 | — | GET,POST /wishlists
GET,PATCH,DELETE /wishlists/{id}
POST /wishlists/{id}/wishlist-items
PATCH,DELETE /wishlists/{id}/wishlist-items/{id} | ### Backward-compatible extension modules (no migration required) The following modules are not migrated to API Platform and do not need to be. They expose no API resource of their own — they only contribute plugins (mappers and expanders) that are consumed in a backward-compatible way by both the legacy Glue REST API and the API Platform resources of the host module they extend. Because they carry no standalone resource, they have no "Released In" version. | Module | Plugin provided | Consumed by | |---|---|---| | DiscountsRestApi | DiscountsRestQuoteRequestAttributesExpanderPlugin | QuoteRequestsRestApi | | MerchantRelationshipProductListsRestApi | CustomerProductListCustomerExpanderPlugin | CustomersRestApi | | OmsRestApi | OmsRestOrderItemsAttributesMapperPlugin | OrdersRestApi | ## Backend API modules All BackendAPI modules tracked in the migration scope. {% info_block warningBox "Backend API endpoints are not backward compatible" %} The Backend API migration is not implemented inside the legacy modules listed below. The new endpoints are delivered by the feature modules listed in the **Feature** column, and they are **not backward compatible** with the legacy Glue endpoints they replace: payloads, identifiers, validation, error responses, and the set of available operations can differ. Before you migrate, review the differences for each feature individually in that feature's documentation. {% endinfo_block %} | Module | Category | Status | Implemented in | Released In | Requires | Key endpoints | |---|---|---|---|---|---|---| | CartNotesBackendApi | Extension-Only BackendAPI | Planned | — | — | SalesOrdersBackendApi | (extension-only) | | CategoriesBackendApi | BackendAPI | Reimplemented | `Spryker.Category`, `Spryker.ProductCategory` — see [Manage categories via Backend API](/docs/pbc/all/product-information-management/latest/base-shop/manage-using-backend-api/categories/backend-api-retrieve-categories.html) | — | — | GET,POST /categories
GET,PATCH,DELETE /categories/{categoryKey}
GET /categories/{categoryKey}/products
GET /categories/{categoryKey}/products/{sku}
POST /categories/{categoryKey}/assign-products
POST /categories/{categoryKey}/unassign-products | | DynamicEntityBackendApi | BackendAPI | Planned | — | — | — | GET,POST,PATCH,PUT /dynamic-entity/{entity-name} (~62 auto-generated entity endpoints) | | OauthBackendApi | BackendAPI | Planned | — | — | — | POST /token | | PickingListsBackendApi | BackendAPI | Planned | — | — | — | GET /picking-lists
GET /picking-lists/{id}
PATCH /picking-lists/{id}/picking-list-items/{id}
POST /start-picking | | PickingListsUsersBackendApi | Extension-Only BackendAPI | Planned | — | — | PickingListsBackendApi, UsersBackendApi | (extension-only) | | PickingListsWarehousesBackendApi | Extension-Only BackendAPI | Planned | — | — | PickingListsBackendApi, WarehousesBackendApi | (extension-only) | | ProductAttributesBackendApi | BackendAPI | Planned | — | — | — | GET,POST /product-attributes
GET,PATCH /product-attributes/{id} | | ProductImageSetsBackendApi | BackendAPI | Planned | — | — | — | GET /concrete-product-image-sets | | ProductPackagingUnitsBackendApi | Extension-Only BackendAPI | Planned | — | — | PickingListsBackendApi | (extension-only) | | ProductsBackendApi | BackendAPI | Planned | — | — | — | GET,POST /product-abstract
DELETE,GET,PATCH /product-abstract/{id} | | PushNotificationsBackendApi | BackendAPI | Planned | — | — | — | GET,POST /push-notification-providers
PATCH,DELETE /push-notification-providers/{id}
POST /push-notification-subscriptions | | SalesOrdersBackendApi | BackendAPI | Planned | — | — | — | GET /sales-orders | | ServicePointsBackendApi | BackendAPI | Planned | — | — | — | GET,POST /service-points
GET,PATCH /service-points/{id}
GET,POST /service-point-addresses
PATCH /service-points/{id}/service-point-addresses/{id}
GET,POST /service-types
GET,PATCH /service-types/{id}
GET,POST /services
GET,PATCH /services/{id} | | ShipmentTypesBackendApi | BackendAPI | Planned | — | — | — | GET,POST /shipment-types
GET,PATCH /shipment-types/{id} | | ShipmentsBackendApi | BackendAPI | Planned | — | — | — | GET /sales-shipments | | StoresBackendApi | BackendAPI | Planned | — | — | — | GET,POST,PATCH /stores | | UsersBackendApi | BackendAPI | Planned | — | — | — | GET /users | | WarehouseOauthBackendApi | BackendAPI | Planned | — | — | — | POST /warehouse-tokens | | WarehouseUsersBackendApi | BackendAPI | Planned | — | — | — | GET,POST /warehouse-user-assignments
GET,PATCH,DELETE /warehouse-user-assignments/{id} | | WarehousesBackendApi | BackendAPI | Planned | — | — | — | GET /warehouses |

Backend API: Update a category

Mon, 07 Sep 2026 15:12:46 +0000

The categories resource of the Backend API lets Back Office integrations update categories, including moving them in the category tree and reordering them among their siblings. This document describes how to update a category.

Installation

The endpoints are provided by the Category and ProductCategory modules. For details on installing the category capability, see Install the Category Management feature.

Update a category

To update a category, send the request:

PATCH /categories/{{category_key}}

PATH PARAMETER	DESCRIPTION
{{category_key}}	Key of the category to update. The key is matched case-insensitively. To get it, retrieve categories.

Request

HEADER KEY	HEADER VALUE	REQUIRED	DESCRIPTION
Authorization	string	✓	Alphanumeric string that authorizes the Back Office user to send requests to protected resources. Get it by authenticating as a Back Office user.

The update is partial: attributes you omit keep their stored values. Attributes that hold a list behave as follows:

localizedAttributes: entries are merged by localeName. An entry updates only the fields it contains; locales you omit stay untouched.
extraParentCategoryKeys, stores, imageSets: the stored list is replaced with the provided one. Omit the attribute to keep the stored list; send an empty array to remove all entries.

Request sample: move a category under another parent and update its attributes

PATCH https://glue-backend.mysprykershop.com/categories/gaming-laptops

{
    "data": {
        "type": "categories",
        "id": "gaming-laptops",
        "attributes": {
            "parentCategoryKey": "notebooks",
            "position": 1,
            "isActive": false,
            "localizedAttributes": [
                {
                    "localeName": "en_US",
                    "metaTitle": "Gaming Laptops and Notebooks"
                }
            ]
        }
    }
}

ATTRIBUTE	TYPE	DESCRIPTION
parentCategoryKey	String	Key of the new parent category. A new value moves the category with its whole subtree under the new parent and regenerates the category URLs. The key is matched case-insensitively. The category itself and its descendants are not allowed as the parent. The root category cannot be moved.
position	Integer	New sort weight of the category among its siblings. Use it to reorder categories on one level.
templateName	String	Name of an existing category template. The name is case-sensitive.
isActive	Boolean	Defines whether the category is active.
isInMenu	Boolean	Defines whether the category is shown in the Storefront navigation menu.
isSearchable	Boolean	Defines whether the category is searchable.
isClickable	Boolean	Defines whether the category is clickable in the Storefront.
localizedAttributes	Array	Localized attributes to update, merged by `localeName`. Changing `name` regenerates the category URL in that locale.
extraParentCategoryKeys	Array	Keys of the additional parent categories. Replaces the stored list.
stores	Array	Names of the stores the category is assigned to. Replaces the stored list.
imageSets	Array	Image sets of the category. Replaces the stored list.

categoryKey and isRoot cannot be changed.

Response

Response sample: update a category

{
    "data": {
        "id": "gaming-laptops",
        "type": "categories",
        "attributes": {
            "categoryKey": "gaming-laptops",
            "isActive": false,
            "isInMenu": true,
            "isSearchable": true,
            "isClickable": true,
            "templateName": "Catalog (default)",
            "parentCategoryKey": "notebooks",
            "position": 1,
            "extraParentCategoryKeys": [],
            "localizedAttributes": [
                {
                    "localeName": "en_US",
                    "name": "Gaming Laptops",
                    "metaTitle": "Gaming Laptops and Notebooks",
                    "metaDescription": "High-performance laptops",
                    "metaKeywords": "gaming, laptops",
                    "url": "/en/computer/notebooks/gaming-laptops"
                },
                {
                    "localeName": "de_DE",
                    "name": "Gaming-Laptops",
                    "metaTitle": "Gaming-Laptops",
                    "metaDescription": "Leistungsstarke Laptops",
                    "metaKeywords": "gaming, laptops",
                    "url": "/de/computer/notebooks/gaming-laptops"
                }
            ],
            "stores": [
                "DE",
                "AT"
            ],
            "imageSets": [
                {
                    "localeName": "en_US",
                    "name": "default",
                    "images": [
                        {
                            "externalUrlSmall": "https://images.example.com/gaming-s.jpg",
                            "externalUrlLarge": "https://images.example.com/gaming-l.jpg",
                            "sortOrder": 0
                        }
                    ]
                }
            ],
            "isRoot": false
        },
        "links": {
            "self": "https://glue-backend.mysprykershop.com/categories/gaming-laptops"
        }
    }
}

ATTRIBUTE	TYPE	DESCRIPTION
categoryKey	String	Unique key of the category. It is also the resource `id`.
uuid	String	Universally unique identifier of the category. Read-only. It is `null` on installations that do not have the optional `uuid` column, and on categories created before it was introduced until `uuid:generate Category spy_category` has been run for them. `categoryKey`, not `uuid`, is the resource `id`.
isActive	Boolean	Defines whether the category is active.
isInMenu	Boolean	Defines whether the category is shown in the Storefront navigation menu.
isSearchable	Boolean	Defines whether the category is searchable.
isClickable	Boolean	Defines whether the category is clickable in the Storefront.
templateName	String	Name of the category template.
parentCategoryKey	String	`categoryKey` of the parent category. `null` for the root category.
position	Integer	Sort weight of the category among its siblings. Siblings are ordered by this value in ascending order.
extraParentCategoryKeys	Array	`categoryKey` values of the additional parent categories.
localizedAttributes	Array	Localized attributes of the category, one entry per locale.
localizedAttributes.localeName	String	Locale name—for example, `en_US`.
localizedAttributes.name	String	Name of the category in the locale.
localizedAttributes.metaTitle	String	Meta title of the category in the locale.
localizedAttributes.metaDescription	String	Meta description of the category in the locale.
localizedAttributes.metaKeywords	String	Meta keywords of the category in the locale.
localizedAttributes.url	String	URL of the category in the locale. It is generated from the category name and the parent categories.
stores	Array	Names of the stores the category is assigned to.
imageSets	Array	Image sets of the category.
imageSets.localeName	String	Locale name of the image set. `null` for the default image set.
imageSets.name	String	Name of the image set.
imageSets.images	Array	Images of the image set.
imageSets.images.externalUrlSmall	String	URL of the small image.
imageSets.images.externalUrlLarge	String	URL of the large image.
imageSets.images.sortOrder	Integer	Order of the image within the image set.
isRoot	Boolean	Defines whether the category is the root category.

Possible errors

The request is validated as a whole: if any check fails, nothing is updated and all failed checks are returned in the errors array.

STATUS	CODE	REASON
404	N/A	The category with the specified key doesn’t exist.
422	901	An attribute has a wrong type.
422	N/A	`categoryKey` differs from the key of the category. The key cannot be changed.
422	N/A	`isRoot` differs from the stored value. The root status cannot be changed.
422	N/A	`parentCategoryKey` is provided for the root category. The root category cannot be moved.
422	N/A	The category specified in `parentCategoryKey` or `extraParentCategoryKeys` doesn’t exist.
422	N/A	The category specified in `parentCategoryKey` or `extraParentCategoryKeys` is the category itself or one of its descendants.
422	N/A	The template specified in `templateName` doesn’t exist. The available template names are listed in the error details.
422	N/A	A locale specified in `localizedAttributes` is not available, or an entry has no `localeName`.
422	N/A	A store specified in `stores` doesn’t exist.
422	N/A	A category with the same name already exists on the target level.

| 401 | N/A | The Authorization header is missing, or the access token is invalid or expired. | | 403 | N/A | The authenticated Back Office user is not allowed to access the categories resource. |

To view generic errors and status codes of the Backend API, see Backend API request and response reference.

Backend API: Retrieve categories

Mon, 07 Sep 2026 15:12:46 +0000

The categories resource of the Backend API lets Back Office integrations read the category tree of the shop. This document describes how to retrieve a paginated category collection and a single category by its key.

Installation

The endpoints are provided by the Category and ProductCategory modules. For details on installing the category capability, see Install the Category Management feature.

Retrieve categories

To retrieve a paginated collection of categories, send the request:

GET /categories

Request

HEADER KEY	HEADER VALUE	REQUIRED	DESCRIPTION
Authorization	string	✓	Alphanumeric string that authorizes the Back Office user to send requests to protected resources. Get it by authenticating as a Back Office user.

QUERY PARAMETER	DESCRIPTION	EXEMPLARY VALUES
page[limit]	Number of categories per page. Default: `10`.	`page[limit]=20`
page[offset]	Number of categories to skip. Default: `0`.	`page[offset]=20`
sort	Sorts the collection by a field. Prefix the field with `-` for descending order. Supported fields: `categoryKey`, `position`, `name`. `name` sorts by the localized name in the request locale, which you pass in the `Accept-Language` header; if the header is missing, the default locale is used. Categories without a name in that locale are not part of a name-sorted result. Any other field returns a `400` error.	`sort=name` `sort=-position`
parentCategoryKey	Returns only the direct children of the category with the specified key, including the categories that have it as an additional parent. The key is matched case-insensitively. An unknown key returns a `404` error.	`parentCategoryKey=computer`

REQUEST	USAGE
`GET https://glue-backend.mysprykershop.com/categories`	Retrieve the first page of the category collection.
`GET https://glue-backend.mysprykershop.com/categories?page[limit]=2&page[offset]=2`	Retrieve the second page of the collection with two categories per page.
`GET https://glue-backend.mysprykershop.com/categories?sort=-name`	Retrieve categories sorted by their localized name in descending order.
`GET https://glue-backend.mysprykershop.com/categories?parentCategoryKey=computer&sort=position`	Retrieve the direct child categories of the `computer` category ordered as in the Back Office category tree.

Response

The pagination summary is returned in the top-level meta.pagination object, and the pagination links in the top-level links object. Collection members do not carry pagination data.

Response sample: retrieve categories

{
    "links": {
        "self": "https://glue-backend.mysprykershop.com/categories",
        "first": "https://glue-backend.mysprykershop.com/categories?page[limit]=2&page[offset]=0",
        "last": "https://glue-backend.mysprykershop.com/categories?page[limit]=2&page[offset]=32",
        "prev": "https://glue-backend.mysprykershop.com/categories?page[limit]=2&page[offset]=0",
        "next": "https://glue-backend.mysprykershop.com/categories?page[limit]=2&page[offset]=4"
    },
    "meta": {
        "pagination": {
            "numFound": 34,
            "currentPage": 2,
            "maxPage": 17,
            "currentItemsPerPage": 2
        }
    },
    "data": [
        {
            "id": "camcorders",
            "type": "categories",
            "attributes": {
                "categoryKey": "camcorders",
                "isActive": true,
                "isInMenu": true,
                "isSearchable": true,
                "isClickable": true,
                "templateName": "Catalog (default)",
                "parentCategoryKey": "cameras-and-camcorder",
                "position": 90,
                "extraParentCategoryKeys": [],
                "localizedAttributes": [
                    {
                        "localeName": "de_DE",
                        "name": "Digitale Videokameras",
                        "metaTitle": "Digitale Videokameras",
                        "metaDescription": "Digitale Videokameras",
                        "metaKeywords": "Digitale Videokameras",
                        "url": "/de/kameras-&-camcorders/digitale-videokameras"
                    },
                    {
                        "localeName": "en_US",
                        "name": "Camcorders",
                        "metaTitle": "Camcorders",
                        "metaDescription": "Camcorders",
                        "metaKeywords": "Camcorders",
                        "url": "/en/cameras-&-camcorders/camcorders"
                    }
                ],
                "stores": [
                    "DE",
                    "AT"
                ],
                "imageSets": [],
                "isRoot": false
            },
            "links": {
                "self": "https://glue-backend.mysprykershop.com/categories/camcorders"
            }
        },
        {
            "id": "digital-cameras",
            "type": "categories",
            "attributes": {
                "categoryKey": "digital-cameras",
                "isActive": true,
                "isInMenu": true,
                "isSearchable": true,
                "isClickable": true,
                "templateName": "Catalog (default)",
                "parentCategoryKey": "cameras-and-camcorder",
                "position": 100,
                "extraParentCategoryKeys": [],
                "localizedAttributes": [
                    {
                        "localeName": "de_DE",
                        "name": "Digitale Kameras",
                        "metaTitle": "Digitale Kameras",
                        "metaDescription": "Digitale Kameras",
                        "metaKeywords": "Digitale Kameras",
                        "url": "/de/kameras-&-camcorders/digitale-kameras"
                    },
                    {
                        "localeName": "en_US",
                        "name": "Digital Cameras",
                        "metaTitle": "Digital Cameras",
                        "metaDescription": "Digital Cameras",
                        "metaKeywords": "Digital Cameras",
                        "url": "/en/cameras-&-camcorders/digital-cameras"
                    }
                ],
                "stores": [
                    "DE",
                    "AT"
                ],
                "imageSets": [],
                "isRoot": false
            },
            "links": {
                "self": "https://glue-backend.mysprykershop.com/categories/digital-cameras"
            }
        }
    ]
}

META ATTRIBUTE	TYPE	DESCRIPTION
pagination.numFound	Integer	Total number of categories in the collection.
pagination.currentPage	Integer	Number of the current page.
pagination.maxPage	Integer	Total number of pages.
pagination.currentItemsPerPage	Integer	Number of categories per page.

ATTRIBUTE	TYPE	DESCRIPTION
categoryKey	String	Unique key of the category. It is also the resource `id`.
uuid	String	Universally unique identifier of the category. Read-only. It is `null` on installations that do not have the optional `uuid` column, and on categories created before it was introduced until `uuid:generate Category spy_category` has been run for them. `categoryKey`, not `uuid`, is the resource `id`.
isActive	Boolean	Defines whether the category is active.
isInMenu	Boolean	Defines whether the category is shown in the Storefront navigation menu.
isSearchable	Boolean	Defines whether the category is searchable.
isClickable	Boolean	Defines whether the category is clickable in the Storefront.
templateName	String	Name of the category template.
parentCategoryKey	String	`categoryKey` of the parent category. `null` for the root category.
position	Integer	Sort weight of the category among its siblings. Siblings are ordered by this value in ascending order.
extraParentCategoryKeys	Array	`categoryKey` values of the additional parent categories.
localizedAttributes	Array	Localized attributes of the category, one entry per locale.
localizedAttributes.localeName	String	Locale name—for example, `en_US`.
localizedAttributes.name	String	Name of the category in the locale.
localizedAttributes.metaTitle	String	Meta title of the category in the locale.
localizedAttributes.metaDescription	String	Meta description of the category in the locale.
localizedAttributes.metaKeywords	String	Meta keywords of the category in the locale.
localizedAttributes.url	String	URL of the category in the locale. It is generated from the category name and the parent categories.
stores	Array	Names of the stores the category is assigned to.
imageSets	Array	Image sets of the category.
imageSets.localeName	String	Locale name of the image set. `null` for the default image set.
imageSets.name	String	Name of the image set.
imageSets.images	Array	Images of the image set.
imageSets.images.externalUrlSmall	String	URL of the small image.
imageSets.images.externalUrlLarge	String	URL of the large image.
imageSets.images.sortOrder	Integer	Order of the image within the image set.
isRoot	Boolean	Defines whether the category is the root category.

Retrieve a category

To retrieve a single category, send the request:

GET /categories/{{category_key}}

PATH PARAMETER	DESCRIPTION
{{category_key}}	Key of the category to retrieve. The key is matched case-insensitively. To get it, retrieve categories.

Request

HEADER KEY	HEADER VALUE	REQUIRED	DESCRIPTION
Authorization	string	✓	Alphanumeric string that authorizes the Back Office user to send requests to protected resources. Get it by authenticating as a Back Office user.

Request sample: retrieve a category

GET https://glue-backend.mysprykershop.com/categories/computer

Response

Response sample: retrieve a category

{
    "data": {
        "id": "computer",
        "type": "categories",
        "attributes": {
            "categoryKey": "computer",
            "isActive": true,
            "isInMenu": true,
            "isSearchable": true,
            "isClickable": true,
            "templateName": "CMS Block",
            "parentCategoryKey": "demoshop",
            "position": 100,
            "extraParentCategoryKeys": [],
            "localizedAttributes": [
                {
                    "localeName": "de_DE",
                    "name": "Computer",
                    "metaTitle": "Computer",
                    "metaDescription": "Computer",
                    "metaKeywords": "Computer",
                    "url": "/de/computer"
                },
                {
                    "localeName": "en_US",
                    "name": "Computer",
                    "metaTitle": "Computer",
                    "metaDescription": "Computer",
                    "metaKeywords": "Computer",
                    "url": "/en/computer"
                }
            ],
            "stores": [
                "DE",
                "AT"
            ],
            "imageSets": [],
            "isRoot": false
        },
        "links": {
            "self": "https://glue-backend.mysprykershop.com/categories/computer"
        }
    }
}

ATTRIBUTE	TYPE	DESCRIPTION
categoryKey	String	Unique key of the category. It is also the resource `id`.
uuid	String	Universally unique identifier of the category. Read-only. It is `null` on installations that do not have the optional `uuid` column, and on categories created before it was introduced until `uuid:generate Category spy_category` has been run for them. `categoryKey`, not `uuid`, is the resource `id`.
isActive	Boolean	Defines whether the category is active.
isInMenu	Boolean	Defines whether the category is shown in the Storefront navigation menu.
isSearchable	Boolean	Defines whether the category is searchable.
isClickable	Boolean	Defines whether the category is clickable in the Storefront.
templateName	String	Name of the category template.
parentCategoryKey	String	`categoryKey` of the parent category. `null` for the root category.
position	Integer	Sort weight of the category among its siblings. Siblings are ordered by this value in ascending order.
extraParentCategoryKeys	Array	`categoryKey` values of the additional parent categories.
localizedAttributes	Array	Localized attributes of the category, one entry per locale.
localizedAttributes.localeName	String	Locale name—for example, `en_US`.
localizedAttributes.name	String	Name of the category in the locale.
localizedAttributes.metaTitle	String	Meta title of the category in the locale.
localizedAttributes.metaDescription	String	Meta description of the category in the locale.
localizedAttributes.metaKeywords	String	Meta keywords of the category in the locale.
localizedAttributes.url	String	URL of the category in the locale. It is generated from the category name and the parent categories.
stores	Array	Names of the stores the category is assigned to.
imageSets	Array	Image sets of the category.
imageSets.localeName	String	Locale name of the image set. `null` for the default image set.
imageSets.name	String	Name of the image set.
imageSets.images	Array	Images of the image set.
imageSets.images.externalUrlSmall	String	URL of the small image.
imageSets.images.externalUrlLarge	String	URL of the large image.
imageSets.images.sortOrder	Integer	Order of the image within the image set.
isRoot	Boolean	Defines whether the category is the root category.

Possible errors

STATUS	CODE	REASON
400	400	The `sort` parameter references an unsupported field. The supported fields are listed in the error details.
404	N/A	The category with the specified key doesn’t exist, or the category specified in the `parentCategoryKey` parameter doesn’t exist.

To view generic errors and status codes of the Backend API, see Backend API request and response reference.

Backend API: Manage product assignments of a category

Mon, 07 Sep 2026 15:12:46 +0000

The category-products sub-resource of the Backend API manages which abstract products are assigned to a category. This document describes how to assign products to a category in bulk, retrieve the assigned products, and unassign some or all of them.

Installation

The endpoints are provided by the Category and ProductCategory modules. For details on installing the category capability, see Install the Category Management feature.

Assign products to a category

To assign one or more abstract products to a category, send the request:

POST /categories/{{category_key}}/assign-products

PATH PARAMETER	DESCRIPTION
{{category_key}}	Key of the category. The key is matched case-insensitively. To get it, retrieve categories.

Request

HEADER KEY	HEADER VALUE	REQUIRED	DESCRIPTION
Authorization	string	✓	Alphanumeric string that authorizes the Back Office user to send requests to protected resources. Get it by authenticating as a Back Office user.

Request sample: assign products to a category

POST https://glue-backend.mysprykershop.com/categories/gaming-laptops/assign-products

{
    "data": {
        "type": "category-products",
        "attributes": {
            "skus": ["112", "113"]
        }
    }
}

ATTRIBUTE	TYPE	REQUIRED	DESCRIPTION
skus	Array	✓	Non-empty list of abstract product SKUs to assign. The operation is all-or-nothing: if any SKU is unknown, nothing is assigned. SKUs that are already assigned are ignored, so repeating the request is safe.

Response

If the products are assigned successfully, the endpoint returns the 204 No Content status code.

Retrieve the products assigned to a category

To retrieve the paginated list of abstract products assigned to a category, send the request:

GET /categories/{{category_key}}/products

Request

HEADER KEY	HEADER VALUE	REQUIRED	DESCRIPTION
Authorization	string	✓	Alphanumeric string that authorizes the Back Office user to send requests to protected resources. Get it by authenticating as a Back Office user.

QUERY PARAMETER	DESCRIPTION	EXEMPLARY VALUES
page[limit]	Number of products per page. Default: `10`.	`page[limit]=20`
page[offset]	Number of products to skip. Default: `0`.	`page[offset]=20`

The products are ordered by their position within the category in ascending order. The product name is returned in the request locale, which you pass in the Accept-Language header; if the header is missing, the default locale is used.

Request sample: retrieve the products assigned to a category

GET https://glue-backend.mysprykershop.com/categories/gaming-laptops/products?page[limit]=1

Response

Response sample: retrieve the products assigned to a category

{
    "links": {
        "self": "https://glue-backend.mysprykershop.com/categories/gaming-laptops/products",
        "first": "https://glue-backend.mysprykershop.com/categories/gaming-laptops/products?page[limit]=1&page[offset]=0",
        "last": "https://glue-backend.mysprykershop.com/categories/gaming-laptops/products?page[limit]=1&page[offset]=1",
        "next": "https://glue-backend.mysprykershop.com/categories/gaming-laptops/products?page[limit]=1&page[offset]=1"
    },
    "meta": {
        "pagination": {
            "numFound": 2,
            "currentPage": 1,
            "maxPage": 2,
            "currentItemsPerPage": 1
        }
    },
    "data": [
        {
            "id": "112",
            "type": "category-products",
            "attributes": {
                "sku": "112",
                "name": "Acer Extensa M2610",
                "position": 0
            },
            "links": {
                "self": "https://glue-backend.mysprykershop.com/categories/gaming-laptops/products/112"
            }
        }
    ]
}

ATTRIBUTE	TYPE	DESCRIPTION
sku	String	SKU of the assigned abstract product. It is also the resource `id`.
name	String	Name of the product in the request locale.
position	Integer	Position of the product within the category.

The pagination summary in meta.pagination has the same structure as in the category collection.

Retrieve a product assigned to a category

To retrieve a single product assignment, send the request:

GET /categories/{{category_key}}/products/{{sku}}

PATH PARAMETER	DESCRIPTION
{{category_key}}	Key of the category.
{{sku}}	SKU of the abstract product. To get it, retrieve the products assigned to the category.

Request

HEADER KEY	HEADER VALUE	REQUIRED	DESCRIPTION
Authorization	string	✓	Alphanumeric string that authorizes the Back Office user to send requests to protected resources. Get it by authenticating as a Back Office user.

Request sample: retrieve a product assigned to a category

GET https://glue-backend.mysprykershop.com/categories/gaming-laptops/products/112

Response

Response sample: retrieve a product assigned to a category

{
    "data": {
        "id": "112",
        "type": "category-products",
        "attributes": {
            "sku": "112",
            "name": "Acer Extensa M2610",
            "position": 0
        },
        "links": {
            "self": "https://glue-backend.mysprykershop.com/categories/gaming-laptops/products/112"
        }
    }
}

Unassign products from a category

To unassign some or all abstract products from a category, send the request:

POST /categories/{{category_key}}/unassign-products

Request

HEADER KEY	HEADER VALUE	REQUIRED	DESCRIPTION
Authorization	string	✓	Alphanumeric string that authorizes the Back Office user to send requests to protected resources. Get it by authenticating as a Back Office user.

Request sample: unassign specific products from a category

POST https://glue-backend.mysprykershop.com/categories/gaming-laptops/unassign-products

{
    "data": {
        "type": "category-products",
        "attributes": {
            "skus": ["112"]
        }
    }
}

Request sample: unassign all products from a category

POST https://glue-backend.mysprykershop.com/categories/gaming-laptops/unassign-products

{
    "data": {
        "type": "category-products",
        "attributes": {
            "all": true
        }
    }
}

ATTRIBUTE	TYPE	REQUIRED	DESCRIPTION
skus	Array	✓ unless `all` is `true`	Non-empty list of abstract product SKUs to unassign. The operation is all-or-nothing: if any SKU is unknown or not assigned to the category, nothing is removed.
all	Boolean	✓ unless `skus` is provided	Set to `true` to unassign all products from the category. Cannot be combined with `skus`. Repeating the request on a category without assignments is safe.

Response

If the products are unassigned successfully, the endpoint returns the 204 No Content status code.

Possible errors

STATUS	CODE	REASON
400	400	`skus` is missing or empty in the assign request.
400	400	Neither `skus` nor `all: true` is provided in the unassign request, or both are provided.
404	N/A	The category with the specified key doesn’t exist.
404	N/A	The product with the specified SKU doesn’t exist or is not assigned to the category.
422	N/A	One or more SKUs in the assign request are unknown. Nothing is assigned; the unknown SKUs are listed in the error details.
422	N/A	One or more SKUs in the unassign request are unknown or not assigned to the category. Nothing is removed; the offending SKUs are listed in the error details.

To view generic errors and status codes of the Backend API, see Backend API request and response reference.

Backend API: Delete a category

Mon, 07 Sep 2026 15:12:46 +0000

The categories resource of the Backend API lets Back Office integrations delete categories. This document describes how to delete a category and how the category tree changes as a result.

Installation

The endpoints are provided by the Category and ProductCategory modules. For details on installing the category capability, see Install the Category Management feature.

Delete a category

To delete a category, send the request:

DELETE /categories/{{category_key}}

PATH PARAMETER	DESCRIPTION
{{category_key}}	Key of the category to delete. The key is matched case-insensitively. To get it, retrieve categories.

Deleting a category behaves as in the Back Office:

The child categories of the deleted category are moved under its parent category.
All additional-parent placements of the deleted category are removed together with their URLs; the subtrees below those placements are moved under the respective parent.
The product assignments of the deleted category are removed.
The root category cannot be deleted.

Request

HEADER KEY	HEADER VALUE	REQUIRED	DESCRIPTION
Authorization	string	✓	Alphanumeric string that authorizes the Back Office user to send requests to protected resources. Get it by authenticating as a Back Office user.

Request sample: delete a category

DELETE https://glue-backend.mysprykershop.com/categories/gaming-laptops

Response

If the category is deleted successfully, the endpoint returns the 204 No Content status code.

Possible errors

STATUS	CODE	REASON
404	N/A	The category with the specified key doesn’t exist.
422	N/A	The category is the root category. The root category cannot be deleted.

To view generic errors and status codes of the Backend API, see Backend API request and response reference.

Backend API: Create a category

Mon, 07 Sep 2026 15:12:46 +0000

The categories resource of the Backend API lets Back Office integrations create categories in the category tree. This document describes how to create a category and which validations the request has to pass.

Installation

The endpoints are provided by the Category and ProductCategory modules. For details on installing the category capability, see Install the Category Management feature.

Create a category

To create a category, send the request:

POST /categories

Request

HEADER KEY	HEADER VALUE	REQUIRED	DESCRIPTION
Authorization	string	✓	Alphanumeric string that authorizes the Back Office user to send requests to protected resources. Get it by authenticating as a Back Office user.

Request sample: create a category

POST https://glue-backend.mysprykershop.com/categories

{
    "data": {
        "type": "categories",
        "attributes": {
            "categoryKey": "gaming-laptops",
            "parentCategoryKey": "computer",
            "templateName": "Catalog (default)",
            "isActive": true,
            "isInMenu": true,
            "isSearchable": true,
            "isClickable": true,
            "position": 5,
            "stores": ["DE", "AT"],
            "localizedAttributes": [
                {
                    "localeName": "en_US",
                    "name": "Gaming Laptops",
                    "metaTitle": "Gaming Laptops",
                    "metaDescription": "High-performance laptops",
                    "metaKeywords": "gaming, laptops"
                },
                {
                    "localeName": "de_DE",
                    "name": "Gaming-Laptops",
                    "metaTitle": "Gaming-Laptops",
                    "metaDescription": "Leistungsstarke Laptops",
                    "metaKeywords": "gaming, laptops"
                }
            ],
            "imageSets": [
                {
                    "localeName": "en_US",
                    "name": "default",
                    "images": [
                        {
                            "externalUrlSmall": "https://images.example.com/gaming-s.jpg",
                            "externalUrlLarge": "https://images.example.com/gaming-l.jpg",
                            "sortOrder": 0
                        }
                    ]
                }
            ]
        }
    }
}

ATTRIBUTE	TYPE	REQUIRED	DESCRIPTION
categoryKey	String	✓	Unique key of the category. It becomes the resource `id` and cannot be changed later. Keys are matched case-insensitively, so a key that differs from an existing one only by case is rejected as a duplicate.
parentCategoryKey	String	✓ unless `isRoot` is `true`	Key of the parent category. The key is matched case-insensitively; the response contains the stored key.
templateName	String	✓	Name of an existing category template. The name is case-sensitive.
localizedAttributes	Array	✓	Localized attributes of the category. Provide at least one entry; each entry needs `localeName` and a non-empty `name`.
localizedAttributes.localeName	String	✓	Name of an available locale—for example, `en_US`.
localizedAttributes.name	String	✓	Name of the category in the locale. Must be unique among the categories on the same level. The category URL is generated from it.
localizedAttributes.metaTitle	String		Meta title of the category in the locale.
localizedAttributes.metaDescription	String		Meta description of the category in the locale.
localizedAttributes.metaKeywords	String		Meta keywords of the category in the locale.
isRoot	Boolean		Set to `true` to create the root category. Only one root category can exist, and `parentCategoryKey` must be omitted. Default: `false`.
isActive	Boolean		Defines whether the category is active. Default: `false`.
isInMenu	Boolean		Defines whether the category is shown in the Storefront navigation menu. Default: `true`.
isSearchable	Boolean		Defines whether the category is searchable. Default: `true`.
isClickable	Boolean		Defines whether the category is clickable in the Storefront. Default: `true`.
position	Integer		Sort weight of the category among its siblings. Duplicates are allowed; setting it doesn’t renumber the siblings.
extraParentCategoryKeys	Array		Keys of additional parent categories. The keys are matched case-insensitively.
stores	Array		Names of existing stores to assign the category to.
imageSets	Array		Image sets of the category.
imageSets.localeName	String		Locale name of the image set. Omit it for the default image set.
imageSets.name	String	✓	Name of the image set.
imageSets.images	Array	✓	Images of the image set.
imageSets.images.externalUrlSmall	String	✓	URL of the small image.
imageSets.images.externalUrlLarge	String	✓	URL of the large image.
imageSets.images.sortOrder	Integer		Order of the image within the image set.

Localized attributes

The Back Office requires a name in every available locale. The API accepts a subset of locales, but a category without a name in a locale is not shown in the Back Office and in the Storefront for that locale, and it is not part of a name-sorted collection in that locale. Provide all locales unless you have a reason not to.

Response

Response sample: create a category

{
    "data": {
        "id": "gaming-laptops",
        "type": "categories",
        "attributes": {
            "categoryKey": "gaming-laptops",
            "isActive": true,
            "isInMenu": true,
            "isSearchable": true,
            "isClickable": true,
            "templateName": "Catalog (default)",
            "parentCategoryKey": "computer",
            "position": 5,
            "extraParentCategoryKeys": [],
            "localizedAttributes": [
                {
                    "localeName": "en_US",
                    "name": "Gaming Laptops",
                    "metaTitle": "Gaming Laptops",
                    "metaDescription": "High-performance laptops",
                    "metaKeywords": "gaming, laptops",
                    "url": "/en/computer/gaming-laptops"
                },
                {
                    "localeName": "de_DE",
                    "name": "Gaming-Laptops",
                    "metaTitle": "Gaming-Laptops",
                    "metaDescription": "Leistungsstarke Laptops",
                    "metaKeywords": "gaming, laptops",
                    "url": "/de/computer/gaming-laptops"
                }
            ],
            "stores": [
                "DE",
                "AT"
            ],
            "imageSets": [
                {
                    "localeName": "en_US",
                    "name": "default",
                    "images": [
                        {
                            "externalUrlSmall": "https://images.example.com/gaming-s.jpg",
                            "externalUrlLarge": "https://images.example.com/gaming-l.jpg",
                            "sortOrder": 0
                        }
                    ]
                }
            ],
            "isRoot": false
        },
        "links": {
            "self": "https://glue-backend.mysprykershop.com/categories/gaming-laptops"
        }
    }
}

ATTRIBUTE	TYPE	DESCRIPTION
categoryKey	String	Unique key of the category. It is also the resource `id`.
uuid	String	Universally unique identifier of the category. Read-only. It is `null` on installations that do not have the optional `uuid` column, and on categories created before it was introduced until `uuid:generate Category spy_category` has been run for them. `categoryKey`, not `uuid`, is the resource `id`.
isActive	Boolean	Defines whether the category is active.
isInMenu	Boolean	Defines whether the category is shown in the Storefront navigation menu.
isSearchable	Boolean	Defines whether the category is searchable.
isClickable	Boolean	Defines whether the category is clickable in the Storefront.
templateName	String	Name of the category template.
parentCategoryKey	String	`categoryKey` of the parent category. `null` for the root category.
position	Integer	Sort weight of the category among its siblings. Siblings are ordered by this value in ascending order.
extraParentCategoryKeys	Array	`categoryKey` values of the additional parent categories.
localizedAttributes	Array	Localized attributes of the category, one entry per locale.
localizedAttributes.localeName	String	Locale name—for example, `en_US`.
localizedAttributes.name	String	Name of the category in the locale.
localizedAttributes.metaTitle	String	Meta title of the category in the locale.
localizedAttributes.metaDescription	String	Meta description of the category in the locale.
localizedAttributes.metaKeywords	String	Meta keywords of the category in the locale.
localizedAttributes.url	String	URL of the category in the locale. It is generated from the category name and the parent categories.
stores	Array	Names of the stores the category is assigned to.
imageSets	Array	Image sets of the category.
imageSets.localeName	String	Locale name of the image set. `null` for the default image set.
imageSets.name	String	Name of the image set.
imageSets.images	Array	Images of the image set.
imageSets.images.externalUrlSmall	String	URL of the small image.
imageSets.images.externalUrlLarge	String	URL of the large image.
imageSets.images.sortOrder	Integer	Order of the image within the image set.
isRoot	Boolean	Defines whether the category is the root category.

Possible errors

The request is validated as a whole: if any check fails, nothing is created and all failed checks are returned in the errors array.

STATUS	CODE	REASON
422	901	A required attribute is missing or has a wrong type—for example, `categoryKey => This field is missing.`
422	N/A	A category with the specified `categoryKey` already exists.
422	N/A	`parentCategoryKey` is missing and `isRoot` is not `true`.
422	N/A	`parentCategoryKey` is provided together with `isRoot: true`.
422	N/A	`isRoot` is `true`, but a root category already exists.
422	N/A	The category specified in `parentCategoryKey` or `extraParentCategoryKeys` doesn’t exist.
422	N/A	The template specified in `templateName` doesn’t exist. The available template names are listed in the error details.
422	N/A	`localizedAttributes` is missing or empty, an entry has no `localeName`, or an entry has no `name`.
422	N/A	A locale specified in `localizedAttributes` is not available.
422	N/A	A store specified in `stores` doesn’t exist.
422	N/A	A category with the same name already exists on the same level.
422	N/A	The URL generated for a locale conflicts with an existing URL. The category is not created.

To view generic errors and status codes of the Backend API, see Backend API request and response reference.