Variants

Variants represent the different options of a product, such as size, color, or material combinations. Each variant has its own pricing, stock level, and identifiers. All variant endpoints are scoped to a language.

The variant model

The variant model contains all the information about a specific product variant, including pricing, stock, and any custom attributes you have defined.

Properties

  • Name
    id
    Type
    string
    Description

    Unique identifier for the variant.

  • Name
    product_id
    Type
    string
    Description

    The identifier of the product this variant belongs to.

  • Name
    article_code
    Type
    string
    Description

    The article code for the variant.

  • Name
    default
    Type
    boolean
    Description

    Whether this is the default variant for the product.

  • Name
    title
    Type
    string
    Description

    The title of the variant, for example "Blue / Size M".

  • Name
    ean
    Type
    string
    Description

    The EAN (barcode) number of the variant.

  • Name
    main_image
    Type
    string
    Description

    URL of the main image for the variant.

  • Name
    sku
    Type
    string
    Description

    The stock keeping unit identifier.

  • Name
    url
    Type
    string
    Description

    The URL of the variant on your webshop.

  • Name
    old_price_excl
    Type
    float
    Description

    The old price excluding tax.

  • Name
    old_price_incl
    Type
    float
    Description

    The old price including tax.

  • Name
    price_cost
    Type
    float
    Description

    The cost price of the variant.

  • Name
    price_excl
    Type
    float
    Description

    The current price excluding tax.

  • Name
    price_incl
    Type
    float
    Description

    The current price including tax.

  • Name
    stock_level
    Type
    integer
    Description

    The current stock level of the variant.

  • Name
    created_at
    Type
    timestamp
    Description

    Timestamp of when the variant was created.

  • Name
    updated_at
    Type
    timestamp
    Description

    Timestamp of when the variant was last updated.

  • Name
    custom_attributes
    Type
    array
    Description

    An array of custom attribute objects with name and a value field (string_value, integer_value, date_value, datetime_value, or boolean_value).


GET/v2/languages/:language_id/variants

List all variants

This endpoint allows you to retrieve a paginated list of all variants for a given language. By default, a maximum of ten variants are shown per page, with a maximum of 250 per page.

Optional attributes

  • Name
    page
    Type
    integer
    Description

    Page offset to fetch. Defaults to 1.

  • Name
    per_page
    Type
    integer
    Description

    Number of variants per page. Defaults to 10, maximum 250.

  • Name
    created_after
    Type
    timestamp
    Description

    Only return variants created after this date.

  • Name
    created_before
    Type
    timestamp
    Description

    Only return variants created before this date.

  • Name
    updated_after
    Type
    timestamp
    Description

    Only return variants updated after this date.

  • Name
    updated_before
    Type
    timestamp
    Description

    Only return variants updated before this date.

Request

GET
/v2/languages/:language_id/variants
curl -G https://app.reloadify.com/api/v2/languages/en/variants \
  -H "Authorization: Bearer {token}" \
  -d per_page=10 \
  -d page=1

Response

{
  "data": [
    {
      "id": "var_abc123",
      "product_id": "prod_001",
      "article_code": "TEE-BLU-M",
      "default": true,
      "title": "Blue / Size M",
      "ean": "8712345678901",
      "main_image": "https://example.com/images/tee-blue-m.jpg",
      "sku": "TEE-BLU-M-001",
      "url": "https://example.com/products/tee?variant=blue-m",
      "old_price_excl": 34.71,
      "old_price_incl": 39.99,
      "price_cost": 12.50,
      "price_excl": 24.79,
      "price_incl": 29.99,
      "stock_level": 42,
      "created_at": "2025-11-04T12:00:00Z",
      "updated_at": "2026-01-15T09:30:00Z",
      "custom_attributes": [
        {
          "name": "color",
          "string_value": "blue"
        }
      ]
    },
    {
      "id": "var_def456"
      // ...
    }
  ]
}

PUT/v2/languages/:language_id/variants

Create or update a variant

This endpoint allows you to create a new variant or update an existing one. If a variant with the given ID already exists, it will be updated.

Required attributes

  • Name
    id
    Type
    string
    Description

    The unique identifier for the variant in your system.

  • Name
    product_id
    Type
    string
    Description

    The identifier of the product this variant belongs to.

Optional attributes

  • Name
    article_code
    Type
    string
    Description

    The article code for the variant.

  • Name
    default
    Type
    boolean
    Description

    Whether this is the default variant for the product.

  • Name
    title
    Type
    string
    Description

    The title of the variant.

  • Name
    ean
    Type
    string
    Description

    The EAN (barcode) number.

  • Name
    main_image
    Type
    string
    Description

    URL of the main image.

  • Name
    sku
    Type
    string
    Description

    The stock keeping unit identifier.

  • Name
    url
    Type
    string
    Description

    The URL of the variant on your webshop.

  • Name
    old_price_excl
    Type
    float
    Description

    The old price excluding tax.

  • Name
    old_price_incl
    Type
    float
    Description

    The old price including tax.

  • Name
    price_cost
    Type
    float
    Description

    The cost price of the variant.

  • Name
    price_excl
    Type
    float
    Description

    The current price excluding tax.

  • Name
    price_incl
    Type
    float
    Description

    The current price including tax.

  • Name
    stock_level
    Type
    integer
    Description

    The current stock level.

  • Name
    created_at
    Type
    timestamp
    Description

    Timestamp of when the variant was created.

  • Name
    updated_at
    Type
    timestamp
    Description

    Timestamp of when the variant was last updated.

  • Name
    custom_attributes
    Type
    array
    Description

    An array of custom attribute objects. Each object requires a name and one value field: string_value, integer_value, date_value, datetime_value, or boolean_value.

Request

PUT
/v2/languages/:language_id/variants
curl -X PUT https://app.reloadify.com/api/v2/languages/en/variants \
  -H "Authorization: Bearer {token}" \
  -H "Content-Type: application/json" \
  -d '{
    "variant": {
      "id": "var_abc123",
      "product_id": "prod_001",
      "title": "Blue / Size M",
      "sku": "TEE-BLU-M-001",
      "ean": "8712345678901",
      "default": true,
      "price_excl": 24.79,
      "price_incl": 29.99,
      "stock_level": 42,
      "custom_attributes": [
        {
          "name": "color",
          "string_value": "blue"
        }
      ]
    }
  }'

Response

{
  "id": "var_abc123",
  "product_id": "prod_001",
  "article_code": "TEE-BLU-M",
  "default": true,
  "title": "Blue / Size M",
  "ean": "8712345678901",
  "main_image": "https://example.com/images/tee-blue-m.jpg",
  "sku": "TEE-BLU-M-001",
  "url": "https://example.com/products/tee?variant=blue-m",
  "old_price_excl": 34.71,
  "old_price_incl": 39.99,
  "price_cost": 12.50,
  "price_excl": 24.79,
  "price_incl": 29.99,
  "stock_level": 42,
  "created_at": "2025-11-04T12:00:00Z",
  "updated_at": "2026-01-15T09:30:00Z",
  "custom_attributes": [
    {
      "name": "color",
      "string_value": "blue"
    }
  ]
}

GET/v2/languages/:language_id/variants/:variant_id

Retrieve a variant

This endpoint allows you to retrieve a variant by providing the variant ID. Refer to the model at the top of this page to see which properties are included with variant objects.

Request

GET
/v2/languages/en/variants/var_abc123
curl https://app.reloadify.com/api/v2/languages/en/variants/var_abc123 \
  -H "Authorization: Bearer {token}"

Response

{
  "id": "var_abc123",
  "product_id": "prod_001",
  "article_code": "TEE-BLU-M",
  "default": true,
  "title": "Blue / Size M",
  "ean": "8712345678901",
  "main_image": "https://example.com/images/tee-blue-m.jpg",
  "sku": "TEE-BLU-M-001",
  "url": "https://example.com/products/tee?variant=blue-m",
  "old_price_excl": 34.71,
  "old_price_incl": 39.99,
  "price_cost": 12.50,
  "price_excl": 24.79,
  "price_incl": 29.99,
  "stock_level": 42,
  "created_at": "2025-11-04T12:00:00Z",
  "updated_at": "2026-01-15T09:30:00Z",
  "custom_attributes": [
    {
      "name": "color",
      "string_value": "blue"
    }
  ]
}

DELETE/v2/languages/:language_id/variants/:variant_id

Delete a variant

This endpoint allows you to delete a variant. Be careful — this action is irreversible and will remove all data associated with the variant.

Request

DELETE
/v2/languages/en/variants/var_abc123
curl -X DELETE https://app.reloadify.com/api/v2/languages/en/variants/var_abc123 \
  -H "Authorization: Bearer {token}"

Was this page helpful?