Get Attributes for category

Returns the Attributes for given category. Attributes denote the inputs needed to list a product in that category.

Response Details

Category Attributes are grouped into 4 groups:

  1. PRODUCT_DETAILS
  2. PRICING_AND_SHIPPING
  3. PRODUCT_ATTRIBUTES
  4. IMAGES

Each group will have a list of attributes with attributeInfo & attributeValidations.

AttributeInfo has the following params:

  1. id - unique identifier of the attribute
  2. name - name of the attribute
  3. displayName - display name of the attribute
  4. dataType - data type of the attribute; with possible values: INTEGER, LONG, DOUBLE, STRING, BOOLEAN, IMAGE
  5. mandatory
  6. helpText - description of the attribute if any
  7. helpLink - as of now applicable only for image attributes & holds a url of the guideline image

AttributeValidations is a list of validations where the data changes as per the field type with possible values RANGE, SELECT, MAX_LENGTH, INVALID_CHARS

If the type is

  1. RANGE, it contains
    min - minimum value of the attribute
    max - maximum value of the attribute
  2. SELECT, it contains
    values - list of values to be selected from
    freeText - if true, other values than the above provided are also allowed
  3. MAX_LENGTH, it contains
    maxLength - max length of the attribute value
  4. INVALID_CHARS,
    characters - string represents the disallowed characters

Request

ParameterNameDataTypeParameterTypeRequirementDescription
categoryIdintPathMandatoryId of the category (has to be product type) for which attributes are required

Response

metadata :

FieldNameDataTypeDescription
requestIdStringUnique ID for the request
clientIdStringPartnerI Id
responseTimeLongResponse Time
requestedURIStringRequested URI
messageStringError message

payload : Map<String, List> where Key is Category Attributes and value is List of AttributeMetadata Objects

AttributeMetadata:

FieldNameDataTypeDescription
attributeAttributeCategory attributes
validationsListList of AttributeValidations

Attribute :

FieldNameDataTypeDescription
idIntegerAttribute id
nameStringAttribute name
displayNameStringdisplayName
dataTypeStringdataType
mandatorybooleanmandatory
helpTextStringhelpText
helpLinkStringhelpLink

AttributeValidation : There are total 4 types of attrubte validations.these attrubte validations are depands on categories

FieldNameDataTypeDescription
typeStringValidation Type.value=SELECT
freeTextStringfreeText
valuesList<?>values
FieldNameDataTypeDescription
typeStringValidation Type.value=RANGE
maxNumbermax
minNumbermin
FieldNameDataTypeDescription
typeStringValidation Type.value=INVALID_CHARS
charactersStringcharacters
FieldNameDataTypeDescription
typeStringValidation Type.value=MAX_LENGTH
max_lengthIntegermax_length
Language
Authorization