---
title: "Update an item"
method: PATCH
path: "/commerce/{connection_id}/item/{id}"
tags: ["commerce", "item"]
---

# Update an item

`PATCH /commerce/{connection_id}/item/{id}`

## Request

- Base URL: `http://api.unified.to`
- URL: `http://api.unified.to/commerce/{connection_id}/item/{id}`
- Auth: API key in header `authorization`

## Path parameters

- `connection_id` string, required
- `id` string, required

## Query parameters

- `fields` string[]
- `raw` string

## Request body

- CommerceItem
  - `id` string
  - `created_at` string, date-time: (ISO-8601 / YYYY-MM-DDTHH:MM:SSZ format)
  - `updated_at` string, date-time: (ISO-8601 / YYYY-MM-DDTHH:MM:SSZ format)
  - `name` string
  - `public_name` string
  - `slug` string
  - `description` string
  - `global_code` string
  - `public_description` string
  - `is_active` boolean
  - `is_taxable` boolean
  - `vendor_name` string
  - `type` string: product, service, digital-download, ...
  - `is_visible` boolean
  - `is_featured` boolean
  - `weight` number
  - `weight_unit` 'g' | 'kg' | 'oz' | 'lb'
  - `requires_shipping` boolean
  - `prices` CommerceItemPrice[]
    - `price` number, required
    - `compare_at_price` number: The original price of the item before an adjustment or a sale.
    - `currency` string
  - `inventory_id` string
  - `total_stock` number
  - `tags` string[]
  - `media` CommerceItemMedia[]
    - `id` string
    - `url` string, required
    - `alt` string
    - `type` 'image' | 'video'
    - `height` number
    - `width` number
    - `position` number: 1 is the first
    - `metadata` CommerceMetadata[]
      - `id` string
      - `value` unknown
      - `namespace` string
      - `format` 'TEXT' | 'NUMBER' | 'DATE' | 'BOOLEAN' | 'FILE' | 'TEXTAREA' | 'SINGLE_SELECT' | 'MULTIPLE_SELECT' | 'MEASUREMENT' | 'PRICE' | 'YES_NO' | 'CURRENCY' | 'URL'
      - `extra_data` unknown
      - `slug` string
      - `description` string
      - `is_required` boolean
  - `account_id` string: Reference to Accounting Account (reference to AccountingAccount)
  - `metadata` CommerceMetadata[]
    - `id` string
    - `value` unknown
    - `namespace` string
    - `format` 'TEXT' | 'NUMBER' | 'DATE' | 'BOOLEAN' | 'FILE' | 'TEXTAREA' | 'SINGLE_SELECT' | 'MULTIPLE_SELECT' | 'MEASUREMENT' | 'PRICE' | 'YES_NO' | 'CURRENCY' | 'URL'
    - `extra_data` unknown
    - `slug` string
    - `description` string
    - `is_required` boolean
  - `collections` CommerceReference[]: points to Collection with id, name, and type fields
    - `id` string
    - `name` string
    - `type` string
  - `taxrate_id` string: references AccountingTaxrate
  - `location_id` string: (reference to CommerceLocation)
  - `duration` number: minutes
  - `raw` unknown

## Response `200`

Successful

- CommerceItem
  - `id` string
  - `created_at` string, date-time: (ISO-8601 / YYYY-MM-DDTHH:MM:SSZ format)
  - `updated_at` string, date-time: (ISO-8601 / YYYY-MM-DDTHH:MM:SSZ format)
  - `name` string
  - `public_name` string
  - `slug` string
  - `description` string
  - `global_code` string
  - `public_description` string
  - `is_active` boolean
  - `is_taxable` boolean
  - `vendor_name` string
  - `type` string: product, service, digital-download, ...
  - `is_visible` boolean
  - `is_featured` boolean
  - `weight` number
  - `weight_unit` 'g' | 'kg' | 'oz' | 'lb'
  - `requires_shipping` boolean
  - `prices` CommerceItemPrice[]
    - `price` number, required
    - `compare_at_price` number: The original price of the item before an adjustment or a sale.
    - `currency` string
  - `inventory_id` string
  - `total_stock` number
  - `tags` string[]
  - `media` CommerceItemMedia[]
    - `id` string
    - `url` string, required
    - `alt` string
    - `type` 'image' | 'video'
    - `height` number
    - `width` number
    - `position` number: 1 is the first
    - `metadata` CommerceMetadata[]
      - `id` string
      - `value` unknown
      - `namespace` string
      - `format` 'TEXT' | 'NUMBER' | 'DATE' | 'BOOLEAN' | 'FILE' | 'TEXTAREA' | 'SINGLE_SELECT' | 'MULTIPLE_SELECT' | 'MEASUREMENT' | 'PRICE' | 'YES_NO' | 'CURRENCY' | 'URL'
      - `extra_data` unknown
      - `slug` string
      - `description` string
      - `is_required` boolean
  - `account_id` string: Reference to Accounting Account (reference to AccountingAccount)
  - `metadata` CommerceMetadata[]
    - `id` string
    - `value` unknown
    - `namespace` string
    - `format` 'TEXT' | 'NUMBER' | 'DATE' | 'BOOLEAN' | 'FILE' | 'TEXTAREA' | 'SINGLE_SELECT' | 'MULTIPLE_SELECT' | 'MEASUREMENT' | 'PRICE' | 'YES_NO' | 'CURRENCY' | 'URL'
    - `extra_data` unknown
    - `slug` string
    - `description` string
    - `is_required` boolean
  - `collections` CommerceReference[]: points to Collection with id, name, and type fields
    - `id` string
    - `name` string
    - `type` string
  - `taxrate_id` string: references AccountingTaxrate
  - `location_id` string: (reference to CommerceLocation)
  - `duration` number: minutes
  - `raw` unknown

---

[API](https://skmtc.dev/unified/apis/unified-to-api-2.md) · [All operations](https://skmtc.dev/unified/apis/unified-to-api-2/llms.txt) · [OpenAPI document](https://skmtc.dev/unified/apis/unified-to-api-2/revisions/7a38bdd7f089?raw)