Update product variant

PUT

admin

api

accounts

products

{product_id}

variants

{id}

Update product variant

curl --request PUT \
  --url https://erp.arukz.com/admin/api/v1/accounts/products/{product_id}/variants/{id} \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "type": "goods",
  "name": "Laptop Computer",
  "service_tracking": "b",
  "reference": "PROD-001",
  "barcode": "1234567890",
  "price": 999.99,
  "cost": 750,
  "volume": 0.5,
  "weight": 2.5,
  "description": "High-performance laptop with latest specifications.",
  "description_purchase": "Enterprise laptop for business use.",
  "description_sale": "Perfect for professionals and power users.",
  "enable_sales": false,
  "enable_purchase": false,
  "is_favorite": false,
  "images": [
    "architecto"
  ],
  "uom_id": 1,
  "uom_po_id": 1,
  "category_id": 1,
  "company_id": 1,
  "tags": [
    16
  ],
  "property_account_income_id": 1,
  "property_account_expense_id": 2,
  "image": "architecto",
  "service_type": "architecto",
  "sale_line_warn": "architecto",
  "expense_policy": "architecto",
  "invoice_policy": "order",
  "sale_line_warn_msg": "architecto",
  "sales_ok": false,
  "purchase_ok": false
}
'

import requests

url = "https://erp.arukz.com/admin/api/v1/accounts/products/{product_id}/variants/{id}"

payload = {
    "type": "goods",
    "name": "Laptop Computer",
    "service_tracking": "b",
    "reference": "PROD-001",
    "barcode": "1234567890",
    "price": 999.99,
    "cost": 750,
    "volume": 0.5,
    "weight": 2.5,
    "description": "High-performance laptop with latest specifications.",
    "description_purchase": "Enterprise laptop for business use.",
    "description_sale": "Perfect for professionals and power users.",
    "enable_sales": False,
    "enable_purchase": False,
    "is_favorite": False,
    "images": ["architecto"],
    "uom_id": 1,
    "uom_po_id": 1,
    "category_id": 1,
    "company_id": 1,
    "tags": [16],
    "property_account_income_id": 1,
    "property_account_expense_id": 2,
    "image": "architecto",
    "service_type": "architecto",
    "sale_line_warn": "architecto",
    "expense_policy": "architecto",
    "invoice_policy": "order",
    "sale_line_warn_msg": "architecto",
    "sales_ok": False,
    "purchase_ok": False
}
headers = {
    "Authorization": "Bearer <token>",
    "Content-Type": "application/json"
}

response = requests.put(url, json=payload, headers=headers)

print(response.text)

const options = {
  method: 'PUT',
  headers: {Authorization: 'Bearer <token>', 'Content-Type': 'application/json'},
  body: JSON.stringify({
    type: 'goods',
    name: 'Laptop Computer',
    service_tracking: 'b',
    reference: 'PROD-001',
    barcode: '1234567890',
    price: 999.99,
    cost: 750,
    volume: 0.5,
    weight: 2.5,
    description: 'High-performance laptop with latest specifications.',
    description_purchase: 'Enterprise laptop for business use.',
    description_sale: 'Perfect for professionals and power users.',
    enable_sales: false,
    enable_purchase: false,
    is_favorite: false,
    images: ['architecto'],
    uom_id: 1,
    uom_po_id: 1,
    category_id: 1,
    company_id: 1,
    tags: [16],
    property_account_income_id: 1,
    property_account_expense_id: 2,
    image: 'architecto',
    service_type: 'architecto',
    sale_line_warn: 'architecto',
    expense_policy: 'architecto',
    invoice_policy: 'order',
    sale_line_warn_msg: 'architecto',
    sales_ok: false,
    purchase_ok: false
  })
};

fetch('https://erp.arukz.com/admin/api/v1/accounts/products/{product_id}/variants/{id}', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

<?php

$curl = curl_init();

curl_setopt_array($curl, [
  CURLOPT_URL => "https://erp.arukz.com/admin/api/v1/accounts/products/{product_id}/variants/{id}",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "PUT",
  CURLOPT_POSTFIELDS => json_encode([
    'type' => 'goods',
    'name' => 'Laptop Computer',
    'service_tracking' => 'b',
    'reference' => 'PROD-001',
    'barcode' => '1234567890',
    'price' => 999.99,
    'cost' => 750,
    'volume' => 0.5,
    'weight' => 2.5,
    'description' => 'High-performance laptop with latest specifications.',
    'description_purchase' => 'Enterprise laptop for business use.',
    'description_sale' => 'Perfect for professionals and power users.',
    'enable_sales' => false,
    'enable_purchase' => false,
    'is_favorite' => false,
    'images' => [
        'architecto'
    ],
    'uom_id' => 1,
    'uom_po_id' => 1,
    'category_id' => 1,
    'company_id' => 1,
    'tags' => [
        16
    ],
    'property_account_income_id' => 1,
    'property_account_expense_id' => 2,
    'image' => 'architecto',
    'service_type' => 'architecto',
    'sale_line_warn' => 'architecto',
    'expense_policy' => 'architecto',
    'invoice_policy' => 'order',
    'sale_line_warn_msg' => 'architecto',
    'sales_ok' => false,
    'purchase_ok' => false
  ]),
  CURLOPT_HTTPHEADER => [
    "Authorization: Bearer <token>",
    "Content-Type: application/json"
  ],
]);

$response = curl_exec($curl);
$err = curl_error($curl);

curl_close($curl);

if ($err) {
  echo "cURL Error #:" . $err;
} else {
  echo $response;
}

{
  "data": {
    "id": 1,
    "type": "goods",
    "name": "Big Vision 4K Action Camera",
    "service_tracking": "none",
    "reference": "Action-01",
    "barcode": "BV4K-0001",
    "price": 150,
    "cost": 100,
    "volume": 0,
    "weight": 1.2,
    "description": "<p>A high-quality 4k action camera designed for everyday use.</p><p>The <strong>4K Action Camera</strong> is crafted with premium materials, ensuring durability and functionality. Perfect for those who value quality and innovation in their everyday essentials.</p>",
    "description_purchase": null,
    "description_sale": null,
    "enable_sales": false,
    "enable_purchase": false,
    "is_favorite": false,
    "is_configurable": true,
    "images": [
      "01JR9QKPXFKP1S054PZDM17MEP.png",
      "01JR9QKPXPX1TJKCH0DMZ29M12.png"
    ],
    "sort": null,
    "parent_id": null,
    "uom_id": 1,
    "uom_po_id": 1,
    "category_id": 11,
    "creator_id": 1,
    "company_id": 1,
    "created_at": "2025-04-08T03:37:55.000000Z",
    "updated_at": "2025-09-23T07:28:33.000000Z",
    "deleted_at": null,
    "property_account_income_id": null,
    "property_account_expense_id": null,
    "image": null,
    "service_type": null,
    "sale_line_warn": null,
    "expense_policy": null,
    "invoice_policy": null,
    "sale_line_warn_msg": null,
    "sales_ok": true,
    "purchase_ok": true
  },
  "message": "Product variant updated successfully."
}

{
  "message": "Unauthenticated."
}

{
  "message": "Resource not found."
}

{
  "message": "The given data was invalid.",
  "errors": {
    "name": [
      "The name field must be a string."
    ]
  }
}

Authorizations

Authorization

string

header

required

An API token from Sign in, sent as Authorization: Bearer <token>. Tokens last 30 days.

Path Parameters

product_id

integer

required

The product ID

Example:

1

integer

required

The variant ID

Example:

1

Body

application/json

type

enum<string>

Product type: goods, service, consu (consumable).

Available options:

goods,

service

Example:

"goods"

name

string

Product name (max 255 characters). Must not be greater than 255 characters.

Example:

"Laptop Computer"

service_tracking

string | null

Must not be greater than 255 characters.

Example:

"b"

reference

string | null

Internal reference code (max 255 characters). Must not be greater than 255 characters.

Example:

"PROD-001"

barcode

string | null

Product barcode (max 255 characters). Must not be greater than 255 characters.

Example:

"1234567890"

price

number

Sales price (minimum 0). Must be at least 0.

Example:

999.99

cost

number | null

Product cost (minimum 0). Must be at least 0.

Example:

750

volume

number | null

Product volume (min 0, max 99999999999). Must be at least 0. Must not be greater than 99999999999.

Example:

0.5

weight

number | null

Product weight (min 0, max 99999999999). Must be at least 0. Must not be greater than 99999999999.

Example:

2.5

description

string | null

Product description.

Example:

"High-performance laptop with latest specifications."

description_purchase

string | null

Purchase description.

Example:

"Enterprise laptop for business use."

description_sale

string | null

Sales description.

Example:

"Perfect for professionals and power users."

enable_sales

boolean | null

Whether this product can be sold.

Example:

false

enable_purchase

boolean | null

Whether this product can be purchased.

Example:

false

is_favorite

boolean | null

Mark this product as favorite.

Example:

false

images

string[] | null

Example:

["architecto"]

uom_id

integer | null

Unit of measure ID.

Example:

1

uom_po_id

integer | null

Purchase unit of measure ID.

Example:

1

category_id

integer

Product category ID. The id of an existing record in the products_categories table.

Example:

1

company_id

integer | null

Company ID this product belongs to.

Example:

1

Response

Success

⌘I

Update product variant

curl --request PUT \
  --url https://erp.arukz.com/admin/api/v1/accounts/products/{product_id}/variants/{id} \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "type": "goods",
  "name": "Laptop Computer",
  "service_tracking": "b",
  "reference": "PROD-001",
  "barcode": "1234567890",
  "price": 999.99,
  "cost": 750,
  "volume": 0.5,
  "weight": 2.5,
  "description": "High-performance laptop with latest specifications.",
  "description_purchase": "Enterprise laptop for business use.",
  "description_sale": "Perfect for professionals and power users.",
  "enable_sales": false,
  "enable_purchase": false,
  "is_favorite": false,
  "images": [
    "architecto"
  ],
  "uom_id": 1,
  "uom_po_id": 1,
  "category_id": 1,
  "company_id": 1,
  "tags": [
    16
  ],
  "property_account_income_id": 1,
  "property_account_expense_id": 2,
  "image": "architecto",
  "service_type": "architecto",
  "sale_line_warn": "architecto",
  "expense_policy": "architecto",
  "invoice_policy": "order",
  "sale_line_warn_msg": "architecto",
  "sales_ok": false,
  "purchase_ok": false
}
'

import requests

url = "https://erp.arukz.com/admin/api/v1/accounts/products/{product_id}/variants/{id}"

payload = {
    "type": "goods",
    "name": "Laptop Computer",
    "service_tracking": "b",
    "reference": "PROD-001",
    "barcode": "1234567890",
    "price": 999.99,
    "cost": 750,
    "volume": 0.5,
    "weight": 2.5,
    "description": "High-performance laptop with latest specifications.",
    "description_purchase": "Enterprise laptop for business use.",
    "description_sale": "Perfect for professionals and power users.",
    "enable_sales": False,
    "enable_purchase": False,
    "is_favorite": False,
    "images": ["architecto"],
    "uom_id": 1,
    "uom_po_id": 1,
    "category_id": 1,
    "company_id": 1,
    "tags": [16],
    "property_account_income_id": 1,
    "property_account_expense_id": 2,
    "image": "architecto",
    "service_type": "architecto",
    "sale_line_warn": "architecto",
    "expense_policy": "architecto",
    "invoice_policy": "order",
    "sale_line_warn_msg": "architecto",
    "sales_ok": False,
    "purchase_ok": False
}
headers = {
    "Authorization": "Bearer <token>",
    "Content-Type": "application/json"
}

response = requests.put(url, json=payload, headers=headers)

print(response.text)

const options = {
  method: 'PUT',
  headers: {Authorization: 'Bearer <token>', 'Content-Type': 'application/json'},
  body: JSON.stringify({
    type: 'goods',
    name: 'Laptop Computer',
    service_tracking: 'b',
    reference: 'PROD-001',
    barcode: '1234567890',
    price: 999.99,
    cost: 750,
    volume: 0.5,
    weight: 2.5,
    description: 'High-performance laptop with latest specifications.',
    description_purchase: 'Enterprise laptop for business use.',
    description_sale: 'Perfect for professionals and power users.',
    enable_sales: false,
    enable_purchase: false,
    is_favorite: false,
    images: ['architecto'],
    uom_id: 1,
    uom_po_id: 1,
    category_id: 1,
    company_id: 1,
    tags: [16],
    property_account_income_id: 1,
    property_account_expense_id: 2,
    image: 'architecto',
    service_type: 'architecto',
    sale_line_warn: 'architecto',
    expense_policy: 'architecto',
    invoice_policy: 'order',
    sale_line_warn_msg: 'architecto',
    sales_ok: false,
    purchase_ok: false
  })
};

fetch('https://erp.arukz.com/admin/api/v1/accounts/products/{product_id}/variants/{id}', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

<?php

$curl = curl_init();

curl_setopt_array($curl, [
  CURLOPT_URL => "https://erp.arukz.com/admin/api/v1/accounts/products/{product_id}/variants/{id}",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "PUT",
  CURLOPT_POSTFIELDS => json_encode([
    'type' => 'goods',
    'name' => 'Laptop Computer',
    'service_tracking' => 'b',
    'reference' => 'PROD-001',
    'barcode' => '1234567890',
    'price' => 999.99,
    'cost' => 750,
    'volume' => 0.5,
    'weight' => 2.5,
    'description' => 'High-performance laptop with latest specifications.',
    'description_purchase' => 'Enterprise laptop for business use.',
    'description_sale' => 'Perfect for professionals and power users.',
    'enable_sales' => false,
    'enable_purchase' => false,
    'is_favorite' => false,
    'images' => [
        'architecto'
    ],
    'uom_id' => 1,
    'uom_po_id' => 1,
    'category_id' => 1,
    'company_id' => 1,
    'tags' => [
        16
    ],
    'property_account_income_id' => 1,
    'property_account_expense_id' => 2,
    'image' => 'architecto',
    'service_type' => 'architecto',
    'sale_line_warn' => 'architecto',
    'expense_policy' => 'architecto',
    'invoice_policy' => 'order',
    'sale_line_warn_msg' => 'architecto',
    'sales_ok' => false,
    'purchase_ok' => false
  ]),
  CURLOPT_HTTPHEADER => [
    "Authorization: Bearer <token>",
    "Content-Type: application/json"
  ],
]);

$response = curl_exec($curl);
$err = curl_error($curl);

curl_close($curl);

if ($err) {
  echo "cURL Error #:" . $err;
} else {
  echo $response;
}

{
  "data": {
    "id": 1,
    "type": "goods",
    "name": "Big Vision 4K Action Camera",
    "service_tracking": "none",
    "reference": "Action-01",
    "barcode": "BV4K-0001",
    "price": 150,
    "cost": 100,
    "volume": 0,
    "weight": 1.2,
    "description": "<p>A high-quality 4k action camera designed for everyday use.</p><p>The <strong>4K Action Camera</strong> is crafted with premium materials, ensuring durability and functionality. Perfect for those who value quality and innovation in their everyday essentials.</p>",
    "description_purchase": null,
    "description_sale": null,
    "enable_sales": false,
    "enable_purchase": false,
    "is_favorite": false,
    "is_configurable": true,
    "images": [
      "01JR9QKPXFKP1S054PZDM17MEP.png",
      "01JR9QKPXPX1TJKCH0DMZ29M12.png"
    ],
    "sort": null,
    "parent_id": null,
    "uom_id": 1,
    "uom_po_id": 1,
    "category_id": 11,
    "creator_id": 1,
    "company_id": 1,
    "created_at": "2025-04-08T03:37:55.000000Z",
    "updated_at": "2025-09-23T07:28:33.000000Z",
    "deleted_at": null,
    "property_account_income_id": null,
    "property_account_expense_id": null,
    "image": null,
    "service_type": null,
    "sale_line_warn": null,
    "expense_policy": null,
    "invoice_policy": null,
    "sale_line_warn_msg": null,
    "sales_ok": true,
    "purchase_ok": true
  },
  "message": "Product variant updated successfully."
}

{
  "message": "Unauthenticated."
}

{
  "message": "Resource not found."
}

{
  "message": "The given data was invalid.",
  "errors": {
    "name": [
      "The name field must be a string."
    ]
  }
}

Get started

Endpoints

Authorizations

Path Parameters

Body

Response