{ "swagger": "2.0", "info": { "title": "AutoSync API", "contact": {}, "version": "1.0" }, "paths": { "/keys/config": { "get": { "tags": [ "Auth" ], "summary": "Get API key configuration", "parameters": [ { "type": "string", "description": "API key", "name": "key", "in": "query", "required": true } ], "responses": { "200": { "description": "OK" } } } }, "/keys/validate": { "get": { "tags": [ "Auth" ], "summary": "Check key validity", "parameters": [ { "type": "string", "description": "API key", "name": "key", "in": "query", "required": true } ], "responses": { "200": { "description": "OK" } } } }, "/status": { "get": { "tags": [ "Status" ], "summary": "Check if the service is available", "parameters": [ { "type": "string", "description": "API key", "name": "key", "in": "query", "required": true } ], "responses": { "200": { "description": "OK" } } } }, "/tires": { "get": { "tags": [ "Tires" ], "summary": "List tires", "parameters": [ { "type": "string", "description": "API key", "name": "key", "in": "query", "required": true }, { "maxLength": 150, "type": "string", "description": "Filter by segment tags excluding specified tags. Comma (`,`) acts as an AND operator, e.g. `All Terrain,All Weather` for tires classified as not All Terrain and not All Weather.", "name": "f-andNotSegmentTags", "in": "query" }, { "maxLength": 50, "type": "string", "description": "Filter by vehicle type tags excluding specified tags. Comma (`,`) acts as an AND operator, e.g. `Car,SUV/Light Truck` for tires designed as not for cars and not for SUVs.", "name": "f-andNotVehicleTypeTags", "in": "query" }, { "maxLength": 150, "type": "string", "description": "Filter by segment tags. Comma (`,`) acts as an AND operator, e.g. `All Terrain,All Weather` for tires classified as both All Terrain and All Weather.", "name": "f-andSegmentTags", "in": "query" }, { "maxLength": 50, "type": "string", "description": "Filter by vehicle type tags. Comma (`,`) acts as an AND operator, e.g. `Car,SUV/Light Truck` for tires designed for both cars and SUVs.", "name": "f-andVehicleTypeTags", "in": "query" }, { "minimum": 0, "type": "number", "description": "Filter by aspect ratio, e.g. `45`. Applies to metric tires only.", "name": "f-aspectRatio", "in": "query" }, { "maxLength": 50, "type": "string", "description": "Filter by brand name, e.g. `Michelin`.", "name": "f-brand", "in": "query" }, { "type": "string", "description": "Filter by comma-separated brand IDs, e.g. `265,267`.", "name": "f-brandIds", "in": "query" }, { "maximum": 200, "minimum": 0, "type": "number", "description": "Filter by external diameter, e.g. `33` [inch]. Applies to both metric and floatation tires. Use `f-format` to specify tire type.", "name": "f-diameter", "in": "query" }, { "maximum": 200, "minimum": 0, "type": "number", "description": "Filter by external diameter with a positive margin of variance, e.g. `33` [inch] for values between approximately 33\" and 34\". Applies to both metric and floatation tires. Use `f-format` to specify tire type.", "name": "f-diameterWithMargin", "in": "query" }, { "enum": [ "", "M", "F", "O", "U" ], "type": "string", "description": "Filter by size format (`M` - metric, `F` - flotation, `O` - other non-standard size, or `U` - unknown).", "name": "f-format", "in": "query" }, { "type": "boolean", "description": "List only tires with wheel coordinates for overlaying wheels on tires.", "name": "f-hasCoordinates", "in": "query" }, { "type": "boolean", "description": "List only tires with external product IDs. Requires external product IDs to be activated and configured in the portal.", "name": "f-hasExternalProductId", "in": "query" }, { "type": "boolean", "description": "List only tires with available view-on-vehicle images of angle 0100.", "name": "f-hasImg0100", "in": "query" }, { "type": "boolean", "description": "List only tires with available view-on-vehicle images of angle 0301.", "name": "f-hasImg0301", "in": "query" }, { "type": "boolean", "description": "List only tires with rotation images.", "name": "f-hasImgRotation", "in": "query" }, { "type": "boolean", "description": "List only tires with prices. Requires pricing to be activated in the portal.", "name": "f-hasPrice", "in": "query" }, { "type": "boolean", "description": "List only tires with rebates.", "name": "f-hasRebates", "in": "query" }, { "type": "boolean", "description": "List only tires with available view-on-vehicle images of angle 0100 or 0301.", "name": "f-hasVovImg", "in": "query" }, { "minimum": 0, "type": "integer", "description": "Filter by tire ID.", "name": "f-id", "in": "query" }, { "type": "string", "description": "Filter by comma-separated tire IDs, e.g. `1932823,1931763`.", "name": "f-ids", "in": "query" }, { "type": "string", "description": "List only tires with images updated after a given date, e.g. `2025-01-01`.", "name": "f-imgUpdatedAfter", "in": "query" }, { "type": "boolean", "description": "List only tires that are in stock. Requires inventory to be activated in the portal.", "name": "f-inStock", "in": "query" }, { "maximum": 1000, "minimum": 0, "type": "number", "description": "Filter by width, e.g. `12.5` [inch]. Applies to both metric and floatation tires. Use `f-format` to specify tire type.", "name": "f-inchWidth", "in": "query" }, { "maximum": 1000, "minimum": 0, "type": "number", "description": "Filter by width with a margin of variance, e.g. `12` [inch] for values between approximately 11.5\" and 12.5\". Applies to both metric and floatation tires. Use `f-format` to specify tire type.", "name": "f-inchWidthWithMargin", "in": "query" }, { "maximum": 200, "minimum": 0, "type": "number", "description": "Filter by maximum external diameter, e.g. `35` [inch]. Applies to both metric and floatation tires. Use `f-format` to specify tire type.", "name": "f-maxDiameter", "in": "query" }, { "maximum": 100000, "minimum": 0, "type": "number", "description": "Filter by maximum price [$].", "name": "f-maxPrice", "in": "query" }, { "maximum": 200, "minimum": 0, "type": "number", "description": "Filter by minimum external diameter, e.g. `30` [inch]. Applies to both metric and floatation tires. Use `f-format` to specify tire type.", "name": "f-minDiameter", "in": "query" }, { "minimum": 0, "type": "integer", "description": "Filter by minimum inventory level, e.g. `4`. Setting the parameter to `1` is the same as using `f-inStock` parameter. Requires inventory to be activated in the portal.", "name": "f-minInventory", "in": "query" }, { "maximum": 2000, "minimum": 0, "type": "integer", "description": "Filter by minimum load rating, e.g. `100`.", "name": "f-minLoadRating", "in": "query" }, { "maximum": 100000, "minimum": 0, "type": "number", "description": "Filter by minimum price [$].", "name": "f-minPrice", "in": "query" }, { "minimum": 0, "type": "number", "description": "Filter by minimum rim diameter, e.g. `18` [inch]. Applies to both metric and floatation tires. Use `f-format` to specify tire type.", "name": "f-minRimDiameter", "in": "query" }, { "enum": [ "", "D", "E", "F", "G", "H", "J", "K", "L", "M", "N", "P", "Q", "R", "S", "T", "U", "V", "W", "Y", "(Y)", "Z" ], "type": "string", "description": "Filter by minimum speed rating. E.g. `H` speed rating will return tires with one of the following speed ratings: H, V, Z, W, Y, (Y) (H or higher).", "name": "f-minSpeedRating", "in": "query" }, { "maxLength": 20, "type": "string", "description": "Filter by the lowest of comma-separated minimum speed ratings. E.g. `H,V,W,U` will result in filtering by `U` speed rating (the lowest of the four) and will return tires with one of the following speed ratings: U, H, V, Z, W, Y, (Y) (H or higher).", "name": "f-minSpeedRatings", "in": "query" }, { "maxLength": 50, "type": "string", "description": "Filter by model name, e.g. `Crossclimate 2`.", "name": "f-model", "in": "query" }, { "minimum": 0, "type": "integer", "description": "Filter by model ID.", "name": "f-modelId", "in": "query" }, { "type": "string", "description": "Filter by model ID.", "name": "f-modelIds", "in": "query" }, { "enum": [ "", "M", "F", "O", "U" ], "type": "string", "description": "Exclude size format (`M` - metric, `F` - flotation, `O` - other non-standard size, or `U` - unknown).", "name": "f-notFormat", "in": "query" }, { "maxLength": 150, "type": "string", "description": "Filter by segment tags. Comma (`,`) acts as an OR operator, e.g. `All Terrain,All Weather` for tires classified as either All Terrain or All Weather.", "name": "f-orSegmentTags", "in": "query" }, { "maxLength": 50, "type": "string", "description": "Filter by vehicle type tags. Comma (`,`) acts as an OR operator, e.g. `Car,Trailer` for tires designed for either for cars or trailers.", "name": "f-orVehicleTypeTags", "in": "query" }, { "maxLength": 50, "type": "string", "description": "Filter by part number. Reserved characters must be URL-encoded, e.g. `+` → `%2B`. **Specifying a part number is not sufficient to uniquely identify a tire.** A part number must be combined with a brand for distinct results. For example, `f-pn=99883\u0026f-brand=Michelin`.", "name": "f-pn", "in": "query" }, { "maxLength": 50, "type": "string", "description": "Filter by a full-text search, e.g. `Michelin 225/50R17`. Searched fields include brand, model, model description, part number and display name.", "name": "f-query", "in": "query" }, { "minimum": 0, "type": "number", "description": "Filter by rim diameter, e.g. `22` [inch]. Applies to both metric and floatation tires. Use `f-format` to specify tire type.", "name": "f-rimDiameter", "in": "query" }, { "maximum": 200, "minimum": 0, "type": "integer", "description": "Filter by external diameter rounded to a whole number, e.g. `33` [inch]. Applies to both metric and floatation tires. Use `f-format` to specify tire type.", "name": "f-roundedDiameter", "in": "query" }, { "maximum": 10000, "minimum": 0, "type": "number", "description": "Filter by section width, e.g. `235` [mm]. Applies to metric tires only.", "name": "f-sectionWidth", "in": "query" }, { "maxLength": 5000, "type": "string", "description": "Filter by comma-separated sizes, e.g. `215/65R17,225/65R17` for metric tires and `31X10.50R15,33X10.50R15` for floatation tires.", "name": "f-sizes", "in": "query" }, { "maxLength": 5000, "type": "string", "description": "Filter by comma-separated sizes and compatible sizes with a margin of variance. E.g. `215/65R15,225/60R16` list tires of the following sizes: 215/65R15, 215/60R16, 215/65R16, 225/60R16, and 26x8.5R15.", "name": "f-sizesWithMargin", "in": "query" }, { "enum": [ "", "active", "discontinued" ], "type": "string", "description": "Filter by status (`active` or `discontinued`). A key receives only the statuses it is configured for; asking for `discontinued` on a key configured for active tires only returns nothing.", "name": "f-status", "in": "query" }, { "type": "string", "description": "List only tires updated after a given date, e.g. `2025-01-01`.", "name": "f-updatedAfter", "in": "query" }, { "enum": [ "", "studless", "studdable", "studded" ], "type": "string", "description": "Filter by winter classification (`studless`, `studdable`, or `studded`)", "name": "f-winterClass", "in": "query" }, { "type": "boolean", "description": "Include wheel coordinates for overlaying wheels on tires.", "name": "i-coordinates", "in": "query" }, { "type": "boolean", "description": "Include DriveRight Data tire ID.", "name": "i-drId", "in": "query" }, { "type": "boolean", "description": "Include external product IDs. Requires external product IDs to be activated and configured in the portal.", "name": "i-externalProductId", "in": "query" }, { "type": "boolean", "description": "Include paths to non-view-on-vehicle images.", "name": "i-img", "in": "query" }, { "type": "boolean", "description": "Include the ID of the tire represented in the image.", "name": "i-imgDetails", "in": "query" }, { "type": "boolean", "description": "Include the date of the latest image addition or update.", "name": "i-imgUpdatedAt", "in": "query" }, { "type": "boolean", "description": "Include stock availability. Requires inventory to be activated in the portal.", "name": "i-inStock", "in": "query" }, { "type": "boolean", "description": "Include inventory level. Requires inventory to be activated in the portal.", "name": "i-inventory", "in": "query" }, { "type": "boolean", "description": "Include price. Requires pricing to be activated in the portal.", "name": "i-price", "in": "query" }, { "type": "boolean", "description": "Include rebate information.", "name": "i-rebates", "in": "query" }, { "type": "boolean", "description": "Include specifications.", "name": "i-specs", "in": "query" }, { "type": "boolean", "description": "Include the status (`active` or `discontinued`). Discontinued tires are listed only for keys configured to receive them; for every other key the value is always `active`.", "name": "i-status", "in": "query" }, { "type": "boolean", "description": "Include segment and vehicle type tags.", "name": "i-tags", "in": "query" }, { "type": "boolean", "description": "Include Unique ID, which is a combination of brand ID and tire SKU. Tire SKUs are not always unique.", "name": "i-uid", "in": "query" }, { "type": "boolean", "description": "Include the date of the last changes.", "name": "i-updatedAt", "in": "query" }, { "type": "boolean", "description": "Include URLs of view-on-vehicle images.", "name": "i-vovImg", "in": "query" }, { "enum": [ "", "asc", "desc" ], "type": "string", "description": "Sort by brand (`asc` or `desc`). A brand priority list configured in the portal takes precedence.", "name": "s-brand", "in": "query" }, { "enum": [ "", "asc", "desc" ], "type": "string", "description": "Sort by VoV image availability (`asc` - tires without VoV images first, `desc` - tires with VoV images first). A brand priority list configured in the portal takes precedence.", "name": "s-hasVovImg", "in": "query" }, { "enum": [ "", "asc", "desc" ], "type": "string", "description": "Sort by inventory level (`asc` - lowest stock first, `desc` - highest stock first). Tires without inventory are always listed last, regardless of the direction. A brand priority list configured in the portal takes precedence. Requires inventory to be activated in the portal.", "name": "s-inventory", "in": "query" }, { "enum": [ "", "asc", "desc" ], "type": "string", "description": "Sort by model (`asc` or `desc`). A brand priority list configured in the portal takes precedence.", "name": "s-model", "in": "query" }, { "enum": [ "", "asc", "desc" ], "type": "string", "description": "Sort by price (`asc` - cheapest first, `desc` - most expensive first). Tires without a price are always listed last, regardless of the direction. A brand priority list configured in the portal takes precedence. Requires pricing to be activated in the portal.", "name": "s-price", "in": "query" } ], "responses": { "200": { "description": "OK" } } } }, "/tires/brands": { "get": { "tags": [ "Tires" ], "summary": "List tire brands", "parameters": [ { "type": "string", "description": "API key", "name": "key", "in": "query", "required": true }, { "enum": [ "", "M", "F", "O", "U" ], "type": "string", "description": "Filter by size format (`M` - metric, `F` - flotation, `O` - other non-standard size, or `U` - unknown).", "name": "f-format", "in": "query" }, { "type": "boolean", "description": "List only tire brands with tires that have external product IDs.", "name": "f-hasExternalProductId", "in": "query" }, { "type": "boolean", "description": "List only tire brands with tires that have available view-on-vehicle images of angle 0100.", "name": "f-hasImg0100", "in": "query" }, { "type": "boolean", "description": "List only tire brands with tires that have available view-on-vehicle images of angle 0301.", "name": "f-hasImg0301", "in": "query" }, { "type": "boolean", "description": "List only tire brands with tires that have prices. Requires pricing to be activated in the portal.", "name": "f-hasPrice", "in": "query" }, { "type": "boolean", "description": "List only tire brands with tires that have available view-on-vehicle images of angle 0100 or 0301.", "name": "f-hasVovImg", "in": "query" }, { "minimum": 0, "type": "integer", "description": "Filter by brand ID.", "name": "f-id", "in": "query" }, { "type": "boolean", "description": "List only tire brands with tires in stock. Requires inventory to be activated in the portal.", "name": "f-inStock", "in": "query" }, { "enum": [ "", "M", "F", "O", "U" ], "type": "string", "description": "Exclude size format (`M` - metric, `F` - flotation, `O` - other non-standard size, or `U` - unknown).", "name": "f-notFormat", "in": "query" }, { "enum": [ "", "studless", "studdable", "studded" ], "type": "string", "description": "Filter by winter classification (`studless`, `studdable`, or `studded`)", "name": "f-winterClass", "in": "query" }, { "type": "boolean", "description": "Include AutoCare's brand ID.", "name": "i-aaiaBrandCode", "in": "query" }, { "type": "boolean", "description": "Include brand’s about information.", "name": "i-about", "in": "query" }, { "type": "boolean", "description": "Include the paths to banner images.", "name": "i-imgBanner", "in": "query" }, { "type": "boolean", "description": "Include the paths to banner logo images.", "name": "i-imgBannerLogo", "in": "query" }, { "type": "boolean", "description": "Include the paths to brand logos.", "name": "i-logos", "in": "query" }, { "type": "boolean", "description": "Include brand’s manufacturer.", "name": "i-manufacturer", "in": "query" }, { "type": "boolean", "description": "Include the total number of tires for each brand.", "name": "i-tireCount", "in": "query" }, { "type": "boolean", "description": "Include the total number of tire models for each brand.", "name": "i-tireModelCount", "in": "query" } ], "responses": { "200": { "description": "OK" } } } }, "/tires/default_images": { "get": { "tags": [ "Tires" ], "summary": "List default tires for lifted vehicles", "parameters": [ { "type": "string", "description": "API key", "name": "key", "in": "query", "required": true } ], "responses": { "200": { "description": "OK" } } } }, "/tires/filters": { "get": { "tags": [ "Tires" ], "summary": "List tire filters", "parameters": [ { "type": "string", "description": "API key", "name": "key", "in": "query", "required": true }, { "maxLength": 150, "type": "string", "description": "Filter by segment tags excluding specified tags. Comma (`,`) acts as an AND operator, e.g. `All Terrain,All Weather` for tires classified as not All Terrain and not All Weather.", "name": "f-andNotSegmentTags", "in": "query" }, { "maxLength": 50, "type": "string", "description": "Filter by vehicle type tags excluding specified tags. Comma (`,`) acts as an AND operator, e.g. `Car,SUV/Light Truck` for tires classified as not for cars and not for SUVs.", "name": "f-andNotVehicleTypeTags", "in": "query" }, { "maxLength": 150, "type": "string", "description": "Filter by segment tags. Comma (`,`) acts as an AND operator, e.g. `All Terrain,All Weather` for tires classified as both All Terrain and All Weather.", "name": "f-andSegmentTags", "in": "query" }, { "maxLength": 50, "type": "string", "description": "Filter by vehicle type tags. Comma (`,`) acts as an AND operator, e.g. `Car,SUV/Light Truck` for tires designed for both cars and SUVs.", "name": "f-andVehicleTypeTags", "in": "query" }, { "minimum": 0, "type": "number", "description": "Filter by aspect ratio, e.g. `55`. Applies to metric tires only.", "name": "f-aspectRatio", "in": "query" }, { "minimum": 0, "type": "number", "description": "Filter by secondary tire aspect ratio, e.g. `65`. Specifying `f-aspectRatio` and `f-aspectRatio2` will list only filter values applicable to tires of both aspect ratios. Intended for vehicles with staggered fitment. Applies to metric tires only.", "name": "f-aspectRatio2", "in": "query" }, { "maxLength": 50, "type": "string", "description": "Filter by brand name, e.g. `Bridgestone`.", "name": "f-brand", "in": "query" }, { "type": "string", "description": "Filter by comma-separated brand IDs `265,267`.", "name": "f-brandIds", "in": "query" }, { "minimum": 0, "type": "number", "description": "Filter by external diameter, e.g. `33` [inch]. Applies to both metric and floatation tires. Use `f-format` to specify tire type.", "name": "f-diameter", "in": "query" }, { "minimum": 0, "type": "number", "description": "Filter by secondary tire external diameter, e.g. `35` [inch]. Specifying `f-diameter` and `f-diameter2` will list only filter values applicable to tires of both diameters. Intended for vehicles with staggered fitment. Applies to both metric and floatation tires. Use `f-format` to specify tire type.", "name": "f-diameter2", "in": "query" }, { "maximum": 200, "minimum": 0, "type": "number", "description": "Filter by external diameter with a positive margin of variance, e.g. `33` [inch] for values between approximately 33\" and 34\". Applies to both metric and floatation tires. Use `f-format` to specify tire type.", "name": "f-diameterWithMargin", "in": "query" }, { "maximum": 200, "minimum": 0, "type": "number", "description": "Filter by secondary external diameter with a positive margin of variance, e.g. `33` [inch] for values between approximately 33\" and 34\". Specifying `f-diameterWithMargin` and `f-diameterWithMargin2` will list only filter values applicable to tires of both diameters with a margin of variance. Intended for vehicles with staggered fitment. Applies to both metric and floatation tires. Use `f-format` to specify tire type.", "name": "f-diameterWithMargin2", "in": "query" }, { "enum": [ "", "M", "F", "O", "U" ], "type": "string", "description": "Filter by size format (`M` - metric, `F` - flotation, `O` - other non-standard size, or `U` - unknown).", "name": "f-format", "in": "query" }, { "type": "boolean", "description": "Enforce size 2 inch widths to be greater than size 1. This may be used to list larger tires for rear axles. Intended for vehicles with staggered fitment.", "name": "f-gtInchWidth2", "in": "query" }, { "type": "boolean", "description": "Enforce size 2 rim diameters to be greater than size 1. This may be used to list larger tires for rear axles. Intended for vehicles with staggered fitment.", "name": "f-gtRimDiameter2", "in": "query" }, { "type": "boolean", "description": "Enforce size 2 inch widths to be greater than size 1 or equal. This may be used to list larger tires for rear axles. Intended for vehicles with staggered fitment.", "name": "f-gteInchWidth2", "in": "query" }, { "type": "boolean", "description": "Enforce size 2 rim diameters to be greater than size 1 or equal. This may be used to list larger tires for rear axles. Intended for vehicles with staggered fitment.", "name": "f-gteRimDiameter2", "in": "query" }, { "type": "boolean", "description": "List only values of tires with external product IDs.", "name": "f-hasExternalProductId", "in": "query" }, { "type": "boolean", "description": "List only values of tires with available view-on-vehicle images of angle 0100.", "name": "f-hasImg0100", "in": "query" }, { "type": "boolean", "description": "List only values of tires with available view-on-vehicle images of angle 0301.", "name": "f-hasImg0301", "in": "query" }, { "type": "boolean", "description": "List only values of tires with prices. Requires pricing to be activated in the portal.", "name": "f-hasPrice", "in": "query" }, { "type": "boolean", "description": "List only values of tires with rebates.", "name": "f-hasRebates", "in": "query" }, { "type": "boolean", "description": "List only values of tires with available view-on-vehicle images of angle 0100 or 0301.", "name": "f-hasVovImg", "in": "query" }, { "type": "boolean", "description": "List only values of tires that are in stock. Requires inventory to be activated in the portal.", "name": "f-inStock", "in": "query" }, { "minimum": 0, "type": "number", "description": "Filter by width, e.g. `10.5` [inch]. Applies to floatation tires only.", "name": "f-inchWidth", "in": "query" }, { "minimum": 0, "type": "number", "description": "Filter by secondary width, e.g. `11.5` [inch]. Specifying `f-inchWidth` and `f-inchWidth2` will list only filter values applicable to tires of both inch widths. Intended for vehicles with staggered fitment. Applies to floatation tires only.", "name": "f-inchWidth2", "in": "query" }, { "maximum": 1000, "minimum": 0, "type": "number", "description": "Filter by width with a positive margin of variance, e.g. `10` [inch] for values between approximately 10\" and 10.5\". Applies to both metric and floatation tires. Use `f-format` to specify tire type.", "name": "f-inchWidthWithMargin", "in": "query" }, { "maximum": 1000, "minimum": 0, "type": "number", "description": "Filter by secondary width with a positive margin of variance, e.g. `11` [inch] for values between approximately 11\" and 11.5\". Specifying `f-inchWidthWithMargin` and `f-inchWidthWithMargin2` will list only filter values applicable to tires of both inch widths with a margin of variance. Intended for vehicles with staggered fitment. Applies to both metric and floatation tires. Use `f-format` to specify tire type.", "name": "f-inchWidthWithMargin2", "in": "query" }, { "minimum": 0, "type": "number", "description": "Filter by maximum external diameter, e.g. `35` [inch]. Applies to both metric and floatation tires. Use `f-format` to specify tire type.", "name": "f-maxDiameter", "in": "query" }, { "minimum": 0, "type": "number", "description": "Filter by secondary tire maximum external diameter, e.g. `35` [inch]. Specifying `f-maxDiameter` and `f-maxDiameter2` will list only filter values applicable to tires of both diameters. Intended for vehicles with staggered fitment. Applies to both metric and floatation tires. Use `f-format` to specify tire type.", "name": "f-maxDiameter2", "in": "query" }, { "maximum": 100000, "minimum": 0, "type": "number", "description": "Filter by maximum price [$].", "name": "f-maxPrice", "in": "query" }, { "minimum": 0, "type": "number", "description": "Filter by minimum external diameter, e.g. `30` [inch]. Applies to both metric and floatation tires. Use `f-format` to specify tire type.", "name": "f-minDiameter", "in": "query" }, { "minimum": 0, "type": "number", "description": "Filter by secondary tire minimum external diameter, e.g. `30` [inch]. Specifying `f-minDiameter` and `f-minDiameter2` will list only filter values applicable to tires of both diameters. Intended for vehicles with staggered fitment. Applies to both metric and floatation tires. Use `f-format` to specify tire type.", "name": "f-minDiameter2", "in": "query" }, { "maximum": 2000, "minimum": 0, "type": "integer", "description": "Filter by minimum load rating, e.g. `91`.", "name": "f-minLoadRating", "in": "query" }, { "maximum": 2000, "minimum": 0, "type": "integer", "description": "Filter by minimum load rating, e.g. `95`. Specifying f-minLoadRating and f-minLoadRating2 will list only filter values applicable to tires of both load ratings. Intended for vehicles with staggered fitment.", "name": "f-minLoadRating2", "in": "query" }, { "maximum": 100000, "minimum": 0, "type": "number", "description": "Filter by minimum price [$].", "name": "f-minPrice", "in": "query" }, { "minimum": 0, "type": "number", "description": "Filter by minimum rim diameter, e.g. `18` [inch].", "name": "f-minRimDiameter", "in": "query" }, { "enum": [ "", "D", "E", "F", "G", "H", "J", "K", "L", "M", "N", "P", "Q", "R", "S", "T", "U", "V", "W", "Y", "(Y)", "Z" ], "type": "string", "description": "Filter by minimum speed rating. E.g. `H` speed rating will return filter values applicable to tires with one of the following speed ratings: H, V, Z, W, Y, (Y) (H or higher).", "name": "f-minSpeedRating", "in": "query" }, { "enum": [ "", "D", "E", "F", "G", "H", "J", "K", "L", "M", "N", "P", "Q", "R", "S", "T", "U", "V", "W", "Y", "(Y)", "Z" ], "type": "string", "description": "Filter by minimum speed rating. E.g. `H` speed rating will return filter values applicable to tires with one of the following speed ratings: H, V, Z, W, Y, (Y) (H or higher). Specifying f-minSpeedRating and f-minSpeedRating2 will list only filter values applicable to tires of both speed ratings. Intended for vehicles with staggered fitment.", "name": "f-minSpeedRating2", "in": "query" }, { "maxLength": 20, "type": "string", "description": "Filter by the lowest of comma-separated minimum speed ratings. E.g. `H,V,W,U` will result in filtering by `U` speed rating (the lowest of the four) and will return filter values applicable to tires with one of the following speed ratings: U, H, V, Z, W, Y, (Y) (H or higher).", "name": "f-minSpeedRatings", "in": "query" }, { "maxLength": 20, "type": "string", "description": "Filter by the lowest of comma-separated secondary minimum speed ratings. Specifying `f-minSpeedRatings` and `f-minSpeedRatings2` will return filter values applicable to each of the lowest of the minimum speed ratings. Intended for vehicles with staggered fitment.", "name": "f-minSpeedRatings2", "in": "query" }, { "enum": [ "", "M", "F", "O", "U" ], "type": "string", "description": "Exclude size format (`M` - metric, `F` - flotation, `O` - other non-standard size, or `U` - unknown).", "name": "f-notFormat", "in": "query" }, { "maxLength": 150, "type": "string", "description": "Filter by segment tags. Comma (`,`) acts as an OR operator, e.g. `All Terrain,All Weather` for tires classified as either \"All Terrain\" or \"All Weather\".", "name": "f-orSegmentTags", "in": "query" }, { "maxLength": 50, "type": "string", "description": "Filter by vehicle type tags. Comma (`,`) acts as an OR operator, e.g. `Car,Trailer` for tires designed for either for cars or trailers.", "name": "f-orVehicleTypeTags", "in": "query" }, { "minimum": 0, "type": "number", "description": "Filter by rim diameter, e.g. `18` [inch].", "name": "f-rimDiameter", "in": "query" }, { "minimum": 0, "type": "number", "description": "Filter by rim diameter, e.g. `20` [inch]. Specifying f-rimDiameter and f-rimDiameter2 will list only filter values applicable to tires of both rim diameters. Intended for vehicles with staggered fitment.", "name": "f-rimDiameter2", "in": "query" }, { "maximum": 200, "minimum": 0, "type": "integer", "description": "Filter by external diameter rounded to a whole number, e.g. `33` [inch]. Applies to both metric and floatation tires. Use `f-format` to specify tire type.", "name": "f-roundedDiameter", "in": "query" }, { "maximum": 200, "minimum": 0, "type": "integer", "description": "Filter by secondary tire external diameter rounded to a whole number, e.g. `35` [inch]. Specifying `f-roundedDiameter` and `f-roundedDiameter2` will list only filter values applicable to tires of both diameters including values that can be rounded to the diameters. Intended for vehicles with staggered fitment. Applies to both metric and floatation tires. Use `f-format` to specify tire type.", "name": "f-roundedDiameter2", "in": "query" }, { "minimum": 0, "type": "number", "description": "Filter by section width, e.g. `225` [mm]. Applies to metric tires only.", "name": "f-sectionWidth", "in": "query" }, { "maximum": 10000, "minimum": 0, "type": "number", "description": "Filter by secondary tire section width, e.g. `235` [mm]. Specifying `f-sectionWidth` and `f-sectionWidth2` will list only filter values applicable to tires of both widths. Intended for vehicles with staggered fitment. Applies to metric tires only.", "name": "f-sectionWidth2", "in": "query" }, { "maxLength": 5000, "type": "string", "description": "Filter by comma-separated sizes, e.g. `235/40R18` for metric tires and `31X10.50R15` for floatation tires. Comma (`,`) acts as an OR operator and pipe operator (`|`) allows specifying secondary sizes for rear wheels, e.g. `235/40R18|245/40R18,31X10.50R15|31X11.50R15`.", "name": "f-sizes", "in": "query" }, { "maxLength": 5000, "type": "string", "description": "Filter by comma-separated sizes and compatible sizes with a margin of variance, e.g. `235/40R18` for metric tires and `31X10.50R15` for floatation tires. Comma (`,`) acts as an OR operator and pipe operator (`|`) allows specifying secondary sizes for rear wheels, e.g. `235/40R18|245/40R18,31X10.50R15|31X11.50R15`.", "name": "f-sizesWithMargin", "in": "query" }, { "enum": [ "", "studless", "studdable", "studded" ], "type": "string", "description": "Filter by winter classification (`studless`, `studdable`, or `studded`)", "name": "f-winterClass", "in": "query" }, { "type": "boolean", "description": "Include a list of aspect ratios. Applies to metric tires only.", "name": "i-aspectRatios", "in": "query" }, { "type": "boolean", "description": "Include brand logos together with brand names.", "name": "i-brandLogos", "in": "query" }, { "type": "boolean", "description": "Include a list of brands.", "name": "i-brands", "in": "query" }, { "type": "boolean", "description": "Include a list of diameters. Applies to both metric and floatation tires. Use `f-format` to specify tire type.", "name": "i-diameters", "in": "query" }, { "type": "boolean", "description": "Include a list of inch widths. Applies to floatation tires only.", "name": "i-inchWidths", "in": "query" }, { "type": "boolean", "description": "Include a price range. Requires pricing to be activated in the portal.", "name": "i-prices", "in": "query" }, { "type": "boolean", "description": "Include a list of rim diameters.", "name": "i-rimDiameters", "in": "query" }, { "type": "boolean", "description": "Include a list of diameters rounded to a whole number. Applies to both metric and floatation tires. Use `f-format` to specify tire type.", "name": "i-roundedDiameters", "in": "query" }, { "type": "boolean", "description": "Include a list of section widths. Applies to metric tires only.", "name": "i-sectionWidths", "in": "query" }, { "type": "boolean", "description": "Include a list of speed ratings.", "name": "i-speedRatings", "in": "query" }, { "type": "boolean", "description": "Include a list of tags.", "name": "i-tags", "in": "query" }, { "type": "boolean", "description": "Include a list of winter classifications", "name": "i-winterClasses", "in": "query" } ], "responses": { "200": { "description": "OK" } } } }, "/tires/models": { "get": { "tags": [ "Tires" ], "summary": "List tire models", "parameters": [ { "type": "string", "description": "API key", "name": "key", "in": "query", "required": true }, { "maxLength": 150, "type": "string", "description": "Filter by segment tags excluding specified tags. Comma (`,`) acts as an AND operator, e.g. `All Terrain,All Weather` for tires models with tires classified as not All Terrain and not All Weather.", "name": "f-andNotSegmentTags", "in": "query" }, { "maxLength": 50, "type": "string", "description": "Filter by vehicle type tags excluding specified tags. Comma (`,`) acts as an AND operator, e.g. `Car,SUV/Light Truck` for tires models with tires classified as not for cars and not for SUVs.", "name": "f-andNotVehicleTypeTags", "in": "query" }, { "maxLength": 150, "type": "string", "description": "Filter by segment tags. Comma (`,`) acts as an AND operator, e.g. `All Terrain,All Weather` for tires classified as both All Terrain and All Weather.", "name": "f-andSegmentTags", "in": "query" }, { "maxLength": 50, "type": "string", "description": "filter by vehicle type tags. Comma (`,`) acts as an AND operator, e.g. `Car,SUV/Light Truck` for tires designed for both cars and SUVs.", "name": "f-andVehicleTypeTags", "in": "query" }, { "minimum": 0, "type": "number", "description": "Filter by tire aspect ratio, e.g. `45`.", "name": "f-aspectRatio", "in": "query" }, { "minimum": 0, "type": "number", "description": "Filter by secondary tire aspect ratio, e.g. `55`. Specifying `f-aspectRatio` and `f-aspectRatio2` will list only tire models with tires of both aspect ratios. Intended for vehicles with staggered fitment.", "name": "f-aspectRatio2", "in": "query" }, { "maxLength": 50, "type": "string", "description": "Filter by brand name, e.g. `Goodyear`.", "name": "f-brand", "in": "query" }, { "type": "string", "description": "Filter by comma-separated brand IDs `265,267`.", "name": "f-brandIds", "in": "query" }, { "maximum": 200, "minimum": 0, "type": "number", "description": "Filter by external diameter, e.g. `33` [inch]. Applies to both metric and floatation tires. Use `f-format` to specify tire type.", "name": "f-diameter", "in": "query" }, { "maximum": 200, "minimum": 0, "type": "number", "description": "Filter by secondary external diameter, e.g. `35` [inch]. Specifying `f-diameter` and `f-diameter2` will list only tire models with tires of both diameters. Intended for vehicles with staggered fitment. Applies to both metric and floatation tires. Use `f-format` to specify tire type.", "name": "f-diameter2", "in": "query" }, { "maximum": 200, "minimum": 0, "type": "number", "description": "Filter by external diameter with a positive margin of variance, e.g. `33` [inch] for values between approximately 33\" and 34\". Applies to both metric and floatation tires. Use `f-format` to specify tire type.", "name": "f-diameterWithMargin", "in": "query" }, { "maximum": 200, "minimum": 0, "type": "number", "description": "Filter by secondary external diameter with a positive margin of variance, e.g. `33` [inch] for values between approximately 33\" and 34\". Specifying `f-diameterWithMargin` and `f-diameterWithMargin2` will list only tire models with tires of both diameters with a margin of variance. Intended for vehicles with staggered fitment. Applies to both metric and floatation tires. Use `f-format` to specify tire type.", "name": "f-diameterWithMargin2", "in": "query" }, { "enum": [ "", "M", "F", "O", "U" ], "type": "string", "description": "Filter by size format (`M` - metric, `F` - flotation, `O` - other non-standard size, or `U` - unknown).", "name": "f-format", "in": "query" }, { "type": "boolean", "description": "Enforce size 2 inch widths to be greater than size 1. This may be used to list larger tires for rear axles. Intended for vehicles with staggered fitment.", "name": "f-gtInchWidth2", "in": "query" }, { "type": "boolean", "description": "Enforce size 2 rim diameters to be greater than size 1. This may be used to list larger tires for rear axles. Intended for vehicles with staggered fitment.", "name": "f-gtRimDiameter2", "in": "query" }, { "type": "boolean", "description": "Enforce size 2 inch widths to be greater than size 1 or equal. This may be used to list larger tires for rear axles. Intended for vehicles with staggered fitment.", "name": "f-gteInchWidth2", "in": "query" }, { "type": "boolean", "description": "Enforce size 2 rim diameters to be greater than size 1 or equal. This may be used to list larger tires for rear axles. Intended for vehicles with staggered fitment.", "name": "f-gteRimDiameter2", "in": "query" }, { "type": "boolean", "description": "List only tires models with tires with wheel coordinates.", "name": "f-hasCoordinates", "in": "query" }, { "type": "boolean", "description": "List only tire models with tires with external product IDs. Requires external product IDs to be activated and configured in the portal.", "name": "f-hasExternalProductId", "in": "query" }, { "type": "boolean", "description": "List only tires models with tires with available view-on-vehicle images of angle 0100.", "name": "f-hasImg0100", "in": "query" }, { "type": "boolean", "description": "List only tires models with tires with available view-on-vehicle images of angle 0301.", "name": "f-hasImg0301", "in": "query" }, { "type": "boolean", "description": "List only tires models with tires with prices. Requires pricing to be activated in the portal.", "name": "f-hasPrice", "in": "query" }, { "type": "boolean", "description": "List only tires models with tires with available view-on-vehicle images of angle 0100 or 0301.", "name": "f-hasVovImg", "in": "query" }, { "minimum": 0, "type": "integer", "description": "Filter by tire model ID.", "name": "f-id", "in": "query" }, { "type": "boolean", "description": "List only tire models with at least one tire in stock. Requires inventory to be activated in the portal.", "name": "f-inStock", "in": "query" }, { "maximum": 1000, "minimum": 0, "type": "number", "description": "Filter by width, e.g. `10.5` [inch]. Applies to both metric and floatation tires. Use `f-format` to specify tire type.", "name": "f-inchWidth", "in": "query" }, { "maximum": 1000, "minimum": 0, "type": "number", "description": "Filter by secondary width, e.g. `11.5` [inch]. Specifying `f-inchWidth` and `f-inchWidth2` will list only tire models with tires of both inch widths. Intended for vehicles with staggered fitment. Applies to both metric and floatation tires. Use `f-format` to specify tire type.", "name": "f-inchWidth2", "in": "query" }, { "maximum": 1000, "minimum": 0, "type": "number", "description": "Filter by width with a positive margin of variance, e.g. `10` [inch] for values between approximately 10\" and 10.5\". Applies to both metric and floatation tires. Use `f-format` to specify tire type.", "name": "f-inchWidthWithMargin", "in": "query" }, { "maximum": 1000, "minimum": 0, "type": "number", "description": "Filter by secondary width with a positive margin of variance, e.g. `11` [inch] for values between approximately 11\" and 11.5\". Specifying `f-inchWidthWithMargin` and `f-inchWidthWithMargin2` will list only tire models with tires of both inch widths with a margin of variance. Intended for vehicles with staggered fitment. Applies to both metric and floatation tires. Use `f-format` to specify tire type.", "name": "f-inchWidthWithMargin2", "in": "query" }, { "maximum": 200, "minimum": 0, "type": "number", "description": "Filter by maximum external diameter, e.g. `35` [inch]. Applies to both metric and floatation tires. Use `f-format` to specify tire type.", "name": "f-maxDiameter", "in": "query" }, { "maximum": 200, "minimum": 0, "type": "number", "description": "Filter by secondary maximum external diameter, e.g. `35` [inch]. Specifying `f-maxDiameter` and `f-maxDiameter2` will list only tire models with tires of both diameters. Intended for vehicles with staggered fitment. Applies to both metric and floatation tires. Use `f-format` to specify tire type.", "name": "f-maxDiameter2", "in": "query" }, { "maximum": 100000, "minimum": 0, "type": "number", "description": "Filter by maximum price [$].", "name": "f-maxPrice", "in": "query" }, { "maximum": 200, "minimum": 0, "type": "number", "description": "Filter by minimum external diameter, e.g. `30` [inch]. Applies to both metric and floatation tires. Use `f-format` to specify tire type.", "name": "f-minDiameter", "in": "query" }, { "maximum": 200, "minimum": 0, "type": "number", "description": "Filter by secondary minimum external diameter, e.g. `30` [inch]. Specifying `f-minDiameter` and `f-minDiameter2` will list only tire models with tires of both diameters. Intended for vehicles with staggered fitment. Applies to both metric and floatation tires. Use `f-format` to specify tire type.", "name": "f-minDiameter2", "in": "query" }, { "maximum": 2000, "minimum": 0, "type": "integer", "description": "Filter by minimum load rating, e.g. `100`.", "name": "f-minLoadRating", "in": "query" }, { "maximum": 2000, "minimum": 0, "type": "integer", "description": "Filter by secondary minimum load rating, e.g. `108`. Specifying `f-minLoadRating` and `f-minLoadRating2` will list only tire models with at least one tire meeting each of the minimum load ratings. Intended for vehicles with staggered fitment.", "name": "f-minLoadRating2", "in": "query" }, { "maximum": 100000, "minimum": 0, "type": "number", "description": "Filter by minimum price [$].", "name": "f-minPrice", "in": "query" }, { "minimum": 0, "type": "number", "description": "Filter by minimum rim diameter, e.g. `18` [inch].", "name": "f-minRimDiameter", "in": "query" }, { "enum": [ "", "D", "E", "F", "G", "H", "J", "K", "L", "M", "N", "P", "Q", "R", "S", "T", "U", "V", "W", "Y", "(Y)", "Z" ], "type": "string", "description": "Filter by minimum speed rating. E.g. `H` speed rating will return tire models that have tires with one of the following speed ratings: H, V, Z, W, Y, (Y) (H or higher).", "name": "f-minSpeedRating", "in": "query" }, { "enum": [ "", "D", "E", "F", "G", "H", "J", "K", "L", "M", "N", "P", "Q", "R", "S", "T", "U", "V", "W", "Y", "(Y)", "Z" ], "type": "string", "description": "Filter by secondary minimum speed rating. Specifying `f-minSpeedRating` and `f-minSpeedRating2` will list only tire models with at least one tire meeting each of the minimum speed ratings. Intended for vehicles with staggered fitment.", "name": "f-minSpeedRating2", "in": "query" }, { "maxLength": 20, "type": "string", "description": "Filter by the lowest of comma-separated minimum speed ratings. E.g. `H,V,W,U` will result in filtering by `U` speed rating (the lowest of the four) and will return tire models that have tires with one of the following speed ratings: U, H, V, Z, W, Y, (Y) (H or higher).", "name": "f-minSpeedRatings", "in": "query" }, { "maxLength": 20, "type": "string", "description": "Filter by the lowest of comma-separated secondary minimum speed ratings. Specifying `f-minSpeedRatings` and `f-minSpeedRatings2` will list only tire models with at least one tire meeting each of the minimum speed ratings of the lowest speed rating. Intended for vehicles with staggered fitment.", "name": "f-minSpeedRatings2", "in": "query" }, { "enum": [ "", "M", "F", "O", "U" ], "type": "string", "description": "Exclude size format (`M` - metric, `F` - flotation, `O` - other non-standard size, or `U` - unknown).", "name": "f-notFormat", "in": "query" }, { "maxLength": 150, "type": "string", "description": "Filter by segment tags. Comma (`,`) acts as an OR operator, e.g. `All Terrain,All Weather` for tires classified as either All Terrain or All Weather.", "name": "f-orSegmentTags", "in": "query" }, { "maxLength": 50, "type": "string", "description": "Filter by vehicle type tags. Comma (`,`) acts as an OR operator, e.g. `Car,Trailer` for tires designed for either for cars or trailers.", "name": "f-orVehicleTypeTags", "in": "query" }, { "maxLength": 50, "type": "string", "description": "Filter by a full-text search, e.g. `Michelin Crossclimate`. Searched fields include brand, model, model description, part number and display name.", "name": "f-query", "in": "query" }, { "minimum": 0, "type": "number", "description": "Filter by rim diameter, e.g. `22` [inch].", "name": "f-rimDiameter", "in": "query" }, { "minimum": 0, "type": "number", "description": "Filter by rim diameter, e.g. `24` [inch]. Specifying `f-rimDiameter` and `f-rimDiameter2` will list only tire models with tires of both rim diameters. Intended for vehicles with staggered fitment.", "name": "f-rimDiameter2", "in": "query" }, { "maximum": 200, "minimum": 0, "type": "integer", "description": "Filter by external diameter rounded to a whole number, e.g. `33` [inch]. Applies to both metric and floatation tires. Use `f-format` to specify tire type.", "name": "f-roundedDiameter", "in": "query" }, { "maximum": 200, "minimum": 0, "type": "integer", "description": "Filter by secondary external diameter rounded to a whole number, e.g. `35` [inch]. Specifying `f-diameter` and `f-diameter2` will list only tire models with tires of both diameters. Intended for vehicles with staggered fitment. Applies to both metric and floatation tires. Use `f-format` to specify tire type.", "name": "f-roundedDiameter2", "in": "query" }, { "maximum": 10000, "minimum": 0, "type": "number", "description": "Filter by tire section width, e.g. `235` [mm]. Applies to metric tires only.", "name": "f-sectionWidth", "in": "query" }, { "maximum": 10000, "minimum": 0, "type": "number", "description": "Filter by secondary tire section width, e.g. `245` [mm]. Specifying `f-sectionWidth` and `f-sectionWidth2` will list only tire models with tires of both widths. Intended for vehicles with staggered fitment. Applies to metric tires only.", "name": "f-sectionWidth2", "in": "query" }, { "maxLength": 5000, "type": "string", "description": "Filter by comma-separated sizes, e.g. `235/40R18` for metric tires and `31X10.50R15` for floatation tires. Comma (`,`) acts as an OR operator and pipe operator (`|`) allows specifying secondary sizes for rear wheels, e.g. `235/40R18|245/40R18,31X10.50R15|31X11.50R15`.", "name": "f-sizes", "in": "query" }, { "maxLength": 5000, "type": "string", "description": "Filter by comma-separated sizes and compatible sizes with a margin of variance, e.g. `235/40R18` for metric tires and `31X10.50R15` for floatation tires. Comma (`,`) acts as an OR operator and pipe operator (`|`) allows specifying secondary sizes for rear wheels, e.g. `235/40R18|245/40R18,31X10.50R15|31X11.50R15`.", "name": "f-sizesWithMargin", "in": "query" }, { "enum": [ "", "studless", "studdable", "studded" ], "type": "string", "description": "Filter by winter classification (`studless`, `studdable`, or `studded`)", "name": "f-winterClass", "in": "query" }, { "type": "boolean", "description": "Include all unique display names for each tire model.", "name": "i-displayNames", "in": "query" }, { "type": "boolean", "description": "Include paths to all available images.", "name": "i-img", "in": "query" }, { "type": "boolean", "description": "Include details of the selected images that represent the model (e.g. rim size or diameter). Tire models may include tires of multiple widths, aspect ratios, diameters etc.", "name": "i-imgDetails", "in": "query" }, { "type": "boolean", "description": "Include stock availability. Requires inventory to be activated in the portal.", "name": "i-inStock", "in": "query" }, { "type": "boolean", "description": "Include minimum and maximum prices.", "name": "i-minMaxPrice", "in": "query" }, { "type": "boolean", "description": "Include description, features and benefits.", "name": "i-specs", "in": "query" }, { "type": "boolean", "description": "Include segment and vehicle type tags.", "name": "i-tags", "in": "query" }, { "type": "boolean", "description": "Include the total number of tires for each model.", "name": "i-tireCount", "in": "query" }, { "enum": [ "", "asc", "desc" ], "type": "string", "description": "Sort by brand (`asc` or `desc`). A brand priority list configured in the portal takes precedence.", "name": "s-brand", "in": "query" }, { "enum": [ "", "asc", "desc" ], "type": "string", "description": "Sort by model (`asc` or `desc`). A brand priority list configured in the portal takes precedence.", "name": "s-model", "in": "query" } ], "responses": { "200": { "description": "OK" } } } }, "/vehicles": { "get": { "tags": [ "Vehicles" ], "summary": "List vehicles", "parameters": [ { "type": "string", "description": "API key", "name": "key", "in": "query", "required": true }, { "minimum": 0, "type": "integer", "description": "Filter by ACES vehicle ID.", "name": "f-acesVehicleId", "in": "query" }, { "maxLength": 20, "type": "string", "description": "Filter by bed type, e.g. `fleetside`. Relevant to pickup trucks only.", "name": "f-bed", "in": "query" }, { "maxLength": 50, "type": "string", "description": "Filter by body type, e.g. `coupe`.", "name": "f-body", "in": "query" }, { "minimum": 0, "type": "integer", "description": "Specify image color by ID. Takes precedence over `f-imgColor`.", "name": "f-colorId", "in": "query" }, { "minimum": 0, "type": "integer", "description": "Filter by door count, e.g. `2`. Currently, only a limited number of vehicles have door count information.", "name": "f-doors", "in": "query" }, { "type": "boolean", "description": "Filter by DRW (Dual Rear Wheel). `true` returns only DRW vehicles, `false` returns only SRW (Single Rear Wheel) vehicles.", "name": "f-drw", "in": "query" }, { "type": "string", "description": "List only vehicles with DT images updated after a given date, e.g. `2025-01-01 15:45:00` or `2025-01-01`.", "name": "f-dtImgUpdatedAfter", "in": "query" }, { "minimum": 0, "type": "integer", "description": "Filter by DT vehicle trim ID.", "name": "f-dtTrimId", "in": "query" }, { "type": "string", "description": "Filter by comma-separated DT vehicle trim IDs.", "name": "f-dtTrimIds", "in": "query" }, { "type": "boolean", "description": "List only vehicles with DT trim IDs.", "name": "f-hasDtTrimId", "in": "query" }, { "minimum": 0, "type": "integer", "description": "Filter by vehicle ID.", "name": "f-id", "in": "query" }, { "enum": [ "", "rand", "mono" ], "type": "string", "description": "Specify image color: `rand` – random color (default), `mono` – prefer monochromatic color. `f-colorId` takes precedence if both are specified.", "name": "f-imgColor", "in": "query" }, { "enum": [ "", "png", "jpeg", "webp" ], "type": "string", "description": "Return paths to images converted to a specified image format. Be aware that delivering images in formats other than the native WebP introduces additional overhead, which may increase the latency when accessing the images.", "name": "f-imgFormat", "in": "query" }, { "type": "string", "description": "List only vehicles with images updated after a given date, e.g. `2025-01-01`.", "name": "f-imgUpdatedAfter", "in": "query" }, { "type": "boolean", "description": "Modifier for `i-lifts`. When set, includes vehicles whose lift images have not yet been revised.", "name": "f-liftsUnrevised", "in": "query" }, { "maxLength": 50, "type": "string", "description": "Filter by make, e.g. `Ford`.", "name": "f-make", "in": "query" }, { "maxLength": 50, "type": "string", "description": "Filter by model name, e.g. `F-150`.", "name": "f-model", "in": "query" }, { "maxLength": 100, "type": "string", "description": "Filter by a full-text search query, e.g. `2025 Ford Bronco Badlands`.", "name": "f-query", "in": "query" }, { "enum": [ "", "CA", "US" ], "type": "string", "description": "Filter by region: `US` (United States) or `CA` (Canada). Returns every vehicle sold in that country, including vehicles sold in both countries (region `US/CA`).", "name": "f-region", "in": "query" }, { "maxLength": 50, "type": "string", "description": "Filter by sub model name, e.g. `Wilderness`.", "name": "f-submodel", "in": "query" }, { "maxLength": 50, "type": "string", "description": "Filter by comma-separated vehicle types, e.g. `car,CUV`.", "name": "f-types", "in": "query" }, { "type": "string", "description": "Filter by VIN number, e.g. `4S4BTGUD0N3998061`. Requires VIN lookup to be activated in the portal. If the VIN does not uniquely identify a single vehicle, multiple results will be returned. Invalid VINs will trigger \"Invalid value for query parameter: f-vin\" error.", "name": "f-vin", "in": "query" }, { "minimum": 0, "type": "integer", "description": "Filter by year, e.g. `2025`.", "name": "f-year", "in": "query" }, { "type": "boolean", "description": "Include the ACES IDs the vehicle maps to: ACES make ID, ACES base vehicle ID, ACES sub model ID and ACES vehicle ID. Supersedes `i-acesVehicleId`, which returns ACES vehicle ID alone.", "name": "i-acesIds", "in": "query" }, { "type": "boolean", "description": "Include ACES vehicle ID.", "name": "i-acesVehicleId", "in": "query" }, { "type": "boolean", "description": "Include a list of available colors.", "name": "i-colors", "in": "query" }, { "type": "boolean", "description": "Include a complete list of all available colors with paths to their images.", "name": "i-colorsWithImages", "in": "query" }, { "type": "string", "description": "Include wheel coordinates for comma-separated vehicle angles, e.g. `001,032`. Valid vehicle angles: `001`, `014`, `032`. Additional data automatically included: `InImageWheelDiameters` – minimum and maximum wheel diameters that visually fit the vehicle [inch], `Rotations[vehicle angle]` – wheel rotation [deg] for each vehicle angle, `WheelAngles[vehicle angle]` – left and right wheel angles that should be used for each vehicle angle. Angle 014 may additionally include coordinates and the associated data for an externally mounted spare wheels for some vehicles.", "name": "i-coordinates", "in": "query" }, { "type": "boolean", "description": "Include the date of the latest DT image addition or update.", "name": "i-dtImgUpdatedAt", "in": "query" }, { "type": "boolean", "description": "Include DT vehicle trim ID.", "name": "i-dtTrimId", "in": "query" }, { "type": "boolean", "description": "Include OE fitments. See `i-optionalFitments` and `i-plusSizes` for additional fitments.", "name": "i-fitments", "in": "query" }, { "type": "boolean", "description": "Include the paths to all images.", "name": "i-img", "in": "query" }, { "type": "boolean", "description": "Include the path to the side angle images in the default color.", "name": "i-img001", "in": "query" }, { "type": "boolean", "description": "Include the path to the rear angle images in the default color.", "name": "i-img014", "in": "query" }, { "type": "boolean", "description": "Include the path to the front angle images in the default color.", "name": "i-img032", "in": "query" }, { "type": "boolean", "description": "Include stock wheel images. These are images of wheels that have been cut out from vehicle images and can be overlaid on tires.", "name": "i-imgStockWheels", "in": "query" }, { "type": "boolean", "description": "Include the date of the latest image addition or update.", "name": "i-imgUpdatedAt", "in": "query" }, { "type": "boolean", "description": "Include wheel diameters that visually fit the vehicle image.", "name": "i-inImageWheelDiameters", "in": "query" }, { "type": "boolean", "description": "Include lift data and images for all vehicle angles: 001, 014, 032.", "name": "i-lifts", "in": "query" }, { "type": "boolean", "description": "Include OE optional fitments.", "name": "i-optionalFitments", "in": "query" }, { "type": "boolean", "description": "Include extended fitment options.", "name": "i-plusSizes", "in": "query" }, { "type": "boolean", "description": "Include region: `US` (United States), `CA` (Canada), or `US/CA` (both). Vehicles sold in both countries report `US/CA`.", "name": "i-region", "in": "query" }, { "type": "boolean", "description": "Include tags and a niche tag.", "name": "i-tags", "in": "query" }, { "enum": [ "", "asc", "desc" ], "type": "string", "description": "Sort by vehicle description length. For example, combining `s-descriptionLength=asc` with `f-query=2022 Ford Bronco Big Bend` will return the larger Bronco first, followed by the smaller Bronco Sport, since the former has a shorter description.", "name": "s-descriptionLength", "in": "query" }, { "enum": [ "", "asc", "desc" ], "type": "string", "description": "Sort by the date of the latest image addition or update to the DT vehicle (`asc` or `desc`).", "name": "s-dtImgUpdatedAt", "in": "query" } ], "responses": { "200": { "description": "OK" } } } }, "/vehicles/makes": { "get": { "tags": [ "Vehicles" ], "summary": "List vehicle makes", "parameters": [ { "type": "string", "description": "API key", "name": "key", "in": "query", "required": true }, { "maxLength": 50, "type": "string", "description": "Filter by comma-separated vehicle types, e.g. `van,truck`.", "name": "f-types", "in": "query" }, { "minimum": 0, "type": "integer", "description": "Filter by year, e.g. `1999`.", "name": "f-year", "in": "query" }, { "type": "boolean", "description": "Include AutoCare's brand ID.", "name": "i-aaiaBrandCode", "in": "query" }, { "type": "boolean", "description": "Include the paths to make logos.", "name": "i-logos", "in": "query" }, { "type": "boolean", "description": "Include the number of vehicles for each make (subject to the filters).", "name": "i-vehicleCount", "in": "query" } ], "responses": { "200": { "description": "OK" } } } }, "/vehicles/models": { "get": { "tags": [ "Vehicles" ], "summary": "List vehicle models", "parameters": [ { "type": "string", "description": "API key", "name": "key", "in": "query", "required": true }, { "enum": [ "", "rand", "mono" ], "type": "string", "description": "Specify preferred image colors. `rand` – random colors (default), `mono` – prefer monochromatic colors. Takes effect only if any images are included.", "name": "f-imgColor", "in": "query" }, { "enum": [ "", "png", "jpeg", "webp" ], "type": "string", "description": "Return paths to images converted to a specified image format. Be aware that delivering images in formats other than the native WebP introduces additional overhead, which may increase the latency when accessing the images.", "name": "f-imgFormat", "in": "query" }, { "maxLength": 50, "type": "string", "description": "Filter by make, e.g. `Chevrolet`.", "name": "f-make", "in": "query" }, { "maxLength": 50, "type": "string", "description": "Filter by a full-text search query, e.g. `2025 Chevrolet`.", "name": "f-query", "in": "query" }, { "maxLength": 50, "type": "string", "description": "Filter by comma-separated vehicle types, e.g. `car,cuv`.", "name": "f-types", "in": "query" }, { "minimum": 0, "type": "integer", "description": "Filter by year, eg.g `2023`.", "name": "f-year", "in": "query" }, { "type": "boolean", "description": "Enable/disable API key-level filter for vehicle models. If disabled, the API will ignore \"Allowed Vehicle Models\" setting in the portal. `true` - enable (default), `false` - disable.", "name": "gf-vehicleModels", "in": "query" }, { "type": "boolean", "description": "Include body type. The same model will be listed multiple times if it’s available in multiple body types (e.g. Hatchback and Sedan). Both `i-body` and `i-drw` may include multiple variants for a single vehicle model.", "name": "i-body", "in": "query" }, { "type": "boolean", "description": "Include DRW. If a model is available in both SRW (Single Rear Wheel) and DRW (Dual Rear Wheel) variants, it will be listed twice. Both `i-drw` and `i-body` may include multiple variants for a single vehicle model.", "name": "i-drw", "in": "query" }, { "type": "boolean", "description": "Include the paths to images of all angles in the default color.", "name": "i-img", "in": "query" }, { "type": "boolean", "description": "Include the path to the side angle images in the default color.", "name": "i-img001", "in": "query" }, { "type": "boolean", "description": "Include the path to the rear angle images in the default color.", "name": "i-img014", "in": "query" }, { "type": "boolean", "description": "Include the path to the front angle images in the default color.", "name": "i-img032", "in": "query" }, { "type": "boolean", "description": "Include the year of the vehicle in the image (it may be different from the year of the vehicle). Takes effect only if any images are included.", "name": "i-imgYear", "in": "query" }, { "type": "boolean", "description": "Include the latest year for each vehicle model, e.g 2019 for Jaguar XJ which was discontinued in 2020. When `i-year` parameter is used, `i-maxYear` will have the same value.", "name": "i-maxYear", "in": "query" }, { "type": "boolean", "description": "Include vehicle type.", "name": "i-type", "in": "query" }, { "type": "boolean", "description": "Include years.", "name": "i-year", "in": "query" } ], "responses": { "200": { "description": "OK" } } } }, "/vehicles/submodels": { "get": { "tags": [ "Vehicles" ], "summary": "List vehicle sub models", "parameters": [ { "type": "string", "description": "API key", "name": "key", "in": "query", "required": true }, { "minimum": 0, "type": "integer", "description": "Filter by door count, e.g. `2`. Currently, only a limited number of vehicle sub models have door count information.", "name": "f-doors", "in": "query" }, { "type": "boolean", "description": "Filter by DRW (Dual Rear Wheel). `true` returns only DRW vehicles, `false` returns only SRW (Single Rear Wheel) vehicles.", "name": "f-drw", "in": "query" }, { "enum": [ "", "rand", "mono" ], "type": "string", "description": "Specify preferred image colors: `rand` – random colors (default), `mono` – prefer monochromatic colors. Takes effect only if any images are included.", "name": "f-imgColor", "in": "query" }, { "enum": [ "", "png", "jpeg", "webp" ], "type": "string", "description": "Return paths to images converted to a specified image format. Be aware that delivering images in formats other than the native WebP introduces additional overhead, which may increase the latency when accessing the images.", "name": "f-imgFormat", "in": "query" }, { "maxLength": 50, "type": "string", "description": "Filter by make, e.g. `Ford`.", "name": "f-make", "in": "query" }, { "maxLength": 50, "type": "string", "description": "Filter by model name, e.g. `F-150`.", "name": "f-model", "in": "query" }, { "maxLength": 50, "type": "string", "description": "Filter by a full-text search query, e.g. `Volvo V90`.", "name": "f-query", "in": "query" }, { "maxLength": 50, "type": "string", "description": "Filter by comma-separated vehicle types, e.g. `car,CUV`.", "name": "f-types", "in": "query" }, { "minimum": 0, "type": "integer", "description": "Filter by year, e.g. `2025`.", "name": "f-year", "in": "query" }, { "type": "boolean", "description": "Include body type. The same sub model will be listed multiple times if it is available in multiple body types.", "name": "i-body", "in": "query" }, { "type": "boolean", "description": "Include the paths to images of all angles in the default color.", "name": "i-img", "in": "query" }, { "type": "boolean", "description": "Include the path to the side angle images in the default color.", "name": "i-img001", "in": "query" }, { "type": "boolean", "description": "Include the path to the rear angle images in the default color.", "name": "i-img014", "in": "query" }, { "type": "boolean", "description": "Include the path to the front angle images in the default color.", "name": "i-img032", "in": "query" }, { "type": "boolean", "description": "Include vehicle type.", "name": "i-type", "in": "query" } ], "responses": { "200": { "description": "OK" } } } }, "/vehicles/years": { "get": { "tags": [ "Vehicles" ], "summary": "List vehicle years", "parameters": [ { "type": "string", "description": "API key", "name": "key", "in": "query", "required": true }, { "maxLength": 50, "type": "string", "description": "Filter by make, e.g. `Tesla`.", "name": "f-make", "in": "query" }, { "maxLength": 50, "type": "string", "description": "Filter by model, e.g. `Bronco`.", "name": "f-model", "in": "query" }, { "maxLength": 50, "type": "string", "description": "Filter by sub model, e.g. `Wilderness`.", "name": "f-submodel", "in": "query" }, { "maxLength": 50, "type": "string", "description": "Filter by comma-separated vehicle types, e.g. `truck,van`.", "name": "f-types", "in": "query" } ], "responses": { "200": { "description": "OK" } } } }, "/vvs/rfq": { "post": { "tags": [ "E-Commerce" ], "summary": "Post a request for quote", "parameters": [ { "type": "string", "description": "API key", "name": "key", "in": "query", "required": true }, { "description": " ", "name": "body", "in": "body", "required": true, "schema": { "$ref": "#/definitions/rfq.Cart" } } ], "responses": { "200": { "description": "OK" } } } }, "/vvs/rfq/checkpoint": { "post": { "tags": [ "E-Commerce" ], "summary": "Post a checkout step checkpoint", "parameters": [ { "type": "string", "description": "API key", "name": "key", "in": "query", "required": true }, { "description": " ", "name": "body", "in": "body", "required": true, "schema": { "$ref": "#/definitions/vvs_rfq_checkpoint.postData" } } ], "responses": { "200": { "description": "OK" } } } }, "/wheels": { "get": { "tags": [ "Wheels" ], "summary": "List wheels", "parameters": [ { "type": "string", "description": "API key", "name": "key", "in": "query", "required": true }, { "maxLength": 100, "type": "string", "description": "Filter by segment tags. Comma (`,`) acts as an AND operator, e.g. `All Terrain,All Weather` for wheels classified as both All Terrain and All Weather.", "name": "f-andSegmentTags", "in": "query" }, { "maxLength": 50, "type": "string", "description": "Filter by vehicle type tags. Comma (`,`) acts as an AND operator, e.g. `Car,SUV/Light Truck` for wheels designed for both cars and SUVs.", "name": "f-andVehicleTypeTags", "in": "query" }, { "maximum": 300, "minimum": 0, "type": "number", "description": "Filter by either of the bolt circles: bolt circle 1 or bolt circle 2, e.g. `139.70` [mm].", "name": "f-boltCircle", "in": "query" }, { "maxLength": 50, "type": "string", "description": "Filter by brand name, e.g. `TSW`.", "name": "f-brand", "in": "query" }, { "type": "string", "description": "Filter by comma-separated brand IDs, e.g. `21,67`.", "name": "f-brandIds", "in": "query" }, { "maxLength": 100, "type": "string", "description": "Filter by comma-separated diameters, e.g. `20,22,24` [inch].", "name": "f-diameters", "in": "query" }, { "minimum": 0, "type": "integer", "description": "Filter by DT article number.", "name": "f-dtArticleNumber", "in": "query" }, { "type": "string", "description": "Filter by comma-separated DT article numbers.", "name": "f-dtArticleNumbers", "in": "query" }, { "type": "string", "description": "List only wheels with DT images updated after a given date, e.g. `2025-01-01 15:45:00` or `2025-01-01`.", "name": "f-dtImgUpdatedAfter", "in": "query" }, { "type": "boolean", "description": "List only wheels with DT article numbers.", "name": "f-hasDtArticleNumber", "in": "query" }, { "type": "boolean", "description": "List only wheels with external product IDs. Requires external product IDs to be activated and configured in the portal.", "name": "f-hasExternalProductId", "in": "query" }, { "type": "boolean", "description": "List only wheels with available images of angle 0001 (standard). Every wheel returned by this endpoint already has a 0001 image, so this filter never narrows the results. It is accepted for symmetry with `f-hasImg0002` and `f-hasImg0003`.", "name": "f-hasImg0001", "in": "query" }, { "type": "boolean", "description": "List only wheels with available images of angle 0002 (beauty).", "name": "f-hasImg0002", "in": "query" }, { "type": "boolean", "description": "List only wheels with available images of angle 0003 (face).", "name": "f-hasImg0003", "in": "query" }, { "type": "boolean", "description": "List only wheels with rotation images.", "name": "f-hasImgRotation", "in": "query" }, { "type": "boolean", "description": "List only wheels with prices. Requires pricing to be activated in the portal.", "name": "f-hasPrice", "in": "query" }, { "type": "boolean", "description": "List only wheels with available view-on-vehicle images of angle 0100 or 0300.", "name": "f-hasVovImg", "in": "query" }, { "minimum": 0, "type": "integer", "description": "Filter by wheel ID.", "name": "f-id", "in": "query" }, { "type": "string", "description": "Filter by comma-separated wheel IDs, e.g. `11503,11499`.", "name": "f-ids", "in": "query" }, { "enum": [ "", "png", "webp" ], "type": "string", "x-enum-varnames": [ "WheelImgFormatNone", "WheelImgFormatPng", "WheelImgFormatWebp" ], "description": "Return paths to images converted to a specified image format (WebP or PNG).", "name": "f-imgFormat", "in": "query" }, { "type": "string", "description": "List only wheels with images updated after a given date, e.g. `2025-01-01`.", "name": "f-imgUpdatedAfter", "in": "query" }, { "type": "boolean", "description": "List only wheels that are in stock. Requires inventory to be activated in the portal.", "name": "f-inStock", "in": "query" }, { "maximum": 20, "minimum": 0, "type": "integer", "description": "Filter by lug count, e.g. `5`.", "name": "f-lugCount", "in": "query" }, { "maximum": 1000, "minimum": -1000, "type": "number", "description": "Filter by maximum offset, e.g. `-44` [mm].", "name": "f-maxOffset", "in": "query" }, { "maximum": 100000, "minimum": 0, "type": "number", "description": "Filter by maximum price [$].", "name": "f-maxPrice", "in": "query" }, { "maximum": 500, "minimum": 0, "type": "number", "description": "Filter by minimum bore, e.g. `101` [mm].", "name": "f-minBore", "in": "query" }, { "minimum": 0, "type": "integer", "description": "Filter by minimum inventory level, e.g. `4`. Setting the parameter to `1` is the same as using `f-inStock` parameter. Requires inventory to be activated in the portal.", "name": "f-minInventory", "in": "query" }, { "maximum": 9999, "minimum": 0, "type": "number", "description": "Filter by minimum load rating, e.g. `1600` [lbs].", "name": "f-minLoadRating", "in": "query" }, { "maximum": 1000, "minimum": -1000, "type": "number", "description": "Filter by minimum offset, e.g. `35` [mm].", "name": "f-minOffset", "in": "query" }, { "maximum": 100000, "minimum": 0, "type": "number", "description": "Filter by minimum price [$].", "name": "f-minPrice", "in": "query" }, { "maxLength": 50, "type": "string", "description": "Filter by wheel model name, e.g. `Vector`.", "name": "f-model", "in": "query" }, { "maxLength": 50, "type": "string", "description": "Filter by niche tag. `N/A` – only wheels for vehicles with no niche tag set, any other value will include wheels with the specified niche tag and with no niche tag set, e.g. `Lexus ES` – wheels with either no niche tag set or for Lexus ES vehicles.", "name": "f-nicheTag", "in": "query" }, { "maximum": 1000, "minimum": -1000, "type": "number", "description": "Filter by offset, e.g. `35` [mm]. Takes precedence over `f-minOffset` and `f-maxOffset`.", "name": "f-offset", "in": "query" }, { "type": "string", "description": "Filter by comma-separated offsets, e.g. `35,40,-10` [mm]. Takes precedence over `f-offset`.", "name": "f-offsets", "in": "query" }, { "maxLength": 100, "type": "string", "description": "Filter by segment tags. Comma (`,`) acts as an OR operator, e.g. `All Terrain,All Weather` for wheels classified as either All Terrain or All Weather.", "name": "f-orSegmentTags", "in": "query" }, { "maxLength": 50, "type": "string", "description": "Filter by vehicle type tags. Comma (`,`) acts as an OR operator, e.g. `Car,Trailer` for wheels designed for either for cars or trailers.", "name": "f-orVehicleTypeTags", "in": "query" }, { "maxLength": 50, "type": "string", "description": "Filter by part number. Reserved characters must be URL-encoded, e.g. `+` → `%2B`.", "name": "f-pn", "in": "query" }, { "maxLength": 1000, "type": "string", "description": "Filter by comma-separated part numbers, e.g. `127-2084BM,127-2981GB`. Reserved characters must be URL-encoded e.g. `+` → `%2B`.", "name": "f-pns", "in": "query" }, { "type": "string", "description": "Filter by position, e.g. `Front Dually`. Valid values: `Front Dually`, `N/A`, `Inner Dually`, `Outer Dually`, `Front`, `Rear`.", "name": "f-position", "in": "query" }, { "maxLength": 100, "type": "string", "description": "Filter by comma-separated positions, e.g. `N/A,Front,Front Dually`. Valid position values: `Front Dually`, `N/A`, `Inner Dually`, `Outer Dually`, `Front`, `Rear`.", "name": "f-positions", "in": "query" }, { "maxLength": 50, "type": "string", "description": "Filter by a full-text search query based on the following fields: part number, brand, model, sub model, bolt pattern, short color, short finish, tags, and niche tag, e.g. `Black Rhino 5x130 black matte`.", "name": "f-query", "in": "query" }, { "maxLength": 100, "type": "string", "description": "Filter by comma-separated short (simplified) colors, e.g. `black`.", "name": "f-shortColors", "in": "query" }, { "maxLength": 100, "type": "string", "description": "Filter by comma-separated short (simplified) finishes, e.g. `gloss`.", "name": "f-shortFinishes", "in": "query" }, { "maxLength": 2000, "type": "string", "description": "Filter by comma-separated sizes, e.g. `20x9.5,20x10.5`.", "name": "f-sizes", "in": "query" }, { "enum": [ "", "active", "discontinued" ], "type": "string", "description": "Filter by status (`active` or `discontinued`). A key receives only the statuses it is configured for; asking for `discontinued` on a key configured for active wheels only returns nothing.", "name": "f-status", "in": "query" }, { "minimum": 0, "type": "integer", "description": "Filter by style ID.", "name": "f-styleId", "in": "query" }, { "maxLength": 50, "type": "string", "description": "Filter by sub model name, e.g. `VF100`.", "name": "f-submodel", "in": "query" }, { "type": "string", "description": "List only tires updated after a given date, e.g. `2025-01-01`.", "name": "f-updatedAfter", "in": "query" }, { "maxLength": 50, "type": "string", "description": "Filter by comma-separated widths, e.g. `9,10` [inch].", "name": "f-widths", "in": "query" }, { "type": "boolean", "description": "Include center cap information.", "name": "i-cap", "in": "query" }, { "type": "boolean", "description": "Include description.", "name": "i-description", "in": "query" }, { "type": "boolean", "description": "Include DT article number", "name": "i-dtArticleNumber", "in": "query" }, { "type": "boolean", "description": "Include the date of the latest image addition or update to the DT wheel.", "name": "i-dtImgUpdatedAt", "in": "query" }, { "type": "boolean", "description": "Include external product IDs. Requires external product IDs to be activated and configured in the portal.", "name": "i-externalProductId", "in": "query" }, { "type": "boolean", "description": "Include feature benefits (1-4).", "name": "i-features", "in": "query" }, { "type": "boolean", "description": "Include the paths to all images.", "name": "i-img", "in": "query" }, { "type": "boolean", "description": "Include the path to the 0001 (standard) angle image.", "name": "i-img0001", "in": "query" }, { "type": "boolean", "description": "Include the path to the 0002 (beauty) angle image.", "name": "i-img0002", "in": "query" }, { "type": "boolean", "description": "Include the path to the 0003 (face) angle image.", "name": "i-img0003", "in": "query" }, { "type": "boolean", "description": "Include the path to the 0100 (view-on-vehicle front) angle image.", "name": "i-img0100", "in": "query" }, { "type": "boolean", "description": "Include the path to the 0200 (view-on-vehicle rear) angle image.", "name": "i-img0200", "in": "query" }, { "type": "boolean", "description": "Include the path to the 0300 (view-on-vehicle face) angle image. The paths will be returned as 0300 in case of regular wheels, 0300Front and 0300Rear in case of dually wheels.", "name": "i-img0300", "in": "query" }, { "type": "boolean", "description": "Include the path to the 1001 (high resolution standard) angle image.", "name": "i-img1001", "in": "query" }, { "type": "boolean", "description": "Include the path to the rotation image.", "name": "i-imgRotation", "in": "query" }, { "type": "boolean", "description": "Include the date of the latest image addition or update.", "name": "i-imgUpdatedAt", "in": "query" }, { "type": "boolean", "description": "Include stock availability. Requires inventory to be activated in the portal.", "name": "i-inStock", "in": "query" }, { "type": "boolean", "description": "Include total inventory level. The values may differ for Canadian clients. Requires inventory to be activated in the portal.", "name": "i-inventory", "in": "query" }, { "type": "boolean", "description": "Include prices. Requires pricing to be activated in the portal.", "name": "i-price", "in": "query" }, { "type": "boolean", "description": "Include shipping data (box weight and dimensions).", "name": "i-shipping", "in": "query" }, { "type": "boolean", "description": "Include specifications.", "name": "i-specs", "in": "query" }, { "type": "boolean", "description": "Include the status (`active` or `discontinued`). Discontinued wheels are listed only for keys configured to receive them; for every other key the value is always `active`.", "name": "i-status", "in": "query" }, { "type": "boolean", "description": "Include tags segment and vehicle type tags.", "name": "i-tags", "in": "query" }, { "type": "boolean", "description": "Include the date of the last changes.", "name": "i-updatedAt", "in": "query" }, { "enum": [ "", "asc", "desc" ], "type": "string", "description": "Sort by brand (`asc` or `desc`). A brand priority list configured in the portal takes precedence.", "name": "s-brand", "in": "query" }, { "enum": [ "", "asc", "desc" ], "type": "string", "description": "Sort by the date of the latest image addition or update to the DT wheel (`asc` or `desc`). A brand priority list configured in the portal takes precedence.", "name": "s-dtImgUpdatedAt", "in": "query" }, { "enum": [ "", "asc", "desc" ], "type": "string", "description": "Sort by 0001 (standard) angle image availability. Every wheel returned by this endpoint already has a 0001 image, so this sort never changes the order. It is accepted for symmetry with `s-hasImg0002` and `s-hasImg0003`. A brand priority list configured in the portal takes precedence.", "name": "s-hasImg0001", "in": "query" }, { "enum": [ "", "asc", "desc" ], "type": "string", "description": "Sort by 0002 (beauty) angle image availability (`asc` - wheels without the image first, `desc` - wheels with the image first). A brand priority list configured in the portal takes precedence.", "name": "s-hasImg0002", "in": "query" }, { "enum": [ "", "asc", "desc" ], "type": "string", "description": "Sort by 0003 (face) angle image availability (`asc` - wheels without the image first, `desc` - wheels with the image first). A brand priority list configured in the portal takes precedence.", "name": "s-hasImg0003", "in": "query" }, { "enum": [ "", "asc", "desc" ], "type": "string", "description": "Sort by VoV image availability (`asc` - wheels without VoV images first, `desc` - wheels with VoV images first). A brand priority list configured in the portal takes precedence.", "name": "s-hasVovImg", "in": "query" }, { "enum": [ "", "asc", "desc" ], "type": "string", "description": "Sort by inventory level (`asc` - lowest stock first, `desc` - highest stock first). Wheels without inventory are always listed last, regardless of the direction. A brand priority list configured in the portal takes precedence. Requires inventory to be activated in the portal.", "name": "s-inventory", "in": "query" }, { "enum": [ "", "asc", "desc" ], "type": "string", "description": "Sort by model (`asc` or `desc`). A brand priority list configured in the portal takes precedence.", "name": "s-model", "in": "query" }, { "enum": [ "", "asc", "desc" ], "type": "string", "description": "Sort by price (`asc` - cheapest first, `desc` - most expensive first). Wheels without a price are always listed last, regardless of the direction. A brand priority list configured in the portal takes precedence. Requires pricing to be activated in the portal.", "name": "s-price", "in": "query" } ], "responses": { "200": { "description": "OK" } } } }, "/wheels/brands": { "get": { "tags": [ "Wheels" ], "summary": "List wheel brands", "parameters": [ { "type": "string", "description": "API key", "name": "key", "in": "query", "required": true }, { "type": "boolean", "description": "List only wheel brands with wheels that have external product IDs.", "name": "f-hasExternalProductId", "in": "query" }, { "type": "boolean", "description": "List only wheel brands with wheels that have available images of angle 0001 (standard). Every wheel brand returned by this endpoint already has wheels with a 0001 image, so this filter never narrows the results. It is accepted for symmetry with `f-hasImg0002` and `f-hasImg0003`.", "name": "f-hasImg0001", "in": "query" }, { "type": "boolean", "description": "List only wheel brands with wheels that have available images of angle 0002 (beauty).", "name": "f-hasImg0002", "in": "query" }, { "type": "boolean", "description": "List only wheel brands with wheels that have available images of angle 0003 (face).", "name": "f-hasImg0003", "in": "query" }, { "type": "boolean", "description": "List only wheel brands with wheels that have prices. Requires pricing to be activated in the portal.", "name": "f-hasPrice", "in": "query" }, { "type": "boolean", "description": "List only wheel brands with wheels that have available view-on-vehicle images of angle 0100 or 0300.", "name": "f-hasVovImg", "in": "query" }, { "minimum": 0, "type": "integer", "description": "Filter by brand ID.", "name": "f-id", "in": "query" }, { "type": "boolean", "description": "List only brands with products in stock. Requires inventory to be activated in the portal.", "name": "f-inStock", "in": "query" }, { "maxLength": 100, "type": "string", "description": "Filter by comma-separated positions, e.g. `N/A,Front,Front Dually`. Valid position values: `Front Dually`, `N/A`, `Inner Dually`, `Outer Dually`, `Front`, `Rear`.", "name": "f-positions", "in": "query" }, { "type": "boolean", "description": "Include AutoCare's brand ID.", "name": "i-aaiaBrandCode", "in": "query" }, { "type": "boolean", "description": "Include brand’s about information.", "name": "i-about", "in": "query" }, { "type": "boolean", "description": "Include the paths to banner images.", "name": "i-imgBanner", "in": "query" }, { "type": "boolean", "description": "Include the paths to banner logo images.", "name": "i-imgBannerLogo", "in": "query" }, { "type": "boolean", "description": "Include the paths to brand logos.", "name": "i-logos", "in": "query" }, { "type": "boolean", "description": "Include brand’s manufacturer.", "name": "i-manufacturer", "in": "query" }, { "type": "boolean", "description": "Include the total number of wheels for each brand.", "name": "i-wheelCount", "in": "query" }, { "type": "boolean", "description": "Include the total number of wheel styles for each brand.", "name": "i-wheelStyleCount", "in": "query" } ], "responses": { "200": { "description": "OK" } } } }, "/wheels/filters": { "get": { "tags": [ "Wheels" ], "summary": "List wheel filters", "parameters": [ { "type": "string", "description": "API key", "name": "key", "in": "query", "required": true }, { "maxLength": 100, "type": "string", "description": "Filter by segment tags. Comma (`,`) acts as an AND operator, e.g. `All Terrain,All Weather` for wheels classified as both All Terrain and All Weather.", "name": "f-andSegmentTags", "in": "query" }, { "maxLength": 50, "type": "string", "description": "Filter by vehicle type tags. Comma (`,`) acts as an AND operator, e.g. `Car,SUV/Light Truck` for wheels designed for both cars and SUVs.", "name": "f-andVehicleTypeTags", "in": "query" }, { "maximum": 300, "minimum": 0, "type": "number", "description": "Filter by either of the bolt circles: bolt circle 1 or bolt circle 2, e.g. `114.30` [mm].", "name": "f-boltCircle", "in": "query" }, { "maxLength": 50, "type": "string", "description": "Filter by brand name, e.g. `TSW`.", "name": "f-brand", "in": "query" }, { "type": "string", "description": "Filter by comma-separated brand IDs, e.g. `21,67`.", "name": "f-brandIds", "in": "query" }, { "maxLength": 100, "type": "string", "description": "Filter by comma-separated diameters, e.g. `20,22,24` [inch].", "name": "f-diameters", "in": "query" }, { "maxLength": 100, "type": "string", "description": "Filter by secondary comma-separated diameters, e.g. `22,24` [inch]. Specifying `f-diameters` and `f-diameters2` will list values that belong to wheel styles with wheels of both sets of diameters. Intended for vehicles with staggered fitment.", "name": "f-diameters2", "in": "query" }, { "type": "boolean", "description": "Enforce size 2 diameters to be greater than size 1. This may be used to list larger wheels for rear axles. Intended for vehicles with staggered fitment.", "name": "f-gtDiameter2", "in": "query" }, { "type": "boolean", "description": "Enforce size 2 widths and diameters to be greater than size 1. This may be used to list larger wheels for rear axles. Intended for vehicles with staggered fitment.", "name": "f-gtSize2", "in": "query" }, { "type": "boolean", "description": "Enforce size 2 widths to be greater than size 1. This may be used to list larger wheels for rear axles. Intended for vehicles with staggered fitment.", "name": "f-gtWidth2", "in": "query" }, { "type": "boolean", "description": "Enforce size 2 diameters to be greater than size 1 or equal. This may be used to list larger wheels for rear axles. Intended for vehicles with staggered fitment.", "name": "f-gteDiameter2", "in": "query" }, { "type": "boolean", "description": "Enforce size 2 widths and diameters to be greater than size 1 or equal. This may be used to list same or larger wheels for rear axles. Intended for vehicles with staggered fitment.", "name": "f-gteSize2", "in": "query" }, { "type": "boolean", "description": "Enforce size 2 widths to be greater than size 1 or equal. This may be used to list larger wheels for rear axles. Intended for vehicles with staggered fitment.", "name": "f-gteWidth2", "in": "query" }, { "type": "boolean", "description": "List only values of wheels that have external product IDs.", "name": "f-hasExternalProductId", "in": "query" }, { "type": "boolean", "description": "List only values of wheels that have available images of angle 0001 (standard). Every wheel behind the values returned by this endpoint already has a 0001 image, so this filter never narrows the results. It is accepted for symmetry with `f-hasImg0002` and `f-hasImg0003`.", "name": "f-hasImg0001", "in": "query" }, { "type": "boolean", "description": "List only values of wheels that have available images of angle 0002 (beauty).", "name": "f-hasImg0002", "in": "query" }, { "type": "boolean", "description": "List only values of wheels that have available images of angle 0003 (face).", "name": "f-hasImg0003", "in": "query" }, { "type": "boolean", "description": "List only values of wheels that have prices. Requires pricing to be activated in the portal.", "name": "f-hasPrice", "in": "query" }, { "type": "boolean", "description": "List only values of wheels that have available view-on-vehicle images of angle 0100 or 0300.", "name": "f-hasVovImg", "in": "query" }, { "type": "boolean", "description": "List only values of wheels that are in stock. Requires inventory to be activated in the portal.", "name": "f-inStock", "in": "query" }, { "maximum": 20, "minimum": 0, "type": "integer", "description": "Filter by lug count, e.g. `5`.", "name": "f-lugCount", "in": "query" }, { "maximum": 1000, "minimum": -1000, "type": "number", "description": "Filter by maximum offset, e.g. `40` [mm].", "name": "f-maxOffset", "in": "query" }, { "maximum": 1000, "minimum": -1000, "type": "number", "description": "Filter by secondary maximum offset, e.g. `35` [mm]. Specifying `f-maxOffset` and `f-maxOffset2` will list values that belong to wheel styles with wheels meeting both offset requirements. Intended for vehicles with staggered fitment.", "name": "f-maxOffset2", "in": "query" }, { "maximum": 100000, "minimum": 0, "type": "number", "description": "Filter by maximum price [$].", "name": "f-maxPrice", "in": "query" }, { "maximum": 500, "minimum": 0, "type": "number", "description": "Filter by minimum bore, e.g. `72.6` [mm].", "name": "f-minBore", "in": "query" }, { "maximum": 500, "minimum": 0, "type": "number", "description": "Filter by secondary minimum bore, e.g. `66.5` [mm]. Specifying `f-minBore` and `f-minBore2` will list values that belong to wheel styles with wheels meeting both bore requirements. Intended for vehicles with staggered fitment.", "name": "f-minBore2", "in": "query" }, { "maximum": 9999, "minimum": 0, "type": "number", "description": "Filter by minimum load rating, e.g. `1600` [lbs].", "name": "f-minLoadRating", "in": "query" }, { "maximum": 1000, "minimum": -1000, "type": "number", "description": "Filter by minimum offset, e.g. `-44` [mm].", "name": "f-minOffset", "in": "query" }, { "maximum": 1000, "minimum": -1000, "type": "number", "description": "Filter by secondary minimum offset, e.g. `-40` [mm]. Specifying `f-minOffset` and `f-minOffset2` will list values that belong to wheel styles with wheels meeting both offset requirements. Intended for vehicles with staggered fitment.", "name": "f-minOffset2", "in": "query" }, { "maximum": 100000, "minimum": 0, "type": "number", "description": "Filter by minimum price [$].", "name": "f-minPrice", "in": "query" }, { "maxLength": 50, "type": "string", "description": "Filter by niche tag. `N/A` – only wheels for vehicles with no niche tag set, any other value will include wheels with the specified niche tag and with no niche tag set, e.g. `Lexus ES` – wheels with either no niche tag set or for Lexus ES vehicles.", "name": "f-nicheTag", "in": "query" }, { "maximum": 1000, "minimum": -1000, "type": "number", "description": "Filter by offset, e.g. `35` [mm]. Takes precedence over `f-minOffset` and `f-maxOffset`.", "name": "f-offset", "in": "query" }, { "maximum": 1000, "minimum": -1000, "type": "number", "description": "Filter by secondary offset, e.g. `30` [mm]. Specifying `f-offset` and `f-offset2` will list values that belong to wheel styles with wheels meeting both offset requirements. Intended for vehicles with staggered fitment.", "name": "f-offset2", "in": "query" }, { "type": "string", "description": "Filter by comma-separated offsets, e.g. `35,40,-10` [mm]. Takes precedence over `f-offset`.", "name": "f-offsets", "in": "query" }, { "type": "string", "description": "Filter by secondary comma-separated offsets, e.g. `35,40,-10` [mm]. Takes precedence over `f-offset2`. Intended for vehicles with staggered fitment.", "name": "f-offsets2", "in": "query" }, { "maxLength": 100, "type": "string", "description": "Filter by segment tags. Comma (`,`) acts as an OR operator, e.g. `All Terrain,All Weather` for wheels classified as either All Terrain or All Weather.", "name": "f-orSegmentTags", "in": "query" }, { "maxLength": 50, "type": "string", "description": "Filter by vehicle type tags. Comma (`,`) acts as an OR operator, e.g. `Car,Trailer` for wheels designed for either for cars or trailers.", "name": "f-orVehicleTypeTags", "in": "query" }, { "maxLength": 100, "type": "string", "description": "Filter by comma-separated positions, e.g. `N/A,Front,Front Dually`. Valid position values: `Front Dually`, `N/A`, `Inner Dually`, `Outer Dually`, `Front`, `Rear`.", "name": "f-positions", "in": "query" }, { "maxLength": 100, "type": "string", "description": "Filter by secondary comma-separated positions, e.g. `N/A,Front,Front Dually`. Valid position values: `Front Dually`, `N/A`, `Inner Dually`, `Outer Dually`, `Front`, `Rear`. Specifying `f-positions` and `f-positions2` will list values that belong to wheel styles with wheels meeting both position requirements. Intended for vehicles with staggered fitment.", "name": "f-positions2", "in": "query" }, { "maxLength": 100, "type": "string", "description": "Filter by comma-separated short (simplified) colors, e.g. `silver`.", "name": "f-shortColors", "in": "query" }, { "maxLength": 100, "type": "string", "description": "Filter by comma-separated short (simplified) finishes, e.g. `satin`.", "name": "f-shortFinishes", "in": "query" }, { "maxLength": 2000, "type": "string", "description": "Filter by comma-separated sizes, e.g. `18x8.5,18x9.5`.", "name": "f-sizes", "in": "query" }, { "maxLength": 100, "type": "string", "description": "Filter by comma-separated widths, e.g. `9.5,10.5` [inch].", "name": "f-widths", "in": "query" }, { "maxLength": 100, "type": "string", "description": "Filter by secondary comma-separated widths, e.g. `10.5,11.5` [inch]. Specifying `f-widths` and `f-widths2` will list values that belong to wheel styles with wheels of both sets of widths. Intended for vehicles with staggered fitment.", "name": "f-widths2", "in": "query" }, { "type": "boolean", "description": "Include a list of bolt circles.", "name": "i-boltCircles", "in": "query" }, { "type": "boolean", "description": "Include brand logos together with brand names.", "name": "i-brandLogos", "in": "query" }, { "type": "boolean", "description": "Include a list of brands.", "name": "i-brands", "in": "query" }, { "type": "boolean", "description": "Include a list of diameters.", "name": "i-diameters", "in": "query" }, { "type": "boolean", "description": "Include a list of lug counts.", "name": "i-lugCounts", "in": "query" }, { "type": "boolean", "description": "Include a list of offsets.", "name": "i-offsets", "in": "query" }, { "type": "boolean", "description": "Include a price range. Requires pricing to be activated in the portal.", "name": "i-prices", "in": "query" }, { "type": "boolean", "description": "Include a list of short (simplified) colors.", "name": "i-shortColors", "in": "query" }, { "type": "boolean", "description": "Include a list of short (simplified) finishes.", "name": "i-shortFinishes", "in": "query" }, { "type": "boolean", "description": "Include unique diameter x width combinations.", "name": "i-sizes", "in": "query" }, { "type": "boolean", "description": "Include a list of tags.", "name": "i-tags", "in": "query" }, { "type": "boolean", "description": "Include a list of widths.", "name": "i-widths", "in": "query" } ], "responses": { "200": { "description": "OK" } } } }, "/wheels/styles": { "get": { "tags": [ "Wheels" ], "summary": "List wheel styles", "parameters": [ { "type": "string", "description": "API key", "name": "key", "in": "query", "required": true }, { "maxLength": 100, "type": "string", "description": "Filter by segment tags. Comma (`,`) acts as an AND operator, e.g. `All Terrain,All Weather` for wheels classified as both All Terrain and All Weather.", "name": "f-andSegmentTags", "in": "query" }, { "maxLength": 50, "type": "string", "description": "Filter by vehicle type tags. Comma (`,`) acts as an AND operator, e.g. `Car,SUV/Light Truck` for wheels designed for both cars and SUVs.", "name": "f-andVehicleTypeTags", "in": "query" }, { "maximum": 300, "minimum": 0, "type": "number", "description": "Filter by either of the bolt circles: bolt circle 1 or bolt circle 2, e.g. `165.1` [mm].", "name": "f-boltCircle", "in": "query" }, { "maxLength": 50, "type": "string", "description": "Filter by brand name, e.g. `Black Rhino`.", "name": "f-brand", "in": "query" }, { "type": "string", "description": "Filter by comma-separated brand IDs, e.g. `9,473`.", "name": "f-brandIds", "in": "query" }, { "maxLength": 100, "type": "string", "description": "Filter by comma-separated diameters, e.g. `20,22` [inch].", "name": "f-diameters", "in": "query" }, { "maxLength": 100, "type": "string", "description": "Filter by secondary comma-separated diameters, e.g. `22,24` [inch]. Specifying `f-diameters` and `f-diameters2` will list only wheel styles with wheels of both diameters. Intended for vehicles with staggered fitment.", "name": "f-diameters2", "in": "query" }, { "enum": [ 0, 1 ], "type": "integer", "description": "Filter by exposed or covered lugs: `0` - false (covered), `1` - true (exposed).", "name": "f-exposedLugs", "in": "query" }, { "type": "boolean", "description": "Enforce size 2 diameters to be greater than size 1. This may be used to list larger wheels for rear axles. Intended for vehicles with staggered fitment.", "name": "f-gtDiameter2", "in": "query" }, { "type": "boolean", "description": "Enforce size 2 widths and diameters to be greater than size 1. This may be used to list larger wheels for rear axles. Intended for vehicles with staggered fitment.", "name": "f-gtSize2", "in": "query" }, { "type": "boolean", "description": "Enforce size 2 widths to be greater than size 1. This may be used to list larger wheels for rear axles. Intended for vehicles with staggered fitment.", "name": "f-gtWidth2", "in": "query" }, { "type": "boolean", "description": "Enforce size 2 diameters to be greater than size 1 or equal. This may be used to list larger wheels for rear axles. Intended for vehicles with staggered fitment.", "name": "f-gteDiameter2", "in": "query" }, { "type": "boolean", "description": "Enforce size 2 widths and diameters to be greater than size 1 or equal. This may be used to list same or larger wheels for rear axles. Intended for vehicles with staggered fitment.", "name": "f-gteSize2", "in": "query" }, { "type": "boolean", "description": "Enforce size 2 widths to be greater than size 1 or equal. This may be used to list larger wheels for rear axles. Intended for vehicles with staggered fitment.", "name": "f-gteWidth2", "in": "query" }, { "type": "boolean", "description": "List only wheel styles with wheels that have external product IDs.", "name": "f-hasExternalProductId", "in": "query" }, { "type": "boolean", "description": "List only wheel styles with wheels that have available images of angle 0001 (standard). Every wheel style returned by this endpoint already has wheels with a 0001 image, so this filter never narrows the results. It is accepted for symmetry with `f-hasImg0002` and `f-hasImg0003`.", "name": "f-hasImg0001", "in": "query" }, { "type": "boolean", "description": "List only wheel styles with wheels that have available images of angle 0002 (beauty).", "name": "f-hasImg0002", "in": "query" }, { "type": "boolean", "description": "List only wheel styles with wheels that have available images of angle 0003 (face).", "name": "f-hasImg0003", "in": "query" }, { "type": "boolean", "description": "List only wheel styles with wheels that have prices. Requires pricing to be activated in the portal.", "name": "f-hasPrice", "in": "query" }, { "type": "boolean", "description": "List only wheel styles with wheels that have available view-on-vehicle images of angle 0100 or 0300.", "name": "f-hasVovImg", "in": "query" }, { "minimum": 0, "type": "integer", "description": "Filter by wheel style ID.", "name": "f-id", "in": "query" }, { "enum": [ "", "png", "webp" ], "type": "string", "x-enum-varnames": [ "WheelImgFormatNone", "WheelImgFormatPng", "WheelImgFormatWebp" ], "description": "Return paths to images converted to a specified image format (WebP or PNG).", "name": "f-imgFormat", "in": "query" }, { "type": "boolean", "description": "List only wheel styles with wheels in stock. Requires inventory to be activated in the portal.", "name": "f-inStock", "in": "query" }, { "maximum": 20, "minimum": 0, "type": "integer", "description": "Filter by lug count, e.g. `6`.", "name": "f-lugCount", "in": "query" }, { "maxLength": 50, "type": "string", "description": "Filter by lug type, e.g. `Conical`.", "name": "f-lugType", "in": "query" }, { "maxLength": 50, "type": "string", "description": "Filter by material, e.g. `Cast Aluminum`.", "name": "f-material", "in": "query" }, { "maximum": 1000, "minimum": -1000, "type": "number", "description": "Filter by maximum offset, e.g. `40` [mm].", "name": "f-maxOffset", "in": "query" }, { "maximum": 1000, "minimum": -1000, "type": "number", "description": "Filter by secondary maximum offset, e.g. `35` [mm]. Specifying `f-maxOffset` and `f-maxOffset2` will list only wheel styles with wheels meeting both offset requirements. Intended for vehicles with staggered fitment.", "name": "f-maxOffset2", "in": "query" }, { "maximum": 100000, "minimum": 0, "type": "number", "description": "Filter by maximum price [$].", "name": "f-maxPrice", "in": "query" }, { "maximum": 500, "minimum": 0, "type": "number", "description": "Filter by minimum bore, e.g. `72.6` [mm].", "name": "f-minBore", "in": "query" }, { "maximum": 500, "minimum": 0, "type": "number", "description": "Filter by secondary minimum bore, e.g. `66.5` [mm]. Specifying `f-minBore` and `f-minBore2` will list only wheel styles with wheels meeting both bore requirements. Intended for vehicles with staggered fitment.", "name": "f-minBore2", "in": "query" }, { "maximum": 9999, "minimum": 0, "type": "number", "description": "Filter by minimum load rating, e.g. `1600` [lbs].", "name": "f-minLoadRating", "in": "query" }, { "maximum": 1000, "minimum": -1000, "type": "number", "description": "Filter by minimum offset, e.g. `-44` [mm].", "name": "f-minOffset", "in": "query" }, { "maximum": 1000, "minimum": -1000, "type": "number", "description": "Filter by secondary minimum offset, e.g. `-40` [mm]. Specifying `f-minOffset` and `f-minOffset2` will list only wheel styles with wheels meeting both offset requirements. Intended for vehicles with staggered fitment.", "name": "f-minOffset2", "in": "query" }, { "maximum": 100000, "minimum": 0, "type": "number", "description": "Filter by minimum price [$].", "name": "f-minPrice", "in": "query" }, { "maxLength": 50, "type": "string", "description": "Filter by niche tag. `N/A` – only wheels for vehicles with no niche tag set, any other value will include wheels with the specified niche tag and with no niche tag set, e.g. `Lexus ES` – wheels with either no niche tag set or for Lexus ES vehicles.", "name": "f-nicheTag", "in": "query" }, { "maximum": 1000, "minimum": -1000, "type": "number", "description": "Filter by offset, e.g. `35` [mm]. Takes precedence over `f-minOffset` and `f-maxOffset`.", "name": "f-offset", "in": "query" }, { "maximum": 1000, "minimum": -1000, "type": "number", "description": "Filter by secondary offset, e.g. `30` [mm]. Takes precedence over `f-minOffset2` and `f-maxOffset2`. Specifying `f-offset` and `f-offset2` will list only wheel styles with wheels meeting both offset requirements. Intended for vehicles with staggered fitment.", "name": "f-offset2", "in": "query" }, { "type": "string", "description": "Filter by comma-separated offsets, e.g. `35,40,-10` [mm]. Takes precedence over `f-offset`.", "name": "f-offsets", "in": "query" }, { "type": "string", "description": "Filter by secondary comma-separated offsets, e.g. `35,40,-10` [mm]. Takes precedence over `f-offset2`. Intended for vehicles with staggered fitment.", "name": "f-offsets2", "in": "query" }, { "maxLength": 100, "type": "string", "description": "Filter by segment tags. Comma (`,`) acts as an OR operator, e.g. `All Terrain,All Weather` for wheels classified as either All Terrain or All Weather.", "name": "f-orSegmentTags", "in": "query" }, { "maxLength": 50, "type": "string", "description": "Filter by vehicle type tags. Comma (`,`) acts as an OR operator, e.g. `Car,Trailer` for wheels designed for either for cars or trailers.", "name": "f-orVehicleTypeTags", "in": "query" }, { "maxLength": 100, "type": "string", "description": "Filter by comma-separated positions, e.g. `N/A,Front,Front Dually`. Valid position values: `Front Dually`, `N/A`, `Inner Dually`, `Outer Dually`, `Front`, `Rear`.", "name": "f-positions", "in": "query" }, { "maxLength": 100, "type": "string", "description": "Filter by secondary comma-separated positions, e.g. `N/A,Front,Front Dually`. Valid position values: `Front Dually`, `N/A`, `Inner Dually`, `Outer Dually`, `Front`, `Rear`. Specifying `f-positions` and `f-positions2` will list only wheel styles with wheels meeting both position requirements. Intended for vehicles with staggered fitment.", "name": "f-positions2", "in": "query" }, { "maxLength": 50, "type": "string", "description": "Filter by a full-text search query based on the following fields: part number, brand, model, sub model, bolt pattern (e.g. 5x130), short color, short finish, tags, and niche tag.", "name": "f-query", "in": "query" }, { "maxLength": 100, "type": "string", "description": "Filter by comma-separated short (simplified) colors, e.g. `chrome`.", "name": "f-shortColors", "in": "query" }, { "maxLength": 100, "type": "string", "description": "Filter by comma-separated short (simplified) finishes, e.g. `matte`.", "name": "f-shortFinishes", "in": "query" }, { "maxLength": 2000, "type": "string", "description": "Filter by comma-separated sizes, e.g. `18x8.5,18x9.5`.", "name": "f-sizes", "in": "query" }, { "maxLength": 50, "type": "string", "description": "Filter by structure, e.g. `1-Piece`.", "name": "f-structure", "in": "query" }, { "maxLength": 100, "type": "string", "description": "Filter by comma-separated widths, e.g. `10,12` [inch].", "name": "f-widths", "in": "query" }, { "maxLength": 100, "type": "string", "description": "Filter by secondary comma-separated widths, e.g. `12,14` [inch]. Specifying `f-widths` and `f-widths2` will list only wheel styles with wheels of both widths. Intended for vehicles with staggered fitment.", "name": "f-widths2", "in": "query" }, { "type": "boolean", "description": "Include description.", "name": "i-description", "in": "query" }, { "type": "boolean", "description": "Include a list of diameters for each style.", "name": "i-diameters", "in": "query" }, { "type": "boolean", "description": "Include feature benefits (1-4).", "name": "i-features", "in": "query" }, { "type": "boolean", "description": "Include the path to the 0001 (standard) angle image.", "name": "i-img0001", "in": "query" }, { "type": "boolean", "description": "Include the path to the 0002 (beauty) angle image.", "name": "i-img0002", "in": "query" }, { "type": "boolean", "description": "Include the path to the 0003 (face) angle image.", "name": "i-img0003", "in": "query" }, { "type": "boolean", "description": "Include details of the selected images that represent the style (e.g. color, diameter or short finish). Each wheel style may include wheels of multiple colors or diameters.", "name": "i-imgDetails", "in": "query" }, { "type": "boolean", "description": "Include stock availability. Requires inventory to be activated in the portal.", "name": "i-inStock", "in": "query" }, { "type": "boolean", "description": "Include price ranges.", "name": "i-minMaxPrice", "in": "query" }, { "type": "boolean", "description": "Include a list of offsets for each style.", "name": "i-offsets", "in": "query" }, { "type": "boolean", "description": "Include a list of short colors for each style.", "name": "i-shortColors", "in": "query" }, { "type": "boolean", "description": "Include a list of short finishes for each style.", "name": "i-shortFinishes", "in": "query" }, { "type": "boolean", "description": "Include a list of sizes for each style. A size is a combination of diameter and width, e.g. 18x9.", "name": "i-sizes", "in": "query" }, { "type": "boolean", "description": "Include specifications.", "name": "i-specs", "in": "query" }, { "type": "boolean", "description": "Include segment and vehicle type tags.", "name": "i-tags", "in": "query" }, { "type": "boolean", "description": "Include the total number of wheels for each wheel style.", "name": "i-wheelCount", "in": "query" }, { "enum": [ "", "asc", "desc" ], "type": "string", "description": "Sort by model (`asc` or `desc`). A brand priority list configured in the portal takes precedence.", "name": "s-model", "in": "query" } ], "responses": { "200": { "description": "OK" } } } } }, "definitions": { "rfq.Cart": { "type": "object", "required": [ "customer", "idempotencyKey", "products" ], "properties": { "checkpointId": { "type": "integer" }, "customer": { "$ref": "#/definitions/rfq.Customer" }, "idempotencyKey": { "type": "string", "maxLength": 64, "minLength": 32 }, "locationId": { "type": "integer" }, "products": { "type": "array", "minItems": 1, "items": { "$ref": "#/definitions/rfq.Product" } }, "services": { "type": "array", "items": { "$ref": "#/definitions/rfq.Service" } }, "vehicleId": { "type": "integer" }, "vehicleLift": { "type": "number" } } }, "rfq.Customer": { "type": "object", "required": [ "email", "firstName", "lastName", "phone" ], "properties": { "address": { "type": "string", "maxLength": 300 }, "email": { "type": "string", "maxLength": 50 }, "firstName": { "type": "string", "maxLength": 30, "minLength": 1 }, "lastName": { "type": "string", "maxLength": 30, "minLength": 1 }, "message": { "type": "string", "maxLength": 500 }, "phone": { "type": "string", "maxLength": 20, "minLength": 10 } } }, "rfq.Product": { "type": "object", "required": [ "id", "type" ], "properties": { "desc": { "type": "string", "maxLength": 1000 }, "id": { "type": "integer" }, "pn": { "type": "string", "maxLength": 50, "minLength": 2 }, "price": { "type": "number" }, "qty": { "type": "integer" }, "type": { "type": "string", "enum": [ "wheel", "tire" ] } } }, "rfq.Service": { "type": "object", "required": [ "id", "qty" ], "properties": { "id": { "type": "integer" }, "price": { "type": "number" }, "productId": { "type": "integer" }, "productIds": { "type": "array", "items": { "type": "integer" } }, "qty": { "type": "integer", "minimum": 1 }, "title": { "type": "string", "maxLength": 1000 } } }, "vvs_rfq_checkpoint.postData": { "type": "object", "required": [ "step" ], "properties": { "id": { "type": "integer" }, "step": { "type": "integer", "maximum": 3, "minimum": 1 }, "userAgent": { "description": "Cart rfq.Cart `json:\"cart\" validate:\"required\"`", "type": "string", "maxLength": 500 } } }, "wheel_consts.WheelImgFormat": { "type": "string", "enum": [ "", "png", "webp" ], "x-enum-varnames": [ "WheelImgFormatNone", "WheelImgFormatPng", "WheelImgFormatWebp" ] } } }