---
title: "Get Seller Attributes"
method: GET
path: "/v1/channel/attribute/seller/{sellerId}"
tags: ["Attributes"]
---

# Get Seller Attributes

`GET /v1/channel/attribute/seller/{sellerId}`

## Request

- Base URL: `https://scx-sbx.api.jtl-software.com`
- URL: `https://scx-sbx.api.jtl-software.com/v1/channel/attribute/seller/{sellerId}`
- Auth: HTTP bearer
- TypeScript: <https://skmtc.dev/jtl-software/apis/scx-authentication-api/docs/v1/channel/attribute/seller/:sellerId/get.ts> (a function with typed inputs; its response is checked against the schema)

Get Seller specific attributes

## Path parameters

- `sellerId` string, required: A unique Id identify a Seller on a specific SalesChannel. The SellerId is generated from the Channel itself during the Seller SignUp Process.

## Response `200`

Attribute list retrieved

- AttributeListSchema: Versioned list of attribute definitions published by the channel.
  - `attributeListVersion` string
  - `attributeList` Attribute[]
    - `attributeId` string, required: AttributeId must be a category tree wide unique identifer.
    - `displayName` string, required: Display name is used to display the attribute inside a User Interface.
    - `isMultipleAllowed` boolean: Define if there is more than one value allowed for this attribute.
    - `type` 'smalltext' | 'htmltext' | 'text' | 'integer' | 'decimal' | 'enum' | 'date' | 'boolean' | 'image' | 'document' | 'url' | 'label': Attribute type decribe which kind of data is expecet for a particular attribute. * Type **smalltext** is considerd a plain text any may not exceed more than 255 characters. * Type **text** is considerd plain text and may not exceed a maximum length more than 50.000 characters. * Type **htmltext** may be used for text where HTML Markup is allowed. The maximum lengh schould not exceed more than 50.000 characters. * Type **date** must follow [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) standard with Timezone. * Type **enum** may provide data with enumValues property * Type **image** a attribute with an existing remote File uploaded using `POST /v1/seller/offer/file` * Type **document** a attribute with an existing remote File uploaded using `POST /v1/seller/offer/file` * Type **url** must match a URL Schema * Type **label** can be used as help text. Requires description to be set
    - `values` AllowedValue[]: A set of possible choices for this specific attribute, in the form of a list of possible enumerations.
      - `value` string, required: An enumeration to include in the set. The enumeration bust be string-based. Example: '1', 'green_l_st'
      - `display` string: An optional alias for the enumeration, which will be shown in the GUI. If left empty, the value will be shown instead. Example: 'Red', 'Light Green + Striped'
      - `sort` integer: Specifies the order of values
    - `attributeValueValidation` string: Regular expression to validate attribute value
    - `conditionalMandatoryBy` object[], nullable: This property defines conditional mandatory settings
      - `attributeId` string: AttributeId must be a category tree wide unique identifer.
      - `attributeValues` string[]
    - `conditionalOptionalBy` object[], nullable: This property defines conditional optional settings
      - `attributeId` string: AttributeId must be a category tree wide unique identifer.
      - `attributeValues` string[]
    - `required` boolean
    - `recommended` boolean: A Channel may recommend to have a attribute set when lisitng a offer on a certain markatplace to gain more visibility and potential transactions.
    - `section` string: Optinal attribute to assign a attribute to a specific section. A section can be used by a Seller Integration to show attributes grouped inside a identical section name.
    - `sectionPosition` integer: Section position is used to sort attributes in descending order inside a section. This property may be used by a Seller Integration to determine display sequence in a User Interface.
    - `isRepeatableSubSection` boolean, nullable: A repeatable subSection can be used to group related attributes together. Those related set of attributes is repeatable as a group. When thoese attributes are transmitted to the SCX-Seller API as Channel Attributes they must have the "group" property filled with a unique identifier. This attribute affect the subSection property. All subsections with the same name must have the same value isRepeatableSubSection and musst not be mixed with different settings.
    - `subSection` string: A sub section can be used to build a group of attributes inside a section.
    - `subSectionPosition` integer: Sub section position is used to sort attributes in descending order. This property may be used by a Seller Integration to determine display sequence in a User Interface inside identicy **section**s
    - `description` string: Describe the purpose of an Attribute.
    - `isVariationDimension` boolean
    - `enumValues` string[]: (DEPRECATED - use values property instead) If the attribte type equals to ENUM this propertie must be set.

## Other responses

- `401`: Access forbidden, invalid or unknown Token was used.
- `500`: Unexpected Server Error

---

[API](https://skmtc.dev/jtl-software/apis/scx-authentication-api.md) - [All operations](https://skmtc.dev/jtl-software/apis/scx-authentication-api/llms.txt) - [OpenAPI document](https://skmtc.dev/jtl-software/apis/scx-authentication-api/revisions/f979b1ea6951?raw)