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

Request

POST

`ProductCategoryAttributeRequest`

Field Name	Type	Description
AuthorizationToken	`String`	Authorization Token from the customers integration
CategoryIds	`String[]`	Defines the category ids the customer has selected.
GeneralSettings	`Setting[]`	See Setting table. Defines the settings the customer has filled out based on what was provided by the developer in the GetConfiguratorSettings call.

`Setting`

Field Name	Type	Description
ID	`String`	ConfigItemId defined in GetConfiguratorSettings.
Values	`String[]`	The value(s) chosen by the customer for this setting.

Sample

{
  "AuthorizationToken": "0dfdbaf3e4d5434f825e774e31bcc148",
  "CategoryIds": [
    "3",
    "8"
  ],
  "GeneralSettings": []
}

Response

`ProductCategoryAttributeResponse`

Field Name	Type	Description
Attributes	`ListingCategoryAttribute[]`	See ListingCategoryAttribute table.
Error	`String`	Defines if there was an error with the request and returns it.

`ListingCategoryAttribute`

Field Name	Type	Description
ID	`String`	Id of the attribute.
FriendlyName	`String`	Name of the attribute displayed to the customer in the attributes window.
Description	`String`	Is used for the tooltip of the attribute to give the customer additional information to help him understand what this attribute is exactly.
MustBeSpecified	`MustBeSpecified`	See MustBeSpecified table. Defines how the attribute will be marked in the attributes window.
ExpectedType	`String`	Determines what type of value is expected. See ExpectedType
ValueOptions	`String[]`	Provides a list of options the customer can select the attribute value from.
ValueFromOptionsList	`Boolean`	Set to true if setting ValueOptions
MaxAttributeUse	`Integer`	Defines how often each attribute can be set by the customer for any given listing. E.g. you might only be allowed to set 1 condition, but have several different Tags. Default is 0 must be set to 1 or more
AttribueReadFrom	`AttribueReadFrom`	Defines where the attribute will be read from. See AttribueReadFrom
RegExValidation	`String`	Defines the regular expression to use to validate the entered value on save. Only used when ExpectedType is set to "String".
RegExError	`String`	Defines the error message to display to user when the entered value fails RegEx validation.

`MustBeSpecified (Flagged Enum)`

Flag	Numeric Value	Description
Required	`1`	Means that the attribute has to be set by the customer in order to create the listing and cannot be left empty and will be auto added to the selected attributes in the attributes screen.
Desired	`2`	Means that the attribute value can remain empty in order to create/update the listing.

`ExpectedType (Flagged Enum)`

Flag	Numeric Value	Description
STRING	`1`	String
INT	`2`	Integer
DECIMAL	`3`	Decimal
BOOL	`4`	Boolean
DATETIME	`5`	DateTime
LIST	`6`	List

`AttribueReadFrom (Flagged Enum)`

Flag	Numeric Value	Description
Child	`0`	Means that the attribute will be read and added to each variation child item.
Parent	`1`	Means that the attribute will be read and added to the variation parent item (if a variation listing).
Optional	`2`	Means that the customer can decide themselves if it should be read from the parent or each child item..

Sample

{
  "Attributes": [
    {
      "AttribueReadFrom": "Child",
      "Description": "Color",
      "ExpectedType": "STRING",
      "FriendlyName": "Color",
      "MaxAttributeUse": 1,
      "MustBeSpecified": "Required",
      "RegExError": null,
      "RegExValidation": null,
      "ValueFromOptionsList": true,
      "ValueOptions": [
        "Red",
        "Green",
        "Blue"
      ]
    }
  ],
  "Error": null
}