---
title: "Edit an item"
method: PATCH
path: "/items/{item_id}"
tags: ["Items"]
---

# Edit an item

`PATCH /items/{item_id}`

## Request

- Base URL: `https://api.vrio.app`
- URL: `https://api.vrio.app/items/{item_id}`
- Auth: API key in header `X-Api-Key`

 

## Request body

- object
  - `item_name` string: Internal name of the Item.
  - `item_category_id` integer: They category, or group, this item has been assigned to. Categories are frequently utilized for collection pages and front-end navigation, as well as analytics.
  - `item_description` string: Description details set on the item.
  - `item_additional_description` string: Additional field for item description.
  - `item_additional_details_1` string: Additional field for item description.
  - `item_additional_details_2` string: Additional field for item description.
  - `item_additional_details_3` string: Additional field for item description.
  - `item_additional_details_4` string: Additional field for item description.
  - `item_additional_details_5` string: Additional field for item description.
  - `item_ingredients` string: List of ingredients in the Item.
  - `item_image` string: Base64 encoded.
  - `item_video` string: Video Link associated with the Item.
  - `item_sales_page` string: Applicable only if using a Vrio Storefront, this associates the Item to the specific sales page.
  - `item_tag` string: Descriptive label attached to a product, aiding in organization, search, and categorization for efficient inventory management. For multiples, separate by ,
  - `item_tax_code` string: When using a TaxJar tax connection, Vrio will pass the tax code for the item to calculate taxes.
  - `item_sku` string: Stock Keeping Unit - unique identifier.
  - `item_weight` string: Weight of item in ounces.
  - `item_quantity` integer: Current stock available. This value will be auto deducted with new orders.
  - `item_upc` string: Universal product code.
  - `item_msrp` string: Manufacturers suggested retail price. Only editable if no offers is associated with that item yet.
  - `item_cost` string: The cost represents the item's expense and is utilized for measuring profitability and lifetime value metrics.
  - `item_shippable` boolean: If true, a shipment will be created after a successful order is placed with this Item.
  - `out_of_stock_block` boolean: If true, if there is no quantity or current stock available, any sale will be denied until there is available stock.
  - `item_perishable` boolean: A flag to denote if the item is perishable. This can be used in customer communications.
  - `item_turnaround_time` integer: How many days does it take to replenish stock.
  - `connection_id` integer: Fulfillment connection id this item is associated to.
  - `item_active` boolean: If true, the item is Active.
  - `item_notes` string: Notes left on the Item history section.

## Response `200`

OK

- object
  - `item_id` integer
  - `item_name` string
  - `item_category_id` integer, nullable
  - `item_description` string, nullable
  - `item_image` string, nullable
  - `item_active` boolean
  - `item_price` string, nullable
  - `item_msrp` string, nullable
  - `item_cost` string, nullable
  - `item_shippable` boolean
  - `item_sku` string, nullable
  - `item_weight` string, nullable
  - `item_upc` string, nullable
  - `item_slug` string, nullable
  - `item_quantity` integer
  - `connection_id` integer, nullable
  - `out_of_stock_block` boolean
  - `item_turnaround_time` integer
  - `item_additional_description` string, nullable
  - `item_ingredients` string, nullable
  - `item_video` string, nullable
  - `item_sales_page` string, nullable
  - `item_perishable` boolean
  - `item_tax_code` string, nullable
  - `item_additional_details_1` string, nullable
  - `item_additional_details_2` string, nullable
  - `item_additional_details_3` string, nullable
  - `item_additional_details_4` string, nullable
  - `item_additional_details_5` string, nullable
  - `date_created` string, date-time
  - `created_by` integer
  - `date_modified` string, date-time
  - `modified_by` integer
  - `item_notes` string, nullable
  - `item_options` object[], nullable
    - `item_option_id` integer
    - `item_option_name` string
    - `item_option_values` object[]
      - `item_option_value_id` integer
      - `item_option_value_name` string
  - `item_option_variations` object[], nullable
    - `items_option_variation_id` integer
    - `items_option_variation_key` string
    - `items_option_variation_name` string
    - `items_option_variation_quantity` integer
    - `items_option_variation_sku` string, nullable
    - `items_option_variation_price` string
    - `items_option_variation_msrp` string
    - `items_option_variation_cost` string, nullable
    - `items_option_variation_weight` string, nullable
    - `items_option_variation_upc` string, nullable
    - `items_option_variation_image` string, nullable
    - `items_option_variation_images` object[]
      - `image_id` integer
      - `image_url` string
  - `item_images` object[], nullable
    - `image_id` integer
    - `image_url` string
  - `item_tags` object[], nullable
    - `tag_id` integer
    - `tag_name` string
    - `tag_slug` string
    - `tag_image` string, nullable
  - `item_swap_options` object[], nullable
    - `swap_item_id` integer
    - `swap_item_name` string
    - `swap_item_image` string, nullable
    - `swap_item_type_id` integer
    - `swap_item_description` string, nullable
    - `item_options` object[]
      - `item_option_id` integer
      - `item_option_name` string
      - `item_option_values` object[]
        - `item_option_value_id` integer
        - `item_option_value_name` string
    - `item_option_variations` object[]
      - `items_option_variation_id` integer
      - `items_option_variation_key` string
      - `items_option_variation_name` string
      - `items_option_variation_quantity` integer
      - `items_option_variation_sku` string, nullable
      - `items_option_variation_price` string
      - `items_option_variation_msrp` string
      - `items_option_variation_cost` string, nullable
      - `items_option_variation_weight` string, nullable
      - `items_option_variation_upc` string, nullable
      - `items_option_variation_image` string, nullable
      - `items_option_variation_images` object[]
        - `image_id` integer
        - `image_url` string
  - `connection` object, nullable
    - `connection_id` integer
    - `connection_name` string

## Other responses

- `400`: Error response
- `401`: Unauthorized response
- `403`: Forbidden response
- `500`: Error response

---

[API](https://skmtc.dev/vrio/apis/crm-products.md) - [All operations](https://skmtc.dev/vrio/apis/crm-products/llms.txt) - [OpenAPI document](https://skmtc.dev/vrio/apis/crm-products/revisions/0a531509f84d?raw)