获取产品

正式环境

https://product.example.com

GET

/store/products/{id}

检索产品的详细信息。为了根据客户的情况准确、正确地定价产品，强烈建议通过以下字段
region_id, currency_code, and cart_id when available.

传递 sales_channel_id 可确保仅检索当前销售渠道中可用的产品。

您也可以在请求标头中使用可发布的 API 密钥，而不是传递 sales_channel_id。

请求示例

Shell

JavaScript

Java

Swift

curl --location --request GET 'https://product.example.com/store/products/' \
--header 'Authorization: Bearer {{ACCESS_TOKEN}}'

响应示例

200 - 示例 1

{
    "product": {
        "id": "prod_01G1G5V2MBA328390B5AXJ610F",
        "title": "Medusa Coffee Mug",
        "subtitle": "string",
        "description": "Every programmer's best friend.",
        "handle": "coffee-mug",
        "is_giftcard": false,
        "thumbnail": "http://example.com",
        "profile_id": "sp_01G1G5V239ENSZ5MV4JAR737BM",
        "weight": null,
        "length": null,
        "height": null,
        "width": null,
        "hs_code": null,
        "origin_country": null,
        "mid_code": null,
        "material": null,
        "collection_id": "pcol_01F0YESBFAZ0DV6V831JXWH0BG",
        "type_id": "ptyp_01G8X9A7ESKAJXG2H0E6F1MW7A",
        "discountable": true,
        "external_id": null,
        "created_at": "2019-08-24T14:15:22Z",
        "updated_at": "2019-08-24T14:15:22Z",
        "deleted_at": "2019-08-24T14:15:22Z",
        "status": "draft",
        "metadata": {
            "car": "white"
        },
        "categories": [
            {
                "id": "pcat_01G2SG30J8C85S4A5CHM2S1NS2",
                "name": "Regular Fit",
                "description": "",
                "handle": "regular-fit",
                "mpath": "pcat_id1.pcat_id2.pcat_id3",
                "is_internal": false,
                "is_active": false,
                "rank": 0,
                "parent_category_id": null,
                "parent_category": {},
                "created_at": "2019-08-24T14:15:22Z",
                "updated_at": "2019-08-24T14:15:22Z",
                "category_children": [
                    {}
                ],
                "products": [
                    {}
                ],
                "metadata": {
                    "car": "white"
                }
            }
        ],
        "profile": {
            "id": "sp_01G1G5V239ENSZ5MV4JAR737BM",
            "name": "默认送货方案",
            "created_at": "2019-08-24T14:15:22Z",
            "updated_at": "2019-08-24T14:15:22Z",
            "deleted_at": "2019-08-24T14:15:22Z",
            "type": "default",
            "products": [
                {}
            ],
            "shipping_options": [
                {}
            ],
            "metadata": {
                "car": "white"
            }
        },
        "profiles": [
            {
                "id": "sp_01G1G5V239ENSZ5MV4JAR737BM",
                "name": "默认送货方案",
                "created_at": "2019-08-24T14:15:22Z",
                "updated_at": "2019-08-24T14:15:22Z",
                "deleted_at": "2019-08-24T14:15:22Z",
                "type": "default",
                "products": [
                    {}
                ],
                "shipping_options": [
                    {}
                ],
                "metadata": {
                    "car": "white"
                }
            }
        ],
        "collection": {
            "id": "pcol_01F0YESBFAZ0DV6V831JXWH0BG",
            "title": "Summer Collection",
            "handle": "summer-collection",
            "created_at": "2019-08-24T14:15:22Z",
            "updated_at": "2019-08-24T14:15:22Z",
            "deleted_at": "2019-08-24T14:15:22Z",
            "products": [
                {}
            ],
            "metadata": {
                "car": "white"
            }
        },
        "type": {
            "id": "ptyp_01G8X9A7ESKAJXG2H0E6F1MW7A",
            "value": "Clothing",
            "created_at": "2019-08-24T14:15:22Z",
            "updated_at": "2019-08-24T14:15:22Z",
            "deleted_at": "2019-08-24T14:15:22Z",
            "metadata": {
                "car": "white"
            }
        },
        "tags": [
            {
                "id": "ptag_01G8K2MTMG9168F2B70S1TAVK3",
                "value": "Pants",
                "created_at": "2019-08-24T14:15:22Z",
                "updated_at": "2019-08-24T14:15:22Z",
                "deleted_at": "2019-08-24T14:15:22Z",
                "metadata": {
                    "car": "white"
                }
            }
        ],
        "images": [
            {
                "id": "img_01G749BFYR6T8JTVW6SGW3K3E6",
                "url": "http://example.com",
                "created_at": "2019-08-24T14:15:22Z",
                "updated_at": "2019-08-24T14:15:22Z",
                "deleted_at": "2019-08-24T14:15:22Z",
                "metadata": {
                    "car": "white"
                }
            }
        ],
        "options": [
            {
                "id": "opt_01F0YESHQBZVKCEXJ24BS6PCX3",
                "title": "Size",
                "product_id": "prod_01G1G5V2MBA328390B5AXJ610F",
                "product": {},
                "created_at": "2019-08-24T14:15:22Z",
                "updated_at": "2019-08-24T14:15:22Z",
                "deleted_at": "2019-08-24T14:15:22Z",
                "metadata": {
                    "car": "white"
                },
                "values": [
                    {
                        "id": "optval_01F0YESHR7S6ECD03RF6W12DSJ",
                        "value": "large",
                        "option_id": "opt_01F0YESHQBZVKCEXJ24BS6PCX3",
                        "option": {},
                        "variant_id": "variant_01G1G5V2MRX2V3PVSR2WXYPFB6",
                        "variant": {},
                        "created_at": "2019-08-24T14:15:22Z",
                        "updated_at": "2019-08-24T14:15:22Z",
                        "deleted_at": "2019-08-24T14:15:22Z",
                        "metadata": {
                            "car": "white"
                        }
                    }
                ]
            }
        ],
        "sales_channels": [
            {
                "id": "sc_01G8X9A7ESKAJXG2H0E6F1MW7A",
                "name": "Market",
                "description": "Multi-vendor market",
                "is_disabled": false,
                "created_at": "2019-08-24T14:15:22Z",
                "updated_at": "2019-08-24T14:15:22Z",
                "deleted_at": "2019-08-24T14:15:22Z",
                "metadata": {
                    "car": "white"
                },
                "locations": [
                    {
                        "id": "scloc_01G8X9A7ESKAJXG2H0E6F1MW7A",
                        "sales_channel_id": "sc_01G8X9A7ESKAJXG2H0E6F1MW7A",
                        "location_id": "string",
                        "sales_channel": {},
                        "created_at": "2019-08-24T14:15:22Z",
                        "updated_at": "2019-08-24T14:15:22Z",
                        "deleted_at": "2019-08-24T14:15:22Z"
                    }
                ]
            }
        ],
        "variants": [
            {
                "id": "variant_01G1G5V2MRX2V3PVSR2WXYPFB6",
                "title": "Small",
                "product_id": "prod_01G1G5V2MBA328390B5AXJ610F",
                "product": {},
                "sku": "shirt-123",
                "barcode": null,
                "ean": null,
                "upc": null,
                "variant_rank": 0,
                "inventory_quantity": 100,
                "allow_backorder": false,
                "manage_inventory": true,
                "hs_code": null,
                "origin_country": null,
                "mid_code": null,
                "material": null,
                "weight": null,
                "length": null,
                "height": null,
                "width": null,
                "created_at": "2019-08-24T14:15:22Z",
                "updated_at": "2019-08-24T14:15:22Z",
                "deleted_at": "2019-08-24T14:15:22Z",
                "purchasable": true,
                "metadata": {
                    "car": "white"
                },
                "options": [
                    {
                        "id": "optval_01F0YESHR7S6ECD03RF6W12DSJ",
                        "value": "large",
                        "option_id": "opt_01F0YESHQBZVKCEXJ24BS6PCX3",
                        "option": {},
                        "variant_id": "variant_01G1G5V2MRX2V3PVSR2WXYPFB6",
                        "variant": {},
                        "created_at": "2019-08-24T14:15:22Z",
                        "updated_at": "2019-08-24T14:15:22Z",
                        "deleted_at": "2019-08-24T14:15:22Z",
                        "metadata": {
                            "car": "white"
                        }
                    }
                ],
                "inventory_items": [
                    {
                        "id": "pvitem_01G8X9A7ESKAJXG2H0E6F1MW7A",
                        "inventory_item_id": "string",
                        "variant_id": "string",
                        "variant": {},
                        "required_quantity": 1,
                        "created_at": "2019-08-24T14:15:22Z",
                        "updated_at": "2019-08-24T14:15:22Z",
                        "deleted_at": "2019-08-24T14:15:22Z"
                    }
                ],
                "prices": [
                    {
                        "id": "ma_01F0YESHRFQNH5S8Q0PK84YYZN",
                        "amount": 100,
                        "min_quantity": 1,
                        "max_quantity": 1,
                        "price_list_id": "pl_01G8X3CKJXCG5VXVZ87H9KC09W",
                        "price_list": {},
                        "variant_id": "variant_01G1G5V2MRX2V3PVSR2WXYPFB6",
                        "variant": {},
                        "region_id": "reg_01G1G5V26T9H8Y0M4JNE3YGA4G",
                        "region": {},
                        "created_at": "2019-08-24T14:15:22Z",
                        "updated_at": "2019-08-24T14:15:22Z",
                        "deleted_at": "2019-08-24T14:15:22Z",
                        "currency_code": "usd",
                        "currency": {
                            "symbol": "$",
                            "symbol_native": "$",
                            "name": "US Dollar",
                            "includes_tax": false,
                            "code": "usd"
                        }
                    }
                ],
                "original_price": 0,
                "calculated_price": 0,
                "original_price_incl_tax": 0,
                "calculated_price_incl_tax": 0,
                "original_tax": 0,
                "calculated_tax": 0,
                "tax_rates": [
                    {
                        "rate": 0,
                        "name": "string",
                        "code": "string"
                    }
                ]
            }
        ]
    }
}

请求参数

Authorization

在 Header 添加参数

Authorization

，其值为在 Bearer 之后拼接 Token

示例：

Authorization: Bearer ********************

Path 参数

Query 参数

Header 参数

返回响应

🟢200正常

application/json

Body

🟠400客户端错误或多个错误

🟠404未找到错误

🟠409无效状态错误

🟠422无效请求错误

🔴500服务器错误

修改于 2025-06-04 02:23:08

获取产品列表

请求密码重置