Endpoint - GetVariationsByCategory

Endpoint which returns a list of required variation options. This is used e.g. when configurator variation window is opened. Request contains selected customer category ids and filled customer settings that can be used to determine the list of required variations to be returned.

This endpoint returns a list of required variation options. This is used e.g. when configurator variation window is opened. Request contains selected customer category ids and filled customer settings that can be used to determine the list of required variations to be returned

Request

Post

ConfigTestRequest

Field NameTypeDescription
AuthorizationTokenStringAuthorization Token from the customers integration.
CategoryIdsString[]Category IDs customer has selected.
GeneralSettingsSetting[]See Setting table. The settings the customer has filled out based on what was provided by the developer in the GetConfiguratorSettings call. Settings to be sent here are those that have GroupName "GENERAL" and "VARIATION". See Settings.

Setting

Field NameTypeDescription
IDStringConfigItemId defined in GetConfiguratorSettings.
ValueString[]The value(s) chosen by the customer for this setting.

Sample

{
  "AuthorizationToken": "0dfdbaf3e4d5434f825e774e31bcc148",
  "CategoryIds": [
    "3",
    "8"
  ],
  "GeneralSettings": [
    {
      "ID": "VariationTheme",
      "Values": [
        "Color-Size"
      ]
    }
  ]
}

Response

ProductCategoryVariationsResponse

Field NameTypeDescription
ErrorStringDefines if there was an error with the request and returns it.
MaxVariationAttributesIntegerHow many variation attributes (e.g. color, size) can be used for a listing.
NeededVariationsListingCategoryVariation[]See ListingCategoryVariation table. For the selected category IDs and filled in settings, any variation attributes that have to be specified if it is a variarion listing. E.g. if a variation listing was created each variation has to have color and size set. See ListingCategoryVariation table.

ListingCategoryVariation

Field NameTypeDescription
VariationNameStringVariation attribute name e.g. color, size, gender etc.
DescriptionStringIs used for the tooltip of the variation attribute to give the customer additional information to help him understand what this attribute is exactly.

Sample

{
  "Error": null,
  "MaxVariationAttributes": 50,
  "NeededVariations": {}
}