Putiikkipalvelu Docs
API Endpoints

Products

Product catalog endpoints

Get latest products

GET
/latest-products

Authorization

ApiKeyAuth
x-api-key<token>

API key is automatically provided for demo requests in the playground

In: header

Query Parameters

take*integer

Number of products to return

Range1 <= value <= 100

Response Body

application/json

application/json

curl -X GET "https://test.putiikkipalvelu.fi/api/storefront/v1/latest-products?take=6"
[
  {
    "id": "clx123abc",
    "name": "Gold Ring",
    "slug": "gold-ring",
    "description": "string",
    "price": 15000,
    "images": [
      "http://example.com"
    ],
    "quantity": 0,
    "salePrice": 12000,
    "salePercent": "20",
    "saleStartDate": "2019-08-24T14:15:22Z",
    "saleEndDate": "2019-08-24T14:15:22Z",
    "variations": [
      {
        "id": "clx456def",
        "price": 15000,
        "salePrice": 12000,
        "salePercent": "20",
        "saleStartDate": "2019-08-24T14:15:22Z",
        "saleEndDate": "2019-08-24T14:15:22Z"
      }
    ]
  }
]
{
  "error": "Error message"
}
Empty

Get product by slug

GET
/product/{slug}

Authorization

ApiKeyAuth
x-api-key<token>

API key is automatically provided for demo requests in the playground

In: header

Path Parameters

slug*string

Product URL slug

Response Body

application/json

application/json

application/json

curl -X GET "https://test.putiikkipalvelu.fi/api/storefront/v1/product/gold-ring"
{
  "id": "clx123abc",
  "name": "Gold Ring",
  "slug": "gold-ring",
  "description": "string",
  "price": 15000,
  "images": [
    "http://example.com"
  ],
  "quantity": 0,
  "salePrice": 12000,
  "salePercent": "20",
  "saleStartDate": "2019-08-24T14:15:22Z",
  "saleEndDate": "2019-08-24T14:15:22Z",
  "variations": [
    {
      "id": "clx456def",
      "price": 15000,
      "salePrice": 12000,
      "salePercent": "20",
      "saleStartDate": "2019-08-24T14:15:22Z",
      "saleEndDate": "2019-08-24T14:15:22Z",
      "weight": 0.3,
      "quantity": 0,
      "sku": "string",
      "images": [
        "http://example.com"
      ],
      "description": "string",
      "showOnStore": true,
      "options": [
        {
          "value": "Large",
          "optionType": {
            "name": "Size"
          }
        }
      ]
    }
  ],
  "weight": 0.5,
  "sku": "string",
  "metaTitle": "string",
  "metaDescription": "string",
  "categories": [
    {
      "id": "string",
      "name": "string",
      "slug": "string",
      "parentId": "string"
    }
  ]
}
{
  "error": "Error message"
}
Empty
{
  "error": "Error message"
}

Get product count

GET
/products-count

Authorization

ApiKeyAuth
x-api-key<token>

API key is automatically provided for demo requests in the playground

In: header

Query Parameters

slugs?array<string>

Category slug hierarchy. Omit or use "all-products" for all products. The last slug in the array is used as the category filter.

Response Body

application/json

curl -X GET "https://test.putiikkipalvelu.fi/api/storefront/v1/products-count?slugs=jewelry%2Crings"
{
  "count": 42
}
Empty

Get sorted products with pagination

GET
/sorted-products

Authorization

ApiKeyAuth
x-api-key<token>

API key is automatically provided for demo requests in the playground

In: header

Query Parameters

slugs?array<string>

Category slug hierarchy. Omit or use "all-products" for all products.

page?integer

Page number (1-based)

Default1
Range1 <= value
pageSize?integer

Products per page

Default12
Range1 <= value <= 100
sort?string

Sort order

Default"newest"
Value in"newest" | "price_asc" | "price_desc" | "popularity"

Response Body

application/json

application/json

curl -X GET "https://test.putiikkipalvelu.fi/api/storefront/v1/sorted-products?slugs=jewelry%2Crings"
{
  "name": "Korut",
  "products": [
    {
      "id": "clx123abc",
      "name": "Gold Ring",
      "slug": "gold-ring",
      "description": "string",
      "price": 15000,
      "images": [
        "http://example.com"
      ],
      "quantity": 0,
      "salePrice": 12000,
      "salePercent": "20",
      "saleStartDate": "2019-08-24T14:15:22Z",
      "saleEndDate": "2019-08-24T14:15:22Z",
      "variations": [
        {
          "id": "clx456def",
          "price": 15000,
          "salePrice": 12000,
          "salePercent": "20",
          "saleStartDate": "2019-08-24T14:15:22Z",
          "saleEndDate": "2019-08-24T14:15:22Z"
        }
      ]
    }
  ],
  "totalCount": 42
}
Empty
{
  "error": "Error message"
}

Get filtered products

GET
/filtered-products

Authorization

ApiKeyAuth
x-api-key<token>

API key is automatically provided for demo requests in the playground

In: header

Query Parameters

slugs?array<string>

Category slug hierarchy. Omit or use "all-products" for all products.

page?integer

Page number (1-based)

Default1
Range1 <= value
pageSize?integer

Products per page

Default12
Range1 <= value <= 100
sort?string

Sort order

Default"newest"
Value in"newest" | "price_asc" | "price_desc" | "popularity"

Response Body

application/json

application/json

curl -X GET "https://test.putiikkipalvelu.fi/api/storefront/v1/filtered-products?slugs=jewelry"
{
  "name": "string",
  "products": [
    {
      "id": "clx123abc",
      "name": "Gold Ring",
      "slug": "gold-ring",
      "description": "string",
      "price": 15000,
      "images": [
        "http://example.com"
      ],
      "quantity": 0,
      "salePrice": 12000,
      "salePercent": "20",
      "saleStartDate": "2019-08-24T14:15:22Z",
      "saleEndDate": "2019-08-24T14:15:22Z",
      "variations": [
        {
          "id": "clx456def",
          "price": 15000,
          "salePrice": 12000,
          "salePercent": "20",
          "saleStartDate": "2019-08-24T14:15:22Z",
          "saleEndDate": "2019-08-24T14:15:22Z"
        }
      ]
    }
  ]
}
Empty
{
  "error": "Error message"
}

Store Config

Previous Page

Categories

Next Page