AppsThemesSupport

Variant

🔒

Requires product access scope.

Variant Properties

FieldsTypeDesc
option1stringThe value of the variant for the first product option.

If there's no first product option, then nil is returned.
option2stringThe value of the variant for the second product option.

If there's no second product option, then nil is returned.
option3stringThe value of the variant for the third product option.

If there's no third product option, then nil is returned.
imageimage The image is attached to the variant. Mandatory if need_variant_image is true
compare_at_pricestringThe compare at price of the variant in the currency's subunit.

The value is output in the customer's local (presentment) currency.
pricestringThe price of the variant in the currency's subunit.

The value is output in the customer's local (presentment) currency.
cost_pricestringThe cost price of the variant.
positionintegerThe position of the variant.
skustringThe SKU of the variant.
barcodestringThe barcode of the variant.
notestringThe note of the variant.
invetory_quantityint32The inventory quantity of the variant.
weightstringThe weight of the variant.
weight_unitstringThe unit for the weight of the variant, supports kg, g, lb, oz
wholesale_priceWholesalePriceThe wholesale price of the variant.
extendExtend

WholesalePrice

FieldsTypeDesc
pricestringWholesale price.
min_quantityintegerMini Order Quantity

Extend

FieldsTypeDesc
lengthnumber
widthnumber
heightnumber
dimension_unitstring
origin_country_codestringCountry of origin code of the product.
hs_codestringHS codes are the international standard for commodity classification, and Shoplazza can automatically generate HS codes based on commodity information.

Example

{
  "id": "e9a785a4-739b-45e6-93bb-d056d706c295",
  "product_id": "a1a88be0-a1d4-47e4-a2f2-ba6e131cf447",
  "image_id": "8ef098c5-5a08-44b4-b5fb-89214bb507dc",
  "created_at": "2024-04-17T02:15:18Z",
  "updated_at": "2024-04-17T02:15:35Z",
  "title": "L-blue-S",
  "option1": "L",
  "option2": "blue",
  "option3": "S",
  "image": {
    "src": "//cdn.shoplazza.com/ccf0794c594bad32a320eea0d6bfe40c.jpeg",
    "width": 174,
    "height": 180,
    "path": "ccf0794c594bad32a320eea0d6bfe40c.jpeg",
    "alt": ""
  },
  "position": 6,
  "compare_at_price": "12.10",
  "price": "10.10",
  "sku": "T-M-L-blue-S-A001009",
  "barcode": "6929000212340",
  "note": "node",
  "inventory_quantity": 10,
  "weight": "1.10",
  "weight_unit": "kg",
  "cost_price": "1.10",
  "wholesale_price": [
    {
      "price": "10.10",
      "min_quantity": 1
    }
  ],
  "extend": {
    "length": 10,
    "width": 10,
    "height": 10,
    "dimension_unit": "in",
    "origin_country_code": "AS",
    "hs_code": "62114390"
  }
}