pub struct BatchRetrieveCatalogObjectsRequest {
pub object_ids: Vec<String>,
pub include_related_objects: Option<bool>,
}
Expand description
This is a model class for BatchRetrieveCatalogObjectsRequest type.
Fields§
§object_ids: Vec<String>
The IDs of the CatalogObjects to be retrieved.
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§
Source§impl Clone for BatchRetrieveCatalogObjectsRequest
impl Clone for BatchRetrieveCatalogObjectsRequest
Source§fn clone(&self) -> BatchRetrieveCatalogObjectsRequest
fn clone(&self) -> BatchRetrieveCatalogObjectsRequest
1.0.0 · Source§const fn clone_from(&mut self, source: &Self)
const fn clone_from(&mut self, source: &Self)
source
. Read moreSource§impl Default for BatchRetrieveCatalogObjectsRequest
impl Default for BatchRetrieveCatalogObjectsRequest
Source§fn default() -> BatchRetrieveCatalogObjectsRequest
fn default() -> BatchRetrieveCatalogObjectsRequest
Source§impl PartialEq for BatchRetrieveCatalogObjectsRequest
impl PartialEq for BatchRetrieveCatalogObjectsRequest
Source§fn eq(&self, other: &BatchRetrieveCatalogObjectsRequest) -> bool
fn eq(&self, other: &BatchRetrieveCatalogObjectsRequest) -> bool
self
and other
values to be equal, and is used by ==
.impl Eq for BatchRetrieveCatalogObjectsRequest
impl StructuralPartialEq for BatchRetrieveCatalogObjectsRequest
Auto Trait Implementations§
impl Freeze for BatchRetrieveCatalogObjectsRequest
impl RefUnwindSafe for BatchRetrieveCatalogObjectsRequest
impl Send for BatchRetrieveCatalogObjectsRequest
impl Sync for BatchRetrieveCatalogObjectsRequest
impl Unpin for BatchRetrieveCatalogObjectsRequest
impl UnwindSafe for BatchRetrieveCatalogObjectsRequest
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.