V1Item

June 26, 2019 ยท View on GitHub

squareconnect.models.v1_item

Description

V1Item

Properties

NameTypeDescriptionNotes
idstrThe 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]
namestrThe item's name.[optional]
descriptionstrThe item's description.[optional]
typestrThe item's type. This value is NORMAL for almost all items. See V1ItemType for possible values[optional]
colorstrThe color of the discount's display label in Square Register, if not the default color. The default color is 9da2a6. See V1ItemColor for possible values[optional]
abbreviationstrThe text of the item's display label in Square Register. Only up to the first five characters of the string are used.[optional]
visibilitystrIndicates whether the item is viewable from the merchant's online store (PUBLIC) or PRIVATE. See V1ItemVisibility for possible values[optional]
available_onlineboolIf true, the item can be added to shipping orders from the merchant's online store.[optional]
master_imageV1ItemImageThe 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]
modifier_listslist[V1ModifierList]The modifier lists that apply to the item, if any.[optional]
feeslist[V1Fee]The fees that apply to the item, if any.[optional]
taxableboolDeprecated. This field is not used.[optional]
category_idstrThe ID of the item's category, if any.[optional]
available_for_pickupboolIf true, the item can be added to pickup orders from the merchant's online store. Default value: false[optional]
v2_idstrThe ID of the CatalogObject in the Connect v2 API. Objects that are shared across multiple locations share the same v2 ID.[optional]

[Back to Model list] [Back to API list] [Back to README]