Skip to main content
GET
/
storefront
/
products
상품 목록 조회
curl --request GET \
  --url https://api.headlesscommerce.io/v1/storefront/products \
  --header 'Authorization: Bearer <token>'
{
  "data": [
    {
      "id": "<string>",
      "name": "<string>",
      "slug": "<string>",
      "description": "<string>",
      "type": "physical",
      "status": "draft",
      "tags": [
        "<string>"
      ],
      "attributes": {},
      "images": [
        {
          "id": "<string>",
          "url": "<string>",
          "alt_text": "<string>",
          "position": 123,
          "width": 123,
          "height": 123
        }
      ],
      "options": [
        {
          "id": "<string>",
          "name": "<string>",
          "position": 123,
          "values": [
            {
              "id": "<string>",
              "value": "<string>",
              "position": 123
            }
          ]
        }
      ],
      "variants": [
        {
          "id": "<string>",
          "product_id": "<string>",
          "sku": "<string>",
          "barcode": "<string>",
          "price": {
            "amount": 123,
            "currency": "<string>"
          },
          "compare_at_price": {
            "amount": 123,
            "currency": "<string>"
          },
          "cost_price": {
            "amount": 123,
            "currency": "<string>"
          },
          "weight": 123,
          "is_active": true,
          "option_values": [
            {
              "id": "<string>",
              "value": "<string>",
              "position": 123
            }
          ],
          "images": [
            {
              "id": "<string>",
              "url": "<string>",
              "alt_text": "<string>",
              "position": 123,
              "width": 123,
              "height": 123
            }
          ],
          "inventory": {
            "id": "<string>",
            "variant_id": "<string>",
            "track_inventory": true,
            "allow_backorder": true,
            "safety_stock": 123,
            "on_hand": 123,
            "reserved": 123,
            "available": 123,
            "metadata": {}
          },
          "metadata": {},
          "created_at": "2023-11-07T05:31:56Z",
          "updated_at": "2023-11-07T05:31:56Z"
        }
      ],
      "metadata": {},
      "created_at": "2023-11-07T05:31:56Z",
      "updated_at": "2023-11-07T05:31:56Z"
    }
  ],
  "total_count": 123,
  "has_more": true,
  "next_cursor": "<string>"
}

Authorizations

Authorization
string
header
required

API Key. 예: sk_live_xxxxx 또는 pk_live_xxxxx

Query Parameters

limit
integer
default:20
Required range: 1 <= x <= 100
starting_after
string

이 ID 이후의 결과 반환 (cursor)

q
string

상품명 검색 (부분 일치)

category_id
string
collection_id
string
tag
string

태그 필터. 콤마 구분으로 여러 태그 AND 조건. 예: tag=신상,할인

price_min
integer

최소 가격 (최소 통화 단위). 대표 Variant 기준

price_max
integer

최대 가격 (최소 통화 단위). 대표 Variant 기준

sort
enum<string>
default:created_at
Available options:
created_at,
name,
price
order
enum<string>
default:desc
Available options:
asc,
desc

Response

200 - application/json

성공

data
object[]
total_count
integer

Admin API에서만 반환. 필터 조건에 맞는 전체 건수

has_more
boolean
next_cursor
string | null