BackOffice API changelog
- 3-4 minutes to read
This topic includes new features, improvements, and bug fixes for the BackOffice API.
January 24, 2023
- 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 DesignAtomsService_RenderDesignProofToResource, DesignAtomsService_RenderDesignPreviewToResource, or DesignAtomsImages_RenderImagePreviewToResource.
- 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.
- Fixed a problem with an automatic retry for normal tasks in a job that has a completed long-running task.
December 20, 2023
- Added the endpoint DesignAtomsService_ExtractItemImage to retrieve the image source.
December 11, 2023
render-vdp-hirestasks can now save text as text in print files. To do so, set the
PdfTextOutputModerendering parameter to
text. By default, this parameter is
outlines, and these tasks output text as vector outlines.
- The BuildInfo endpoints of DesignAtoms API and AssetProcessor API now return the
December 1, 2023
- Added the
FitModeparameter to the rendering config of the endpoint DesignAtomsImages_RenderImagePreview to define the image insertion mode.
- Now, the missing extension of the downloaded file is added automatically depending on its format.
November 2, 2023
render-image-previewtask 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.
- You can now search product references by SKU using the endpoint Products_GetAllProducts.
September 25, 2023
- Added support for private mockups to the DesignAtoms API (DesignAtomsMockups3d_GetContentAsProtobuf, DesignAtomsMockups3d_GetGeometryFile).
- You can now omit the
customers-canvasnamespace when defining rendering tasks. It will be used by default.
- Added the possibility to create rendering jobs without starting them automatically.
August 24, 2023
- Added support for private mockups to the AssetStorage API (PrivateMockups) and AssetProcessor API (PrivateMockupProcessor).
- You can now search products and variants by SKU using endpoints Products_GetProductVariantDesigns and Products_GetProductVariants.
August 9, 2023
- Added a
purchase-images-from-deposit-photostask to purchase commercial Depositphotos images specified in the design and embed original images in the design file.
- Fixed a problem with rendering designs in the
- Fixed a problem when
export-to-order-deskwould fail in some cases.
June 29, 2023
- Added support for authorization through tokens.
- Added tenant ID information to all endpoints.
- Added a lock indicator for endpoints that require authorization in the Swagger API.
June 19, 2023
- Added an
change-group-in-order-desktask to transfer the order to the folder specified in the
- Added an
export-to-order-desktask to export data to order item metadata in the Order Desk.
- Added support for metadata in options of PIM widgets.
- Applied whitespace truncation in the name and value of the options.
- The storefront filter becomes optional for the Projects_GetAll endpoint.
- Renamed the
attach-data-to-orderrendering task to
- Changed the type of crop mark size parameters to float.
May 2, 2023
- Added an
extract-project-resourcetask to rendering jobs for retrieving a resource and placing it in artifact storage.
- Added an
export-to-ecommercetask 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.
- Now, working with folders in AssetStorage is case-insensitive.
- Added a ban on creating jobs without a
finalizetask to the Rendering Service.
April 14, 2023
- Fixed the
StorefrontUsers_fullAPI scope typo.
March 30, 2023
- 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 conneted to products in storefronts.
- Reduced the provider requests to the same format.
- Reduced enums to a string form.
March 24, 2023
- Added support for M3D mockups in the Asset Processor API.
- Added a DesignAtomsMockups3d API for working with 3D mockups.
February 27, 2023
- Moved the endpoints PrivateDesignProcessor_CopyDesignFromPublicDesign and PrivateDesignProcessor_CopyDesignFromPublicResource to the Asset Processor API.
January 23, 2023
- Added the possibility to group designs by
FolderIdin the Storefront Products API. The endpoint Products_GetProductVariantDesigns now returns the