Struct square_api_client::models::BatchRetrieveCatalogObjectsRequest

pub struct BatchRetrieveCatalogObjectsRequest {
    pub object_ids: Vec<String>,
    pub include_related_objects: Option<bool>,
}

This is a model class for BatchRetrieveCatalogObjectsRequest type.

Fields

object_ids: Vec<String>

The IDs of the CatalogObjects to be retrieved.

include_related_objects: Option<bool>

If true, the response will include additional objects that are related to the requested objects. Related objects are defined as any objects referenced by ID by the results in the objects field of the response. These objects are put in the related_objects field. Setting this to true is helpful when the objects are needed for immediate display to a user. This process only goes one level deep. Objects referenced by the related objects will not be included. For example,

if the objects field of the response contains a CatalogItem, its associated CatalogCategory objects, CatalogTax objects, CatalogImage objects and CatalogModifierLists will be returned in the related_objects field of the response. If the objects field of the response contains a CatalogItemVariation, its parent CatalogItem will be returned in the related_objects field of the response.

Default value: false

Trait Implementations

impl Clone for BatchRetrieveCatalogObjectsRequest

fn clone(&self) -> BatchRetrieveCatalogObjectsRequest

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for BatchRetrieveCatalogObjectsRequest

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

Formats the value using the given formatter.

impl Default for BatchRetrieveCatalogObjectsRequest

fn default() -> BatchRetrieveCatalogObjectsRequest

Returns the “default value” for a type.

impl PartialEq<BatchRetrieveCatalogObjectsRequest> for BatchRetrieveCatalogObjectsRequest

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

This method tests for self and other values to be equal, and is used by ==.

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

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

impl Serialize for BatchRetrieveCatalogObjectsRequest

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 BatchRetrieveCatalogObjectsRequest

impl StructuralEq for BatchRetrieveCatalogObjectsRequest

impl StructuralPartialEq for BatchRetrieveCatalogObjectsRequest