Update a product (PATCH allowlist enforced)

Updates mutable top-level fields on a product: name, sku, description, list_price, cost, weight, dimensions, tax_rate_id, category_id, reorder_point, reorder_qty, metadata, and is_active. Child arrays (variants, pricing, components) are managed via their own sub-resource endpoints. Returns 404 if the product does not belong to the entity. Requires products:write scope.

PATCH /products/{id}

Update a product (PATCH allowlist enforced)

cURL

curl --request PATCH \
  --url https://api.arcuserp.com/v1/products/{id} \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "title": "Widget Pro XL (updated)",
  "list_price": 54.99,
  "packaging_classification": "sioc",
  "is_active": true
}
'

200

{
  "data": {
    "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
    "object": "product",
    "entity_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
    "title": "<string>",
    "description": "<string>",
    "sku": "<string>",
    "part_number": "<string>",
    "barcode": "<string>",
    "category_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
    "vendor_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
    "list_price": 123,
    "cost": 123,
    "is_active": true,
    "is_sellable": true,
    "is_serialized": true,
    "charge_tax": true,
    "track_inventory": true,
    "weight": 123,
    "weight_uom": "<string>",
    "length": 123,
    "width": 123,
    "height": 123,
    "length_uom": "<string>",
    "quantity_uom": "<string>",
    "product_tax_code": "<string>",
    "reorder_point": 123,
    "reorder_qty": 123,
    "safety_stock": 123,
    "packaging_classification": "over_box",
    "has_variants": true,
    "metadata": {},
    "created_at": "2023-11-07T05:31:56Z",
    "updated_at": "2023-11-07T05:31:56Z"
  }
}

Authorizations

Authorization · string · header · required

API key issued per entity via Settings > Developers > API Keys. Each key carries scopes (e.g. orders:read, products:write). Bearer token format: Authorization: Bearer ark_live_ent_Test keys use ark_test_ent_. Both are issued per entity
via Settings > Developers > API Keys.

Headers

Idempotency-Key · string

Client-generated unique key for idempotent POST/PATCH/DELETE operations. Alias for the Idempotency parameter. Max 255 chars. On retry with the same key, the original response is returned without re-executing the operation. Keys expire after 24 hours.

Maximum string length: 255

Path Parameters

id · string<uuid> · required

Body

application/json

Only allowlisted top-level fields are accepted. Sending id, entity_id, cost, searchable_text, has_variants, or any marketplace ID (shopify_product_id, amazon_asin, etc.) returns 400 field_not_writable. Cost is read-only here; use POST /v1/products/{id}/revalue to change it.

title · string

description · string | null

sku · string | null

part_number · string | null

barcode · string | null

list_price · number

category_id · string<uuid> | null

vendor_id · string<uuid> | null

is_active · boolean

is_serialized · boolean

charge_tax · boolean

track_inventory · boolean

weight · number | null

weight_uom · string

length · number | null

width · number | null

height · number | null

length_uom · string

quantity_uom · string

product_tax_code · string | null

packaging_classification · enum<string>

Amazon-FBA packaging classification. See Product schema for full enum semantics. Invalid values return 400 invalid_packaging_classification from the canonical validator with hint listing the four legal values.

Available options: over_box, sioc, sipp, prep_free

Example:

"sioc"

reorder_point · integer | null

reorder_qty · integer | null

safety_stock · integer

metadata · object

Response

200

application/json

Updated product

data · object

Arcus ERP product (physical/kit/box/service/variant_parent).

Show child attributes