Putiikkipalvelu Docs

Shipping

Shipment methods and pickup locations

Get available shipping methods

GET
/shipment-methods

Authorization

ApiKeyAuth
x-api-key<token>

API key is automatically provided for demo requests in the playground

In: header

Query Parameters

cartWeight?number

Cart weight in kg. If provided, filters Shipit methods where maxWeight >= cartWeight

Response Body

application/json

application/json

application/json

curl -X GET "https://test.putiikkipalvelu.fi/api/storefront/v1/shipment-methods?cartWeight=2.5"
{
  "shipmentMethods": [
    {
      "id": "clx123ship",
      "name": "Posti - Paketti",
      "description": "Delivery to pickup point",
      "price": 590,
      "active": true,
      "min_estimate_delivery_days": 1,
      "max_estimate_delivery_days": 3,
      "shipitMethod": {
        "id": "clx123shipit",
        "serviceId": "90010",
        "name": "Posti SmartPOST",
        "carrier": "Posti",
        "logo": "https://example.com/posti.png",
        "pickUpIncluded": false,
        "homeDelivery": false,
        "pickupPoint": true,
        "onlyParchelLocker": true
      }
    }
  ]
}
{
  "error": "Error message"
}
{
  "error": "Error message"
}

Get shipping methods with pickup locations

GET
/shipment-methods/{postalCode}

Authorization

ApiKeyAuth
x-api-key<token>

API key is automatically provided for demo requests in the playground

In: header

Path Parameters

postalCode*string

Customer's postal code

Query Parameters

cartWeight?number

Cart weight in kg. If provided, filters Shipit methods where maxWeight >= cartWeight

cartTotal?integer

Cart total in cents. If provided and meets a method's freeShippingThreshold, that method returns price=0

country?string

Country code (ISO 3166-1 alpha-2). Defaults to Finland.

Default"FI"

Response Body

application/json

application/json

application/json

application/json

application/json

application/json

curl -X GET "https://test.putiikkipalvelu.fi/api/storefront/v1/shipment-methods/00100?cartWeight=2.5&cartTotal=5000&country=FI"
{
  "shipmentMethods": [
    {
      "id": "clx123ship",
      "name": "Posti - Paketti",
      "description": "Delivery to pickup point",
      "price": 590,
      "active": true,
      "min_estimate_delivery_days": 1,
      "max_estimate_delivery_days": 3,
      "shipitMethod": {
        "serviceId": "90010",
        "carrier": "Posti"
      }
    }
  ],
  "pricedLocations": [
    {
      "id": "loc_123",
      "name": "K-Market Kamppi",
      "address1": "Urho Kekkosen katu 1",
      "zipcode": "00100",
      "city": "Helsinki",
      "countryCode": "FI",
      "serviceId": "90010",
      "carrier": "Posti",
      "merchantPrice": 590,
      "carrierLogo": "https://example.com/posti.png",
      "latitude": 60.1699,
      "longitude": 24.9384,
      "distanceInMeters": 250,
      "distanceInKilometers": 0.25,
      "openingHours": {
        "monday": [
          "08:00-21:00"
        ],
        "tuesday": [
          "08:00-21:00"
        ],
        "wednesday": [
          "08:00-21:00"
        ],
        "thursday": [
          "08:00-21:00"
        ],
        "friday": [
          "08:00-21:00"
        ],
        "saturday": [
          "10:00-18:00"
        ],
        "sunday": [
          "12:00-18:00"
        ],
        "exceptions": []
      }
    }
  ]
}
{
  "error": "Postal code is required"
}
{
  "error": "Error message"
}
{
  "error": "Shipit integration not found"
}
{
  "error": "Error message"
}
{
  "error": "Failed to fetch shipping locations from external service"
}