square_api_client/models/batch_retrieve_inventory_changes_request.rs
1//! Model struct for BatchRetrieveInventoryChangesRequest type
2
3use serde::{Deserialize, Serialize};
4
5use super::enums::{InventoryChangeType, InventoryState};
6
7/// This is a model struct for BatchRetrieveInventoryChangesRequest type.
8#[derive(Clone, Debug, Default, Deserialize, Eq, PartialEq, Serialize)]
9pub struct BatchRetrieveInventoryChangesRequest {
10 /// The filter to return results by CatalogObject ID. The filter is applicable only when set
11 pub catalog_object_ids: Option<Vec<String>>,
12 /// The filter to return results by Location ID. This filter is applicable only when set.
13 pub location_ids: Option<Vec<String>>,
14 /// The filter to return results with their calculated_at value after the given time.
15 pub updated_after: String,
16 /// The filter to return results with their created_at or calculated_at value
17 /// strictly before the given time
18 pub updated_before: String,
19 /// A pagination cursor returned by a previous call to this endpoint.
20 /// Provide this to retrieve the next set of results for the original query.
21 pub cursor: String,
22 /// The filter to return results by InventoryState.
23 /// The filter is only applicable when set. Ignored are untracked states of
24 /// NONE, SOLD, and UNLINKED_RETURN.
25 /// The default is null.
26 pub states: Vec<InventoryState>,
27 /// The filter to return results by InventoryChangeType values other than TRANSFER.
28 /// The default value is [PHYSICAL_COUNT, ADJUSTMENT].
29 pub types: Vec<InventoryChangeType>,
30}