pub struct CatalogItem {Show 16 fields
pub name: Option<String>,
pub description: Option<String>,
pub abbreviation: Option<String>,
pub label_color: Option<String>,
pub available_online: Option<bool>,
pub available_for_pickup: Option<bool>,
pub available_electronically: Option<bool>,
pub category_id: Option<String>,
pub tax_ids: Option<Vec<String>>,
pub modifier_list_info: Option<Vec<CatalogItemModifierListInfo>>,
pub variations: Option<Vec<CatalogObject>>,
pub product_type: Option<CatalogItemProductType>,
pub skip_modifier_screen: Option<bool>,
pub item_options: Option<Vec<CatalogItemOptionForItem>>,
pub image_ids: Option<Vec<String>>,
pub sort_name: Option<String>,
}
Expand description
A CatalogObject instance of the ITEM
type, also referred to as an item, in the catalog.
Fields§
§name: Option<String>
The item’s name. This is a searchable attribute for use in applicable query filters, its value must not be empty, and the length is of Unicode code points.
description: Option<String>
The item’s description. This is a searchable attribute for use in applicable query filters, and its value length is of Unicode code points.
abbreviation: Option<String>
The text of the item’s display label in the Square Point of Sale app. Only up to the first five characters of the string are used. This attribute is searchable, and its value length is of Unicode code points.
label_color: Option<String>
The color of the item’s display label in the Square Point of Sale app. This must be a valid hex color code.
available_online: Option<bool>
If true
, the item can be added to shipping orders from the merchant’s online store.
available_for_pickup: Option<bool>
If true
, the item can be added to pickup orders from the merchant’s online store.
available_electronically: Option<bool>
If true
, the item can be added to electronically fulfilled orders from the merchant’s
online store.
category_id: Option<String>
The ID of the item’s category, if any.
tax_ids: Option<Vec<String>>
A set of IDs indicating the taxes enabled for this item. When updating an item, any taxes
listed here will be added to the item. Taxes may also be added to or deleted from an item
using UpdateItemTaxes
.
modifier_list_info: Option<Vec<CatalogItemModifierListInfo>>
A set of CatalogItemModifierListInfo
objects representing the modifier lists that apply to
this item, along with the overrides and min and max limits that are specific to this item.
Modifier lists may also be added to or deleted from an item using UpdateItemModifierLists
.
variations: Option<Vec<CatalogObject>>
A list of [CatalogItemVariation] objects for this item. An item must have at least one variation.
product_type: Option<CatalogItemProductType>
The product type of the item. May not be changed once an item has been created.
Only items of product type REGULAR
or APPOINTMENTS_SERVICE
may be created by this API;
items with other product types are read-only.
skip_modifier_screen: Option<bool>
If false
, the Square Point of Sale app will present the CatalogItem
’s details screen
immediately, allowing the merchant to choose CatalogModifier
s before adding the item to
the cart. This is the default behavior.
If true
, the Square Point of Sale app will immediately add the item to the cart with the
pre-selected modifiers, and merchants can edit modifiers by drilling down onto the item’s
details.
Third-party clients are encouraged to implement similar behaviors.
item_options: Option<Vec<CatalogItemOptionForItem>>
List of item options IDs for this item. Used to manage and group item variations in a specified order.
Maximum: 6 item options.
image_ids: Option<Vec<String>>
The IDs of images associated with this CatalogItem
instance. These images will be shown to
customers in Square Online Store. The first image will show up as the icon for this item in
POS.
sort_name: Option<String>
A name to sort the item by. If this name is unspecified, namely, the sort_name
field is
absent, the regular name
field is used for sorting.
It is currently supported for sellers of the Japanese locale only.
Trait Implementations§
Source§impl Clone for CatalogItem
impl Clone for CatalogItem
Source§fn clone(&self) -> CatalogItem
fn clone(&self) -> CatalogItem
1.0.0 · Source§const fn clone_from(&mut self, source: &Self)
const fn clone_from(&mut self, source: &Self)
source
. Read moreSource§impl Debug for CatalogItem
impl Debug for CatalogItem
Source§impl Default for CatalogItem
impl Default for CatalogItem
Source§fn default() -> CatalogItem
fn default() -> CatalogItem
Source§impl<'de> Deserialize<'de> for CatalogItem
impl<'de> Deserialize<'de> for CatalogItem
Source§fn deserialize<__D>(__deserializer: __D) -> Result<Self, __D::Error>where
__D: Deserializer<'de>,
fn deserialize<__D>(__deserializer: __D) -> Result<Self, __D::Error>where
__D: Deserializer<'de>,
Source§impl PartialEq for CatalogItem
impl PartialEq for CatalogItem
Source§impl Serialize for CatalogItem
impl Serialize for CatalogItem
impl Eq for CatalogItem
impl StructuralPartialEq for CatalogItem
Auto Trait Implementations§
impl Freeze for CatalogItem
impl RefUnwindSafe for CatalogItem
impl Send for CatalogItem
impl Sync for CatalogItem
impl Unpin for CatalogItem
impl UnwindSafe for CatalogItem
Blanket Implementations§
Source§impl<T> BorrowMut<T> for Twhere
T: ?Sized,
impl<T> BorrowMut<T> for Twhere
T: ?Sized,
Source§fn borrow_mut(&mut self) -> &mut T
fn borrow_mut(&mut self) -> &mut T
Source§impl<T> CloneToUninit for Twhere
T: Clone,
impl<T> CloneToUninit for Twhere
T: Clone,
Source§impl<Q, K> Equivalent<K> for Q
impl<Q, K> Equivalent<K> for Q
Source§impl<Q, K> Equivalent<K> for Q
impl<Q, K> Equivalent<K> for Q
Source§fn equivalent(&self, key: &K) -> bool
fn equivalent(&self, key: &K) -> bool
key
and return true
if they are equal.