Get Product Variants

Retrieves a list of product variants. The product variants can be filtered by fields such as id or title. The product variants can also be paginated.

For accurate and correct pricing of the product variants based on the customer's context, it's highly recommended to pass fields such as
region_id, currency_code, and cart_id when available.

Passing sales_channel_id ensures retrieving only variants of products available in the specified sales channel.
You can alternatively use a publishable API key in the request header instead of passing a sales_channel_id.

返回响应

🟢200成功

application/json

Bodyapplication/json

示例

{
    "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:22.123Z",
            "updated_at": "2019-08-24T14:15:22.123Z",
            "deleted_at": "2019-08-24T14:15:22.123Z",
            "purchasable": true,
            "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:22.123Z",
                    "updated_at": "2019-08-24T14:15:22.123Z",
                    "deleted_at": "2019-08-24T14:15:22.123Z"
                }
            ],
            "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:22.123Z",
                    "updated_at": "2019-08-24T14:15:22.123Z",
                    "deleted_at": "2019-08-24T14:15:22.123Z",
                    "currency_code": "usd",
                    "currency": {
                        "symbol": "$",
                        "symbol_native": "$",
                        "name": "US Dollar",
                        "includes_tax": false,
                        "code": "usd"
                    }
                }
            ],
            "options": [
                {
                    "id": "optval_01F0YESHR7S6ECD03RF6W12DSJ",
                    "value": "large",
                    "option_id": "opt_01F0YESHQBZVKCEXJ24BS6PCX3",
                    "option": {},
                    "variant_id": "variant_01G1G5V2MRX2V3PVSR2WXYPFB6",
                    "variant": {},
                    "created_at": "2019-08-24T14:15:22.123Z",
                    "updated_at": "2019-08-24T14:15:22.123Z",
                    "deleted_at": "2019-08-24T14:15:22.123Z",
                    "metadata": {
                        "car": "white"
                    }
                }
            ],
            "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"
                }
            ]
        }
    ]
}

🟠400请求有误

🟠404记录不存在

🟠409409

🟠422参数错误

🔴500服务器错误

Get Product Variants

请求参数

请求示例代码

返回响应