Personalization platform API changelog

• 12 minutes to read

This topic includes new features, improvements, and bug fixes for the APIs.

January 2026

Mockup Enhancements

• The render-image-preview-with-mockup and render-design-preview-with-mockup tasks now support multiple mockups.
• Added endpoints to the Asset Processor API for retrieving artwork parameters of mockups and mockup groups.
• Added endpoints to the Design Atom API for rendering previews 2D mockup based on alternative artwork layers.
• Added the GET /api/storage/v1/mockups/folders/content endpoint to fetch folder content by folder ID for cases where the ID does not match the folder path.
• Added the mockupValidationType field to the GET /api/storefront/v1/products/{id}/variant-mockups endpoint response, which returns values like "Mockup3D", "MockupLink", or "Mockup2D".

Bug Fixes

• Fixed an issue where POST atoms/v1/images/render-preview incorrectly generated images with a fixed 800×800 size.

December 2025

New Features

MockupLink Support

• Introduced a new MockupLink type for 2D mockups, enabling dynamic linking and rendering.
• Added MockupLink support in:
  • Preview rendering via DesignAtomsApi.
  • Resource preparation for PIM product variants.
  • Rendering tasks in RenderingNode.
• Enabled automatic generation of MockupLink from PSD mockup containers.

General Improvements

Error Handling & Data Processing

• Adapted error response concepts (based on the ImageProcessingHub model) for better consistency.
• Added support for setting GroupId in ProjectItem for improved organization.

Pipeline & Rendering

• Added fallback keys for custom-fields with spaces during pipeline compilation.
• Added an upload-to-onedrive rendering task.

November 2025

General Improvements

• You can now process projects with product versioning support in the Storefront Projects API. The following endpoints now include versionId and variantId fields to specify the exact product instance:
  • /api/storefront/v1/projects/with-single-item
  • /api/storefront/v1/projects/multiple-items
  • /api/storefront/v1/projects/by-scenario/specific-pipeline
• Added two new parameters to the draw-crop-marks task for better control over cropmark rendering: drawCropMarkBlackCropLineMaxLength and drawCropMarkWhiteCropLineMaxLength to limit the length of the black and white crop lines, correspondingly.
• Added a custom task sn-export-order-details-to-csv that generates a CSV file with order information, including: order number, ordered items, customer/company name, order cost.

October 2025

General Improvements

• Removed explicit handling of OPTIONS requests in the internal BackOffice API. Now, the API will only confirm endpoint availability for OPTIONS requests, as intended.
• Adjusted CORS-policy configuration for the BackOffice API and Accounting API.

Bug Fixes

• Fixed an issue where resource owner information in BackOffice was not updated during the anonymous user data merge operation.
• Fixed an issue where CORS errors were displayed instead of the actual 500 error details when BackOffice API requests failed.

September 11, 2025

General Improvements

• Added a render-vdp-preview task to generate previews for VDP (Variable Data Printing) orders as a set of single images with a mockup, simulating a multi-page PDF.
• Enhanced rendering pipelines with support for complex conditional logic in rendering pipelines, enabling more dynamic workflows:
  • Introduced inversion in expressions (e.g., skipIf: "{{artifact-name?}}!=").
  • Added SkipIfAny, SkipIfAll, SkipIfNotAny, and SkipIfNotAll conditions for finer control over task processing. For more details, see the Flow topic.
• Added support for PNG and JPEG inputs in the merge-separate-pages task.
• You can now use collections of artifacts in the render-image-preview-with-mockup task.
• Added a RetentionPolicy filter when retrieving private assets via the Asset Storage API.
• Introduced a new endpoint ​POST /api​/backoffice​/v1​/products​/{id}​/set-image to set a thumbnail image for an existing product via API.
• UIDs are now used as keys for options and option values when creating or removing PIM product asset connections, ensuring consistent asset binding.

Bug Fixes

• Fixed an issue where the pageIndex parameter was ignored during preview generation by the Asset Processor API when applyAutoCrop was set to true.
• Fixed an issue where crop marks were not being drawn on sides with a specified slug by the draw-crop-marks task.
• Fixed an issue where renaming a folder did not update the path for assets linked to products.
• Fixed an error occurring when calling the endpoint PUT /api/atoms/v1/designs/{id}/print-product/container/{containerId}/model.

August 8, 2025

New Features

• Introduced a new API for working with multi-page images, offering the following capabilities:
  • Retrieve a preview of a specified page from a multi-page image.
  • Extract a specific page from a multi-page image.
  • Obtain a preview of a specified page from a multi-page image, including the mockup.
  • Create a design element based on a specified page from a multi-page image.

General Improvements

• Added an IncludeAnonymous flag to the endpoint GET /api/storefront/v1/storefront-users to filter out temporary (anonymous) users.
• Implemented the endpoint /api/processor/v1/designs/{id}/embed-all-linked-data to embed all external assets referenced in a design, improving integration capabilities.
• Added the possibility to select the output file type, either "Jpeg" or "Png", in PrintProductItem.ExtractImage endpoints.
• Added a populate-psd-template rendering task to populate smart objects in PSD templates with artifacts.

Bug Fixes

• Fixed a problem with SKU search in ProductReferences.GetAll to ensure accurate results.
• Fixed a problem with the rendering of black-and-white files with imposition.

July 3, 2025

General Improvements

• Added missing fonts validation for importing PSD and IDML templates to the Asset Processor API when fonts are specified through Family and Style.
• Improved error messages for ImageItem recoloring in the Design Atoms API. These errors now report status 409.
• Added the stub property to renderingConfig of the POST ​/api​/atoms​/v1​/designs​/render-preview endpoint to disable placeholder's stub content when rendering design preview. To do so, set this property to false.
• Added the HasContent tag to FolderInfoDto in the Asset Storage API. Despite the HasChildern tag, HasContent allows you to check not only the nested folders but also files.

Bug Fixes

• Fixed a problem when the endpoint GET ​/api​/atoms​/v1​/designs​/{id}​/print-product​/items did not return BarcodeItem inserted into PlaceholderItem.
• Fixed a problem with updating nested design elements using the PUT ​/api​/atoms​/v1​/designs​/{id}​/print-product​/items​/{itemId}​/model endpoint.
• Fixed a problem with applying AutoCrop when rendering image preview.

June 5, 2025

New Features

• Introduced a new BackOffice API designed to manage tenant-related data within the Personalization Platform.
• Added an extract-design-images task to extract original images.
• Added support for SSH public key auth for SFTP file uploading in the upload-to-ftp task.
• Implemented /api/atoms/v1/designs/{id}/apply-items-data endpoint in the Design Atoms API. It allows you to set values for design items that are not marked with the isVariable flag through an itemsData object.

April 10, 2025

New Features

• Adapted the Storefront API to the scheme with separated product links:

  • Deprecated the Storefront Products API and moved ProductsController to the Storefront API.
  • Marked ProductReferencesExtController and certain methods in ProductsController as Not recommended.
  • Added a separate ProductLinkController to the Storefront API with methods for retrieving product links and summaries.
  • Updated ProductDTO to include Image and default StorefrontId, StorefrontProductId, and StorefrontProductName based on the first ProductReference.

General Improvements

• Generated API clients now support different Content-Type headers for various response codes.
• Added the PdfKeepOriginalColors parameter to the render-hires and render-vdp-hires tasks.
• Added a render-design-preview-with-mockup task to prepare a design preview with using a PSD mockup. This task implements the POST ​/api​/atoms​/v1​/designs​/render-preview endpoint.
• Added a render-image-preview-with-mockup task to prepare an image preview with using a PSD mockup. This task implements the POST ​/api​/atoms​/v1​/images​/render-preview endpoint.

Bug Fixes

• Improved an error message about the problem of importing a design with a missing palette.

March 13, 2025

New Features

• Added new endpoints to the Design Atoms API for working with the product model:
  • Implemented /api/atoms/v1/designs/{id}/print-product/containers endpoints for manipulating surface containers.
  • Implemented /api/atoms/v1/designs/{id}/print-product/items endpoints for manipulating surface container items.
  • Implemented /api/atoms/v1/designs/{id}/print-product/print-areas endpoints for creating a print-area and updating its parameters based on the description.
  • Added the possibility to add custom headers to the request when creating an image item using URL to simplify working with client storages.

General Improvements

• Added the /api/rendering/v1/jobs/update-project-owner endpoint for batch updating project owners in rendering jobs in the Rendering Service API.
• The render-vdp-hires and render-hires tasks now support the hiResOutputRotateMode parameter to rotate output images.

Bug Fixes

• Fixed a problem when Asset Storage generated asset previews even when the token had read-only permission.

February 6, 2025

New Features

• Added the possibility to manipulate a product model with the Design Atoms API. Implemented new endpoints for working with surfaces, surface mockups, and print areas. For more details, refer to the Working with product model topic.
• Added support for color palettes to Personalization Platform services.

General Improvements

• The render-hires and render-vdp-hires tasks now support BMP output format.
• Added endpoints to the Asset Storage API to delete asset folders by ID.
• Added the /api/storage/v1/resources/namespaces/{namespace} endpoint to the Asset Storage API to delete resources by namespace.

Bug Fixes

• Fixed a problem with changing the owner of a private design when batch updating the owner.
• Fixed error codes that appear when linking Toggle sets and Data schemas.

December 12, 2024

New Features

• Added new endpoints to the Design Atoms API to create multiple images from the following sources:
  • Asset storage by IDs: POST /api/atoms/v1/designs/print-product/items/from-storage/batch-create
  • Remote Web images by URLs: POST /api/atoms/v1/designs/print-product/items/from-storage/batch-create
  • Input files: POST /api/atoms/v1/designs/print-product/items/from-storage/batch-create

General Improvements

• Added the possibility to overwrite preview images rendered and saved to resources if they already exist. To do so, use the overwriteExistingResource parameter in /api/atoms/v1/images/render-preview/to-resource, /api/atoms/v1/images/render-preview/from-file/to-resource, or /api/atoms/v1/images/render-preview/from-url/to-resource.
• Refined image processing endpoints for converted EPS graphics.

Bug Fixes

• Fixed a problem with batch copying of resources in the EU environment.
• Fixed a problem with batch updating of asset custom fields in some cases.

March 28, 2024

New Features

• Added the endpoints /api/storefront/v1/products/{id}/personalization-workflow and /api/storefront/v1/product-references/{reference}/personalization-workflow to get workflow information for PIM Products.
• Added the endpoint /api/storefront/v1/product-specifications/{id}/personalization-workflow to get workflow information for Product Specifications.
• Added the endpoints /api/storefront/v1/processing-pipelines and /api/storefront/v1/processing-pipelines/{id}.

General Improvements

• You can now apply a filter by asset folder and custom fields in the endpoints /api/storefront/v1/products/{id}/variant-designs and /api/storefront/v1/products/{id}/variant-mockups.
• The ProductDto in Storefront API now contains identifiers of the linked personalization workflow and processing pipeline.

March 14, 2024

New Features

• Added the endpoint /api/storefront/v1/projects/by-scenario/specific-pipeline to create projects based on a custom scenario for processing pipelines.

General Improvements

• Now, if the product has linked design and mockup, then the endpoint GET /api/storefront/v1/products/{id}/variants returns information about the mockup used for the resource preview of the PIM product variant.
• You can now filter the projects by their processing status in the endpoint GET /api/storefront/v1/projects.

February 27, 2023

New Features

• Added the endpoints /api/processor/v1/designs/{id}/calculate-count-per-sheet and /api/processor/v1/private-designs/{id}/calculate-count-per-sheet to estimate the number of designs that can fit a given page.

General Improvements

• Added the possibility to filter product links by tags and custom fields with the endpoint /api/storefront/v1/product-references.
• The render-vdp-hires task now supports the print area filter.

January 24, 2023

General Improvements

• You can now render private designs with preview mockups into an image and save this combined image in assets storage at once. To do so, use the endpoints /api/atoms/v1/designs/render-proof/to-resource, /api/atoms/v1/designs/render-preview/to-resource, or /api/atoms/v1/images/render-preview/to-resource.
• Added an endpoint /api/storefront/v1/products/{id}/variants/{productVariantId} to get a specified product variant by its identifier.
• You can now apply a filter by asset name in the endpoints /api/storefront/v1/products/{id}/variant-designs and /api/storefront/v1/products/{id}/variant-mockups.

Bug Fixes

• Fixed a problem with an automatic retry for normal tasks in a job that has a completed long-running task.

December 20, 2023

General Improvements

• Added the endpoint /api/atoms/v1/designs/model/items/extract-image to retrieve the image source.

December 11, 2023

General Improvements

• The draw-crop-marks, render-hires, and render-vdp-hires tasks can now save text as text in print files. To do so, set the PdfTextOutputMode rendering parameter to text. By default, this parameter is outlines, and these tasks output text as vector outlines.
• The BuildInfo endpoints of the Design Atoms API and Asset Processor API now return the DesignAtoms and DesignAtoms.Model version numbers.

December 1, 2023

General Improvements

• Added the FitMode parameter to the rendering config of the endpoints /api/atoms/v1/images/render-preview to define the image insertion mode.
• Now, the missing extension of the downloaded file is added automatically depending on its format.

November 2, 2023

New Features

• The render-image-preview task now supports images from Asset Storage and 3D mockups.
• Added the possibility to copy resources in Asset Storage using endpoints POST /api/storage/v1/resources/{id} and POST /api/storage/v1/private-resources/{id}.
• Added endpoints GET /api/storefront/v1/projects/{id}/preview and GET /api/storefront/v1/projects/{id}/preview-url to get a project preview stream and URL.

General Improvements

• You can now search product references by SKU using the endpoint /api/storefront/v1/products.

September 25, 2023

General Improvements

• Added support for private mockups to the Design Atoms API (GET /api/atoms/v1/mockups-3d/{id}/content/as-protobuf, GET /api/atoms/v1/mockups-3d/{id}/geometry/file.
• You can now omit the customers-canvas namespace when defining rendering tasks. It will be used by default.
• Added the possibility to create rendering jobs without starting them automatically.

August 24, 2023

General Improvements

• Added support for private mockups to the Asset Storage API (PrivateMockups) and Asset Processor API (PrivateMockupProcessor).
• You can now search products and variants by SKU using endpoints /api/storefront/v1/products/{id}/variant-designs and /api/storefront/v1/products/{id}/variants.

August 9, 2023

New Features

• Added a purchase-images-from-deposit-photos task to purchase commercial Depositphotos images specified in the design and embed original images in the design file.

Bug Fixes

• Fixed a problem with rendering designs in the draw-crop-mark task.
• Fixed a problem when export-to-order-desk would fail in some cases.

June 29, 2023

New Features

• Added support for authorization through tokens.
• Added tenant ID information to all endpoints.

General Improvements

• Added a lock indicator for endpoints that require authorization in the Swagger API.

June 19, 2023

New Features

• Added an change-group-in-order-desk task to transfer the order to the folder specified in the destinationGroupName parameter.
• Added an export-to-order-desk task to export data to order item metadata in the Order Desk.
• Added support for metadata in options of PIM widgets.

General Improvements

• Applied whitespace truncation in the name and value of the options.

Maintenance

• The storefront filter becomes optional for the GET /api/storefront/v1/projects endpoint.
• Renamed the attach-data-to-order rendering task to export-to-ecommerce.
• Changed the type of crop mark size parameters to float.

May 2, 2023

New Features

• Added an extract-project-resource task to rendering jobs for retrieving a resource and placing it in artifact storage.
• Added an export-to-ecommerce task to rendering jobs for attaching data to an e-commerce order. You can add plain text, comma-separated list, or JSON values to an order.
• Added endpoint for attaching data to an e-commerce order /api/storefront/v1/projects/{id}/order-data.

General Improvements

• Now, working with folders in Asset Storage is case-insensitive.
• Added a ban on creating jobs without a finalize task to the Rendering Service.

April 14, 2023

Maintenance

• Fixed the StorefrontUsers_full API scope typo.

March 30, 2023

New Features

• Added endpoints for getting the results of project processing /api/storefront/v1/projects/{id}/processing-results, resuming the project processing /api/storefront/v1/projects/{id}/resume-processing, and restarting the project processing /api/storefront/v1/projects/{id}/restart-processing.
• Added the possibility to create projects based on a scenario with /api/storefront/v1/projects/by-scenario/render-hires.
• Added endpoint /api/storefront/v1/product-references/product-links to get a list of product links connected to products in storefronts.

Maintenance

• Reduced the provider requests to the same format.
• Reduced enums to a string form.

March 24, 2023

New Features

• Added support for M3D mockups in the Asset Processor API.

General Improvements

• Added a DesignAtomsMockups3d API for working with 3D mockups.

February 27, 2023

General Improvements

• Moved the endpoints for creating private designs from templates and creating private designs from resources to the Asset Processor API.

January 23, 2023

General Improvements

• Added the possibility to group designs by FolderId in the Storefront Products API. The endpoint /api/storefront/v1/products/{id}/variant-designs now returns the designGroup field.