V1Item

November 20, 2019 ยท View on GitHub

Description

V1Item Note: This model is deprecated.

Properties

NameGetterSetterTypeDescriptionNotes
idgetId()setId($value)stringThe 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]
namegetName()setName($value)stringThe item's name.[optional]
descriptiongetDescription()setDescription($value)stringThe item's description.[optional]
typegetType()setType($value)stringThe item's type. This value is NORMAL for almost all items. See V1ItemType for possible values[optional]
colorgetColor()setColor($value)stringThe 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]
abbreviationgetAbbreviation()setAbbreviation($value)stringThe 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]
visibilitygetVisibility()setVisibility($value)stringIndicates whether the item is viewable from the merchant's online store (PUBLIC) or PRIVATE. See V1ItemVisibility for possible values[optional]
available_onlinegetAvailableOnline()setAvailableOnline($value)boolIf true, the item can be added to shipping orders from the merchant's online store.[optional]
master_imagegetMasterImage()setMasterImage($value)\SquareConnect\Model\V1ItemImageThe item's master image, if any.[optional]
categorygetCategory()setCategory($value)\SquareConnect\Model\V1CategoryThe category the item belongs to, if any.[optional]
variationsgetVariations()setVariations($value)\SquareConnect\Model\V1Variation[]The item's variations. You must specify at least one variation.[optional]
modifier_listsgetModifierLists()setModifierLists($value)\SquareConnect\Model\V1ModifierList[]The modifier lists that apply to the item, if any.[optional]
feesgetFees()setFees($value)\SquareConnect\Model\V1Fee[]The fees that apply to the item, if any.[optional]
taxablegetTaxable()setTaxable($value)boolDeprecated. This field is not used.[optional]
category_idgetCategoryId()setCategoryId($value)stringThe ID of the item's category, if any.[optional]
available_for_pickupgetAvailableForPickup()setAvailableForPickup($value)boolIf true, the item can be added to pickup orders from the merchant's online store. Default value: false[optional]
v2_idgetV2Id()setV2Id($value)stringThe ID of the CatalogObject in the Connect v2 API. Objects that are shared across multiple locations share the same v2 ID.[optional]

Note: All properties are protected and only accessed via getters and setters.

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