Putiikkipalvelu Docs

Categories

Category tree and navigation

List all categories

GET
/categories

Authorization

ApiKeyAuth
x-api-key<token>

API key is automatically provided for demo requests in the playground

In: header

Response Body

application/json

application/json

application/json

curl -X GET "https://test.putiikkipalvelu.fi/api/storefront/v1/categories"
[
  {
    "id": "clx789ghi",
    "name": "Korut",
    "slug": "korut",
    "storeId": "clx123abc",
    "parentId": null,
    "createdAt": "2024-01-15T12:00:00.000Z",
    "children": [
      {
        "id": "clx789jkl",
        "name": "Sormukset",
        "slug": "sormukset",
        "storeId": "clx123abc",
        "parentId": "clx789ghi",
        "createdAt": "2024-01-15T12:00:00.000Z",
        "children": []
      },
      {
        "id": "clx789mno",
        "name": "Kaulakorut",
        "slug": "kaulakorut",
        "storeId": "clx123abc",
        "parentId": "clx789ghi",
        "createdAt": "2024-01-15T12:00:00.000Z",
        "children": []
      }
    ]
  },
  {
    "id": "clx789pqr",
    "name": "Vaatteet",
    "slug": "vaatteet",
    "storeId": "clx123abc",
    "parentId": null,
    "createdAt": "2024-01-20T10:00:00.000Z",
    "children": []
  }
]
{
  "error": "Error message"
}
{
  "error": "Error message"
}

Get category by slug

GET
/categories/{slug}

Authorization

ApiKeyAuth
x-api-key<token>

API key is automatically provided for demo requests in the playground

In: header

Path Parameters

slug*string

Category URL slug (unique per store)

Response Body

application/json

application/json

application/json

application/json

curl -X GET "https://test.putiikkipalvelu.fi/api/storefront/v1/categories/korut"
{
  "category": {
    "id": "clx789ghi",
    "name": "Korut",
    "slug": "korut",
    "storeId": "clx123abc",
    "parentId": null,
    "createdAt": "2024-01-15T12:00:00.000Z",
    "children": []
  }
}
{
  "error": "Error message"
}
{
  "error": "Category not found"
}
{
  "error": "Error message"
}