Creating Variation
Endpoint: POST /admin/variations
Purpose
This API is used to create a new product variation along with its corresponding options. A variation defines a customizable product attribute such as size, color, material, etc. Each option includes display labels, values, display order, default status, and can include an image reference. This endpoint helps administrators set up new configurable attributes for products to enable flexible product customization.
Path Parameters
No path parameters for this endpoint.
Query Parameters
No query parameters for this endpoint.
Use Case
Administrators use this endpoint to define a new variation and add its available options. Each option is set with values like label, order, and default status. Once created, the system assigns unique IDs to the variation and its options, including auto-generated values or references. This API is crucial for expanding product configuration and enabling customer-facing customization on the storefront.
Request Body
{
"variation": {
"name": "VARIATION_NAME",
"standard": "VARIATION_STANDARD",
"is_disposable": "VARIATION_IS_DISPOSABLE",
"options": [
{
"id": "VARIATION_OPTION_ID_1",
"label": "VARIATION_OPTION_LABEL_1",
"value": "VARIATION_OPTION_VALUE_1",
"order": "VARIATION_OPTION_ORDER_1",
"default": "VARIATION_OPTION_DEFAULT_1"
},
{
"id": "VARIATION_OPTION_ID_2",
"label": "VARIATION_OPTION_LABEL_2",
"value": "VARIATION_OPTION_VALUE_2",
"order": "VARIATION_OPTION_ORDER_2",
"default": "VARIATION_OPTION_DEFAULT_2"
}
]
}
}Response
{
"variation": {
"id": "VARIATION_ID",
"name": "VARIATION_NAME",
"standard": "VARIATION_STANDARD",
"is_disposable": "VARIATION_IS_DISPOSABLE",
"options": [
{
"id": "VARIATION_OPTION_ID_1",
"label": "VARIATION_OPTION_LABEL_1",
"value": "VARIATION_OPTION_VALUE_1",
"order": "VARIATION_OPTION_ORDER_1",
"default": "VARIATION_OPTION_DEFAULT_1",
"image": "VARIATION_OPTION_IMAGE_1"
},
{
"id": "VARIATION_OPTION_ID_2",
"label": "VARIATION_OPTION_LABEL_2",
"value": "VARIATION_OPTION_VALUE_2",
"order": "VARIATION_OPTION_ORDER_2",
"default": "VARIATION_OPTION_DEFAULT_2",
"image": "VARIATION_OPTION_IMAGE_2"
}
]
}
}