v1-item.md

V1 Item

V1Item

Structure

V1Item

Fields

Name	Type	Tags	Description
id	string	Optional	The item's ID. Must be unique among all entity IDs ever provided on behalf of the merchant. You can never reuse an ID. This value can include alphanumeric characters, dashes (-), and underscores (_).
name	string	Optional	The item's name.
description	string	Optional	The item's description.
type	str (V1 Item Type)	Optional	-
color	str (V1 Item Color)	Optional	-
abbreviation	string	Optional	The text of the item's display label in Square Point of Sale. Only up to the first five characters of the string are used.
visibility	str (V1 Item Visibility)	Optional	-
available_online	bool	Optional	If true, the item can be added to shipping orders from the merchant's online store.
master_image	V1 Item Image	Optional	V1ItemImage
category	V1 Category	Optional	V1Category
variations	List of V1 Variation	Optional	The item's variations. You must specify at least one variation.
modifier_lists	List of V1 Modifier List	Optional	The modifier lists that apply to the item, if any.
fees	List of V1 Fee	Optional	The fees that apply to the item, if any.
taxable	bool	Optional	Deprecated. This field is not used.
category_id	string	Optional	The ID of the item's category, if any.
available_for_pickup	bool	Optional	If true, the item can be added to pickup orders from the merchant's online store. Default value: false
v2_id	string	Optional	The ID of the CatalogObject in the Connect v2 API. Objects that are shared across multiple locations share the same v2 ID.

Example (as JSON)

{
  "id": null,
  "name": null,
  "description": null,
  "type": null,
  "color": null,
  "abbreviation": null,
  "visibility": null,
  "available_online": null,
  "master_image": null,
  "category": null,
  "variations": null,
  "modifier_lists": null,
  "fees": null,
  "taxable": null,
  "category_id": null,
  "available_for_pickup": null,
  "v2_id": null
}