/v2/providers/seller_api/apis/api/v1/marketplace/meta/category-related-metas/display-category-codes/{displayCategoryCode}v1Category Metadata Query
Summary
Available buyer market: Korean Use the displayCategoryCode to search for the list of public notices, options, required documents, and certification information belonging to the corresponding category.
Details
Path
GET
/v2/providers/seller_api/apis/api/v1/marketplace/meta/category-related-metas/display-category-codes/{displayCategoryCode}
Example Endpoint
Request Parameters
Path Segment Parameter
| Name | Required | Type | Description | ||||
|---|---|---|---|---|---|---|---|
| displayCategoryCode | O | Number |
Display category code
|
||||
Request Example
not require body
Response Message
|
Name |
Type |
Description |
|||||||||||||||
|
code |
Number |
Result code: |
|||||||||||||||
|
message |
String |
Result message |
|||||||||||||||
|
data |
Array |
Category metadata; |
|||||||||||||||
|
|
isAllowSingleItem |
Boolean |
Whether a single item can be listed or not |
||||||||||||||
|
|
attributes |
Array |
Category option list (Purchase option/search option ) |
||||||||||||||
|
|
|
attributeTypeName |
String |
Option type name |
|||||||||||||
|
|
|
required |
String |
|
|||||||||||||
|
|
|
dataType |
String |
Data type
|
|||||||||||||
|
|
|
basicUnit |
String |
Basic unit |
|||||||||||||
|
|
|
usableUnits |
Array |
List of usable units |
|||||||||||||
|
|
|
groupNumber |
String |
Group attributes (Whether it is in the format that offers the option of choosing attributes) |
|||||||||||||
|
|
|
exposed |
String |
Purchase option/search option separator
|
|||||||||||||
|
|
noticeCategories |
Array |
Product notice list; |
||||||||||||||
|
|
|
noticeCategoryName |
String |
Product notice category name |
|||||||||||||
|
|
|
noticeCategoryDetailNames |
String |
Product notice category, detailed list |
|||||||||||||
|
|
|
|
noticeCategoryDetailName |
String |
Product notice category, detailed name |
||||||||||||
|
|
|
|
required |
String |
Required or not
|
||||||||||||
|
|
requiredDocumentNames |
Array |
List of required documents; |
||||||||||||||
|
|
|
templateName |
String |
Required document name |
|||||||||||||
|
|
|
required |
String |
Whether the document is required or not
|
|||||||||||||
|
|
certifications |
Array |
Product certification information; |
||||||||||||||
|
|
|
certificationType |
String |
Enter in the "certificationType" field when listing/modifying a product |
|||||||||||||
|
|
|
name |
String |
Certification name |
|||||||||||||
|
|
|
dataType |
String |
Certification name |
|||||||||||||
|
|
|
required |
String |
Required or not |
|||||||||||||
|
|
allowedOfferConditions |
Array |
Allowed product condition
|
||||||||||||||
|
|
isExpirationDateRequiredForRocketGrowth |
Boolean |
Whether distributionPeriod is required or not for Rocket Growth product sku information |
||||||||||||||
Response Example
{
"code": "SUCCESS",
"message": "",
"data": {
"isAllowSingleItem": true,
"attributes": [
{
"attributeTypeName": "수량",
"dataType": "NUMBER",
"basicUnit": "개",
"usableUnits": [
"개",
"개입",
"매",
"매입",
"팩",
"입",
"장",
"병",
"인용",
"인분",
"box",
"Ea",
"포",
"캔",
"박스",
"스틱",
"권",
"set",
"세트",
"조",
"캡슐",
"통",
"정",
"봉",
"마리",
"롤",
"p",
"구",
"피스",
"회",
"회분",
"단계",
"번",
"프렛",
"음판",
"건반",
"쪽",
"단",
"칸",
"종",
"분류",
"현",
"선",
"공",
"자리",
"폭",
"rpm",
"색",
"대"
],
"required": "OPTIONAL",
"groupNumber": "NONE",
"exposed": "EXPOSED"
},
{
"attributeTypeName": "자동차거치용품 거치대고정",
"dataType": "STRING",
"basicUnit": "없음",
"usableUnits": [],
"required": "OPTIONAL",
"groupNumber": "NONE",
"exposed": "NONE"
},
{
"attributeTypeName": "헤드 회전 가능여부",
"dataType": "STRING",
"basicUnit": "없음",
"usableUnits": [],
"required": "OPTIONAL",
"groupNumber": "NONE",
"exposed": "NONE"
},
{
"attributeTypeName": "각도조절 가능여부",
"dataType": "STRING",
"basicUnit": "없음",
"usableUnits": [],
"required": "OPTIONAL",
"groupNumber": "NONE",
"exposed": "NONE"
}
],
"noticeCategories": [
{
"noticeCategoryName": "자동차용품(자동차부품/기타 자동차용품)",
"noticeCategoryDetailNames": [
{
"noticeCategoryDetailName": "품명 및 모델명",
"required": "MANDATORY"
},
{
"noticeCategoryDetailName": "출시년월",
"required": "MANDATORY"
},
{
"noticeCategoryDetailName": "KC 인증 필 유무",
"required": "MANDATORY"
},
{
"noticeCategoryDetailName": "제조자(수입자)",
"required": "MANDATORY"
},
{
"noticeCategoryDetailName": "제조국",
"required": "MANDATORY"
},
{
"noticeCategoryDetailName": "크기",
"required": "MANDATORY"
},
{
"noticeCategoryDetailName": "적용차종",
"required": "MANDATORY"
},
{
"noticeCategoryDetailName": "품질보증기준",
"required": "MANDATORY"
},
{
"noticeCategoryDetailName": "A/S 책임자와 전화번호",
"required": "MANDATORY"
}
]
},
{
"noticeCategoryName": "기타 재화",
"noticeCategoryDetailNames": [
{
"noticeCategoryDetailName": "품명 및 모델명",
"required": "MANDATORY"
},
{
"noticeCategoryDetailName": "인증사항",
"required": "MANDATORY"
},
{
"noticeCategoryDetailName": "제조국(원산지)",
"required": "MANDATORY"
},
{
"noticeCategoryDetailName": "제조자(수입자)",
"required": "MANDATORY"
},
{
"noticeCategoryDetailName": "소비자상담 관련 전화번호",
"required": "MANDATORY"
}
]
}
],
"requiredDocumentNames": [
{
"templateName": "기타인증서류",
"required": "OPTIONAL"
},
{
"templateName": "수입신고필증(병행수입 선택시)",
"required": "MANDATORY_PARALLEL_IMPORTED"
},
{
"templateName": "인보이스영수증(해외구매대행 선택시)",
"required": "MANDATORY_OVERSEAS_PURCHASED"
}
],
"certifications": [
{
"certificationType": "NOT_REQUIRED",
"name": "인증대상아님",
"dataType": "NONE",
"required": "OPTIONAL"
},
{
"certificationType": "PRESENTED_IN_DETAIL_PAGE",
"name": "상세설명에 표시",
"dataType": "NONE",
"required": "OPTIONAL"
},
{
"certificationType": "KC_KID_CERTIFICATION",
"name": "KC인증 어린이제품 안전인증",
"dataType": "CODE",
"required": "RECOMMEND"
},
{
"certificationType": "KC_KID_CONFIRM",
"name": "KC인증 어린이제품 안전확인",
"dataType": "CODE",
"required": "OPTIONAL"
},
{
"certificationType": "KC_KID_PROVIDER",
"name": "KC인증 어린이제품 공급자적합성확인",
"dataType": "NONE",
"required": "OPTIONAL"
},
{
"certificationType": "KC_ELECTRONICS_CERTIFICATION",
"name": "KC인증 전기용품 안전인증",
"dataType": "CODE",
"required": "OPTIONAL"
},
{
"certificationType": "KC_ELECTRONICS_CONFIRM",
"name": "KC인증 전기용품 안전확인",
"dataType": "CODE",
"required": "OPTIONAL"
},
{
"certificationType": "KC_ELECTRONICS_PROVIDER",
"name": "KC인증 전기용품 공급자적합성확인",
"dataType": "NONE",
"required": "OPTIONAL"
},
{
"certificationType": "KC_HOUSEHOLD_CERTIFICATION",
"name": "KC인증 생활용품 안전인증",
"dataType": "CODE",
"required": "RECOMMEND"
},
{
"certificationType": "KC_HOUSEHOLD_CONFIRM",
"name": "KC인증 생활용품 자율안전확인",
"dataType": "CODE",
"required": "RECOMMEND"
},
{
"certificationType": "KC_HOUSEHOLD_QUALITY",
"name": "KC인증 생활용품 안전품질표시",
"dataType": "NONE",
"required": "RECOMMEND"
},
{
"certificationType": "KC_HOUSEHOLD_PACKAGING",
"name": "KC인증 생활용품 어린이보호포장",
"dataType": "NONE",
"required": "RECOMMEND"
},
{
"certificationType": "COMMUNICATION_EQUIPMENT",
"name": "방송통신기자재 적합성 평가 대상",
"dataType": "CODE",
"required": "RECOMMEND"
}
],
"allowedOfferConditions": [
"NEW",
"REFURBISHED",
"USED_BEST",
"USED_GOOD",
"USED_NORMAL"
],
"isExpirationDateRequired": true
}
}
Error Spec
| HTTP Status Code (Error Type) | Error Message | Solution |
|---|---|---|
| 400 (Check Request Parameter) | The management category cannot be found for this display category code. Check with your MD and enter the valid display category. | Make sure that the display category code is correct. |
| 400 (Check Request Parameter) | Make sure that the display category code is in numbers. | Make sure that the display category code is correct. The display category code may only be in numbers. |