Attribute Management

Overview

The Attribute API allows you to manage product attributes, attribute sets, and attribute mappings for your products. Attribute Sets are collections of related attributes that define the characteristics of products in specific categories or contexts.

In SellerCenter, attributes are organized into attribute sets. Each attribute set groups related attributes together (e.g., "Shoes" attribute set might contain attributes like "Size", "Color", "Material"). When creating products, you need to know which attribute set applies to your product category, and then retrieve the specific attributes within that attribute set.

Get Attribute Sets

GET /v2/attribute-sets

Summary: Get the attribute sets available.

Description: Fetch data about the available attribute sets. This endpoint returns a list of all attribute sets in the system, each containing metadata such as ID, name, label, and timestamps. Attribute sets are used to organize attributes by product type or category.

If you want to filter specific attribute sets, you can add attributeSetIds[] to the query parameters. This allows you to retrieve only the attribute sets you're interested in by providing their numeric IDs.

Note:

• Use the attributeSetIds[] parameter to filter by specific attribute set IDs: ?attributeSetIds[]=5642&attributeSetIds[]=5643
• Each attribute set has a unique numeric id and a name (internal identifier) as well as a label (display name)
• The createdAt and updatedAt fields indicate when the attribute set was created and last modified

Get Attribute Set Details

GET /v2/attribute-sets/{attributeSetId}

Summary: Get the attribute set properties.

Description: Get the name and the label of a specific attribute set by its ID. This endpoint returns detailed information about a single attribute set, including its unique identifier, internal name, display label, and timestamps.

Note:

• The attributeSetId parameter is required and must be a valid numeric ID
• Use this endpoint when you need to verify attribute set details before retrieving its attributes

Get Attribute Set Attributes

GET /v2/attribute-sets/{attributeSetId}/attributes

Summary: Get the attributes of a particular attribute set.

Description: Get the attributes of a particular attribute set. The list of attributes includes "global" attributes - those attributes which do not belong to any category and are common for all products. This endpoint is essential when creating products, as it provides all the attributes you need to fill in for products belonging to a specific attribute set.

Note:

• Global attributes are included in the response alongside attribute set-specific attributes
• Use this endpoint to get the complete list of attributes required when creating a product set
• Each attribute includes its type, validation rules, options (if applicable), and whether it's mandatory

Get Attributes

GET /v2/attributes

Summary: Fetching Attributes details by filter

Description: Return list of attributes by using given filters. Maximum limit is 100 even if a higher value is provided. If no attribute IDs nor attribute set IDs are provided then the global attributes will be listed.

This endpoint allows you to retrieve attributes with flexible filtering options. You can filter by specific attribute IDs, attribute set IDs, or retrieve only visible attributes. The response includes pagination information to help you navigate through large result sets.

Note:

• Maximum limit is 100, even if a higher value is provided
• If no attributeIds[] nor attributeSetIds[] are provided, only global attributes are returned
• The onlyVisible parameter defaults to true if not set, meaning only visible attributes are returned by default
• Use pagination parameters (limit and offset) to navigate through results

Get Attribute Details

GET /v2/attributes/{attributeId}

Summary: Fetching Attributes details by attributeId

Description: Fetching Attributes data by Attribute ID. This endpoint returns complete information about a specific attribute, including its type, validation rules, available options (for dropdown/multiselect attributes), whether it's mandatory, and other metadata needed for product creation.

Note:

• The attributeId parameter is required and must be a valid numeric ID
• Use this endpoint when you need detailed information about a specific attribute, including its options and validation rules
• Pay attention to the attributeType field to understand how values should be stored (as plain values, option IDs, or arrays of option IDs)

Generate Attributes Using AI

POST /v2/generative-attributes

Summary: Generate product attributes using AI

Description: Generate product attributes automatically by analyzing product images using AI. This endpoint accepts an array of image URLs and returns suggested attributes based on visual analysis of the products. The AI analyzes the images to detect colors, materials, patterns, and other visual characteristics that can be used as product attributes.

Note:

• Provide at least one image URL in the imageUrls array
• All image URLs must be valid and accessible
• The AI-generated attributes are suggestions and should be reviewed before use
• Generated attributes include the attribute name, attribute set, and suggested values

Important: The generated attributes are suggestions based on image analysis. Always review and validate the suggested attributes before using them in product creation.

Get Mapped Attribute Options

GET /v2/mapped-attribute-options

Summary: Get all mapped attributes and options

Description: Some attributes in SellerCenter can have "dependent" attributes. Imagine attribute "MainColor" with value "Red", "Green" and another attribute "DetailedColor" with values like "Light Red", "Pink Red", "Dark Red", "Scarlet Red", "Deep Green", "Lime", etc. When you set MainColor as "Green" all values for DetailedColor like "Light Red" and "Pink Red" are not valid.

This endpoint returns this mapping so that you will see that for attribute "MainColor" with value "Green" valid values for attribute "DetailedColor" are "Deep Green" and "Lime".

Note:

• Use this endpoint to understand attribute dependencies and valid option combinations
• The mapping helps ensure you only use valid attribute option combinations when creating products
• Each mapping entry contains a parent attribute/option pair and its valid child attribute/option pairs