Introduction
The Get Decoration Method List API is designed to retrieve all available decoration methods associated with a product. These methods can be fetched based on either a specific design ID or a product SKU, enabling flexible integration across different workflows.
This API returns comprehensive information about each decoration method, including its rendering type, supported templates, and other relevant configuration details required for accurate product visualization and customization.
Typically, this API is invoked after a product has been customized in the Artifi Designer and added to the cart on the webstore. It ensures that the system has the correct and complete set of decoration options needed for downstream processes such as pricing, rendering, and order fulfillment.
Use Cases
- Post-Customization Validation
After a user customizes a product in the designer, this API helps validate which decoration methods are applicable to the final design before checkout.
- Dynamic Rendering Configuration
The API provides rendering types , allowing frontend or rendering engines to dynamically adjust how the customized product is displayed.
- Cart-Level Data Enrichment
When a product is added to the cart, the API enriches the cart data with detailed decoration method information required for accurate order processing.
- Template Mapping for Production
Production systems can use the returned templates to map the selected design to the correct print or decoration format.
- SKU-Based Decoration Lookup
For pre-configured or catalog-based products, the API can fetch decoration methods directly using SKU without requiring a design ID.
- Pricing & Cost Calculation
Different decoration methods may have varying costs. This API enables pricing engines to determine applicable charges based on selected methods.
- Integration with Order Fulfillment Systems
Ensures downstream systems (like manufacturing or printing services) receive the correct decoration method and template details for execution.
API Details
Endpoint
Get /api/4/DecorationMethod/GetDecorationMethodList
curl --location 'https://api.artifi.net/api/4/DecorationMethod/GetDecorationMethodList?sku=Artifi_2.16.8' \
--header 'webApiClientKey: c961461a-b287-448c-b9ea-e1162bd80b8e' \
--header 'websiteId: 241'
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 | Default | Description |
sku | string | Yes | — | This is a unique field to identify any product. In this field, users can send either Product base SKU/ProductCode or Variant SKU. This field should be matched with the product available in Admin. If Artifi receives the base product code/SKU and the product has variants, then we are sending back the default SKU details of that product.
|
integer | int | Optional | 0 | This is the ID of the designed product that gets added to cart. Design ID is created when the user adds the customized product to the cart.
|
Success Responses
{
"Response": "Success",
"Message": "",
"Data": {
"templates": [
{
"ViewId": 153617,
"Templates": [
{
"Name": "1233",
"ImageUniqueName": "7a9a05c0-80bc-43ed-ab4a-e43ffdd88c66.png",
"Code": "155714",
"DisplayImageUniqueName": null,
"DisplayName": null,
"DecorationMethodId": 158,
"Id": 155714
}
],
"DecorationMethods": [
{
"DecorationCode": "Default",
"RenderingTypeId": 1,
"DecorationName": "Default",
"DisplayOrder": 1,
"Id": 158,
"IsSelected": true,
"RecolorLimit": 15,
"Effects": null,
"TexturedImage": null,
"RestrictedFeatures": null,
"SingleColor": null
}
]
}
]
},
"ErrorCode": ""
}
Error Code List (Click Here)
Q&A
1. When should this Decoration List API be used?
This API should be used after a product has been customized in the Artifi Designer and added to the cart. It helps retrieve applicable decoration methods and templates required for further processing.
2. What is the difference between using sku and designId (integer)?
- SKU is used to fetch decoration methods for a product (base or variant).
- Design ID is used when the product has already been customized and added to the cart, ensuring decoration methods align with the specific design.
3. Is it mandatory to pass both SKU and Design ID?
No.
- SKU is mandatory
- Design ID is optional and should be passed only when working with customized products.
4. What happens if a base SKU has variants?
If a base SKU is provided and the product has variants, the API returns the default variant SKU details.
5. What does RenderingTypeId represent?
RenderingTypeId defines how the decoration method should be rendered on the product (e.g., print, embroidery, digital rendering). The exact mapping depends on the system configuration.
6. What is the purpose of the Templates array?
The Templates array contains all available design templates associated with a specific product view and decoration method. These templates are used for rendering.
7. Can multiple decoration methods be returned?
Yes. A product view can have multiple decoration methods, but typically one method is marked as default.
8. What does RecolorLimit indicate?
RecolorLimit specifies the maximum number of color changes allowed for a particular decoration method.
9. What happens if invalid SKU is passed?
The API will return an error response (refer to the Error Code documentation for details).
10. Are headers required in this API?
Yes:
- webApiClientKey
- websiteId
must be passed in the request headers for authentication and validation.
11. Can this API be used for pricing calculation?
Yes. The response helps identify decoration methods, which can then be used by pricing engines to calculate costs.