Get a specific product variation details referring to its ID.
Headers
Name
Type
Description
Authorization
string
oAuth token with mandatory Bearer before it. Example: Bearer e***s0, where e***s0 should be replaced with your oAuth token.
Query parameters
Field
Type
Description
lang
string
Preferred language for the product fields in search results. If a certain field does not have the translation available for the set language, the default language text will be used for that field
Response
An array of JSON objects of type 'Variation' with the following fields:
Variation
Field
Type
Description
id
number
Variation ID
combinationNumber
number
Combination # number, which is displayed in the variations table in Control panel
options
Array<OptionValue>
Set of options that identifies this variation. An array of name-value pairs
sku
string
Variation SKU. Omitted if the variation inherits the base product's SKU
thumbnailUrl
string
URL of the product variation thumbnail displayed on the product list pages. Thumbnails size is defined in the store settings. Default size of biggest dimension is 400px. Omitted if the variation inherits the base product's image. The original uploaded product image is available in the originalImageUrl field.
imageUrl
string
URL of the product variation image resized to fit 1500x1500px. Omitted if the variation inherits the base product's image. The original uploaded product image is available in the originalImageUrl field.
smallThumbnailUrl
string
URL of the product variation thumbnail resized to fit 160x160px. Omitted if the variation inherits the base product's image. The original uploaded product image is available in the originalImageUrl field.
hdThumbnailUrl
string
Product variation HD thumbnail URL resized to fit 800x800px. Omitted if the variation inherits the base product's image.
originalImageUrl
string
URL of the original not resized product variation image. Omitted if the variation inherits the base product's image.
quantity
number
Amount of the variation items in stock. If sku is omitted, then quantity of the variation is nested from base product. If sku is present, the variation has its own quantity value.
inStock
boolean
true if the variation is in stock (quantity is more than zero) or has unlimited quantity. false otherwise.
unlimited
boolean
true if the variation has unlimited stock (that is, never runs out)
price
number
Variation price. Omitted if the variation inherits the base product's price
isShippingRequired
boolean
true if variation requires shipping, false otherwise
wholesalePrices
Array<WholesalePrice>
Sorted array of the variation's wholesale price tiers (quantity limit and price). Omitted if the variation inherits the base product's tiered price settings.
weight
number
Variation weight in the units defined in store settings. Omitted if the variation inherits the base product's weight.
warningLimit
number
The minimum 'warning' amount of the product items in stock for this variation, if set. When the variation in stock amount reaches this level, the store administrator gets an email notification. Omitted if the variation inherits the base product's settings
attributes
Array<AttributeValue>
Variation's UPC attribute and its value
defaultDisplayedPrice
number
Product price displayed in a storefront for logged out customer for default location (store location). May differ from the price value when the product has options and variations and the default variation's price is different from the base product price. It also includes taxes
defaultDisplayedPriceFormatted
number
Formatted displayed price
dimensions
<VariationDimensions>
Variation dimensions info
compareToPrice
number
Variation's sale price displayed strike-out in the customer frontend Omitted if empty
costPrice
number
Purchase price (the price at which the seller bought the product from the supplier). A positive number, 0 by default. The field is not shown in the UI and can be used for reports and profit calculations
customsHsTariffCode
string
Product code for customs reference. Omitted if empty
externalReferenceId
string
External ID for products synced from external services (e.g. POS)
minPurchaseQuantity
number
Sets minimum product variation purchase quantity. Default value is taken from a base product. Not visible if the value is not assigned.
maxPurchaseQuantity
number
Sets maximum product variation purchase quantity. Default value is taken from a base product. Not visible if the value is not assigned.
lowestPrice
number
The lowest price for the last 30 days before discount.
defaultDisplayedLowestPrice
number
lowestPrice with tax
defaultDisplayedLowestPriceFormatted
string
Formatted display of defaultDisplayedLowestPrice in the store's formatting for prices
outOfStockVisibilityBehaviour
string
Indicates whether an out of stock product should visible or not. One of: SHOW, HIDE, ALLOW_PREORDER.
OptionValue
Field
Type
Description
name
string
Option name
nameTranslated
<Translations>
Available translations for product option name
value
string
Option value
valueTranslated
<Translations>
Available translations for product option value
Translations
Field
Type
Description
<ISO_LANG_CODE>
string
Translations for each available language. If no other translations are provided, the default language translations is returned. See available languages in store language settings
WholesalePrice
Field
Type
Description
quantity
number
Number of product items on this wholesale tier
price
number
Product price on the tier
AttributeValue
Field
Type
Description
id
number
Unique attribute ID. See Product Classes for the information on attribute IDs
name
string
Attribute displayed name
value
string
Attribute value
type
string
Attribute type. There are user-defined attributes, general attributes and special 'price per unit’ attributes. The 'type’ field contains one of the following: CUSTOM, UPC, BRAND, GENDER, AGE_GROUP, COLOR, SIZE, PRICE_PER_UNIT, UNITS_IN_PRODUCT
show
string
Defines where to display the product attribute value:. Supported values: NOTSHOW, DESCR, PRICE
VariationDimensions
Field
Type
Description
length
number
Length of a variation
width
number
Width of a variation
height
number
Height of a variation
Errors
In case of error, Ecwid responds with an error HTTP status code
HTTP codes
HTTP Status
Meaning
400
Request parameters are malformed
402
The "Product Variations" feature are not available on the merchant plan
404
The variation is not found. Code: COMBINATION_NOT_FOUND
415
Unsupported content-type: expected application/json or text/json
500
Cannot get the variation because of an error on the server
