Medusa API
  1. 【Demo】Products
Medusa API
  • Store API
  • Admin API
    • Auth
      • Apps Oauth
        • Generate Token for App
        • List Applications
      • Get Current User
        GET
      • User Logout
        DELETE
      • User Login
        POST
      • User Login (JWT)
        POST
    • Batch Jobs
      • Cancel a Batch Job
        POST
      • Get a Batch Job
        GET
      • Confirm a Batch Job
        POST
      • List Batch Jobs
        GET
      • Create a Batch Job
        POST
    • Currencies
      • List Currency
        GET
      • Update a Currency
        POST
    • Customers
      • Create a Customer
      • List Customers
      • Update a Customer
      • Get a Customer
    • Customer Groups
      • Remove Customers from Group
      • Add Customers to Group
      • List Customers
      • Create a Customer Group
      • List Customer Groups
      • Get a Customer Group
      • Delete a Customer Group
      • Update a Customer Group
    • Discounts
      • Create a Condition
      • Create a Discount
      • List Discounts
      • Get a Condition
      • Update a Condition
      • Delete a Condition
      • Create a Dynamic Code
      • Remove Batch Resources
      • Add Batch Resources
      • Get Discount by Code
      • Delete a Dynamic Code
      • Add Region to Discount
      • Remove Region
      • Delete a Discount
      • Update a Discount
      • Get a Discount
    • Draft Orders
      • Create a Line Item
      • Delete a Line Item
      • Update a Line Item
      • Update a Draft Order
      • Delete a Draft Order
      • Get a Draft Order
      • Create a Draft Order
      • List Draft Orders
      • Mark Paid
    • Gift Cards
      • Create a Gift Card
      • List Gift Cards
      • Delete a Gift Card
      • Get a Gift Card
      • Update a Gift Card
    • Inventory Items
      • Create an Inventory Item
      • List Inventory Items
      • List Inventory Level
      • Create an Location Level
      • Update an Inventory Item
      • Get an Inventory Item
      • Delete an Inventory Item
      • Update a Location Level
      • Delete a Location Level
    • Invites
      • Lists Invites
      • Create an Invite
      • Delete an Invite
      • Accept an Invite
      • Resend an Invite
    • Notes
      • List Notes
      • Create a Note
      • Get a Note
      • Delete a Note
      • Update a Note
    • Notifications
      • Resend Notification
      • List Notifications
    • Orders
      • Create a Reservation
      • Cancel Claim's Fulfillment
      • Ship a Claim's Fulfillment
      • Cancel Swap's Fulfilmment
      • Get Order Reservations
      • Add a Shipping Method
      • Create a Refund
      • Get an Order
      • Update an Order
      • Create a Fulfillment
      • Cancel a Swap
      • List Orders
      • Create a Swap
      • Complete an Order
      • Create a Swap Fulfillment
      • Cancel a Claim
      • Process a Swap Payment
      • Ship a Fulfillment
      • Capture an Order's Payments
      • Archive Order
      • Update a Claim
      • Request a Return
      • Create a Claim Fulfillment
      • Ship a Swap's Fulfillment
      • Cancel a Fulfilmment
      • Create a Claim
      • Cancel an Order
    • Order Edits
      • Delete a Line Item Change
      • Add a Line Item
      • Upsert Line Item Change
      • Delete Line Item
      • Cancel an Order Edit
      • Delete an Order Edit
      • Get an Order Edit
      • Update an Order Edit
      • Request Confirmation
      • Create an OrderEdit
      • List Order Edits
      • Confirm an OrderEdit
    • Payments
      • Capture a Payment
      • Get Payment details
      • Refund Payment
    • Payment Collections
      • Delete a Payment Collection
      • Get a Payment Collection
      • Update Payment Collection
      • Mark Authorized
    • Product Collections
      • Add Products to Collection
      • Remove Products from Collection
      • Get a Collection
      • Update a Collection
      • Delete a Collection
      • List Collections
      • Create a Collection
    • Product Tags
      • List Product Tags
    • Product Types
      • List Product Types
    • Product Variants
      • Get Variant's Inventory
      • List Product Variants
      • Get a Product variant
    • Price Lists
      • Delete a Product's Prices
      • List Products
      • Delete a Variant's Prices
      • Get a Price List
      • Update a Price List
      • Delete a Price List
      • Add or Update Prices
      • Delete Prices
      • Create a Price List
      • List Price Lists
    • Products
      • List Product Types
      • List Tags Usage Number
      • List a Product's Variants
      • Create a Product Variant
      • Update a Product Variant
      • Delete a Product Variant
      • Add a Product Option
      • Set Metadata
      • Delete a Product Option
      • Update a Product Option
    • Product Categories
      • Create a Product Category
      • List Product Categories
      • Update a Product Category
      • Delete a Product Category
      • Get a Product Category
      • Add Products to a Category
      • Remove Products from Category
    • Publishable Api Keys
      • List Sales Channels
      • Delete Publishable API Key
      • Get a Publishable API Key
      • Revoke a Publishable API Key
      • Remove Sales Channels
      • Add Sales Channels
      • Update Publishable API Key
      • List Publishable API keys
      • Create Publishable API Key
    • Reservations
      • Delete a Reservation
      • Update a Reservation
      • Get a Reservation
      • Create a Reservation
      • List Reservations
    • Regions
      • List Fulfillment Options
      • Add Country
      • Remove Fulfillment Provider
      • Remove Payment Provider
      • Add Payment Provider
      • Delete a Region
      • Update a Region
      • Get a Region
      • List Regions
      • Create a Region
      • Add Fulfillment Provider
      • Remove Country
    • Return Reasons
      • Get a Return Reason
      • Delete a Return Reason
      • Update a Return Reason
      • List Return Reasons
      • Create a Return Reason
    • Returns
      • Receive a Return
      • List Returns
      • Cancel a Return
    • Sales Channels
      • Remove Stock Location from Sales Channels.
      • Associate a Stock Location
      • Get a Sales Channel
      • Delete a Sales Channel
      • Update a Sales Channel
      • Remove Products from Sales Channel
      • Add Products to Sales Channel
      • Create a Sales Channel
      • List Sales Channels
    • Shipping Options
      • Update Shipping Option
      • Get a Shipping Option
      • Delete Shipping Option
      • List Shipping Options
      • Create Shipping Option
    • Shipping Profiles
      • List Shipping Profiles
      • Create a Shipping Profile
      • Delete a Shipping Profile
      • Update a Shipping Profile
      • Get a Shipping Profile
    • Stock Locations
      • Get a Stock Location
      • Update a Stock Location
      • Delete a Stock Location
      • List Stock Locations
      • Create a Stock Location
    • Store
      • List Payment Providers
      • Add a Currency Code
      • Remove a Currency
      • List Tax Providers
      • Update Store Details
      • Get Store details
    • Swaps
      • Get a Swap
      • List Swaps
    • Uploads
      • Upload Files
      • Delete an Uploaded File
      • Get a File's Download URL
      • Protected File Upload
    • Tax Rates
      • Add to Shipping Options
      • Remove Shipping Options from Rate
      • Create a Tax Rate
      • List Tax Rates
      • Add to Products
      • Remove Products from Rate
      • Delete a Tax Rate
      • Get a Tax Rate
      • Update a Tax Rate
      • Add to Product Types
      • Remove Product Types from Rate
    • Users
      • Reset Password
      • Request Password Reset
      • Get a User
      • Delete a User
      • Update a User
      • Create a User
      • List Users
  • 【Demo】Products
    • 检索产品列表
      GET
    • 创建新产品
      POST
    • 删除产品
      DELETE
    • 更新产品信息
      POST
    • 检索产品详情
      GET
  1. 【Demo】Products

检索产品列表

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

Request

Query Params

Request samples

Shell
JavaScript
Java
Swift
Go
PHP
Python
HTTP
C
C#
Objective-C
Ruby
OCaml
Dart
R
Request Request Example
Shell
JavaScript
Java
Swift
curl --location --request GET '/admin/products?q=&discount_condition_id=&id=&status=&collection_id=&tags=&price_list_id=&sales_channel_id=&type_id=&category_id=&include_category_children=&title=&description=&handle=&is_giftcard=&lt=&lt=&lt=&gt=&gt=&gt=&lte=&lte=&lte=&gte=&gte=&gte=&offset=&limit=&expand=&fields=&order='

Responses

🟢200成功
application/json
Body

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服务器错误
Modified at 2024-05-23 07:10:15
Previous
List Users
Next
创建新产品
Built with