Properties
| Name | Type | Description |
|---|---|---|
| variant | object |
JSON Schema
{
"$schema": "https://json-schema.org/draft/2020-12/schema",
"$id": "https://artifacts.apis.io/rutter/json-schema/rutter-variant-response-schema.json",
"title": "VariantResponse",
"x-generated": "2026-11-05",
"x-method": "derived",
"x-generator": "derive-json-schema.py",
"x-source": "openapi/rutter-commerce-api-openapi.yml#/components/schemas/VariantResponse",
"type": "object",
"properties": {
"variant": {
"type": "object",
"properties": {
"id": {
"type": "string",
"description": "The ID of the variant. This value can either be a Rutter-generated UUID or the ID of the variant in the platform. This ID is not guaranteed to be unique across all variants."
},
"platform_id": {
"type": "string",
"description": "The platform specific ID of the variant."
},
"product_id": {
"type": "string"
},
"price": {
"type": "number",
"description": "The price of the variant."
},
"requires_shipping": {
"type": "boolean",
"description": "Whether the variant requires shipping."
},
"barcode": {
"type": [
"string",
"null"
],
"description": "The barcode of the variant."
},
"fulfillment_service": {
"type": [
"string",
"null"
],
"description": "The fulfillment service of the variant."
},
"inventory_management": {
"type": [
"string",
"null"
],
"description": "The inventory management system of the variant."
},
"iso_currency_code": {
"type": [
"string",
"null"
],
"description": "The [ISO 4217](https://www.iso.org/iso-4217-currency-codes.html) currency code of the variant."
},
"sku": {
"type": [
"string",
"null"
],
"description": "The stock keeping unit (SKU) of the variant."
},
"title": {
"type": [
"string",
"null"
],
"description": "The title of the variant."
},
"unit_cost": {
"type": [
"number",
"null"
],
"description": "The unit cost of the variant."
},
"variant_url": {
"type": "string",
"description": "The consumer facing URL used to access the variant online."
},
"compare_at_price": {
"type": [
"number",
"null"
],
"description": "The original price of the variant before a sale, in the currency given by `iso_currency_code`. For Shopify, this is the variant compare-at price. `null` when no sale price is set."
},
"description": {
"type": [
"string",
"null"
],
"description": "The description of the variant."
},
"images": {
"type": "array",
"items": {
"type": "object",
"properties": {
"src": {
"type": "string",
"description": "The URL of the image."
}
},
"required": [
"src"
],
"additionalProperties": false
},
"description": "An array of images linked to the variant."
},
"short_description": {
"type": [
"string",
"null"
],
"description": "An abbreviated description of the variant."
},
"option_values": {
"type": "array",
"items": {
"type": "object",
"properties": {
"name": {
"type": "string",
"description": "The name of the variant option."
},
"value": {
"type": "string",
"description": "The value of the variant option."
}
},
"required": [
"name",
"value"
],
"additionalProperties": false
},
"description": "The option values associated with the variant. This describes how the variant is unique from other variants of the same product."
},
"currency_prices": {
"type": "array",
"items": {
"type": "object",
"properties": {
"iso_currency_code": {
"type": "string",
"description": "The [ISO 4217](https://www.iso.org/iso-4217-currency-codes.html) currency code of the price."
},
"price": {
"type": "number",
"description": "The value of the price."
}
},
"required": [
"iso_currency_code",
"price"
],
"additionalProperties": false
},
"description": "An array of prices in different supported currencies for the variant."
},
"weight": {
"type": [
"object",
"null"
],
"properties": {
"unit": {
"type": "string",
"enum": [
"kg",
"g",
"oz",
"lb",
"gal"
],
"description": "The unit the weight is being measured in."
},
"value": {
"type": "number",
"description": "The value of the weight."
}
},
"required": [
"unit",
"value"
],
"additionalProperties": false,
"description": "The weight of the variant."
},
"linked_products": {
"type": "array",
"items": {
"type": "object",
"properties": {
"variant_id": {
"type": "string"
},
"link_type": {
"type": "string"
},
"sku": {
"type": "string"
}
},
"required": [
"variant_id",
"link_type",
"sku"
],
"additionalProperties": false
}
},
"translations": {
"type": "array",
"items": {
"type": "object",
"properties": {
"locale": {
"type": "string",
"description": "The locale of this translation as a `language-REGION` tag, for example `pt-BR`, `en-US`, `ja-JP`."
},
"option_values": {
"type": "array",
"items": {
"type": "object",
"properties": {
"name": {
"type": "string",
"description": "The name of the variant option."
},
"value": {
"type": "string",
"description": "The value of the variant option."
}
},
"required": [
"name",
"value"
],
"additionalProperties": false
},
"description": "The variant's option values with the option name and value translated into this locale. Parts without a translation keep the original text."
}
},
"required": [
"locale",
"option_values"
],
"additionalProperties": false
},
"description": "Translations of the variant's option values. Only returned when the `locales` query parameter is set. Supported for Shopify."
},
"inventory": {
"type": [
"object",
"null"
],
"properties": {
"total_count": {
"type": [
"number",
"null"
],
"description": "The total amount of inventory of the variant."
},
"locations": {
"type": [
"array",
"null"
],
"items": {
"type": "object",
"properties": {
"id": {
"type": "string",
"description": "The Rutter generated unique ID of the location."
},
"address1": {
"type": "string",
"description": "The first address line of the location."
},
"address2": {
"type": "string",
"description": "The second address line of the location."
},
"city": {
"type": "string",
"description": "The city of the location."
},
"country": {
"type": "string",
"description": "The country of the location."
},
"name": {
"type": "string",
"description": "The name of the location."
},
"postal_code": {
"type": "string",
"description": "The postal code of the location."
},
"quantity": {
"type": "number",
"description": "The quantity of inventory at the location."
},
"region": {
"type": "string",
"description": "The region of the location."
},
"updated_at": {
"type": "string",
"description": "The [ISO 8601](https://www.iso.org/iso-8601-date-and-time-format.html) timestamp that the location was last updated."
}
},
"required": [
"id",
"address1",
"address2",
"city",
"country",
"name",
"postal_code",
"quantity",
"region",
"updated_at"
],
"additionalProperties": false
},
"description": "The locations containing inventory for the variant."
}
},
"required": [
"total_count",
"locations"
],
"additionalProperties": false,
"description": "Details about the inventory of the variant."
},
"created_at": {
"type": [
"string",
"null"
],
"description": "The [ISO 8601](https://www.iso.org/iso-8601-date-and-time-format.html) timestamp that the variant was created."
},
"updated_at": {
"type": [
"string",
"null"
],
"description": "The [ISO 8601](https://www.iso.org/iso-8601-date-and-time-format.html) timestamp that the variant was last updated."
},
"platform_data": {
"type": "object",
"additionalProperties": {},
"description": "The raw platform data corresponding to the Rutter object."
}
},
"required": [
"id",
"product_id",
"price",
"requires_shipping",
"barcode",
"fulfillment_service",
"inventory_management",
"iso_currency_code",
"sku",
"title",
"unit_cost",
"images",
"option_values",
"created_at",
"updated_at"
],
"additionalProperties": false
}
},
"required": [
"variant"
]
}Work with this as data
Every JSON Schema here is available over the APIs.io API and to AI agents over MCP.
MCP server
One button, every client — Claude, Cursor, VS Code and the rest.
https://apis.io/mcp
Tools for schemas
4 MCP tools reach this
find_json_schemasBrowse and filter every JSON Schema in the catalog.apis_io_searchSTART HERE — APIs, providers and tags for one query, each with its total.resolveTurn a domain, URL or GitHub org into the provider it belongs to.find_cohortsEvery scored population of providers in the catalog.
Call it yourself
curl for this page
This JSON Schema
curl "https://apis.io/api/v1/json-schemas/rutter-variant-response"
All schemas
curl "https://apis.io/api/v1/json-schemas?limit=25"Calls without X-API-Key need no key. Calls with it need a paid plan — get a key.
Get an API key
Free tier, no form to fill in. Signing in shares your email address with us — we store it to create your key and to recognise you if you sign in with another provider. See our Privacy Policy and Terms.
A second provider on the same verified email joins the account you already have.