square_api_client/models/
batch_retrieve_catalog_objects_request.rs

1//! Request struct for the Batch Retrieve Catalog Objects API
2
3use serde::Serialize;
4
5/// This is a model class for BatchRetrieveCatalogObjectsRequest type.
6#[derive(Clone, Debug, Default, Eq, PartialEq, Serialize)]
7pub struct BatchRetrieveCatalogObjectsRequest {
8    /// The IDs of the CatalogObjects to be retrieved.
9    pub object_ids: Vec<String>,
10    /// If `true`, the response will include additional objects that are related to the requested
11    /// objects. Related objects are defined as any objects referenced by ID by the results in the
12    /// `objects` field of the response. These objects are put in the `related_objects` field.
13    /// Setting this to `true` is helpful when the objects are needed for immediate display to a
14    /// user. This process only goes one level deep. Objects referenced by the related objects will
15    /// not be included. For example,
16    ///
17    /// if the `objects` field of the response contains a CatalogItem, its associated
18    /// CatalogCategory objects, CatalogTax objects, CatalogImage objects and CatalogModifierLists
19    /// will be returned in the `related_objects` field of the response. If the `objects` field of
20    /// the response contains a CatalogItemVariation, its parent CatalogItem will be returned in the
21    /// `related_objects` field of the response.
22    ///
23    /// Default value: `false`
24    pub include_related_objects: Option<bool>,
25}