Get Commodity Details

Last Updated on : 2023-06-15 05:55:48

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 name	Type	IN	Required	Description
mall_code	String	query	true	The code of the specified mall.
commodity_code	String	uri	true	The unique code of the specified commodity.
lang	String	query	true	The language.

Return parameter

Parameter name	Type	Description
result	CommodityDetailOpenApiVO	The returned result.

Description of result

Parameter name	Type	Description
commodity_code	String	The unique code of the specified commodity.
title	String	The title of the specified commodity.
description	String	The description of the specified commodity.
brand	String	The brand of the specified commodity.
code	String	The code of the specified mall.
pid	String	The product ID (PID) of the specified commodity.
first_category_code	String	The code of the specified level-1 category.
second_category_code	String	The code of the specified level-2 category.
third_category_code	String	The code of the specified level-3 category.
show_pictures	List	The image to show the specified commodity.
detail_pictures	List	The image to show the commodity details.
video	String	The video.
video_pic	String	The cover image of the video.
sku_list	List	The list of SKUs.
postage_type	Integer	The type of postage. Valid values: `1`: free shipping. `2`: fixed postage.
postage_fee	Double	The postage fee.
install_type	Integer	The installation type. Valid values: `1`: no need to install. `2`: on-site installation. `3`: installation by users.
install_fee	Double	The installation fee.
is_jump	Boolean	Specifies whether to navigate to another commodity. Valid values: `true`: Yes. `false`: No.
jump_link	String	The navigation link of the specified commodity.
publish	Boolean	Specifies whether to list the specified commodity. Valid values: `true`: Yes. `false`: No.
type	Integer	The type of the specified commodity. Valid values: `0`: physical commodity. `5`: virtual commodity.
showcase_codes	List	The codes of the specified categories that are presented in the frontend.

Description of sku_list

Parameter name	Type	Description
sku_code	String	The unique code of the specified SKU.
original_price	Double	The original price.
sale_price	Double	The sales price.
inventory	Integer	The inventory.
weight	Double	The weight.
external_code	String	The external code.
sku_attr_list	List	The list of SKU attributes.
sku_pic_list	List	The list of SKU images.
support_out_stock_buy	Boolean	Specifies whether the buyers can place an order when the inventory is zero. Valid values: `true`: Yes. `false`: No.

Description of sku_attr_list

Parameter name	Type	Description
attr_code	String	The unique code of the specified attribute.
attr_name	String	The name of the specified attribute.
attr_value_id	Long	The ID of the specified attribute value.
attr_value_name	String	The 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 code	Error message	Description
2000000	params error	Parameter error.

Prev DocGet SKU Attribute

Next DocGet Commodity Categories