API返回的数据结构有哪些字段？

API 返回的数据结构通常是一个 JSON 对象，其中包含了多个字段，这些字段提供了商品的详细信息。以下是一个常见的商品详情 API 返回值的字段说明，这些字段涵盖了商品的基本信息、价格信息、库存信息、用户评价等关键数据。

商品详情 API 返回值字段说明

示例 JSON 数据

JSON

{
    "code": "0",
    "errorMessage": "success",
    "item_detail_response": {
        "items": [
            {
                "sku_id": "1234567890",
                "title": "商品标题",
                "price": "120.00",
                "original_price": "150.00",
                "discount_price": "100.00",
                "pic_url": "https://example.com/image.jpg",
                "description": "商品详细描述",
                "brand": "品牌名称",
                "category": "分类名称",
                "origin": "产地",
                "stock_quantity": 100,
                "sales_volume": 500,
                "rating": 4.5,
                "comment_count": 200,
                "comments": [
                    {
                        "user_id": "user123",
                        "username": "用户名",
                        "rating": 5,
                        "comment": "好评内容",
                        "comment_time": "2024-10-10T12:00:00Z"
                    }
                ],
                "props_list": {
                    "color": "红色",
                    "size": "L"
                },
                "sku_list": [
                    {
                        "sku_id": "123456",
                        "name": "红色",
                        "price": "120.00",
                        "stock": 50
                    }
                ],
                "seller_info": {
                    "seller_id": "seller123",
                    "shop_id": "shop456",
                    "shop_name": "店铺名称"
                },
                "detail_url": "https://item.example.com/1234567890.html"
            }
        ]
    }
}

字段说明

1. 根字段

• code：返回的状态码，表示请求的结果。

  • 0：表示成功。

  • 其他值：表示失败，具体含义需参考 API 文档。

• errorMessage：错误信息，描述了返回状态码对应的错误原因。

  • 成功时通常返回 "success"。

  • 失败时返回具体的错误信息，如 "Invalid App Key" 或 "Rate Limit Exceeded"。

• item_detail_response：商品详情信息的响应数据。

2. 商品详情字段

• items：商品列表，包含多个商品的详细信息。

  • sku_id：商品的唯一标识 ID。

  • title：商品标题。

  • price：商品当前价格。

  • original_price：商品原价（如果有）。

  • discount_price：商品折扣价（如果有）。

  • pic_url：商品图片的 URL。

  • description：商品详细描述。

  • brand：商品品牌。

  • category：商品分类。

  • origin：商品产地。

  • stock_quantity：当前库存数量。

  • sales_volume：销量。

  • rating：用户评分。

  • comment_count：评论数量。

  • comments：评论内容列表。

    • user_id：用户 ID。

    • username：用户名。

    • rating：用户评分。

    • comment：评论内容。

    • comment_time：评论时间。

  • props_list：商品属性列表，如尺码、颜色等。

  • sku_list：商品的 SKU 列表，每个 SKU 代表一个具体的商品规格和价格组合。

    • sku_id：SKU 的 ID。

    • name：SKU 的名称。

    • price：SKU 的价格。

    • stock：SKU 的库存数量。

  • seller_info：卖家信息。

    • seller_id：卖家 ID。

    • shop_id：店铺 ID。

    • shop_name：店铺名称。

  • detail_url：商品详情页 URL。

示例代码解析 JSON 数据

以下是一个 PHP 示例代码，展示如何解析上述 JSON 数据：

php

<?php
function parse_response($data) {
    if ($data['code'] == '0') {
        $items = $data['item_detail_response']['items'];
        foreach ($items as $item) {
            echo "商品标题: " . $item['title'] . "\n";
            echo "商品价格: " . $item['price'] . "\n";
            echo "商品图片: " . $item['pic_url'] . "\n";
            echo "商品描述: " . $item['description'] . "\n";
            echo "品牌: " . $item['brand'] . "\n";
            echo "分类: " . $item['category'] . "\n";
            echo "产地: " . $item['origin'] . "\n";
            echo "库存数量: " . $item['stock_quantity'] . "\n";
            echo "销量: " . $item['sales_volume'] . "\n";
            echo "用户评分: " . $item['rating'] . "\n";
            echo "评论数量: " . $item['comment_count'] . "\n";

            if (isset($item['comments'])) {
                echo "评论列表：\n";
                foreach ($item['comments'] as $comment) {
                    echo "  用户名: " . $comment['username'] . "\n";
                    echo "  评分: " . $comment['rating'] . "\n";
                    echo "  评论内容: " . $comment['comment'] . "\n";
                    echo "  评论时间: " . $comment['comment_time'] . "\n";
                }
            }

            if (isset($item['props_list'])) {
                echo "商品属性：\n";
                foreach ($item['props_list'] as $key => $value) {
                    echo "  $key: $value\n";
                }
            }

            if (isset($item['sku_list'])) {
                echo "SKU 列表：\n";
                foreach ($item['sku_list'] as $sku) {
                    echo "  SKU ID: " . $sku['sku_id'] . "\n";
                    echo "  名称: " . $sku['name'] . "\n";
                    echo "  价格: " . $sku['price'] . "\n";
                    echo "  库存: " . $sku['stock'] . "\n";
                }
            }

            if (isset($item['seller_info'])) {
                echo "卖家信息：\n";
                echo "  卖家 ID: " . $item['seller_info']['seller_id'] . "\n";
                echo "  店铺 ID: " . $item['seller_info']['shop_id'] . "\n";
                echo "  店铺名称: " . $item['seller_info']['shop_name'] . "\n";
            }

            echo "商品详情页 URL: " . $item['detail_url'] . "\n";
        }
    } else {
        echo "API 请求失败，错误信息: " . $data['errorMessage'] . "\n";
    }
}
?>

总结

通过上述字段说明和代码示例，你可以清晰地了解商品详情 API 返回的 JSON 数据结构，并能够高效地解析和处理这些数据。希望这个示例对你有所帮助！