Get Commodity Details

Last Updated on : 2024-01-12 02:22:52download

Get detailed information about a commodity based on the unique code of the specified commodity.

API address

GET: /v1.0/sellercenter/commodity/detail/{commodity_code}

Request parameter

Parameter nameTypeINRequiredDescription
mall_codeStringquerytrueThe code of the specified mall.
commodity_codeStringuritrueThe unique code of the specified commodity.
langStringquerytrueThe language.

Return parameter

Parameter nameTypeDescription
resultCommodityDetailOpenApiVOThe returned result.

Description of result

Parameter nameTypeDescription
commodity_codeStringThe unique code of the specified commodity.
titleStringThe title of the specified commodity.
descriptionStringThe description of the specified commodity.
brandStringThe brand of the specified commodity.
codeStringThe code of the specified mall.
pidStringThe product ID (PID) of the specified commodity.
first_category_codeStringThe code of the specified level-1 category.
second_category_codeStringThe code of the specified level-2 category.
third_category_codeStringThe code of the specified level-3 category.
show_picturesListThe image to show the specified commodity.
detail_picturesListThe image to show the commodity details.
videoStringThe video.
video_picStringThe cover image of the video.
sku_listListThe list of SKUs.
postage_typeIntegerThe type of postage. Valid values:
  • 1: free shipping.
  • 2: fixed postage.
postage_feeDoubleThe postage fee.
install_typeIntegerThe installation type. Valid values:
  • 1: no need to install.
  • 2: on-site installation.
  • 3: installation by users.
install_feeDoubleThe installation fee.
is_jumpBooleanSpecifies whether to navigate to another commodity. Valid values:
  • true: Yes.
  • false: No.
jump_linkStringThe navigation link of the specified commodity.
publishBooleanSpecifies whether to list the specified commodity. Valid values:
  • true: Yes.
  • false: No.
typeIntegerThe type of the specified commodity. Valid values:
  • 0: physical commodity.
  • 5: virtual commodity.
showcase_codesListThe codes of the specified categories that are presented in the frontend.

Description of sku_list

Parameter nameTypeDescription
sku_codeStringThe unique code of the specified SKU.
original_priceDoubleThe original price.
sale_priceDoubleThe sales price.
inventoryIntegerThe inventory.
weightDoubleThe weight.
external_codeStringThe external code.
sku_attr_listListThe list of SKU attributes.
sku_pic_listListThe list of SKU images.
support_out_stock_buyBooleanSpecifies whether the buyers can place an order when the inventory is zero. Valid values:
  • true: Yes.
  • false: No.

Description of sku_attr_list

Parameter nameTypeDescription
attr_codeStringThe unique code of the specified attribute.
attr_nameStringThe name of the specified attribute.
attr_value_idLongThe ID of the specified attribute value.
attr_value_nameStringThe name of the specified attribute value.

Request example

GET: /v1.0/sellercenter/commodity/detail/CMaplyr4bzck***?mall_code=8h4tiureddm***&lang=zh

Return example

{
    "tid": "7d18bcb5dd9211edacb5726e26805377",
    "result": {
        "multiple_options": true,
        "commodity_code": "CMaplyr4bzck***",
        "code": "define_code",
        "show_pictures": [
            "http://image-demo.oss-cn-hangzhou.aliyuncs.com/exa****.jpg"
        ],
        "description": "",
        "install_fee": 1,
        "pid": "",
        "title": "Refrigerator",
        "type": 0,
        "detail_pictures": [
            "http://image-demo.oss-cn-hangzhou.aliyuncs.com/exa****.jpg"
        ],
        "postage_fee": 100,
        "install_type": 2,
        "third_category_code": "131211",
        "showcase_codes": [
            "Cbgrc6mvk***"
        ],
        "first_category_code": "12",
        "sku_list": [
            {
                "original_price": 1,
                "support_out_stock_buy": false,
                "weight": 0,
                "sku_attr_list": [
                    {
                        "attr_code": "ATat2mzpe14***",
                        "attr_value_name": "Cotton",
                        "attr_name": "Material",
                        "attr_value_id": 52822311
                    }
                ],
                "inventory": 100,
                "sale_price": 2,
                "external_code": "",
                "sku_pic_list": [
                    "http://image-demo.oss-cn-hangzhou.aliyuncs.com/exa****.jpg"
                ],
                "sku_code": "SKcipzukv5m***"
            }
        ],
        "publish": true,
        "postage_type": 1,
        "second_category_code": "1312",
        "is_jump": false,
        "brand": ""
    },
    "t": 1681785675323,
    "success": true
}

Error code

For more information, see error code.

Error codeError messageDescription
2000000params errorParameter error.