--- updatedAt: 2026-05-29T09:20:09.000Z agentTools: projectIndex: https://developer.katanamrp.com/llms.txt --- # Update a variant Updates the specified variant by setting the values of the parameters passed. Any parameters not provided will be left unchanged. # OpenAPI definition ```json { "openapi": "3.0.0", "info": { "title": "RESOURCES", "version": "1.0.0", "description": "public api" }, "servers": [ { "url": "https://api.katanamrp.com/v1" } ], "security": [ { "bearerAuth": [] } ], "components": { "securitySchemes": { "bearerAuth": { "type": "http", "scheme": "bearer" } } }, "paths": { "/variants/{id}": { "patch": { "summary": "Update a variant", "tags": [ "Variant" ], "description": "Updates the specified variant by setting the values of the parameters passed.\n Any parameters not provided will be left unchanged.", "operationId": "updateVariant", "parameters": [ { "name": "id", "required": true, "description": "Variant id", "schema": { "type": "integer" }, "in": "path" }, { "name": "X-Custom-Fields-Format", "required": false, "in": "header", "description": "Selects the representation of `custom_fields` on items, for both the request body and the response.\n\n- `default` — object keyed by custom field definition id (UUID).\n- `legacy` — the `{field_name, field_value}` array tied to custom fields collections.\n\nMost accounts do not need this header: an account that has not moved to item custom fields always gets `legacy`, and an account that has moved and no longer uses collections always gets the object representation. The header matters only while both are available for the account, where `legacy` is the default and `default` opts into the object representation.\n\nRequesting a representation the account does not have returns 422, as does sending a `custom_fields` body whose shape does not match the representation in force, mixing both shapes in one request, or combining `custom_field_collection_id` with the object representation — that field belongs to the legacy representation and is left out of responses entirely under the object one. Responses vary on this header.", "schema": { "type": "string", "enum": [ "default", "legacy" ] } } ], "requestBody": { "description": "Variant details", "required": true, "content": { "application/json": { "schema": { "type": "object", "additionalProperties": false, "properties": { "sku": { "type": "string" }, "sales_price": { "type": "number", "maximum": 100000000000, "minimum": 0, "nullable": true }, "purchase_price": { "type": "number", "maximum": 100000000000, "minimum": 0, "nullable": true }, "product_id": { "type": "integer", "maximum": 2147483647 }, "supplier_item_codes": { "type": "array", "minItems": 1, "items": { "type": "string", "minLength": 1 } }, "internal_barcode": { "type": "string", "minLength": 3, "maxLength": 40 }, "registered_barcode": { "type": "string", "maxLength": 120 }, "material_id": { "type": "integer", "maximum": 2147483647 }, "lead_time": { "type": "integer", "maximum": 999, "nullable": true }, "minimum_order_quantity": { "type": "number", "maximum": 999999999, "minimum": 0, "nullable": true }, "config_attributes": { "type": "array", "minItems": 1, "items": { "type": "object", "additionalProperties": false, "required": [ "config_name", "config_value" ], "properties": { "config_name": { "type": "string", "description": "If a matching config name is not found, an error is returned.\n Use the product/material endpoint to update the configs." }, "config_value": { "type": "string", "description": "If a matching config name is not found,\n the product/material config list of values is updated, and a new value is added." } } } }, "custom_fields": { "description": "Custom field values on the variant, in whichever representation applies to the account — see the `X-Custom-Fields-Format` header.\n\nIn the object representation the values are merged, not replaced: omit a key to leave it unchanged, and send `null` to clear one. Values already snapshotted onto existing sales order rows, purchase order rows, or manufacturing orders are not touched — those records keep what they were created with.", "oneOf": [ { "type": "object", "description": "Object representation. Custom field values keyed by custom field definition id (UUID) of a definition whose `entity_type` is `ProductVariant`, `MaterialVariant`, or `ServiceVariant`. Each value matches the definition’s `field_type` — string for `shortText` / `url`, number for `number`, boolean for `boolean`, `YYYY-MM-DD` string for `date`, or the integer choice `id` for `singleSelect`. Send `null` to clear a single value. Keys that are not a UUID, and UUIDs with no matching definition, are rejected with a 422.", "additionalProperties": { "nullable": true, "anyOf": [ { "type": "string" }, { "type": "number" }, { "type": "boolean" } ] } }, { "type": "array", "maxItems": 3, "description": "Legacy representation. Up to three name/value pairs, drawn from the custom fields collection assigned to the item. Superseded by the object representation.", "items": { "type": "object", "additionalProperties": false, "required": [ "field_name", "field_value" ], "properties": { "field_name": { "maxLength": 40, "type": "string" }, "field_value": { "maxLength": 100, "type": "string" } } } } ] } } } } } }, "responses": { "200": { "description": "Variant updated", "headers": { "X-Ratelimit-Limit": { "description": "Number of requests available for this application.", "schema": { "type": "number" } }, "X-Ratelimit-Remaining": { "description": "Number of requests remaining in quota.", "schema": { "type": "number" } }, "X-Ratelimit-Reset": { "description": "The timestamp when the quota will reset.", "schema": { "type": "number" } } }, "content": { "application/json": { "examples": { "objectCustomFields": { "summary": "Object custom fields representation", "value": { "id": 1, "sku": "EM", "sales_price": 40, "product_id": 1, "material_id": null, "purchase_price": 0, "type": "product", "internal_barcode": "0315", "registered_barcode": "0785223088", "supplier_item_codes": [ "978-0785223085", "0785223088" ], "created_at": "2020-10-23T10:37:05.085Z", "updated_at": "2020-10-23T10:37:05.085Z", "lead_time": 1, "minimum_order_quantity": 3, "config_attributes": [ { "config_name": "Type", "config_value": "Standard" } ], "custom_fields": { "a1b2c3d4-1111-2222-3333-444455556666": "Strong" } } }, "legacyCustomFields": { "summary": "Legacy custom fields representation", "value": { "id": 1, "sku": "EM", "sales_price": 40, "product_id": 1, "material_id": null, "purchase_price": 0, "type": "product", "internal_barcode": "0315", "registered_barcode": "0785223088", "supplier_item_codes": [ "978-0785223085", "0785223088" ], "created_at": "2020-10-23T10:37:05.085Z", "updated_at": "2020-10-23T10:37:05.085Z", "lead_time": 1, "minimum_order_quantity": 3, "config_attributes": [ { "config_name": "Type", "config_value": "Standard" } ], "custom_fields": [ { "field_name": "Power level", "field_value": "Strong" } ] } } } } } }, "401": { "description": "Make sure you've entered your API token correctly.", "headers": { "X-Ratelimit-Limit": { "description": "Number of requests available for this application.", "schema": { "type": "number" } }, "X-Ratelimit-Remaining": { "description": "Number of requests remaining in quota.", "schema": { "type": "number" } }, "X-Ratelimit-Reset": { "description": "The timestamp when the quota will reset.", "schema": { "type": "number" } } }, "content": { "application/json": { "example": { "statusCode": 401, "name": "UnauthorizedError", "message": "Unauthorized" } } } }, "422": { "description": "Check the details property for a specific error message.", "headers": { "X-Ratelimit-Limit": { "description": "Number of requests available for this application.", "schema": { "type": "number" } }, "X-Ratelimit-Remaining": { "description": "Number of requests remaining in quota.", "schema": { "type": "number" } }, "X-Ratelimit-Reset": { "description": "The timestamp when the quota will reset.", "schema": { "type": "number" } } }, "content": { "application/json": { "example": { "statusCode": 422, "name": "UnprocessableEntityError", "message": "The request body is invalid. See error object `details` property for more info.", "code": "VALIDATION_FAILED", "details": [ { "path": ".name", "code": "maxLength", "message": "should NOT be longer than 10 characters", "info": { "limit": 10 } } ] } } } }, "429": { "description": "The rate limit has been reached. Please try again later.", "headers": { "X-Ratelimit-Limit": { "description": "Number of requests available for this application.", "schema": { "type": "number" } }, "X-Ratelimit-Remaining": { "description": "Number of requests remaining in quota.", "schema": { "type": "number" } }, "X-Ratelimit-Reset": { "description": "The timestamp when the quota will reset.", "schema": { "type": "number" } } }, "content": { "application/json": { "example": { "statusCode": 429, "name": "TooManyRequests", "message": "Too Many Requests" } } } }, "500": { "description": "The server encountered an error. If this persists, please contact support", "headers": { "X-Ratelimit-Limit": { "description": "Number of requests available for this application.", "schema": { "type": "number" } }, "X-Ratelimit-Remaining": { "description": "Number of requests remaining in quota.", "schema": { "type": "number" } }, "X-Ratelimit-Reset": { "description": "The timestamp when the quota will reset.", "schema": { "type": "number" } } }, "content": { "application/json": { "example": { "statusCode": 500, "name": "InternalServerError", "message": "Internal Server Error" } } } } } } } }, "x-explorer-enabled": false, "x-samples-enabled": true, "x-samples-languages": [ "curl", "node", "go", "ruby", "python", "php" ], "x-headers": [ { "key": "Authorization", "value": "Bearer " } ] } ```