检索产品列表

检索产品列表。产品可以通过“q”或“status”等字段进行筛选。产品也可以进行排序或分页。

Request

Query Params

string

optional

搜索产品标题、描述、sku以及集合标题的术语。

discount_condition_id

string

optional

根据折扣条件的ID进行筛选。将仅检索应用此折扣条件的产品。

string

optional

按产品ID筛选。

status

array[string]

optional

按状态筛选。

collection_id

array[string]

optional

按产品集合ID筛选。将只检索与指定集合关联的产品。

tags

array[string]

optional

按产品标签ID筛选。将只检索与指定标签关联的产品。

price_list_id

array[string]

optional

按价目表的ID筛选。将仅检索应用这些价目表的产品。

sales_channel_id

array[string]

optional

按销售渠道ID筛选。将仅检索指定销售渠道中可用的产品。

type_id

array[string]

optional

按产品类型ID筛选。将只检索与指定类型关联的产品。

category_id

array[string]

optional

按产品类型ID筛选。将只检索与指定类型关联的产品。

include_category_children

string

optional

按category_id筛选时是否包括产品类别子项

title

string

optional

按标题筛选。

description

string

optional

按描述筛选。

handle

string

optional

按句柄过滤。

is_giftcard

string

optional

是否检索礼品卡或常规产品。

array[string]

optional

按小于此日期的日期筛选

Example:

["","",""]

array[string]

optional

按大于此日期的日期筛选

Example:

["","",""]

lte

array[string]

optional

按小于或等于此日期的日期筛选

Example:

["","",""]

gte

array[string]

optional

按大于或等于此日期的日期筛选

Example:

["","",""]

offset

integer

optional

检索产品时要跳过的产品数。

limit

integer

optional

限制退回的产品数量。

expand

string

optional

逗号分隔的关系应在退货产品中扩展。

fields

string

optional

应包含在退货产品中的逗号分隔字段。

order

string

optional

用于对检索到的产品进行排序的产品字段。

Request samples

Shell

JavaScript

Java

Swift

PHP

Python

HTTP

Objective-C

Ruby

OCaml

Dart

Responses

🟢200成功

application/json

Body

code

string

required

data

object

required

products

array [object {35}]

required

Example

{
    "code": "success",
    "data": {
        "products": [
            {
                "id": "prod_01HY7Y5YJR18ZD0FYSPHF8YJJD",
                "created_at": "2024-05-19T08:06:08.128Z",
                "title": "Medusa T-Shirt",
                "handle": "t-shirt",
                "status": "draft",
                "thumbnail": "https://medusa-public-images.s3.eu-west-1.amazonaws.com/tee-black-front.png",
                "collection": null,
                "collection_id": null,
                "images": [
                    {
                        "id": "img_01HY7Y5YJNMAN9WB00TGAVKCJ0",
                        "created_at": "2024-05-19T08:06:08.128Z",
                        "updated_at": "2024-05-19T08:06:08.128Z",
                        "deleted_at": null,
                        "url": "https://medusa-public-images.s3.eu-west-1.amazonaws.com/tee-black-front.png",
                        "metadata": null
                    },
                    {
                        "id": "img_01HY7Y5YJN7PYT3V4JPGPM8ENG",
                        "created_at": "2024-05-19T08:06:08.128Z",
                        "updated_at": "2024-05-19T08:06:08.128Z",
                        "deleted_at": null,
                        "url": "https://medusa-public-images.s3.eu-west-1.amazonaws.com/tee-black-back.png",
                        "metadata": null
                    },
                    {
                        "id": "img_01HY7Y5YJNC2089ESX7GMC9DW4",
                        "created_at": "2024-05-19T08:06:08.128Z",
                        "updated_at": "2024-05-19T08:06:08.128Z",
                        "deleted_at": null,
                        "url": "https://medusa-public-images.s3.eu-west-1.amazonaws.com/tee-white-front.png",
                        "metadata": null
                    },
                    {
                        "id": "img_01HY7Y5YJNFR3VTSE9XZRHMMZF",
                        "created_at": "2024-05-19T08:06:08.128Z",
                        "updated_at": "2024-05-19T08:06:08.128Z",
                        "deleted_at": null,
                        "url": "https://medusa-public-images.s3.eu-west-1.amazonaws.com/tee-white-back.png",
                        "metadata": null
                    }
                ],
                "options": [
                    {
                        "id": "opt_01HY7Y5YJZJGQEH6N0XF3DV3A0",
                        "created_at": "2024-05-19T08:06:08.128Z",
                        "updated_at": "2024-05-19T08:06:08.128Z",
                        "deleted_at": null,
                        "title": "Size",
                        "product_id": "prod_01HY7Y5YJR18ZD0FYSPHF8YJJD",
                        "metadata": null
                    },
                    {
                        "id": "opt_01HY7Y5YJZRSV2WVPCXAQECG9B",
                        "created_at": "2024-05-19T08:06:08.128Z",
                        "updated_at": "2024-05-19T08:06:08.128Z",
                        "deleted_at": null,
                        "title": "Color",
                        "product_id": "prod_01HY7Y5YJR18ZD0FYSPHF8YJJD",
                        "metadata": null
                    }
                ],
                "sales_channels": [
                    {
                        "id": "sc_01HY7Y5YFJMF6HABMYNQMNGH8G",
                        "created_at": "2024-05-19T08:06:08.047Z",
                        "updated_at": "2024-05-19T08:06:08.047Z",
                        "deleted_at": null,
                        "name": "Default Sales Channel",
                        "description": "Created by Medusa",
                        "is_disabled": false,
                        "metadata": null
                    }
                ],
                "tags": [],
                "type": null,
                "variants": [
                    {
                        "id": "variant_01HY7Y5YKCNQQTBG883JPKZWT7",
                        "created_at": "2024-05-19T08:06:08.128Z",
                        "updated_at": "2024-05-19T08:06:08.128Z",
                        "deleted_at": null,
                        "title": "S / Black",
                        "product_id": "prod_01HY7Y5YJR18ZD0FYSPHF8YJJD",
                        "sku": null,
                        "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,
                        "metadata": null,
                        "options": [

🟠404记录不存在

🔴500服务器错误