Product Variants

For each product, there are one or more product variants, representing a specific version of the product.

Product Variant Properties

Property

Type

Description

id

string

product_id

string

Rutter ID for parent Product

barcode

string | null

title

string

Title of variant

price

number

Price of variant

unit_cost

number | null

Unit cost of variant

iso_currency_code

string

The ISO-4217 currency code of the variant.

sku

string | null

Stock keeping unit

fulfillment_service

string | null

inventory_management

string | null

option_values

object[]

Configuration for this variant, i.e. Color, Size. Length of array is at most 3.

requires_shipping

boolean

inventory

object | null

An object containing two attributes: total_count, which is a number denoting total inventory, and locations, which is an array of objects showing location details and quantity at location.

If the platform doesn't set or provide inventory data, this field will be null

weight

object | null

Weight of this variant, if supplied, otherwise it would be null. It will contain both units and the value. For weight returned by Rutter, it will always be converted to grams.

{
      "id": "39072856",
      "product_id": "987f8ad0-502a-4153-8a46-a19df28e5023",
      "title": "Green",
      "price": 199.00,
      "iso_currency_code": "USD",
      "sku": "IPOD2008GREEN",
      "weight": {
        "value": 500.00,
        "unit": "g"
      },
      "option_values": [
        {
          "name": "Color",
          "value": "Red"
        },
        {
          "name": "Size",
          "value": "XL"
        }
      ],
      "inventory": {
        "total_count": 30,
        "locations": [
          {
            "id": "39072856",
            "name": "CA Warehouse",
            "address1": "544 Guerrero Street",
            "address2": "Apt 3",
            "city": "San Francisco",
            "postal_code": "94110",
            "region": "CA",
            "country": "USA",
            "updated_at": "2016-06-23T09:09:34.752Z",
            "available": 30
          }
        ]
      }
    }

Inventory

Each product variant has an inventory property, which is an object with details about the total quantity and individual quantities of a variant across a merchant's locations. If no locations are available for a merchant, the locations property will be null.