»
Variation PUT API Documentation
Updating Variation
Endpoint: PUT /admin/variations/{$variation_id}
Purpose
This API allows administrators to update an existing variation by its unique ID. It supports modifying the variation's name, standard type, disposability status, and associated options. This is useful for maintaining accuracy and relevance when managing variation data.
Path Parameters
| Parameter | Type | Description |
|---|---|---|
| variation_id | Integer | The unique ID of the variation to update. |
Query Parameters
No query parameters for this endpoint.
Use Case
Administrators use this endpoint to edit existing variations. For instance, updating a variation name, changing the order of options, or setting a default option. This ensures that the system always reflects the latest and correct variation configurations.
PUT
https://{your_site_domain}/api/v4/admin/variations/1
Try It Out
Request Body
JSON
{
"variation": {
"name": "VARIATION_NAME",
"standard": "VARIATION_STANDARD",
"is_disposable": "VARIATION_IS_DISPOSABLE",
"options": [
{
"id": "VARIATION_OPTION_ID",
"label": "VARIATION_OPTION_LABEL",
"value": "VARIATION_OPTION_VALUE",
"order": "VARIATION_OPTION_ORDER",
"default": "VARIATION_OPTION_DEFAULT"
}
]
}
}Response
JSON
{
"variation": {
"id": "VARIATION_ID",
"name": "VARIATION_NAME",
"standard": "VARIATION_STANDARD",
"is_disposable": "VARIATION_IS_DISPOSABLE",
"options": [
{
"id": "VARIATION_OPTION_ID",
"label": "VARIATION_OPTION_LABEL",
"value": "VARIATION_OPTION_VALUE",
"order": "VARIATION_OPTION_ORDER",
"default": "VARIATION_OPTION_DEFAULT",
"image": "VARIATION_OPTION_IMAGE"
}
]
}
}