Skip to main content

hermes_ebay_sell_metadata/models/
property_values_request.rs

1/*
2 * Metadata API
3 *
4 * The Metadata API has operations that retrieve configuration details pertaining to the different eBay marketplaces. In addition to marketplace information, the API also has operations that get information that helps sellers list items on eBay.
5 *
6 * The version of the OpenAPI document: v1.11.1
7 * Contact: your-email@example.com
8 * Generated by: https://openapi-generator.tech
9 */
10
11use crate::models;
12use serde::{Deserialize, Serialize};
13
14/// PropertyValuesRequest : This type defines the request fields used in the <b>getCompatibilityPropertyValues</b> method.
15#[derive(Clone, Default, Debug, PartialEq, Serialize, Deserialize)]
16pub struct PropertyValuesRequest {
17    /// The unique identifier of the eBay leaf category for which to retrieve compatibility property values. This category must be a valid eBay category on the specified eBay marketplace, and the category must support parts compatibility.<br><br>Use the <a href=\"/api-docs/sell/metadata/resources/marketplace/methods/getAutomotivePartsCompatibilityPolicies\" target=\"_blank \">getAutomotivePartsCompatibilityPolicies</a> method to retrieve a list of categories that support parts compatibility.
18    #[serde(rename = "categoryId", skip_serializing_if = "Option::is_none")]
19    pub category_id: Option<String>,
20    /// This array can be used to specify the compatibility properties used limit the result set. Only values associated with the specified name-value pairs will be returned in the response.<br><br>For example, if the <b>propertyName</b> is set to <code>Make</code> and the <b>propertyValue</b> is set to <code>Honda</code>, only compatible Honda vehicles will be returned.
21    #[serde(rename = "propertyFilters", skip_serializing_if = "Option::is_none")]
22    pub property_filters: Option<Vec<models::PropertyFilterInner>>,
23    /// This field specifies the name of the property for which to retrieve associated property values.<br><br>For example, typical vehicle property names are 'Make', 'Model', 'Year', 'Engine', and 'Trim', but will vary based on the eBay marketplace and the eBay category. Use the <a href=\"/api-docs/sell/metadata/resources/compatibilities/methods/getCompatibilityPropertyNames\" target=\"_blank \">getCompatibilityPropertyNames</a> method to retrieve valid property names for a specified category.
24    #[serde(rename = "propertyName", skip_serializing_if = "Option::is_none")]
25    pub property_name: Option<String>,
26    /// This field specifies the sort order for the property values in the result set.<br><br><b>Valid values:</b><ul><li><code>Ascending</code></li><li>Descending</li></ul><span class=\"tablenote\"><b>Note:</b> If no search order is specified, values are sorted in ascending order.</span>
27    #[serde(rename = "sortOrder", skip_serializing_if = "Option::is_none")]
28    pub sort_order: Option<String>,
29}
30
31impl PropertyValuesRequest {
32    /// This type defines the request fields used in the <b>getCompatibilityPropertyValues</b> method.
33    pub fn new() -> PropertyValuesRequest {
34        PropertyValuesRequest {
35            category_id: None,
36            property_filters: None,
37            property_name: None,
38            sort_order: None,
39        }
40    }
41}
42