1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
//! Request struct for the Batch Retrieve Catalog Objects API
use serde::Serialize;
/// This is a model class for BatchRetrieveCatalogObjectsRequest type.
#[derive(Clone, Debug, Default, Eq, PartialEq, Serialize)]
pub struct BatchRetrieveCatalogObjectsRequest {
/// The IDs of the CatalogObjects to be retrieved.
pub object_ids: Vec<String>,
/// 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`
pub include_related_objects: Option<bool>,
/// The specific version of the catalog objects to be included in the response. This allows you
/// to retrieve historical versions of objects. The specified version value is matched against
/// the CatalogObjects' version attribute. If not included, results will be from the current
/// version of the catalog.
pub catalog_version: Option<i64>,
/// Indicates whether to include (true) or not (false) in the response deleted objects, namely,
/// those with the is_deleted attribute set to true.
pub include_deleted_objects: Option<bool>,
/// Specifies whether or not to include the path_to_root list for each returned category instance.
/// The path_to_root list consists of CategoryPathToRootNode objects and specifies the path that
/// starts with the immediate parent category of the returned category and ends with its root
/// category. If the returned category is a top-level category, the path_to_root list is empty and
/// is not returned in the response payload.
pub include_category_path_to_root: Option<bool>,
}