Processing personalization results
- 1-2 minutes to read
After a successful checkout, you can save the personalization results in your Customer's Canvas account for further processing. Here, the special integration entity Project appears. When creating a project, the corresponding private design is marked as permanent and remains in the private storage for as long as this project exists.
The project is primarily used to prepare print files used for making a personalized product. Projects store private designs, data obtained during personalization, and information about the order in the online store.
A separate project is created for each product in the order if the product is linked to the Customer's Canvas specification. Depending on the configuration of the personalization process, a single project may include information about multiple elements and their personalized designs. For example, a project for the product representing a postcard in an envelope may include two elements: a postcard and an envelope.
In the Storefront API, the endpoint Projects_Create is responsible for creating projects. The parameters are the product identifier in the online store, order information, and personalization results.
All projects created under your Customer's Canvas account are displayed on the Projects tab in BackOffice.
Working with Projects
During the life cycle of a project, it can move from one status to another, reflecting the completed stages: creation, confirmation, preparation of a print file, production of products, delivery, and so on.
The possible states and restrictions of transitions between them are currently finalized. To get information about them, you can use the endpoints Projects_GetAllStatuses and Projects_GetAllTransitions. The transition between states is performed using the endpoint Projects_ChangeStatus.
You can get a list of projects related to a given online store and track their status by using the Storefront API endpoint Projects_GetAll. This endpoint supports a paginated output as well as filtering by creation date and status.
To prepare and download a print file for making a personalized product, you can get its URL by using the endpoint Projects_GetProjectPdfUrl.