ProductVariantList_Load_Product

Retrieves the variants of a product, with the parts and attribute options that make up each one. Variants in Miva are the different attribute combinations, typically used to track inventory at the attribute level. Use Limits and Exclusions to narrow the list to variants with or without certain attributes and options.

Before you begin#

• The API token needs ProductVariantList_Load_Product, either assigned directly under Functions or through a group. See Create an API token.
• Requests must be signed if the token requires it. See Make a signed request with HMAC.
• You need the product’s ID, code or SKU.

Example requests#

Retrieve a product’s variants#

Returns every variant of the product with code tshirt.

{
    "Store_Code": "{{Store_Code}}",
    "Miva_Request_Timestamp": "{{$timestamp}}",
    "Function": "ProductVariantList_Load_Product",
    "Product_Code": "tshirt"
}

Request parameters#

Limits Object#

Limits the results to variants that include attributes/options defined.

Exclusions Object#

Limits the results to variants that do not include attributes/options defined.

Example response#

{
  "success": 1,
  "data": [
    {
      "product_id": 16,
      "variant_id": 15,
      "parts": [
        {
          "product_id": 20,
          "product_code": "tshirt_medium_red",
          "product_name": "T-Shirt size:medium color:red",
          "quantity": 1
        }
      ],
      "dimensions": [
        {
          "attr_id": 3,
          "attmpat_id": 0,
          "option_id": 9,
          "option_code": "medium"
        },
        {
          "attr_id": 5,
          "attmpat_id": 0,
          "option_id": 12,
          "option_code": "red"
        }
      ]
    },
    ...
  ]
}

Response parameters#

parts Object#

Parts which make up the variant. Unless the variant is a kit, each variant will have a single part. The part is the non-active product used to store pricing and inventory data.

dimensions Object#

Dimensions is an object containing the different combinations of attributes which make up this variant.

Related functions#

Try in Postman#

In the Miva: JSON API: Authenticated collection, open Products > ProductVariantList_Load_Product. See Set Up Postman.