pub struct RetrieveCatalogObjectParameters {
pub include_related_objects: Option<bool>,
pub catalog_version: Option<i64>,
}
Expand description
This is a model struct for RetrieveCatalogObjectParameters (query parameters)
Fields§
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
catalog_version: Option<i64>
Requests objects as of a specific version of the catalog. This allows you to retrieve historical versions of objects. The value to retrieve a specific version of an object can be found in the version field of [CatalogObject]s. If not included, results will be from the current version of the catalog.
Implementations§
Source§impl RetrieveCatalogObjectParameters
impl RetrieveCatalogObjectParameters
pub fn to_query_string(&self) -> String
Trait Implementations§
Source§impl Clone for RetrieveCatalogObjectParameters
impl Clone for RetrieveCatalogObjectParameters
Source§fn clone(&self) -> RetrieveCatalogObjectParameters
fn clone(&self) -> RetrieveCatalogObjectParameters
1.0.0 · Source§const fn clone_from(&mut self, source: &Self)
const fn clone_from(&mut self, source: &Self)
source
. Read more