Skip to content
This repository has been archived by the owner on Apr 23, 2021. It is now read-only.

Latest commit

 

History

History
29 lines (24 loc) · 2.47 KB

V1Item.md

File metadata and controls

29 lines (24 loc) · 2.47 KB
Raw

SquareConnect.V1Item

Description

Note: This model is deprecated.

V1Item

Properties

Name Type Description Notes
id String 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 (_). [optional]
name String The item's name. [optional]
description String The item's description. [optional]
type String The item's type. This value is NORMAL for almost all items. See V1ItemType for possible values [optional]
color String The 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]
abbreviation String 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. [optional]
visibility String Indicates whether the item is viewable from the merchant's online store (PUBLIC) or PRIVATE. See V1ItemVisibility for possible values [optional]
available_online Boolean If true, the item can be added to shipping orders from the merchant's online store. [optional]
master_image V1ItemImage The item's master image, if any. [optional]
category V1Category The category the item belongs to, if any. [optional]
variations [V1Variation] The item's variations. You must specify at least one variation. [optional]
modifier_lists [V1ModifierList] The modifier lists that apply to the item, if any. [optional]
fees [V1Fee] The fees that apply to the item, if any. [optional]
taxable Boolean Deprecated. This field is not used. [optional]
category_id String The ID of the item's category, if any. [optional]
available_for_pickup Boolean If true, the item can be added to pickup orders from the merchant's online store. Default value: false [optional]
v2_id String The ID of the CatalogObject in the Connect v2 API. Objects that are shared across multiple locations share the same v2 ID. [optional]