BackOffice API changelog

• 7 minutes to read

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

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 Products_GetPersonalizationWorkflow and ProductReferences_GetPersonalizationWorkflow to get workflow information for PIM Products.
• Added the endpoints ProductSpecifications_GetPersonalizationWorkflow and ProductReferences_GetPersonalizationWorkflow to get workflow information for Product Specifications.
• Added the endpoints ProcessingPipelines_GetAll and ProcessingPipelines_Get.

General Improvements

• You can now apply a filter by asset folder and custom fields in the endpoints Products_GetProductVariantDesigns and Products_GetProductVariantMockups.
• The Products DTO in StorefrontProducts API now contains identifiers of the linked personalization workflow and processing pipeline.

March 14, 2024

New Features

• Added the endpoint Projects_CreateBySpecificPipelineScenario 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 Products_GetProductVariants 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 Projects_GetAll.

February 27, 2023

New Features

• Added the endpoints DesignProcessor_CalculateCountPerSheet and PrivateDesignProcessor_CalculateCountPerSheet 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 ProductReferences_GetAll.
• 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 Products_GetProductVariant to get a specified product variant by its identifier.
• You can now apply a filter by asset name in the endpoints Products_GetProductVariantDesigns and Products_GetProductVariantMockups.

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 Resources_Copy and PrivateResources_Copy.
• Added endpoints Projects_GetPreview and Projects_GetPreviewUrl to get a project preview stream and URL.

General Improvements

• You can now search product references by SKU using the endpoint Products_GetAllProducts.

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 Products_GetProductVariantDesigns and Products_GetProductVariants.

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 Projects_GetAll 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 Projects_AttachDataToProjectOrder.

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 Projects_GetProjectProcessingResults, resuming the project processing Projects_ResumeProjectProcessing, and restarting the project processing Projects_RestartProjectProcessing.
• Added the possibility to create projects based on a scenario with Projects_CreateByRenderHiResScenario.
• Added endpoint ProductReferences_GetAllProductLinks 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 PrivateDesignProcessor_CopyDesignFromPublicDesign and PrivateDesignProcessor_CopyDesignFromPublicResource 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 Products_GetProductVariantDesigns now returns the designGroup field.