Introduction
The GetReorder API is designed to facilitate the reordering of previously created designs within the system. This endpoint allows clients to replicate an existing design by generating a new design instance based on historical data. Instead of manually recreating a design from scratch, the API automates the duplication process, ensuring consistency, efficiency, and reduced operational effort.
When the API is invoked, it takes the provided designId (representing the original design) and creates a new design entry with a unique identifier. All relevant attributes, configurations, and associated data from the original design are carried forward to the newly created design. This enables users to quickly reuse prior designs while maintaining the flexibility to modify the duplicated version if needed.
Use Cases
1. Repeat Orders / Reordering Past Designs
Users who want to reorder a previously created design (e.g., reprinting marketing materials, merchandise, or templates) can use this API to quickly generate a duplicate without rebuilding the design manually.
2. Design Template Reusability
Organizations can treat existing designs as templates. By using the reorder API, they can duplicate a base design and make minor adjustments for new use cases, saving time and ensuring consistency.
3. Versioning and Iteration
Designers can duplicate an existing design to create a new version, enabling iterative improvements while preserving the original design unchanged.
4. E-commerce Product Reorders
For platforms dealing with customizable products, customers can reorder previously purchased designs (e.g., personalized items) without reconfiguring all options again.
API Details
Endpoint
GET /api/4/Design/GetReorder
curl --location 'https://api.artifi.net/api/4/Design/GetReorder?DesignId=42962415&UserId=165' \
--header 'websiteId: 241' \
--header 'webApiClientKey: c961461a-b287-448c-b9ea-e1162bd80b8e'
Parameters
Header validation
Header Name | Type | Required | Description |
websiteId | int | Yes | Unique identifier of the website. |
webApiClientKey | string | Yes | API client key used for authentication. |
Query Parameters
Name | Type | Required | Description |
UserId | string | Yes | This will be the ID of the ecommerce website's user, whether it be a registered or a guest user. If the user is registered, pass the user ID in this parameter. If the user is not registered with the e-commerce website, create a temporary ID for the user and pass that temporary ID in this parameter. The non-registered user will be referred to as a guest user, and this will be their unique user ID. The method will return the product customized by the user whose ID is specified in this parameter.
|
DesignId | Integer | Yes | Design id is a customized product id. The product which is customized/designed using Artifi (Product customization tool) and saved or Added to the cart is called a customized product. When this customized product id is specified, it will launch the Artifi editor with the specified customized product. This means, when the Artifi editor gets opened in a specified HTML div element, you will get to see/edit the customized product whose id is specified in this parameter.
|
Success Responses
{
"Response": "Success",
"Message": "The design is re-ordered successfully.",
"Data": {
"DesignId": 43055734,
"CartJson": {
"productDetails": {
"designId": 42962415,
"userId": "165",
"orderStatus": "InProgress",
"productName": "Artifi_2.16.8",
"productCode": "Artifi_2.16.8",
"sku": "5454546565",
"imprintColorLimit": 0,
"productAttribute": [
{
"name": "t-shirt Attribute",
"code": "",
"displayName": "",
"selectedValue": {
"value": "RED",
"valueCode": "",
"keyValue": "",
"displayName": ""
}
}
],
"customAttribute": [],
"colorAttribute": [],
"customDataListDetails": []
},
"designDetails": {
"views": [
{
"viewName": "Front",
"viewCode": "736956",
"decorationMethodCode": "DEFAULT",
"previewStandardUrl": "https://designer.artifi.net/Designer/Services/GetPreviewImage?websiteId=241&webApiClientKey=c961461a-b287-448c-b9ea-e1162bd80b8e&customizedProductId=42962415&viewId=736956&isThumbnail=False",
"previewThumbnailUrl": "https://designer.artifi.net/Designer/Services/GetPreviewImage?websiteId=241&webApiClientKey=c961461a-b287-448c-b9ea-e1162bd80b8e&customizedProductId=42962415&viewId=736956&isThumbnail=True",
"image": [
{
"imageType": "Uploaded",
"id": 3727869,
"widgetKey": "",
"color": "",
"selectedColors": [],
"embroideryData": {
"stitchCount": 0,
"colorCount": 0,
"threads": ""
},
"clipartNote": "",
"clipartCode": "",
"clipartName": "",
"originalUrl": "",
"standardUrl": "",
"thumbnailUrl": "",
"originalFileName": "Whale",
"originalFileMimeType": "",
"imageName": "Whale"
}
],
"text": [
{
"widget_key": "",
"text": "EditMode",
"color": "#000000",
"fontSize": 42,
"fontFamily": "Arimo",
"caption": "Text",
"textStyle": "arc",
"fontCode": "ACDF002",
"textAlign": "left",
"vAlign": "middle",
"embroideryData": {
"stitchCount": 0,
"colorCount": 0,
"threads": ""
},
"fontStyle": "BoldItalic"
}
],
"monogram": []
},
{
"viewName": "Back",
"viewCode": "736962",
"decorationMethodCode": "DEFAULT",
"previewStandardUrl": "https:// exampledomain.artifi.net/Designer/Services/GetPreviewImage?websiteId=241&webApiClientKey=ca9a61461aa-b287-448c-b9ea-e1162bd80b8e&customizedProductId=429623415&viewId=7363962&isThumbnail=False",
"previewThumbnailUrl": "https://designer.artifi.net/Designer/Services/GetPreviewImage?websiteId=241&webApiClientKey=c961461a-b2873-448c-b9ea-e13162bd80b8e&customizedProductId=429623415&viewId=7369632&isThumbnail=True",
"image": [
{
"imageType": "Uploaded",
"id": 7153662,
"widgetKey": "",
"color": "",
"selectedColors": [],
"embroideryData": {
"stitchCount": 0,
"colorCount": 0,
"threads": ""
},
"clipartNote": "",
"clipartCode": "",
"clipartName": "",
"originalUrl": "",
"standardUrl": "",
"thumbnailUrl": "",
"originalFileName": "placeholder",
"originalFileMimeType": "",
"imageName": "placeholder"
}
],
"text": [
{
"widget_key": "",
"text": "QA demo",
"color": "#000000",
"fontSize": 60,
"fontFamily": "Arimo",
"caption": "Text",
"textStyle": "text",
"fontCode": "ACDF002",
"textAlign": "left",
"vAlign": "middle",
"embroideryData": {
"stitchCount": 0,
"colorCount": 0,
"threads": ""
},
"fontStyle": "bold"
}
],
"monogram": []
}
],
"groupViews": []
},
"outputDetails": {
"pdfUrl": ""
},
"designId": 43055734
}
},
"ErrorCode": ""
}
Sample Error Response
{
"Response": "Error",
"Message": "Invalid design id.",
"Data": null,
"ErrorCode": "225"
}
Error Code List (Click Here)
Q&A
1. What is the purpose of the GetReorder API?
The GetReorder API is used to duplicate an existing customized design and create a new design instance based on a previously saved design. This helps users quickly reorder or reuse past designs without recreating them manually.
2. What happens when the API is called?
When the API is invoked with a valid DesignId and UserId:
- A new design entry has been created.
- A new unique DesignId is generated.
- All design configurations, assets, views, text, images, and associated product data are copied from the original design.
- The duplicated design is returned in the response payload.
4. Is authentication required for this API?
Yes. Both websiteId and webApiClientKey are required for authentication and validation.
5. What is the DesignId parameter?
DesignId represents the previously customized product/design created using the Artifi designer. The API uses this ID to duplicate the existing design.
6. What is the UserId parameter?
UserId identifies the ecommerce customer associated with the design.
- For registered users, pass the actual user ID.
- For guest users, generate and pass a temporary unique identifier.
7. Does the reorder API modify the original design?
No. The original design remains unchanged. The API creates a completely new design instance with a new DesignId.
8. Can guest users reorder designs?
Yes. Guest users can reorder designs by passing a temporary unique ID in the UserId parameter.
9. What information is returned in the response?
The success response includes:
- Newly generated DesignId
- Product details
- Design views
- Preview URLs
- Uploaded images
- Text elements
- Design configuration data
- Output details
10. What does the CartJson object contain?
CartJson contains the complete duplicated design configuration including:
Product details
Design views
Text elements
Images
Preview image URLs
Output details
Final generated design ID
11. What happens if an invalid DesignId is passed?
The API returns an error response similar to:
{
"Response": "Error",
"Message": "Invalid design id.",
"Data": null,
"ErrorCode": "225"
}
12. Does the API generate new preview URLs for the reordered design?
Yes. The reordered design includes preview URLs for viewing thumbnails and standard preview images.
13. Can reordered designs be edited further?
Yes. The newly created reordered design can be opened and modified in the Artifi editor like any newly created design.
14. Is this API useful for repeating ecommerce purchases?
Yes. This API is especially useful for ecommerce platforms where users frequently reorder customized products.
15. Can organizations use this API for designs duplication?
Yes. Organizations can use previously created designs as templates and duplicate them using this API for faster design creation and consistency.
16. Does the API support multi-view designs?
Yes. Designs with multiple views (e.g. Front and Back) are fully duplicated along with all associated assets and configurations.
17. What HTTP method is used for this API?
The API uses the GET HTTP method.