Skip to main content

Get Product Annotation by Category ID

This endpoint retrieve list of product annotation (product specification) based on category ID

Path

get

/v1/fs/:fs_id/product/annotation?cat_id=:cat_id

Request Parameters

ParameterTypeRequiredLocationDescription
fs_id
Integer
Required
path
Fulfillment service unique identifier
cat_id
Integer
Required
query
Category unique identifier

Example Request

curl -X GET 'https://fs.tokopedia.net/v1/fs/14231/product/annotation?cat_id=1809' \
-H 'Authorization: Bearer O96erYu3Twmcipyy6-8xsQ'

Response Parameters

NameTypeDemo ValueDescription
variant
String
Product Color
Variant Name
sort_order
Integer
3
values
Object Array

Success Response Examples

{
"header": {
"process_time": 0.139554335,
"messages": "Your request has been processed successfully"
},
"data": [
{
"variant": "Pola Produk",
"sort_order": 2,
"values": [
{
"id": 84,
"Name": "Polkadot",
"data": ""
},
{
"id": 92,
"Name": "Polos",
"data": ""
}
]
},
{
"variant": "Product Color",
"sort_order": 3,
"values": [
{
"id": 65,
"Name": "Hitam",
"data": "#000000"
}
]
},
{
"variant": "Product Color",
"sort_order": 3,
"values": [
{
"id": 64,
"Name": "Beige",
"data": "#ebcca3"
},
{
"id": 68,
"Name": "Emas",
"data": "#ffd700"
}
]
}
]
}

Error Response Examples

{
"header": {
"process_time": 0.000104878,
"messages": "We could not process your request due to malformed request, please check again",
"reason": "Invalid category id format",
"error_code": "PRD_DLV_049"
},
"data": null
}

Error Codes

  • Path
  • Request Parameters
  • Example Request
  • Response Parameters
  • Success Response Examples
  • Error Response Examples
  • Error Codes
  • Have a feedback?