Putiikkipalvelu Docs

Orders

Order details and confirmation

Get order by ID

GET
/order/{orderId}

Authorization

ApiKeyAuth
x-api-key<token>

API key is automatically provided for demo requests in the playground

In: header

Path Parameters

orderId*string

Order ID

Response Body

application/json

application/json

application/json

application/json

application/json

curl -X GET "https://test.putiikkipalvelu.fi/api/storefront/v1/order/clx123order"
{
  "id": "clx123order",
  "storeId": "clx123store",
  "createdAt": "2024-01-15T10:30:00.000Z",
  "totalAmount": 4999,
  "status": "PAID",
  "orderNumber": 1001,
  "OrderLineItems": [
    {
      "id": "item-1",
      "orderId": "clx123order",
      "itemType": "PRODUCT",
      "quantity": 2,
      "price": 1999,
      "totalAmount": 3998,
      "productCode": "prod-abc",
      "name": "Gold Ring",
      "vatRate": 25.5,
      "images": [
        "https://example.com/ring.jpg"
      ]
    },
    {
      "id": "item-2",
      "orderId": "clx123order",
      "itemType": "SHIPPING",
      "quantity": 1,
      "price": 1001,
      "totalAmount": 1001,
      "productCode": "shipping-001",
      "name": "Posti - Kotipaketti",
      "vatRate": 25.5,
      "images": []
    }
  ],
  "orderCustomerData": {
    "id": "cust-data-1",
    "firstName": "John",
    "lastName": "Doe",
    "email": "john@example.com",
    "phone": "+358401234567",
    "address": "Testikatu 1",
    "city": "Helsinki",
    "postalCode": "00100"
  },
  "orderShipmentMethod": {
    "id": "shipment-1",
    "serviceId": "posti-123",
    "name": "Posti - Kotipaketti",
    "description": "Toimitus kotiovelle",
    "logo": "https://example.com/posti-logo.png",
    "price": 1001,
    "orderId": "clx123order",
    "vatRate": 25.5,
    "trackingNumber": "JJFI1234567890",
    "trackingUrls": [
      "https://tracking.posti.fi/JJFI1234567890"
    ],
    "shipmentNumber": null,
    "freightDoc": []
  }
}
{
  "error": "Missing order id"
}
{
  "error": "Error message"
}
{
  "error": "Order not found"
}
{
  "error": "Error message"
}