Endpoint Summary
This table provides quick access to the trademark query service under the Trademarks section. Detailed request and response fields are included under the relevant section.
| No | Service | Endpoint |
|---|---|---|
| 1 | Trademark Query | POST /api/v1/query/trademarks |
General Technical Information
For the Trademarks query endpoint on this page, authentication information is sent in the request body.
ClientId and AppKey fields are required.
This section is prepared to query the trademark records used in the product catalog. The endpoint does not create or update data; it lists existing trademark definitions.
Trademark records can be managed hierarchically through parent and child trademark relationships.
This relationship is interpreted in the response through the ParentId and, if available, Children fields.
When matching trademarks with external systems, TrademarkId, Code, and IntegrationCode fields can be used as references.
Records are returned in the Result field, while the total record count is returned in the TotalCount field.
Trademark represents the manufacturer, brand, or commercial identity information associated with products. Trademark data can be used as reference data in product listing, filtering, search, category pages, and campaign scenarios.
Managing trademark information centrally and consistently prevents the same trademark from being created repeatedly under different names across the catalog and enables healthier product-trademark relationship management.
1. Trademark Query — POST /api/v1/query/trademarks
This endpoint is used to retrieve trademark information from the Trademarks list and product details in the PIM UI through the API.
GetTrademarksis used to query trademark records centrally defined in PIM.TrademarkIdsparameter can be used to query specific trademark records by ID.Namesparameter enables filtering by trademark name.ParentIdfield indicates the parent trademark relationship, if any; for child trademark structures, theChildrenfield can be checked.SortOrderfield can be used to interpret ordering in trademark listings or storefront displays.Translationsfield may include translations of trademark names and descriptions in different languages.
Usage Notes for Trademark Data
- In product queries, the trademark relationship can be used to interpret the product's trademark association.
- Trademark information can be one of the filter values shown to users in category and product filters.
- Active/passive trademark records should be evaluated separately in product listing and filtering scenarios.
- In multi-system integrations, it is recommended to use a code or integration code instead of only the trademark name when matching trademarks.
Endpoint-Specific Query Parameters
| API Parameter | Type | PIM UI Equivalent / Meaning | Description |
|---|---|---|---|
TrademarkIds |
array (integer) |
Trademark System ID List | Used to filter specific trademarks by ID. |
Names |
array (string) |
Trademark Name Filter | Exact-match filter by trademark name. |
API Response Parameters and UI Equivalents
Each Trademark object in the Result array contains the following fields:
| API Response Field | Type | PIM UI Equivalent / Field Name | Description |
|---|---|---|---|
TrademarkId | integer | Trademark System ID | Unique trademark number assigned by the system. |
ParentId | integer? | Parent Trademark ID | ID of the parent trademark in the hierarchy. |
Name | string | Trademark Name | Name displayed in the trademark list and product detail in the UI. |
Code | string | Trademark Code | Unique code of the trademark. |
IntegrationCode | string | Integration Code | External system matching code. |
ShortDescription | string | Short Description | Short description in the trademark detail. |
LongDescription | string | Long Description | Long description in the trademark detail. |
SortOrder | integer | Sort Order | Display order in the trademark list. |
Children | array | Child Trademarks | List of child trademarks under the trademark. |
Products | array | Products in the Trademark | List of products linked to the trademark. |
Pictures | array | Trademark Images | Images assigned to the trademark. |
Properties | array | Trademark Properties | Custom fields defined for the trademark. |
Filters | array | Trademark Filters | Filter configurations defined for the trademark. |
Tags | array | Trademark Tags | Tags assigned to the trademark. |
Options | array | Trademark Options | Options defined for the trademark. |
Translations | array | Multilingual Values | Translations of the trademark name and descriptions. |
Status | integer | Status | 1 = Active, -1 = Passive. |
Created | datetime | Creation Date | Date when the trademark was added to the system. |
Updated | datetime? | Update Date | Last update date. |
Usage Guide in the UI
- Trademark Hierarchy: Similar to categories, trademarks can also have a hierarchical structure. The
ParentIdandChildrenfields reflect this structure. - Product-Trademark Relationship: When you select a trademark in the product detail in the UI, the product is associated with this trademark. When you query products from the API, the related trademark information is returned in the
TrademarkProductsarray.
Common Error Cases
The table below is prepared for the common error cases that may apply to the endpoint under the Trademarks 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 |