Brand Management

Overview

The Brands API allows you to retrieve brand information, manage brand details, and access brand-specific attributes and restrictions. Brands are essential identifiers for products in your catalog and can be either restricted (requiring permission) or non-restricted (freely usable).

In SellerCenter, brands can be either restricted or non-restricted:

• Non-restricted brands: Can be used immediately without any approval when creating products
• Restricted brands: Require explicit permission to use. You must request access before creating products with these brands

Get List Of Brands

GET /v2/brands

Summary: Get list of brands by filter

Description: This endpoint returns the brands based on some filter parameters. The available options are: id, uuid and name. Multiple filters can be used at the same time returning the brands who matched all the filters. The includeInaccessible parameter when passed, all brands are returned, otherwise, only the brands that are available for the current seller are returned.

In SellerCenter some brands are "restricted" and others are not. When brand is not restricted, it means that you can use without any actions from your side. When brand is restricted, it means that you need to request access to use it. The restrictedOnly parameter when passed, only the restricted brands are returned (both accessible and not accessible for current seller, or in other words both current seller has permission to sell and also those current seller has no permission to sell).

If you want to get only the brands that you have permission to sell, you should pass the includeInaccessible=false and in this case only brands that you have permission to sell are returned.

Note: Here is an example of how to use the includeInaccessible and restrictedOnly parameters:

• includeInaccessible=false&restrictedOnly=true - returns only restricted brands that you have permission to sell.
• includeInaccessible=true&restrictedOnly=true - returns all restricted brands, both current seller has permission to sell and also those current seller has no permission to sell.
• includeInaccessible=true&restrictedOnly=false - default behaviour, returns all brands, both restricted and not restricted.
• includeInaccessible=false&restrictedOnly=false - returns only brands that you have permission to sell, including restricted brands allowed for current seller and not restricted brands (those allowed in general).

Get Brand Details

GET /v2/brands/{brandId}

Summary: Get single brand by ID

Description: Get detailed information about a specific brand by its ID. This endpoint returns the full details of a single brand including its name, description, logo URL, status, and accessibility information for your seller account. Use this to verify brand information before creating products or to check if a specific brand is accessible to you.

Get Brand Attributes

GET /v2/brands/{brandId}/attributes

Summary: Get mapped attribute options for the brand

Description: In SellerCenter there is a feature "brand scale to attribute mapping". This feature maybe enabled or disabled. You can know this by looking to config value brand/scale_mapping/enabled. If it is disabled, then sizeSystem is not relevant and all further information is not applicable.

If it is enabled, then in config parameter brand/scale_mapping/attribute there will be numeric ID of so called "size scale attribute". This attribute is always a dropdown and has several options. Example names of options for that attribute are usually looks like: CL_W_JEANS, CL_W_SOCKS_EUR, CL_U_INT.

Some brands require only certain size scale values to be chosen, for example brand X may allow CL_W_JEANS, CL_W_SOCKS_EUR but not allow CL_U_INT. By requesting endpoint /v2/brands/{brandId}/attributes you can get information about which size scale options are allowed for this brand.

Note: Please, keep in mind that empty array in this endpoint means "there are no restrictions for this brand, all size scale options are available". So when you know brand of your product set and "brand scale to attribute mapping" feature is enabled you can get list of allowed options for size scale attribute and you can use only them when you create or update product set.

Value of that "size scale" attribute should be treated as any other attribute and you need to put it in the list of other attributes' values.

Important: When you have "size scale" attribute with ID=12 and you found that desired value for this attribute is CL_W_JEANS (ID=9342), then during creation or updating of product set you need to pass this value both in list of attributes and in sizeSystem property. To be more precise request will look like:

Please, keep in mind that other mappings can be also applied. Example: brand X allow CL_W_JEANS, CL_W_SOCKS_EUR but not allow CL_U_INT. When you create product set in category "Jeans" there can be category-to-attribute mapping that allows for that certain category only CL_W_JEANS. So even if CL_W_SOCKS_EUR is allowed by brand, but attempt to create product set with this size system will fail because that particular category does not allow it.

If brand/scale_mapping/enabled = 0, then you can pass null to "sizeSystem".

Get Restricted Brands

GET /v2/restricted-brands

Summary: Get list of restricted brands by filter

Description: In SellerCenter some brands are "restricted" and others are not. When brand is restricted, it means that you need to request access to use it. This endpoint returns the restricted brands based on some filter parameters. The available options are: status and approved.

Status of brand: active, inactive, deleted. The field determine status of restricted brands.

Approved field determine user's approved brands. In restricted brands, some brands will be approved and available for specific users, and some brands will be not approved and not available for specific sellers. This field is used to filter the brands that current seller has permission to sell.

Note: Use the approved parameter to filter brands:

• approved=true - returns only restricted brands that you have permission to sell
• approved=false - returns only restricted brands that you don't have permission to sell