GET
/v2/providers/seller_api/apis/api/v1/marketplace/meta/category-related-metas/display-category-codes/{displayCategoryCode}v1Category Metadata Query
# 01
Summary
Available buyer market: Korean You can use the display category code (displayCategoryCode) to look up the category's notice, option, required documents, certification information list, etc.
# 02
Details
Available buyer market: Korean
You can use the display category code (displayCategoryCode) to look up the category's notice, option, required documents, certification information list, etc.
When you create a product, the message should be comprised of the types that match the metadata of each category set forth by Coupang.
Path
GET
/v2/providers/seller_api/apis/api/v1/marketplace/meta/category-related-metas/display-category-codes/{displayCategoryCode}
Example Endpoint
https://api-gateway.coupang.com/v2/providers/seller_api/apis/api/v1/marketplace/meta/category-related-metas/display-category-codes/78877
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:
SUCCESS/ERROR
|
||||||||||||||||
| message | String | Result message |
||||||||||||||||
| data | Array |
Category metadata;
Repeat N times as many as the number of seller products in the query
|
||||||||||||||||
| isAllowSingleItem | Boolean |
Whether a single item can be listed or not
true / false
From October 10, 2024, when entering required purchase options, you must enter them in the correct data format to successfully register a product.
|
||||||||||||||||
| attributes | Array |
Category option list (Purchase option/search option )
Repeat as many times as the number of options;
Attributes may be added, modified, and deleted before product sales is approved.
After product sales is approved, attributes may be added but not deleted or modified. |
||||||||||||||||
| attributeTypeName | String | Option type name |
||||||||||||||||
| required | String |
※ The free purchase option configuration(open attribute) is possible. More details can be found in the guide below.
New Product Creation API Guide (changed on October 12, 2020) If you configure free purchase options from October 10, 2024, exposure will be limited.
|
||||||||||||||||
| dataType | String |
Data type
|
||||||||||||||||
| basicUnit | String |
Basic unit
Ex)
Length (cm): cm, mm, m, km Length (inch): in, ft, yd Weight (g): mg, g, kg, t, oz, lb Volume (ml): cc, ml, L Data capacity (GB): KB, MB, GB, TB Quantity (unit): Piece, piece per package, sheet, sheet per package, pack, piece per, page, bottle, portion, box, Ea, pouch, can, stick, book, set, capsule, container, tablet, packet *This field is not used in the beverage category.
|
||||||||||||||||
inputType |
String |
The input type of the attribute
|
||||||||||||||||
inputValues |
Array |
A list of valid value for the attribute
The attribute value must exactly match one of the values in this list.
|
||||||||||||||||
| usableUnits | Array |
List of usable units
Ex)
Length (cm): cm, mm, m, km Length (inch): in, ft, yd Weight (g): mg, g, kg, t, oz, lb Volume (ml): cc, ml, L Data capacity (GB): KB, MB, GB, TB Quantity (unit): Piece, piece per package, sheet, sheet per package, pack, piece per, page, bottle, portion, box, Ea, ouch, can, stick, book, set, capsule, container, tablet, packet |
||||||||||||||||
| groupNumber | String |
Group attributes (Whether it is in the format that offers the option of choosing attributes)
NONE: Not group attributes
1 or 2: Group attributes. In this case, there are attributes in the attributes information with the same groupNumber value. Enter only one of the two. |
||||||||||||||||
| exposed | String |
Purchase option/search option separator
|
||||||||||||||||
| noticeCategories | Array |
Product notice list;
Repeat as many times as the number of options
|
||||||||||||||||
| 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;
Repeat as many times as the number of options
|
||||||||||||||||
| templateName | String | Required document name |
||||||||||||||||
| required | String |
Whether the document is required or not
|
||||||||||||||||
| certifications | Array |
Product certification information;
Repeat as many times as the number of options
|
||||||||||||||||
| certificationType | String | Enter in the "certificationType" field when listing/modifying a product |
||||||||||||||||
| name | String | Certification name |
||||||||||||||||
| dataType | String |
Certification name
CODE (Enter the code issued by the certification authority)
NONE (No need to enter the code) |
||||||||||||||||
| required | String |
Required or not
MANDATORY (Required)
RECOMMEND (Recommended) OPTIONAL (Optional) |
||||||||||||||||
| allowedOfferConditions | Array |
Allowed product condition
Check the value to confirm whether the refurbished / used product may be listed.
|
||||||||||||||||
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"
]
}
}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. |