Endpoint Summary
This table provides quick access to the property and option query services under the Attributes section. Detailed request and response fields are included under the relevant sections.
| No | Service | Endpoint |
|---|---|---|
| 1 | Property Query | POST /api/v1/query/properties |
| 2 | Option Query | POST /api/v1/query/options |
General Technical Information
For the Attributes query endpoints on this page, authentication information is sent in the request body.
ClientId and AppKey fields are required.
This section is prepared to query the property and option definitions used in the product and variant data model. The endpoints do not create or update data; they list existing definitions.
In listing queries, PageIndex starts from 0.
PageSize determines the number of records returned on a single page.
Sorting and Status fields can be used in supported endpoints to sort results and filter active/passive records.
Records are returned in the Result field, while the total record count is returned in the TotalCount field.
Property refers to technical or descriptive fields that describe a product or variant. Values such as processor type, screen size, or warranty period can be managed with this structure.
Option refers to selection fields that enable a product to be structured into variants. Sales-related sub-breakdowns such as color, size, capacity, or measurement can be managed with the option structure.
1. Property Query — POST /api/v1/query/properties
This endpoint is used to retrieve property definitions from the Properties management screen and product/variant detail screens in the PIM UI through the API.
GetPropertiesis used to query property records centrally defined in PIM.- Property records return metadata information for descriptive fields that can be used on products and variants.
GroupIdandGroupfields indicate the property group to which the property belongs.DataTypefield determines the format in which the property will receive a value on a product or variant.DefaultValue,Values, andValueCollectionfields can be used to standardize property values.
Property Data Type Usage
The data type selected for properties determines which input field is displayed in the UI and how the value is interpreted on the API side.
| Data Type | Purpose of Use |
|---|---|
| Single Code | Used for property values that are unique or system-level codes. |
| Single-Line Text | Used for property values in short text format. |
| Long Text | Used for property values that contain longer descriptions or details. |
| Rich Text | Used for property values that require formatted text content. |
| Single Selection | Used for properties where a single value must be selected from predefined values. |
| Multiple Selection | Used for properties where multiple values can be selected from predefined values. |
| List | Used for property values that will be managed in a list structure. |
| Yes/No | Used for binary values such as yes/no or present/not present. |
| Date | Used for property values that must be stored in date format. |
| Used for fields that must receive values in email format. | |
| Phone Number | Used for fields that must receive values in phone number format. |
| URL | Used for property values in link or address format. |
| Price | Used to define values in price format. |
| Percentage | Used for properties where percentage values must be stored. |
| Duration | Used for property values that contain duration information. |
| Measurement | Used for values expressed with measurement units such as size, weight, or volume. |
Endpoint-Specific Query Parameters
This endpoint does not include any additional endpoint-specific filter parameter other than BaseQuery parameters. It can be used with pagination, sorting, and status filters.
Only common parameters: ClientId, AppKey, PageIndex, PageSize, Sorting, Status, ThreadId.
API Response Parameters and UI Equivalents
Each Property object in the Result array contains the following fields:
| API Response Field | Type | PIM UI Equivalent / Field Name | Description |
|---|---|---|---|
PropertyId | integer | Property System ID | Unique property number assigned by the system. |
GroupId | integer? | Group ID | ID of the group to which the property belongs. |
Key | string | Property Key | Technical key displayed in the property list in the UI, such as weight or color. |
DisplayName | string | Display Name | Property name displayed to the user in the UI, such as “Weight” or “Color”. |
DataType | integer | Data Type | Data type of the property, such as text, number, or boolean. |
DefaultValue | string | Default Value | Default value defined for the property. |
Values | string | Possible Values | Selectable values defined for the property, usually separated by commas. |
Extra | string | Additional Information | Additional configuration information for the property. |
ImagePath | string | Image Path | Image link for the property. |
DocumentId | string | Document ID | Document reference linked to the property. |
Group | object | Property Group | Detailed information about the group to which the property belongs. |
Status | integer | Status | 1 = Active, -1 = Passive. |
Created | datetime | Creation Date | Date when the property was added to the system. |
Updated | datetime? | Update Date | Last update date. |
Usage Guide in the UI
- Property Definitions: The definitions listed when you open the Properties page from the left menu in the UI come from this endpoint.
- Product/Variant Properties: The key-value pairs displayed on the Properties tab of a product or variant detail page are based on the
KeyandDisplayNamedefinitions returned here. - Data Types: The
DataTypefield determines the input type shown in the UI when entering a property value, such as a text box, number input, or checkbox.
2. Option Query — POST /api/v1/query/options
This endpoint is used to retrieve option definitions, such as color, size, or material, from the Options management screen and product/variant detail screens in the PIM UI through the API.
GetOptionsis used to query option records centrally defined in PIM.- Options represent selection fields that make up the variant structure of products.
GroupIdandGroupfields indicate the option group to which the option belongs.Valuesfield can be used to list the values linked to the related option.- The
OptionValuesfield returned in variant queries should be interpreted by associating it with these option definitions.
Option Data Type Usage
For options, the data type determines the value format to be used when creating variants.
| Data Type | Purpose of Use |
|---|---|
| Text | Used for option values in text format. |
| Integer | Used for option values in integer format. |
| Decimal Number | Used for option values in decimal number format. |
| Measurement | Used for option values expressed with measurement units such as size, capacity, weight, or similar values. |
Endpoint-Specific Query Parameters
This endpoint does not include any additional endpoint-specific filter parameter other than BaseQuery parameters. It can be used with pagination, sorting, and status filters.
Only common parameters: ClientId, AppKey, PageIndex, PageSize, Sorting, Status, ThreadId.
API Response Parameters and UI Equivalents
Each Option object in the Result array contains the following fields:
| API Response Field | Type | PIM UI Equivalent / Field Name | Description |
|---|---|---|---|
OptionId | integer | Option System ID | Unique option number assigned by the system. |
GroupId | integer? | Group ID | ID of the group to which the option belongs. |
Code | string | Option Code | Unique code of the option, such as color or size. |
Name | string | Option Name | Name displayed in the option list and product detail in the UI, such as “Color” or “Size”. |
DisplayName | string | Display Name | Option label displayed to the user. |
IntegrationCode | string | Integration Code | External system matching code. |
DataType | integer | Data Type | Option data type classification. |
Values | array | Option Values | List of values defined for the option, such as Red, Blue, S, M, or L. |
Group | object | Option Group | Detailed information about the group to which the option belongs. |
ProductOptions | array | Product Options | List of products to which this option is assigned. |
TrademarkOptions | array | Brand Options | List of brands to which this option is assigned. |
CategoryOptions | array | Category Options | List of categories to which this option is assigned. |
Status | integer | Status | 1 = Active, -1 = Passive. |
Created | datetime | Creation Date | Date when the option was added to the system. |
Updated | datetime? | Update Date | Last update date. |
Usage Guide in the UI
- Option Management: The definitions listed when you open the Options page from the left menu in the UI come from this endpoint.
- Option Values: The values under each option, such as the Red and Blue values of the Color option, are returned in the
Valuesarray. Each value has subfields such asValueId,Name, andCode. - Variant Creation: Variants are created based on options. The option-value pairs you select when creating a variant in the UI are returned as
OptionValueswhen you query variants from the API.
Common Error Cases
The table below is prepared for the common error cases that may apply to the endpoints under the Attributes section. When endpoint-specific error messages are finalized, they can be added to the Error Message column.
| HTTP Status | Status | Error Message |
|---|---|---|
400 | Bad Request | |
401 | Unauthorized | |
403 | Forbidden | |
404 | Not Found | |
422 | Unprocessable Entity | |
429 | Too Many Requests | |
500 | Internal Server Error |