Migration status - Glue API to API Platform
Edit on GitHubThis 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.
Looking for the integration guide?
This page does not describe how to integrate API Platform into your project. For step-by-step integration instructions, see:
How to migrate a module
The end-to-end migration steps — upgrade the module, confirm configuration, flip routing, verify, and clean up — are owned by the API Platform migration overview. This page only tracks which modules are available on API Platform and their status.
Status legend
| Status | Meaning |
|---|---|
| Migrated | Module is available on API Platform and production-ready. |
| 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.
| Module | Category | Status | Released In | Requires | Key endpoints |
|---|---|---|---|---|---|
| CartNotesBackendApi | Extension-Only BackendAPI | Planned | — | SalesOrdersBackendApi | (extension-only) |
| CategoriesBackendApi | BackendAPI | Planned | — | — | GET,POST /categories GET,PATCH /categories/{id} |
| 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 |
Thank you!
For submitting the form