Attribute list values

Information

The attribute properties of type list must have list values. This is a list of values belong to that attribute. E.q. list of colors (orange, purple, etc) for the property color

If the type is not list then the value is linked directly to the product. See Attribute scenarios

Scenarios

Attribute scenarios

Usage

URL

PUT /api/origin/{origin_code}/attributelist/{key}/
POST /api/origin/{origin_code}/attributelist

A put also results in creation of a new attribute property when the import key does not exist for this origin.

Request sample

{
    "key": "rood",
    "property": "Kleur",
    "list_value": "Rood",
    "sequence": 10,
    "css_color": "FF0000",
    "origin": "kisch"
}

Fields

Field	Mandatory	Descriptions	Remarks

Field	Mandatory	Descriptions	Remarks
key	yes	Import key of the list value	Must be unique for all list values under all properties. So a list value under attributeproperty A cannot have the same import key as a list value under attributeproperty B
property	yes	Import key of the property this list value belongs to	Can be only 1 property
list_value	yes	Name of the list value as it should be displayed at the webshop
refine_from	no
refine_till	no
sequence	no	when the sort order of the connected property is set at “sequence” the sort order as set in this field is applied to determine in which order the list values are displayed at the webshop	Can only be a numeric value
picture	no
css_color	no	hex code of the colour without the # sign
description	no
origin	yes

Documentation: https://test.cloudsuite.io/api/#tag/origin-greater-attributelist/operation/origin_attributelist_update

Attribute value translations

This translation can only be done if the list value exists.

A language has to be activated in the Cloudsuite admin to be able to update this language via the API.

When a language field is not filled the default language of the shop is shown.

Usage

URL

POST /api/origin/{origin_code}/attributelist/{key}/translations/

Request sample

{
	"list_value": [{
		"lang": "nl_NL",
		"value": "dutch name of the list value"
	},
        {
            "lang": "de_DE",
            "value": "german name of the list value"
        },
        {
            "lang": "en_US",
            "value": "english name of the list value"
        },
        {
            "lang": "es_ES",
            "value": "spanish name of the list value"
        },
        {
            "lang": "fr_FR",
            "value": "french name of the list value "
        }],
	"description": [{
		"lang": "nl_NL",
		"value": "dutch description of the list value"
	}, 
        {
            "lang": "de_DE",
            "value": "german description of the list value"
        },
        {
            "lang": "en_US",
            "value": "english description of the list value"
        },
        {
            "lang": "es_ES",
            "value": "spanish description of the list value"
        },
        {
            "lang": "fr_FR",
            "value": "french description of the list value"
        }],
}

Documentation: https://test.cloudsuite.io/api/#tag/origin-greater-attributelist-greater-translations/operation/origin_attributelist_translations_create

Attribute list values

Contents

Information

Scenarios

Usage

URL

Request sample

Fields

Attribute value translations

Usage

URL

Request sample

Related content