pub struct ListCatalogParameters {
pub cursor: Option<String>,
pub types: Option<Vec<CatalogObjectType>>,
pub catalog_version: Option<i64>,
}
Expand description
This is a model struct for ListCatalogParameters (query parameters)
Fields§
§cursor: Option<String>
The pagination cursor returned in the previous response. Leave unset for an initial request. The page size is currently set to be 100. See Pagination for more information.
types: Option<Vec<CatalogObjectType>>
An optional case-insensitive, comma-separated list of object types to retrieve.
The valid values are defined in the CatalogObjectType enum, for example, ITEM
,
ITEM_VARIATION
, CATEGORY
, DISCOUNT
, TAX
, MODIFIER
, MODIFIER_LIST
, IMAGE
, etc.
If this is unspecified, the operation returns objects of all the top level types at the version of the Square API used to make the request. Object types that are nested onto other object types are not included in the defaults.
At the current API version the default object types are: ITEM, CATEGORY, TAX, DISCOUNT, MODIFIER_LIST, DINING_OPTION, TAX_EXEMPTION, SERVICE_CHARGE, PRICING_RULE, PRODUCT_SET, TIME_PERIOD, MEASUREMENT_UNIT, SUBSCRIPTION_PLAN, ITEM_OPTION, CUSTOM_ATTRIBUTE_DEFINITION, QUICK_AMOUNT_SETTINGS.
catalog_version: Option<i64>
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 [CatalogObject]s’ version
attribute. If not included, results will be from the current
version of the catalog.
Implementations§
Source§impl ListCatalogParameters
impl ListCatalogParameters
pub fn to_query_string(&self) -> String
Trait Implementations§
Source§impl Clone for ListCatalogParameters
impl Clone for ListCatalogParameters
Source§fn clone(&self) -> ListCatalogParameters
fn clone(&self) -> ListCatalogParameters
1.0.0 · Source§const fn clone_from(&mut self, source: &Self)
const fn clone_from(&mut self, source: &Self)
source
. Read more