v1

latestOpenAPI 3.0.12026-07-2412502.6 MB
Items

Edit an item

 

patch/items/{item_id}

Request body

item_namestring

Internal name of the Item.

item_category_idinteger

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_descriptionstring

Description details set on the item.

item_additional_descriptionstring

Additional field for item description.

item_additional_details_1string

Additional field for item description.

item_additional_details_2string

Additional field for item description.

item_additional_details_3string

Additional field for item description.

item_additional_details_4string

Additional field for item description.

item_additional_details_5string

Additional field for item description.

item_ingredientsstring

List of ingredients in the Item.

item_imagestring

Base64 encoded.

item_videostring

Video Link associated with the Item.

item_sales_pagestring

Applicable only if using a Vrio Storefront, this associates the Item to the specific sales page.

item_tagstring

Descriptive label attached to a product, aiding in organization, search, and categorization for efficient inventory management. For multiples, separate by ,

item_tax_codestring

When using a TaxJar tax connection, Vrio will pass the tax code for the item to calculate taxes.

item_skustring

Stock Keeping Unit - unique identifier.

item_weightstring

Weight of item in ounces.

item_quantityinteger

Current stock available. This value will be auto deducted with new orders.

item_upcstring

Universal product code.

item_msrpstring

Manufacturers suggested retail price. Only editable if no offers is associated with that item yet.

item_coststring

The cost represents the item's expense and is utilized for measuring profitability and lifetime value metrics.

item_shippableboolean

If true, a shipment will be created after a successful order is placed with this Item.

out_of_stock_blockboolean

If true, if there is no quantity or current stock available, any sale will be denied until there is available stock.

item_perishableboolean

A flag to denote if the item is perishable. This can be used in customer communications.

item_turnaround_timeinteger

How many days does it take to replenish stock.

connection_idinteger

Fulfillment connection id this item is associated to.

item_activeboolean

If true, the item is Active.

item_notesstring

Notes left on the Item history section.

Response

OK

item_idinteger
item_namestring
item_category_idinteger nullable
item_descriptionstring nullable
item_imagestring nullable
item_activeboolean
item_pricestring nullable
item_msrpstring nullable
item_coststring nullable
item_shippableboolean
item_skustring nullable
item_weightstring nullable
item_upcstring nullable
item_slugstring nullable
item_quantityinteger
connection_idinteger nullable
out_of_stock_blockboolean
item_turnaround_timeinteger
item_additional_descriptionstring nullable
item_ingredientsstring nullable
item_videostring nullable
item_sales_pagestring nullable
item_perishableboolean
item_tax_codestring nullable
item_additional_details_1string nullable
item_additional_details_2string nullable
item_additional_details_3string nullable
item_additional_details_4string nullable
item_additional_details_5string nullable
date_createdstring date-time
created_byinteger
date_modifiedstring date-time
modified_byinteger
item_notesstring nullable

Example response

{
  "date_created": "2023-04-01 00:00:00",
  "date_modified": "2023-04-01 00:00:00"
}