Skip to main content
GET
/
storefront
/
collections
/
by-slug
/
{slug}
Slug로 컬렉션 조회
curl --request GET \
  --url https://api.headlesscommerce.io/v1/storefront/collections/by-slug/{slug} \
  --header 'Authorization: Bearer <token>'
{
  "id": "<string>",
  "name": "<string>",
  "slug": "<string>",
  "description": "<string>",
  "type": "manual",
  "position": 123,
  "metadata": {},
  "created_at": "2023-11-07T05:31:56Z",
  "products": [
    {
      "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"
    }
  ]
}

Authorizations

Authorization
string
header
required

API Key. 예: sk_live_xxxxx 또는 pk_live_xxxxx

Path Parameters

slug
string
required

Response

Success

id
string
name
string
slug
string
description
string
type
enum<string>
Available options:
manual,
auto
position
integer
metadata
object
created_at
string<date-time>
products
object[]