Struct CatalogImage

pub struct CatalogImage {
    pub name: Option<String>,
    pub url: Option<String>,
    pub caption: Option<String>,
    pub photo_studio_order_id: Option<String>,
}

An image file to use in Square catalogs.

It can be associated with CatalogItem, CatalogItemVariation, CatalogCategory, and CatalogModifierList objects. Only the images on items and item variations are exposed in Dashboard. Only the first image on an item is displayed in Square Point of Sale (SPOS). Images on items and variations are displayed through Square Online Store. Images on other object types are for use by 3rd party application developers.

Fields

name: Option<String>

The internal name to identify this image in calls to the Square API. This is a searchable attribute for use in applicable query filters using the SearchCatalogObjects. It is not unique and should not be shown in a buyer facing context.

url: Option<String>

The URL of this image, generated by Square after an image is uploaded using the CreateCatalogImage endpoint. To modify the image, use the UpdateCatalogImage endpoint. Do not change the URL field.

caption: Option<String>

A caption that describes what is shown in the image. Displayed in the Square Online Store. This is a searchable attribute for use in applicable query filters using the SearchCatalogObjects.

photo_studio_order_id: Option<String>

The immutable order ID for this image object created by the Photo Studio service in Square Online Store.

Trait Implementations

impl Clone for CatalogImage

fn clone(&self) -> CatalogImage

Returns a duplicate of the value.

const fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source.

impl Debug for CatalogImage

fn fmt(&self, f: &mut Formatter<'_>) -> Result

Formats the value using the given formatter.

impl Default for CatalogImage

fn default() -> CatalogImage

Returns the “default value” for a type.

impl<'de> Deserialize<'de> for CatalogImage

fn deserialize<__D>(__deserializer: __D) -> Result<Self, __D::Error>

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl PartialEq for CatalogImage

fn eq(&self, other: &CatalogImage) -> bool

Tests for self and other values to be equal, and is used by ==.

fn ne(&self, other: &Rhs) -> bool

Tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.

impl Serialize for CatalogImage

fn serialize<__S>(&self, __serializer: __S) -> Result<__S::Ok, __S::Error>

where __S: Serializer,

Serialize this value into the given Serde serializer.

impl Eq for CatalogImage

impl StructuralPartialEq for CatalogImage