V1Item

November 20, 2019 ยท View on GitHub

Description

V1Item Note: This model is deprecated.

Properties

NameTypeDescriptionNotes
idStringThe 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 (_).[optional]
nameStringThe item's name.[optional]
descriptionStringThe item's description.[optional]
typeStringThe item's type. This value is NORMAL for almost all items. See V1ItemType for possible values[optional]
colorStringThe color of the discount's display label in Square Point of Sale, if not the default color. The default color is 9da2a6. See V1ItemColor for possible values[optional]
abbreviationStringThe text of the item's display label in Square Point of Sale. Only up to the first five characters of the string are used.[optional]
visibilityStringIndicates whether the item is viewable from the merchant's online store (PUBLIC) or PRIVATE. See V1ItemVisibility for possible values[optional]
availableOnlineBooleanIf true, the item can be added to shipping orders from the merchant's online store.[optional]
masterImageV1ItemImageThe item's master image, if any.[optional]
categoryV1CategoryThe category the item belongs to, if any.[optional]
variationsList<V1Variation>The item's variations. You must specify at least one variation.[optional]
modifierListsList<V1ModifierList>The modifier lists that apply to the item, if any.[optional]
feesList<V1Fee>The fees that apply to the item, if any.[optional]
taxableBooleanDeprecated. This field is not used.[optional]
categoryIdStringThe ID of the item's category, if any.[optional]
availableForPickupBooleanIf true, the item can be added to pickup orders from the merchant's online store. Default value: false[optional]
v2IdStringThe ID of the CatalogObject in the Connect v2 API. Objects that are shared across multiple locations share the same v2 ID.[optional]