product

1. Product Request API Basic Information

Request Method

GET

Security Control

Add allocated token verification permission. The token is placed in the Authorization field of the header, and permission verification is performed when requesting the interface.

Request Parameters

Parameter Name	Description	Example/Default Value
since_id	Initial product_id, used for pagination, each page queries data with product_id > since_id and sorts in ascending order	0 (first page)
limit	Page size	100
created_at_min	Minimum time for product creation time query	2025-09-01 00:00:00
created_at_max	Maximum time for product creation time query	2025-09-05 23:59:59
updated_at_min	Minimum time for product update time query	2025-09-01 00:00:00
updated_at_max	Maximum time for product update time query	2025-09-05 23:59:59

Request Parameter Example:

{
  "since_id": 0,
  "limit": "100",
  "created_at_min": "2025-09-01 00:00:00",
  "created_at_max": "2025-09-05 23:59:59",
  "updated_at_min": "2025-09-01 00:00:00",
  "updated_at_max": "2025-09-05 23:59:59",
  "status": "ACTIVE"
}

Response Result

Status Code Rule: status_code == 200 indicates that the request is successful and data is returned.

Response Result Structure:

{
  "products": [
    "product"
  ]
}

2. Product Basic Structure (product)

{
  "id": "Required, the unique identifier of the product",
  "title": "Required, the product title",
  "vendor": "Required, the name of the product supplier",
  "product_type": "Required, the type of product",
  "created_at": "Required, the creation time of the product, in ISO 8601 format",
  "updated_at": "Required, the update time of the product, in ISO 8601 format",
  "published_at": "Required, the publication time of the product, in ISO 8601 format",
  "handle": "Required, the URL handle of the product (used to generate friendly URLs)",
  "status": "Required, the status of the product (e.g., ACTIVE)",
  "tags": "Required, a list of product tags; if none, it should be an empty array",
  "body_html": "Required, the HTML description content of the product",
  "media": [
    {
      "id": "Required, the unique identifier of the media resource",
      "url": "Required, the preview image URL of the media resource"
    }
  ],
  "variants": [
    {
      "id": "Required, the unique identifier of the product variant",
      "currency_code": "Required, the currency code (e.g., USD)",
      "price": "Required, the price of the product variant, as a string",
      "compare_at_price": "Required, the original price of the product variant (used to show discounts), as a string",
      "image": {
        "url": "Required, the image URL of the product variant"
      },
      "sku": "Required, the SKU (Stock Keeping Unit) of the product variant",
      "title": "Required, the title of the product variant (e.g., 450G, 1KG, etc.)",
      "created_at": "Required, the creation time of the product variant, in ISO 8601 format",
      "updated_at": "Required, the update time of the product variant, in ISO 8601 format",
      "barcode": "Required, the barcode of the product variant",
      "inventory_quantity": "Required, the inventory quantity of the product variant, as a number",
      "position": "Required, the sorting position of the product variant, as a number",
      "inventory_item": {
        "id": "Required, the unique identifier of the inventory item",
        "unit_cost": {
          "currency_code": "Required, the currency code (e.g., USD)",
          "amount": "Required, the unit cost amount, as a string"
        },
        "created_at": "Required, the creation time of the inventory item, in ISO 8601 format",
        "updated_at": "Required, the update time of the inventory item, in ISO 8601 format"
      }
    }
  ]
}

3. Product Sample Data

{
  "id": "123456789",
  "title": "Premium Wireless Headphones",
  "vendor": "AudioTech",
  "product_type": "Electronics",
  "created_at": "2025-08-15T08:30:00Z",
  "updated_at": "2025-08-20T14:45:00Z",
  "published_at": "2025-08-16T10:00:00Z",
  "handle": "premium-wireless-headphones",
  "status": "ACTIVE",
  "tags": ["Electronics", "Audio", "Wireless"],
  "body_html": "<h1>Premium Wireless Headphones</h1><p>Experience crystal clear sound with our premium wireless headphones.</p>",
  "media": [
    {
      "id": "gid://shopify/Media/111222333",
      "url": "https://example.com/images/headphones-main.jpg"
    }
  ],
  "variants": [
    {
      "id": "gid://shopify/ProductVariant/444555666",
      "price": "199.99",
      "compare_at_price": "249.99",
      "image": {
        "url": "https://example.com/images/headphones-black.jpg"
      },
      "sku": "AUD-001-BLK",
      "title": "Black",
      "created_at": "2025-08-15T08:30:00Z",
      "updated_at": "2025-08-15T08:30:00Z",
      "barcode": "1234567890123",
      "inventory_quantity": 50,
      "position": 1,
      "inventory_item": {
        "id": "gid://shopify/InventoryItem/777888999",
        "unit_cost": {
          "currency_code": "USD",
          "amount": "120.00"
        },
        "variant": {
          "id": "gid://shopify/ProductVariant/444555666"
        },
        "sku": "AUD-001-BLK",
        "created_at": "2025-08-15T08:30:00Z",
        "updated_at": "2025-08-15T08:30:00Z"
      }
    }
  ]
}