API-viite – Docs

Kanoninen v1-sopimus

Hintadatan OpenAPI-sopimus on generoitujen SDK-metodien, pyyntö- ja vastausmallien, virheiden sekä esimerkkien lähde. SDK-asiakas käyttää tuotannon v1-osoitetta ja palvelinpuolen Bearer-API-avainta.

Katalogi- ja vertailuoperaatiot

Ratkaise normalisoitu tuotetunniste searchProducts-metodilla, tee kahden–neljän tuotteen päätösvertailu compareProducts-metodilla, lue nykyiset toimitetut tarjoukset getProductComparison-metodilla ja hae kooste- tai kauppakohtainen hintahistoria getProductPriceHistory-metodilla.

Virheet ja uudelleenyritykset

Validoi syötteet ennen lähetystä. Yritä tilapäisiä 429- ja 5xx-vastauksia uudelleen Retry-After-otsakkeen ja SDK:n retry-käytännön mukaan; älä yritä tunnistautumis-, validointi- tai not-found-virhettä uudelleen muuttamatta pyyntöä.

GET /v1/connected-catalog

GET/v1/connected-catalog

Todennus vaaditaan

List products from the independent backendlistConnectedProducts

Reads the explicitly bound workspace and environment. No demo fallback. Monetary values in this catalogue are decimal strings.

Parametrit

qquerystringValinnainen

limitqueryintegerValinnainen

cursorquerystringValinnainen

Koodiesimerkit

cURLillustrative

Esimerkin luotettavuus: illustrativeNäyttää muodon tai idean; älä käytä sellaisenaan tuotannossa.

curl --fail-with-body -X GET "https://hintadata.fi/v1/connected-catalog?q=&limit=50&cursor=" \
  -H "Authorization: Bearer $HINTADATA_API_KEY"

Vastaukset7

200Source-owned productsapplication/json

{
  "items": [],
  "total": 0,
  "limit": 0,
  "next_cursor": ""
}

Generoitu status-sopimuksesta

400Virheellinen pyyntö

{
  "error": {
    "code": "request_failed",
    "message": "Virheellinen pyyntö",
    "request_id": "req_example"
  }
}

Generoitu status-sopimuksesta

401Authentication required

{
  "error": {
    "code": "unauthorized",
    "message": "Authentication required",
    "request_id": "req_example"
  }
}

Generoitu status-sopimuksesta

403Workspace, scope or entitlement denied

{
  "error": {
    "code": "forbidden",
    "message": "Workspace, scope or entitlement denied",
    "request_id": "req_example"
  }
}

Generoitu status-sopimuksesta

429Quota exceeded

{
  "error": {
    "code": "rate_limited",
    "message": "Quota exceeded",
    "request_id": "req_example"
  }
}

Generoitu status-sopimuksesta

502Invalid backend response

{
  "error": {
    "code": "server_error",
    "message": "Invalid backend response",
    "request_id": "req_example"
  }
}

Generoitu status-sopimuksesta

503Backend not available or configured

{
  "error": {
    "code": "server_error",
    "message": "Backend not available or configured",
    "request_id": "req_example"
  }
}

Generoitu status-sopimuksesta

KokeileSandbox

GET /v1/connected-catalog/{productId}

GET/v1/connected-catalog/{productId}

Todennus vaaditaan

Inspect observed offers and comparable price groupsgetConnectedProduct

Parametrit

productIdpathstringPakollinen

Koodiesimerkit

cURLillustrative

Esimerkin luotettavuus: illustrativeNäyttää muodon tai idean; älä käytä sellaisenaan tuotannossa.

curl --fail-with-body -X GET "https://hintadata.fi/v1/connected-catalog/" \
  -H "Authorization: Bearer $HINTADATA_API_KEY"

Vastaukset8

200Observed productapplication/json

{
  "canonical_product_id": "",
  "title": "",
  "brand": "",
  "variant": "",
  "gtin": "",
  "match_status": "matched",
  "match_method": "exact_gtin",
  "offers": [],
  "comparison_groups": [],
  "freshness_max_hours": 0
}

Generoitu status-sopimuksesta

400Virheellinen pyyntö

{
  "error": {
    "code": "request_failed",
    "message": "Virheellinen pyyntö",
    "request_id": "req_example"
  }
}

Generoitu status-sopimuksesta

401Authentication required

{
  "error": {
    "code": "unauthorized",
    "message": "Authentication required",
    "request_id": "req_example"
  }
}

Generoitu status-sopimuksesta

403Workspace, scope or entitlement denied

{
  "error": {
    "code": "forbidden",
    "message": "Workspace, scope or entitlement denied",
    "request_id": "req_example"
  }
}

Generoitu status-sopimuksesta

404Product not found

{
  "error": {
    "code": "not_found",
    "message": "Product not found",
    "request_id": "req_example"
  }
}

Generoitu status-sopimuksesta

429Quota exceeded

{
  "error": {
    "code": "rate_limited",
    "message": "Quota exceeded",
    "request_id": "req_example"
  }
}

Generoitu status-sopimuksesta

502Invalid backend response

{
  "error": {
    "code": "server_error",
    "message": "Invalid backend response",
    "request_id": "req_example"
  }
}

Generoitu status-sopimuksesta

503Backend unavailable

{
  "error": {
    "code": "server_error",
    "message": "Backend unavailable",
    "request_id": "req_example"
  }
}

Generoitu status-sopimuksesta

KokeileSandbox

GET /v1/connected-catalog/{productId}/history

GET/v1/connected-catalog/{productId}/history

Todennus vaaditaan

Inspect observed price history without interpolationgetConnectedProductHistory

Parametrit

productIdpathstringPakollinen

limitqueryintegerValinnainen

cursorquerystringValinnainen

Koodiesimerkit

cURLillustrative

Esimerkin luotettavuus: illustrativeNäyttää muodon tai idean; älä käytä sellaisenaan tuotannossa.

curl --fail-with-body -X GET "https://hintadata.fi/v1/connected-catalog//history?limit=50&cursor=" \
  -H "Authorization: Bearer $HINTADATA_API_KEY"

Vastaukset9

200Observed historyapplication/json

{
  "items": [],
  "next_cursor": "",
  "order": "observed",
  "coverage": {
    "event_count": 0,
    "first_observed_at": "",
    "last_observed_at": ""
  },
  "gaps": []
}

Generoitu status-sopimuksesta

400Virheellinen pyyntö

{
  "error": {
    "code": "request_failed",
    "message": "Virheellinen pyyntö",
    "request_id": "req_example"
  }
}

Generoitu status-sopimuksesta

401Authentication required

{
  "error": {
    "code": "unauthorized",
    "message": "Authentication required",
    "request_id": "req_example"
  }
}

Generoitu status-sopimuksesta

403Workspace, scope or entitlement denied

{
  "error": {
    "code": "forbidden",
    "message": "Workspace, scope or entitlement denied",
    "request_id": "req_example"
  }
}

Generoitu status-sopimuksesta

404Product not found

{
  "error": {
    "code": "not_found",
    "message": "Product not found",
    "request_id": "req_example"
  }
}

Generoitu status-sopimuksesta

422Invalid or expired cursor

{
  "error": {
    "code": "validation_error",
    "message": "Invalid or expired cursor",
    "request_id": "req_example"
  }
}

Generoitu status-sopimuksesta

429Quota exceeded

{
  "error": {
    "code": "rate_limited",
    "message": "Quota exceeded",
    "request_id": "req_example"
  }
}

Generoitu status-sopimuksesta

502Invalid backend response

{
  "error": {
    "code": "server_error",
    "message": "Invalid backend response",
    "request_id": "req_example"
  }
}

Generoitu status-sopimuksesta

503Backend unavailable

{
  "error": {
    "code": "server_error",
    "message": "Backend unavailable",
    "request_id": "req_example"
  }
}

Generoitu status-sopimuksesta

KokeileSandbox

GET /v1/webhooks

GET/v1/webhooks

Todennus vaaditaan

Listaa webhook-tilauksetlistWebhooks

Vaatii webhooks:write-oikeuden ja webhooks:manage-käyttöoikeuden. Työtila ja testi-/tuotantoympäristö määräytyvät API-avaimesta.

Koodiesimerkit

cURLillustrative

Esimerkin luotettavuus: illustrativeNäyttää muodon tai idean; älä käytä sellaisenaan tuotannossa.

curl --fail-with-body -X GET "https://hintadata.fi/v1/webhooks" \
  -H "Authorization: Bearer $HINTADATA_API_KEY"

Vastaukset8

200Onnistunut vastausapplication/json

{
  "items": []
}

Generoitu status-sopimuksesta

400Pyyntö hylättiin; tarkista turvallinen virhekoodi.application/json

{
  "error": {
    "code": "",
    "message": ""
  },
  "request_id": ""
}

Generoitu status-sopimuksesta

401Pyyntö hylättiin; tarkista turvallinen virhekoodi.application/json

{
  "error": {
    "code": "",
    "message": ""
  },
  "request_id": ""
}

Generoitu status-sopimuksesta

403Pyyntö hylättiin; tarkista turvallinen virhekoodi.application/json

{
  "error": {
    "code": "",
    "message": ""
  },
  "request_id": ""
}

Generoitu status-sopimuksesta

404Pyyntö hylättiin; tarkista turvallinen virhekoodi.application/json

{
  "error": {
    "code": "",
    "message": ""
  },
  "request_id": ""
}

Generoitu status-sopimuksesta

409Pyyntö hylättiin; tarkista turvallinen virhekoodi.application/json

{
  "error": {
    "code": "",
    "message": ""
  },
  "request_id": ""
}

Generoitu status-sopimuksesta

429Pyyntö hylättiin; tarkista turvallinen virhekoodi.application/json

{
  "error": {
    "code": "",
    "message": ""
  },
  "request_id": ""
}

Generoitu status-sopimuksesta

503Pyyntö hylättiin; tarkista turvallinen virhekoodi.application/json

{
  "error": {
    "code": "",
    "message": ""
  },
  "request_id": ""
}

Generoitu status-sopimuksesta

KokeileSandbox

POST /v1/webhooks

POST/v1/webhooks

Todennus vaaditaan

Luo webhook-tilauscreateWebhook

Vaatii webhooks:write-oikeuden ja webhooks:manage-käyttöoikeuden. Työtila ja testi-/tuotantoympäristö määräytyvät API-avaimesta.

Parametrit

Idempotency-KeyheaderstringPakollinen

PyyntörunkoPakollinen

application/json

Koodiesimerkit

cURLillustrative

Esimerkin luotettavuus: illustrativeNäyttää muodon tai idean; älä käytä sellaisenaan tuotannossa.

curl --fail-with-body -X POST "https://hintadata.fi/v1/webhooks" \
  -H "Authorization: Bearer $HINTADATA_API_KEY" \
  -H "Content-Type: application/json" \
  --data '{
  "url": "",
  "events": [],
  "enabled": true
}'

Vastaukset8

201Onnistunut vastausapplication/json

{
  "rotation": {
    "id": "",
    "prepared_at": 0,
    "expires_at": 0
  },
  "breaker": {
    "failures": 0,
    "open_until": 0,
    "probe_until": 0
  },
  "incident": {
    "id": "",
    "status": "open",
    "opened_at": 0,
    "acknowledged_at": 0,
    "resolved_at": 0,
    "code": ""
  },
  "id": "",
  "url": "",
  "events": [],
  "enabled": true,
  "created_at": "",
  "secret": ""
}

Generoitu status-sopimuksesta

400Pyyntö hylättiin; tarkista turvallinen virhekoodi.application/json

{
  "error": {
    "code": "",
    "message": ""
  },
  "request_id": ""
}

Generoitu status-sopimuksesta

401Pyyntö hylättiin; tarkista turvallinen virhekoodi.application/json

{
  "error": {
    "code": "",
    "message": ""
  },
  "request_id": ""
}

Generoitu status-sopimuksesta

403Pyyntö hylättiin; tarkista turvallinen virhekoodi.application/json

{
  "error": {
    "code": "",
    "message": ""
  },
  "request_id": ""
}

Generoitu status-sopimuksesta

404Pyyntö hylättiin; tarkista turvallinen virhekoodi.application/json

{
  "error": {
    "code": "",
    "message": ""
  },
  "request_id": ""
}

Generoitu status-sopimuksesta

409Pyyntö hylättiin; tarkista turvallinen virhekoodi.application/json

{
  "error": {
    "code": "",
    "message": ""
  },
  "request_id": ""
}

Generoitu status-sopimuksesta

429Pyyntö hylättiin; tarkista turvallinen virhekoodi.application/json

{
  "error": {
    "code": "",
    "message": ""
  },
  "request_id": ""
}

Generoitu status-sopimuksesta

503Pyyntö hylättiin; tarkista turvallinen virhekoodi.application/json

{
  "error": {
    "code": "",
    "message": ""
  },
  "request_id": ""
}

Generoitu status-sopimuksesta

KokeileSandbox

PATCH /v1/webhooks/{webhook_id}

PATCH/v1/webhooks/{webhook_id}

Todennus vaaditaan

Päivitä webhook-tilausupdateWebhook

Vaatii webhooks:write-oikeuden ja webhooks:manage-käyttöoikeuden. Työtila ja testi-/tuotantoympäristö määräytyvät API-avaimesta.

Parametrit

webhook_idpathstringPakollinen

Idempotency-KeyheaderstringValinnainen

Valinnainen päivityksen tai poiston uusinta-avain. Identtinen avaimellinen pyyntö palauttaa alkuperäisen tuloksen 24 tuntia toistamatta peruutuksia tai auditointimerkintöjä.

PyyntörunkoPakollinen

application/json

Koodiesimerkit

cURLillustrative

Esimerkin luotettavuus: illustrativeNäyttää muodon tai idean; älä käytä sellaisenaan tuotannossa.

curl --fail-with-body -X PATCH "https://hintadata.fi/v1/webhooks/" \
  -H "Authorization: Bearer $HINTADATA_API_KEY" \
  -H "Content-Type: application/json" \
  --data '{
  "url": "",
  "events": [],
  "enabled": true
}'

Vastaukset8

200Onnistunut vastausapplication/json

{
  "rotation": {
    "id": "",
    "prepared_at": 0,
    "expires_at": 0
  },
  "breaker": {
    "failures": 0,
    "open_until": 0,
    "probe_until": 0
  },
  "incident": {
    "id": "",
    "status": "open",
    "opened_at": 0,
    "acknowledged_at": 0,
    "resolved_at": 0,
    "code": ""
  },
  "id": "",
  "url": "",
  "events": [],
  "enabled": true,
  "created_at": ""
}

Generoitu status-sopimuksesta

400Pyyntö hylättiin; tarkista turvallinen virhekoodi.application/json

{
  "error": {
    "code": "",
    "message": ""
  },
  "request_id": ""
}

Generoitu status-sopimuksesta

401Pyyntö hylättiin; tarkista turvallinen virhekoodi.application/json

{
  "error": {
    "code": "",
    "message": ""
  },
  "request_id": ""
}

Generoitu status-sopimuksesta

403Pyyntö hylättiin; tarkista turvallinen virhekoodi.application/json

{
  "error": {
    "code": "",
    "message": ""
  },
  "request_id": ""
}

Generoitu status-sopimuksesta

404Pyyntö hylättiin; tarkista turvallinen virhekoodi.application/json

{
  "error": {
    "code": "",
    "message": ""
  },
  "request_id": ""
}

Generoitu status-sopimuksesta

409Pyyntö hylättiin; tarkista turvallinen virhekoodi.application/json

{
  "error": {
    "code": "",
    "message": ""
  },
  "request_id": ""
}

Generoitu status-sopimuksesta

429Pyyntö hylättiin; tarkista turvallinen virhekoodi.application/json

{
  "error": {
    "code": "",
    "message": ""
  },
  "request_id": ""
}

Generoitu status-sopimuksesta

503Pyyntö hylättiin; tarkista turvallinen virhekoodi.application/json

{
  "error": {
    "code": "",
    "message": ""
  },
  "request_id": ""
}

Generoitu status-sopimuksesta

KokeileSandbox

DELETE /v1/webhooks/{webhook_id}

DELETE/v1/webhooks/{webhook_id}

Todennus vaaditaan

Poista webhook-tilausdeleteWebhook

Vaatii webhooks:write-oikeuden ja webhooks:manage-käyttöoikeuden. Työtila ja testi-/tuotantoympäristö määräytyvät API-avaimesta.

Parametrit

webhook_idpathstringPakollinen

Idempotency-KeyheaderstringValinnainen

Valinnainen päivityksen tai poiston uusinta-avain. Identtinen avaimellinen pyyntö palauttaa alkuperäisen tuloksen 24 tuntia toistamatta peruutuksia tai auditointimerkintöjä.

Koodiesimerkit

cURLillustrative

Esimerkin luotettavuus: illustrativeNäyttää muodon tai idean; älä käytä sellaisenaan tuotannossa.

curl --fail-with-body -X DELETE "https://hintadata.fi/v1/webhooks/" \
  -H "Authorization: Bearer $HINTADATA_API_KEY"

Vastaukset8

200Onnistunut vastausapplication/json

{
  "deleted": false
}

Generoitu status-sopimuksesta

400Pyyntö hylättiin; tarkista turvallinen virhekoodi.application/json

{
  "error": {
    "code": "",
    "message": ""
  },
  "request_id": ""
}

Generoitu status-sopimuksesta

401Pyyntö hylättiin; tarkista turvallinen virhekoodi.application/json

{
  "error": {
    "code": "",
    "message": ""
  },
  "request_id": ""
}

Generoitu status-sopimuksesta

403Pyyntö hylättiin; tarkista turvallinen virhekoodi.application/json

{
  "error": {
    "code": "",
    "message": ""
  },
  "request_id": ""
}

Generoitu status-sopimuksesta

404Pyyntö hylättiin; tarkista turvallinen virhekoodi.application/json

{
  "error": {
    "code": "",
    "message": ""
  },
  "request_id": ""
}

Generoitu status-sopimuksesta

409Pyyntö hylättiin; tarkista turvallinen virhekoodi.application/json

{
  "error": {
    "code": "",
    "message": ""
  },
  "request_id": ""
}

Generoitu status-sopimuksesta

429Pyyntö hylättiin; tarkista turvallinen virhekoodi.application/json

{
  "error": {
    "code": "",
    "message": ""
  },
  "request_id": ""
}

Generoitu status-sopimuksesta

503Pyyntö hylättiin; tarkista turvallinen virhekoodi.application/json

{
  "error": {
    "code": "",
    "message": ""
  },
  "request_id": ""
}

Generoitu status-sopimuksesta

KokeileSandbox

POST /v1/webhooks/{webhook_id}/secret-rotation

POST/v1/webhooks/{webhook_id}/secret-rotation

Todennus vaaditaan

Valmistele uusi allekirjoitussalaisuusprepareWebhookSecretRotation

Vaatii webhooks:write- ja webhooks:manage-oikeudet. Palauttaa valmistellun salaisuuden ja rotation.id-tunnisteen; asenna molemmat salaisuudet vastaanottajalle ennen aktivointia. Valmistelu vanhenee 24 tunnissa. Nykyinen salaisuus pysyy aktiivisena. Idempotentti uusinta palauttaa alkuperäisen salaisuusvastauksen 24 tuntia.

Parametrit

webhook_idpathstringPakollinen

Idempotency-KeyheaderstringPakollinen

Koodiesimerkit

cURLillustrative

Esimerkin luotettavuus: illustrativeNäyttää muodon tai idean; älä käytä sellaisenaan tuotannossa.

curl --fail-with-body -X POST "https://hintadata.fi/v1/webhooks//secret-rotation" \
  -H "Authorization: Bearer $HINTADATA_API_KEY"

Vastaukset8

200Onnistunut vastausapplication/json

{
  "rotation": {
    "id": "",
    "prepared_at": 0,
    "expires_at": 0
  },
  "breaker": {
    "failures": 0,
    "open_until": 0,
    "probe_until": 0
  },
  "incident": {
    "id": "",
    "status": "open",
    "opened_at": 0,
    "acknowledged_at": 0,
    "resolved_at": 0,
    "code": ""
  },
  "id": "",
  "url": "",
  "events": [],
  "enabled": true,
  "created_at": "",
  "secret": ""
}

Generoitu status-sopimuksesta

400Pyyntö hylättiin; tarkista turvallinen virhekoodi.application/json

{
  "error": {
    "code": "",
    "message": ""
  },
  "request_id": ""
}

Generoitu status-sopimuksesta

401Pyyntö hylättiin; tarkista turvallinen virhekoodi.application/json

{
  "error": {
    "code": "",
    "message": ""
  },
  "request_id": ""
}

Generoitu status-sopimuksesta

403Pyyntö hylättiin; tarkista turvallinen virhekoodi.application/json

{
  "error": {
    "code": "",
    "message": ""
  },
  "request_id": ""
}

Generoitu status-sopimuksesta

404Pyyntö hylättiin; tarkista turvallinen virhekoodi.application/json

{
  "error": {
    "code": "",
    "message": ""
  },
  "request_id": ""
}

Generoitu status-sopimuksesta

409Pyyntö hylättiin; tarkista turvallinen virhekoodi.application/json

{
  "error": {
    "code": "",
    "message": ""
  },
  "request_id": ""
}

Generoitu status-sopimuksesta

429Pyyntö hylättiin; tarkista turvallinen virhekoodi.application/json

{
  "error": {
    "code": "",
    "message": ""
  },
  "request_id": ""
}

Generoitu status-sopimuksesta

503Pyyntö hylättiin; tarkista turvallinen virhekoodi.application/json

{
  "error": {
    "code": "",
    "message": ""
  },
  "request_id": ""
}

Generoitu status-sopimuksesta

KokeileSandbox

POST /v1/webhooks/{webhook_id}/secret-rotation/activate

POST/v1/webhooks/{webhook_id}/secret-rotation/activate

Todennus vaaditaan

Aktivoi valmisteltu allekirjoitussalaisuusactivateWebhookSecretRotation

Vaatii webhooks:write- ja webhooks:manage-oikeudet. Vahvista, että vastaanottaja hyväksyy valmistellun salaisuuden. Allekirjoitus vaihtuu atomisesti. Hyväksy vanha salaisuus vähintään 60 sekuntia matkalla olevia pyyntöjä varten ja poista se sitten vastaanottajalta. Ei palauta salaisuuksia.

Parametrit

webhook_idpathstringPakollinen

Idempotency-KeyheaderstringPakollinen

PyyntörunkoPakollinen

application/json

Koodiesimerkit

cURLillustrative

Esimerkin luotettavuus: illustrativeNäyttää muodon tai idean; älä käytä sellaisenaan tuotannossa.

curl --fail-with-body -X POST "https://hintadata.fi/v1/webhooks//secret-rotation/activate" \
  -H "Authorization: Bearer $HINTADATA_API_KEY" \
  -H "Content-Type: application/json" \
  --data '{
  "rotation_id": "",
  "confirm": true
}'

Vastaukset2

200Aktivoitu tilausapplication/json

{
  "rotation": {
    "id": "",
    "prepared_at": 0,
    "expires_at": 0
  },
  "breaker": {
    "failures": 0,
    "open_until": 0,
    "probe_until": 0
  },
  "incident": {
    "id": "",
    "status": "open",
    "opened_at": 0,
    "acknowledged_at": 0,
    "resolved_at": 0,
    "code": ""
  },
  "id": "",
  "url": "",
  "events": [],
  "enabled": true,
  "created_at": ""
}

Generoitu status-sopimuksesta

defaultTurvallinen virhekoodi: todennus (401), käyttöoikeus (403), puuttuva tilaus (404), virheellinen syöte (400), vanhentunut pyyntö (409), kapasiteetti (429) tai tallennuksen/salauksen häiriö (503).application/json

{
  "error": {
    "code": "",
    "message": ""
  },
  "request_id": ""
}

Generoitu status-sopimuksesta

KokeileSandbox

POST /v1/webhooks/{webhook_id}/secret-rotation/cancel

POST/v1/webhooks/{webhook_id}/secret-rotation/cancel

Todennus vaaditaan

Peru valmisteltu salaisuuden vaihtocancelWebhookSecretRotation

Vaatii webhooks:write- ja webhooks:manage-oikeudet. Hylkää valmistelun muuttamatta aktiivista salaisuutta. Poista käyttämätön valmisteltu salaisuus vastaanottajalta.

Parametrit

webhook_idpathstringPakollinen

Idempotency-KeyheaderstringPakollinen

PyyntörunkoPakollinen

application/json

Koodiesimerkit

cURLillustrative

Esimerkin luotettavuus: illustrativeNäyttää muodon tai idean; älä käytä sellaisenaan tuotannossa.

curl --fail-with-body -X POST "https://hintadata.fi/v1/webhooks//secret-rotation/cancel" \
  -H "Authorization: Bearer $HINTADATA_API_KEY" \
  -H "Content-Type: application/json" \
  --data '{
  "rotation_id": ""
}'

Vastaukset2

200Aktiivinen tilaus ennallaanapplication/json

{
  "rotation": {
    "id": "",
    "prepared_at": 0,
    "expires_at": 0
  },
  "breaker": {
    "failures": 0,
    "open_until": 0,
    "probe_until": 0
  },
  "incident": {
    "id": "",
    "status": "open",
    "opened_at": 0,
    "acknowledged_at": 0,
    "resolved_at": 0,
    "code": ""
  },
  "id": "",
  "url": "",
  "events": [],
  "enabled": true,
  "created_at": ""
}

Generoitu status-sopimuksesta

defaultTurvallinen virhekoodi: todennus (401), käyttöoikeus (403), puuttuva tilaus (404), virheellinen syöte (400), vanhentunut pyyntö (409), kapasiteetti (429) tai tallennuksen/salauksen häiriö (503).application/json

{
  "error": {
    "code": "",
    "message": ""
  },
  "request_id": ""
}

Generoitu status-sopimuksesta

KokeileSandbox

POST /v1/webhooks/{webhook_id}/incidents/acknowledge

POST/v1/webhooks/{webhook_id}/incidents/acknowledge

Todennus vaaditaan

Kuittaa vastaanottajan häiriöacknowledgeWebhookIncident

Vaatii webhooks:write- ja webhooks:manage-oikeudet. Lopettaa muistutukset, ei yrityksiä tai jäähyä. Onnistunut toimitus ratkaisee häiriön ja käynnistää palautumisilmoituksen. Vanhat epäonnistuneet toimitukset jäävät historiaan.

Parametrit

webhook_idpathstringPakollinen

Idempotency-KeyheaderstringPakollinen

PyyntörunkoPakollinen

application/json

Koodiesimerkit

cURLillustrative

Esimerkin luotettavuus: illustrativeNäyttää muodon tai idean; älä käytä sellaisenaan tuotannossa.

curl --fail-with-body -X POST "https://hintadata.fi/v1/webhooks//incidents/acknowledge" \
  -H "Authorization: Bearer $HINTADATA_API_KEY" \
  -H "Content-Type: application/json" \
  --data '{
  "incident_id": ""
}'

Vastaukset2

200Tilauksen häiriö kuitattuapplication/json

{
  "rotation": {
    "id": "",
    "prepared_at": 0,
    "expires_at": 0
  },
  "breaker": {
    "failures": 0,
    "open_until": 0,
    "probe_until": 0
  },
  "incident": {
    "id": "",
    "status": "open",
    "opened_at": 0,
    "acknowledged_at": 0,
    "resolved_at": 0,
    "code": ""
  },
  "id": "",
  "url": "",
  "events": [],
  "enabled": true,
  "created_at": ""
}

Generoitu status-sopimuksesta

defaultTurvallinen virhekoodi: todennus (401), käyttöoikeus (403), puuttuva tilaus (404), virheellinen syöte (400), vanhentunut pyyntö (409), kapasiteetti (429) tai tallennuksen/salauksen häiriö (503).application/json

{
  "error": {
    "code": "",
    "message": ""
  },
  "request_id": ""
}

Generoitu status-sopimuksesta

KokeileSandbox

GET /v1/webhook-deliveries

GET/v1/webhook-deliveries

Todennus vaaditaan

Listaa webhook-toimituksetlistWebhookDeliveries

Vaatii webhooks:write-oikeuden ja webhooks:manage-käyttöoikeuden. Työtila ja testi-/tuotantoympäristö määräytyvät API-avaimesta.

Parametrit

subscription_idquerystringValinnainen

limitqueryintegerValinnainen

offsetqueryintegerValinnainen

Koodiesimerkit

cURLillustrative

Esimerkin luotettavuus: illustrativeNäyttää muodon tai idean; älä käytä sellaisenaan tuotannossa.

curl --fail-with-body -X GET "https://hintadata.fi/v1/webhook-deliveries?subscription_id=&limit=25&offset=0" \
  -H "Authorization: Bearer $HINTADATA_API_KEY"

Vastaukset8

200Onnistunut vastausapplication/json

{
  "items": [],
  "total": 0,
  "next_offset": ""
}

Generoitu status-sopimuksesta

400Pyyntö hylättiin; tarkista turvallinen virhekoodi.application/json

{
  "error": {
    "code": "",
    "message": ""
  },
  "request_id": ""
}

Generoitu status-sopimuksesta

401Pyyntö hylättiin; tarkista turvallinen virhekoodi.application/json

{
  "error": {
    "code": "",
    "message": ""
  },
  "request_id": ""
}

Generoitu status-sopimuksesta

403Pyyntö hylättiin; tarkista turvallinen virhekoodi.application/json

{
  "error": {
    "code": "",
    "message": ""
  },
  "request_id": ""
}

Generoitu status-sopimuksesta

404Pyyntö hylättiin; tarkista turvallinen virhekoodi.application/json

{
  "error": {
    "code": "",
    "message": ""
  },
  "request_id": ""
}

Generoitu status-sopimuksesta

409Pyyntö hylättiin; tarkista turvallinen virhekoodi.application/json

{
  "error": {
    "code": "",
    "message": ""
  },
  "request_id": ""
}

Generoitu status-sopimuksesta

429Pyyntö hylättiin; tarkista turvallinen virhekoodi.application/json

{
  "error": {
    "code": "",
    "message": ""
  },
  "request_id": ""
}

Generoitu status-sopimuksesta

503Pyyntö hylättiin; tarkista turvallinen virhekoodi.application/json

{
  "error": {
    "code": "",
    "message": ""
  },
  "request_id": ""
}

Generoitu status-sopimuksesta

KokeileSandbox

GET /v1/search

GET/v1/search

Todennus vaaditaan

Hae normalisoituja tuotteitasearchProducts

Hakee tuotteen nimen, EANin tai kanonisen tunnisteen kaikilla hakusanoilla lähdejärjestyksessä. min_price on pienin tunnettu saatavilla oleva toimitettu hinta tai null; store_count laskee eri saatavilla olevat kaupat.

Parametrit

X-API-VersionheaderstringValinnainen

qquerystringPakollinen

Tuotteen nimi, malli, rinnakkaisnimi tai EAN-tunniste.

limitqueryintegerValinnainen

offsetqueryintegerValinnainen

Koodiesimerkit

cURLillustrative

Esimerkin luotettavuus: illustrativeNäyttää muodon tai idean; älä käytä sellaisenaan tuotannossa.

curl --fail-with-body -X GET "https://hintadata.fi/v1/search?q=sony+xm5&limit=25&offset=0" \
  -H "Authorization: Bearer $HINTADATA_API_KEY"

Vastaukset10

200Järjestetyt hakutuloksetapplication/json

{
  "query": "",
  "total": 0,
  "items": [],
  "next_offset": "",
  "evidence": {
    "source_id": "",
    "source_ref": "",
    "observed_at": "",
    "expires_at": "",
    "market": "",
    "currency": "",
    "tax_basis": "inclusive"
  }
}

Generoitu status-sopimuksesta

400Virheellinen pyyntöapplication/json

{
  "error": {
    "code": "",
    "message": ""
  },
  "request_id": ""
}

Generoitu status-sopimuksesta

401API-avain vaaditaanapplication/json

{
  "error": {
    "code": "",
    "message": ""
  },
  "request_id": ""
}

Generoitu status-sopimuksesta

403Avaimen tai tilauksen käyttöoikeus puuttuuapplication/json

{
  "error": {
    "code": "",
    "message": ""
  },
  "request_id": ""
}

Generoitu status-sopimuksesta

404Resurssia ei löytynytapplication/json

{
  "error": {
    "code": "",
    "message": ""
  },
  "request_id": ""
}

Generoitu status-sopimuksesta

409Samanaikainen muutos tai idempotenssiristiriitaapplication/json

{
  "error": {
    "code": "",
    "message": ""
  },
  "request_id": ""
}

Generoitu status-sopimuksesta

413Pyyntö on liian suuriapplication/json

{
  "error": {
    "code": "",
    "message": ""
  },
  "request_id": ""
}

Generoitu status-sopimuksesta

429Pyyntömäärän tai kapasiteetin rajaapplication/json

{
  "error": {
    "code": "",
    "message": ""
  },
  "request_id": ""
}

Generoitu status-sopimuksesta

500Tilapäinen palvelinvirheapplication/json

{
  "error": {
    "code": "",
    "message": ""
  },
  "request_id": ""
}

Generoitu status-sopimuksesta

503Lähdeaineisto tai toimitus ei ole käytettävissäapplication/json

{
  "error": {
    "code": "",
    "message": ""
  },
  "request_id": ""
}

Generoitu status-sopimuksesta

KokeileSandbox

GET /v1/compare

GET/v1/compare

Todennus vaaditaan

Vertaa kahta–neljää tuotettacompareProducts

Vertaa kahden–neljän täsmällisen tuotetunnisteen havaittuja toimitettuja hintoja. Ei soveltuvuusarviota tai aikajaksoa. best_offer on null, jos saatavilla olevaa tarjousta ei tunneta. Historia haetaan erikseen.

Parametrit

X-API-VersionheaderstringValinnainen

idsquerystringValinnainen

Pilkulla erotettu luettelo kahdesta–neljästä kanonisesta tuotetunnisteesta.

idquerystring[]Valinnainen

Vaihtoehto ids-parametrille: toista id-parametri. Valitse yhteensä kaksi–neljä eri tunnistetta.

Koodiesimerkit

cURLillustrative

Esimerkin luotettavuus: illustrativeNäyttää muodon tai idean; älä käytä sellaisenaan tuotannossa.

curl --fail-with-body -X GET "https://hintadata.fi/v1/compare?ids=sony_wh1000xm5_black%2Csony_wh1000xm6_black&id=" \
  -H "Authorization: Bearer $HINTADATA_API_KEY"

Vastaukset10

200Tuotevertailuapplication/json

{
  "products": [],
  "evidence": {
    "source_id": "",
    "source_ref": "",
    "observed_at": "",
    "expires_at": "",
    "market": "",
    "currency": "",
    "tax_basis": "inclusive"
  }
}

Generoitu status-sopimuksesta

400Virheellinen pyyntöapplication/json

{
  "error": {
    "code": "",
    "message": ""
  },
  "request_id": ""
}

Generoitu status-sopimuksesta

401API-avain vaaditaanapplication/json

{
  "error": {
    "code": "",
    "message": ""
  },
  "request_id": ""
}

Generoitu status-sopimuksesta

403Avaimen tai tilauksen käyttöoikeus puuttuuapplication/json

{
  "error": {
    "code": "",
    "message": ""
  },
  "request_id": ""
}

Generoitu status-sopimuksesta

404Resurssia ei löytynytapplication/json

{
  "error": {
    "code": "",
    "message": ""
  },
  "request_id": ""
}

Generoitu status-sopimuksesta

409Samanaikainen muutos tai idempotenssiristiriitaapplication/json

{
  "error": {
    "code": "",
    "message": ""
  },
  "request_id": ""
}

Generoitu status-sopimuksesta

413Pyyntö on liian suuriapplication/json

{
  "error": {
    "code": "",
    "message": ""
  },
  "request_id": ""
}

Generoitu status-sopimuksesta

429Pyyntömäärän tai kapasiteetin rajaapplication/json

{
  "error": {
    "code": "",
    "message": ""
  },
  "request_id": ""
}

Generoitu status-sopimuksesta

500Tilapäinen palvelinvirheapplication/json

{
  "error": {
    "code": "",
    "message": ""
  },
  "request_id": ""
}

Generoitu status-sopimuksesta

503Lähdeaineisto tai toimitus ei ole käytettävissäapplication/json

{
  "error": {
    "code": "",
    "message": ""
  },
  "request_id": ""
}

Generoitu status-sopimuksesta

KokeileSandbox

GET /v1/products/{canonical_product_id}

GET/v1/products/{canonical_product_id}

Todennus vaaditaan

Hae tuote ja sen nykyiset tarjouksetgetProductComparison

Hae tuote ja sen nykyiset tarjoukset

Parametrit

X-API-VersionheaderstringValinnainen

canonical_product_idpathstringPakollinen

Koodiesimerkit

cURLillustrative

Esimerkin luotettavuus: illustrativeNäyttää muodon tai idean; älä käytä sellaisenaan tuotannossa.

curl --fail-with-body -X GET "https://hintadata.fi/v1/products/sony_wh1000xm5_black" \
  -H "Authorization: Bearer $HINTADATA_API_KEY"

Vastaukset10

200Tuotetiedot, tarjoukset ja suositusapplication/json

{
  "canonical_product_id": "",
  "product_name": "",
  "product": {
    "canonical_product_id": "",
    "product_name": "",
    "brand": "",
    "model": "",
    "variant": "",
    "category": "",
    "ean": "",
    "match_confidence": 0,
    "match_status": "",
    "image_path": "",
    "specs": [],
    "comparison_name": "",
    "comparison_score": 0,
    "comparison_badge": "",
    "comparison_summary": ""
  },
  "offers": [],
  "decision": {
    "label": "",
    "store": "",
    "score": 0,
    "delivered_price": 0,
    "url": "",
    "rationale": "",
    "lowest_item_price": 0,
    "lowest_item_store": "",
    "evaluated_offer_count": 0,
    "updated_at": ""
  },
  "evidence": {
    "source_id": "",
    "source_ref": "",
    "observed_at": "",
    "expires_at": "",
    "market": "",
    "currency": "",
    "tax_basis": "inclusive"
  }
}

Generoitu status-sopimuksesta

400Virheellinen pyyntöapplication/json

{
  "error": {
    "code": "",
    "message": ""
  },
  "request_id": ""
}

Generoitu status-sopimuksesta

401API-avain vaaditaanapplication/json

{
  "error": {
    "code": "",
    "message": ""
  },
  "request_id": ""
}

Generoitu status-sopimuksesta

403Avaimen tai tilauksen käyttöoikeus puuttuuapplication/json

{
  "error": {
    "code": "",
    "message": ""
  },
  "request_id": ""
}

Generoitu status-sopimuksesta

404Resurssia ei löytynytapplication/json

{
  "error": {
    "code": "",
    "message": ""
  },
  "request_id": ""
}

Generoitu status-sopimuksesta

409Samanaikainen muutos tai idempotenssiristiriitaapplication/json

{
  "error": {
    "code": "",
    "message": ""
  },
  "request_id": ""
}

Generoitu status-sopimuksesta

413Pyyntö on liian suuriapplication/json

{
  "error": {
    "code": "",
    "message": ""
  },
  "request_id": ""
}

Generoitu status-sopimuksesta

429Pyyntömäärän tai kapasiteetin rajaapplication/json

{
  "error": {
    "code": "",
    "message": ""
  },
  "request_id": ""
}

Generoitu status-sopimuksesta

500Tilapäinen palvelinvirheapplication/json

{
  "error": {
    "code": "",
    "message": ""
  },
  "request_id": ""
}

Generoitu status-sopimuksesta

503Lähdeaineisto tai toimitus ei ole käytettävissäapplication/json

{
  "error": {
    "code": "",
    "message": ""
  },
  "request_id": ""
}

Generoitu status-sopimuksesta

KokeileSandbox

GET /v1/products/{canonical_product_id}/history

GET/v1/products/{canonical_product_id}/history

Todennus vaaditaan

Hae tuotteen tai kaupan hintahistoriagetProductPriceHistory

Palauttaa oletuksena koostetun hintatiedon. Kun store on annettu, palauttaa kaupan hintahavainnot aikajärjestyksessä.

Parametrit

X-API-VersionheaderstringValinnainen

canonical_product_idpathstringPakollinen

rangequerystringValinnainen

enum: 7d, 30d, 90d, 1y

storequerystringValinnainen

Koodiesimerkit

cURLillustrative

Esimerkin luotettavuus: illustrativeNäyttää muodon tai idean; älä käytä sellaisenaan tuotannossa.

curl --fail-with-body -X GET "https://hintadata.fi/v1/products/sony_wh1000xm5_black/history?range=90d&store=power.fi" \
  -H "Authorization: Bearer $HINTADATA_API_KEY"

Vastaukset10

200Koostettu hintatieto tai kaupan hintahistoriaapplication/json

{
  "canonical_product_id": "",
  "range": "7d",
  "series": [],
  "summary": {
    "current_price": "",
    "observation_count": 0
  },
  "evidence": {
    "source_id": "",
    "source_ref": "",
    "observed_at": "",
    "expires_at": "",
    "market": "",
    "currency": "",
    "tax_basis": "inclusive"
  }
}

Generoitu status-sopimuksesta

400Virheellinen pyyntöapplication/json

{
  "error": {
    "code": "",
    "message": ""
  },
  "request_id": ""
}

Generoitu status-sopimuksesta

401API-avain vaaditaanapplication/json

{
  "error": {
    "code": "",
    "message": ""
  },
  "request_id": ""
}

Generoitu status-sopimuksesta

403Avaimen tai tilauksen käyttöoikeus puuttuuapplication/json

{
  "error": {
    "code": "",
    "message": ""
  },
  "request_id": ""
}

Generoitu status-sopimuksesta

404Resurssia ei löytynytapplication/json

{
  "error": {
    "code": "",
    "message": ""
  },
  "request_id": ""
}

Generoitu status-sopimuksesta

409Samanaikainen muutos tai idempotenssiristiriitaapplication/json

{
  "error": {
    "code": "",
    "message": ""
  },
  "request_id": ""
}

Generoitu status-sopimuksesta

413Pyyntö on liian suuriapplication/json

{
  "error": {
    "code": "",
    "message": ""
  },
  "request_id": ""
}

Generoitu status-sopimuksesta

429Pyyntömäärän tai kapasiteetin rajaapplication/json

{
  "error": {
    "code": "",
    "message": ""
  },
  "request_id": ""
}

Generoitu status-sopimuksesta

500Tilapäinen palvelinvirheapplication/json

{
  "error": {
    "code": "",
    "message": ""
  },
  "request_id": ""
}

Generoitu status-sopimuksesta

503Lähdeaineisto tai toimitus ei ole käytettävissäapplication/json

{
  "error": {
    "code": "",
    "message": ""
  },
  "request_id": ""
}

Generoitu status-sopimuksesta

KokeileSandbox

GET /v1/watchlists

GET/v1/watchlists

Todennus vaaditaan

Listaa hintavahditlistPriceWatches

Listaa hintavahdit

Parametrit

X-API-VersionheaderstringValinnainen

limitqueryintegerValinnainen

offsetqueryintegerValinnainen

statusquerystringValinnainen

enum: active, paused

canonical_product_idquerystringValinnainen

Koodiesimerkit

cURLillustrative

Esimerkin luotettavuus: illustrativeNäyttää muodon tai idean; älä käytä sellaisenaan tuotannossa.

curl --fail-with-body -X GET "https://hintadata.fi/v1/watchlists?limit=25&offset=0&status=active&canonical_product_id=" \
  -H "Authorization: Bearer $HINTADATA_API_KEY"

Vastaukset10

200Asiakkaan hintavahditapplication/json

{
  "total": 0,
  "items": [],
  "next_offset": ""
}

Generoitu status-sopimuksesta

400Virheellinen pyyntöapplication/json

{
  "error": {
    "code": "",
    "message": ""
  },
  "request_id": ""
}

Generoitu status-sopimuksesta

401API-avain vaaditaanapplication/json

{
  "error": {
    "code": "",
    "message": ""
  },
  "request_id": ""
}

Generoitu status-sopimuksesta

403Avaimen tai tilauksen käyttöoikeus puuttuuapplication/json

{
  "error": {
    "code": "",
    "message": ""
  },
  "request_id": ""
}

Generoitu status-sopimuksesta

404Resurssia ei löytynytapplication/json

{
  "error": {
    "code": "",
    "message": ""
  },
  "request_id": ""
}

Generoitu status-sopimuksesta

409Samanaikainen muutos tai idempotenssiristiriitaapplication/json

{
  "error": {
    "code": "",
    "message": ""
  },
  "request_id": ""
}

Generoitu status-sopimuksesta

413Pyyntö on liian suuriapplication/json

{
  "error": {
    "code": "",
    "message": ""
  },
  "request_id": ""
}

Generoitu status-sopimuksesta

429Pyyntömäärän tai kapasiteetin rajaapplication/json

{
  "error": {
    "code": "",
    "message": ""
  },
  "request_id": ""
}

Generoitu status-sopimuksesta

500Tilapäinen palvelinvirheapplication/json

{
  "error": {
    "code": "",
    "message": ""
  },
  "request_id": ""
}

Generoitu status-sopimuksesta

503Lähdeaineisto tai toimitus ei ole käytettävissäapplication/json

{
  "error": {
    "code": "",
    "message": ""
  },
  "request_id": ""
}

Generoitu status-sopimuksesta

KokeileSandbox

POST /v1/watchlists

POST/v1/watchlists

Todennus vaaditaan

Luo tuotteen hintavahticreatePriceWatch

Luo uuden erillisen vahdin korvaamatta muita. Idempotency-Key palauttaa saman pyynnön tuloksen. Tuotannon toimituskanavan on oltava määritetty.

Parametrit

X-API-VersionheaderstringValinnainen

Idempotency-KeyheaderstringPakollinen

PyyntörunkoPakollinen

application/json

Koodiesimerkit

cURLillustrative

Esimerkin luotettavuus: illustrativeNäyttää muodon tai idean; älä käytä sellaisenaan tuotannossa.

curl --fail-with-body -X POST "https://hintadata.fi/v1/watchlists" \
  -H "Authorization: Bearer $HINTADATA_API_KEY" \
  -H "Content-Type: application/json" \
  --data '{
  "canonical_product_id": "sony_wh1000xm5_black",
  "condition": "target_price",
  "target_price": 280,
  "channel": "email",
  "destination": "buyer@example.com"
}'

Vastaukset10

201Hintavahti luotuapplication/json

VastausotsakkeetLocation

{
  "id": "",
  "canonical_product_id": "",
  "target_price": 0,
  "channel": "email",
  "destination": "",
  "status": "active",
  "created_at": "",
  "updated_at": "",
  "product": {
    "canonical_product_id": "",
    "product_name": "",
    "brand": "",
    "model": "",
    "variant": "",
    "image_path": "",
    "match_confidence": 0,
    "min_price": "",
    "store_count": 0,
    "relevance_score": 0
  },
  "current_price": "",
  "target_reached": false,
  "revision": 0,
  "condition": "target_price",
  "change_percent": 0,
  "merchant_sku": "",
  "availability": "available"
}

Generoitu status-sopimuksesta

400Virheellinen pyyntöapplication/json

{
  "error": {
    "code": "",
    "message": ""
  },
  "request_id": ""
}

Generoitu status-sopimuksesta

401API-avain vaaditaanapplication/json

{
  "error": {
    "code": "",
    "message": ""
  },
  "request_id": ""
}

Generoitu status-sopimuksesta

403Avaimen tai tilauksen käyttöoikeus puuttuuapplication/json

{
  "error": {
    "code": "",
    "message": ""
  },
  "request_id": ""
}

Generoitu status-sopimuksesta

404Resurssia ei löytynytapplication/json

{
  "error": {
    "code": "",
    "message": ""
  },
  "request_id": ""
}

Generoitu status-sopimuksesta

409Samanaikainen muutos tai idempotenssiristiriitaapplication/json

{
  "error": {
    "code": "",
    "message": ""
  },
  "request_id": ""
}

Generoitu status-sopimuksesta

413Pyyntö on liian suuriapplication/json

{
  "error": {
    "code": "",
    "message": ""
  },
  "request_id": ""
}

Generoitu status-sopimuksesta

429Pyyntömäärän tai kapasiteetin rajaapplication/json

{
  "error": {
    "code": "",
    "message": ""
  },
  "request_id": ""
}

Generoitu status-sopimuksesta

500Tilapäinen palvelinvirheapplication/json

{
  "error": {
    "code": "",
    "message": ""
  },
  "request_id": ""
}

Generoitu status-sopimuksesta

503Lähdeaineisto tai toimitus ei ole käytettävissäapplication/json

{
  "error": {
    "code": "",
    "message": ""
  },
  "request_id": ""
}

Generoitu status-sopimuksesta

KokeileSandbox

PATCH /v1/watchlists/{watch_id}

PATCH/v1/watchlists/{watch_id}

Todennus vaaditaan

Päivitä hintavahtiupdatePriceWatch

Päivitä hintavahti

Parametrit

X-API-VersionheaderstringValinnainen

watch_idpathstringPakollinen

PyyntörunkoPakollinen

application/json

Koodiesimerkit

cURLillustrative

Esimerkin luotettavuus: illustrativeNäyttää muodon tai idean; älä käytä sellaisenaan tuotannossa.

curl --fail-with-body -X PATCH "https://hintadata.fi/v1/watchlists/00000000-0000-4000-8000-000000000001" \
  -H "Authorization: Bearer $HINTADATA_API_KEY" \
  -H "Content-Type: application/json" \
  --data '{
  "expected_revision": 1,
  "target_price": 265,
  "status": "active"
}'

Vastaukset10

200Päivitetty hintavahtiapplication/json

{
  "id": "",
  "canonical_product_id": "",
  "target_price": 0,
  "channel": "email",
  "destination": "",
  "status": "active",
  "created_at": "",
  "updated_at": "",
  "product": {
    "canonical_product_id": "",
    "product_name": "",
    "brand": "",
    "model": "",
    "variant": "",
    "image_path": "",
    "match_confidence": 0,
    "min_price": "",
    "store_count": 0,
    "relevance_score": 0
  },
  "current_price": "",
  "target_reached": false,
  "revision": 0,
  "condition": "target_price",
  "change_percent": 0,
  "merchant_sku": "",
  "availability": "available"
}

Generoitu status-sopimuksesta

400Virheellinen pyyntöapplication/json

{
  "error": {
    "code": "",
    "message": ""
  },
  "request_id": ""
}

Generoitu status-sopimuksesta

401API-avain vaaditaanapplication/json

{
  "error": {
    "code": "",
    "message": ""
  },
  "request_id": ""
}

Generoitu status-sopimuksesta

403Avaimen tai tilauksen käyttöoikeus puuttuuapplication/json

{
  "error": {
    "code": "",
    "message": ""
  },
  "request_id": ""
}

Generoitu status-sopimuksesta

404Resurssia ei löytynytapplication/json

{
  "error": {
    "code": "",
    "message": ""
  },
  "request_id": ""
}

Generoitu status-sopimuksesta

409Samanaikainen muutos tai idempotenssiristiriitaapplication/json

{
  "error": {
    "code": "",
    "message": ""
  },
  "request_id": ""
}

Generoitu status-sopimuksesta

413Pyyntö on liian suuriapplication/json

{
  "error": {
    "code": "",
    "message": ""
  },
  "request_id": ""
}

Generoitu status-sopimuksesta

429Pyyntömäärän tai kapasiteetin rajaapplication/json

{
  "error": {
    "code": "",
    "message": ""
  },
  "request_id": ""
}

Generoitu status-sopimuksesta

500Tilapäinen palvelinvirheapplication/json

{
  "error": {
    "code": "",
    "message": ""
  },
  "request_id": ""
}

Generoitu status-sopimuksesta

503Lähdeaineisto tai toimitus ei ole käytettävissäapplication/json

{
  "error": {
    "code": "",
    "message": ""
  },
  "request_id": ""
}

Generoitu status-sopimuksesta

KokeileSandbox

DELETE /v1/watchlists/{watch_id}

DELETE/v1/watchlists/{watch_id}

Todennus vaaditaan

Poista hintavahtideletePriceWatch

Poista hintavahti

Parametrit

X-API-VersionheaderstringValinnainen

watch_idpathstringPakollinen

Koodiesimerkit

cURLillustrative

Esimerkin luotettavuus: illustrativeNäyttää muodon tai idean; älä käytä sellaisenaan tuotannossa.

curl --fail-with-body -X DELETE "https://hintadata.fi/v1/watchlists/00000000-0000-4000-8000-000000000001" \
  -H "Authorization: Bearer $HINTADATA_API_KEY"

Vastaukset10

204Hintavahti poistettu

400Virheellinen pyyntöapplication/json

{
  "error": {
    "code": "",
    "message": ""
  },
  "request_id": ""
}

Generoitu status-sopimuksesta

401API-avain vaaditaanapplication/json

{
  "error": {
    "code": "",
    "message": ""
  },
  "request_id": ""
}

Generoitu status-sopimuksesta

403Avaimen tai tilauksen käyttöoikeus puuttuuapplication/json

{
  "error": {
    "code": "",
    "message": ""
  },
  "request_id": ""
}

Generoitu status-sopimuksesta

404Resurssia ei löytynytapplication/json

{
  "error": {
    "code": "",
    "message": ""
  },
  "request_id": ""
}

Generoitu status-sopimuksesta

409Samanaikainen muutos tai idempotenssiristiriitaapplication/json

{
  "error": {
    "code": "",
    "message": ""
  },
  "request_id": ""
}

Generoitu status-sopimuksesta

413Pyyntö on liian suuriapplication/json

{
  "error": {
    "code": "",
    "message": ""
  },
  "request_id": ""
}

Generoitu status-sopimuksesta

429Pyyntömäärän tai kapasiteetin rajaapplication/json

{
  "error": {
    "code": "",
    "message": ""
  },
  "request_id": ""
}

Generoitu status-sopimuksesta

500Tilapäinen palvelinvirheapplication/json

{
  "error": {
    "code": "",
    "message": ""
  },
  "request_id": ""
}

Generoitu status-sopimuksesta

503Lähdeaineisto tai toimitus ei ole käytettävissäapplication/json

{
  "error": {
    "code": "",
    "message": ""
  },
  "request_id": ""
}

Generoitu status-sopimuksesta

KokeileSandbox

GET /v1/pricing/recommendations

GET/v1/pricing/recommendations

Todennus vaaditaan

Lue hinnoittelusuosituksetlistPricingRecommendations

Lue hinnoittelusuositukset

Parametrit

limitqueryintegerValinnainen

offsetqueryintegerValinnainen

canonical_product_idquerystringValinnainen

Koodiesimerkit

cURLillustrative

Esimerkin luotettavuus: illustrativeNäyttää muodon tai idean; älä käytä sellaisenaan tuotannossa.

curl --fail-with-body -X GET "https://hintadata.fi/v1/pricing/recommendations?limit=25&offset=0&canonical_product_id=" \
  -H "Authorization: Bearer $HINTADATA_API_KEY"

Vastaukset9

200Onnistunut vastausapplication/json

{
  "items": [],
  "total": 0,
  "next_offset": "",
  "evidence": {
    "source_id": "",
    "source_ref": "",
    "observed_at": "",
    "expires_at": "",
    "market": "",
    "currency": "",
    "tax_basis": "inclusive"
  }
}

Generoitu status-sopimuksesta

400Virheellinen pyyntöapplication/json

{
  "error": {
    "code": "",
    "message": ""
  },
  "request_id": ""
}

Generoitu status-sopimuksesta

401API-avain vaaditaanapplication/json

{
  "error": {
    "code": "",
    "message": ""
  },
  "request_id": ""
}

Generoitu status-sopimuksesta

403Avaimen tai tilauksen käyttöoikeus puuttuuapplication/json

{
  "error": {
    "code": "",
    "message": ""
  },
  "request_id": ""
}

Generoitu status-sopimuksesta

404Resurssia ei löytynytapplication/json

{
  "error": {
    "code": "",
    "message": ""
  },
  "request_id": ""
}

Generoitu status-sopimuksesta

409Samanaikainen muutos tai idempotenssiristiriitaapplication/json

{
  "error": {
    "code": "",
    "message": ""
  },
  "request_id": ""
}

Generoitu status-sopimuksesta

413Pyyntö on liian suuriapplication/json

{
  "error": {
    "code": "",
    "message": ""
  },
  "request_id": ""
}

Generoitu status-sopimuksesta

429Pyyntömäärän tai kapasiteetin rajaapplication/json

{
  "error": {
    "code": "",
    "message": ""
  },
  "request_id": ""
}

Generoitu status-sopimuksesta

503Lähdeaineisto tai toimitus ei ole käytettävissäapplication/json

{
  "error": {
    "code": "",
    "message": ""
  },
  "request_id": ""
}

Generoitu status-sopimuksesta

KokeileSandbox

GET /v1/assortment/opportunities

GET/v1/assortment/opportunities

Todennus vaaditaan

Lue valikoimamahdollisuudetlistAssortmentOpportunities

Lue valikoimamahdollisuudet

Parametrit

limitqueryintegerValinnainen

offsetqueryintegerValinnainen

canonical_product_idquerystringValinnainen

Koodiesimerkit

cURLillustrative

Esimerkin luotettavuus: illustrativeNäyttää muodon tai idean; älä käytä sellaisenaan tuotannossa.

curl --fail-with-body -X GET "https://hintadata.fi/v1/assortment/opportunities?limit=25&offset=0&canonical_product_id=" \
  -H "Authorization: Bearer $HINTADATA_API_KEY"

Vastaukset9

200Onnistunut vastausapplication/json

{
  "items": [],
  "total": 0,
  "next_offset": "",
  "evidence": {
    "source_id": "",
    "source_ref": "",
    "observed_at": "",
    "expires_at": "",
    "market": "",
    "currency": "",
    "tax_basis": "inclusive"
  }
}

Generoitu status-sopimuksesta

400Virheellinen pyyntöapplication/json

{
  "error": {
    "code": "",
    "message": ""
  },
  "request_id": ""
}

Generoitu status-sopimuksesta

401API-avain vaaditaanapplication/json

{
  "error": {
    "code": "",
    "message": ""
  },
  "request_id": ""
}

Generoitu status-sopimuksesta

403Avaimen tai tilauksen käyttöoikeus puuttuuapplication/json

{
  "error": {
    "code": "",
    "message": ""
  },
  "request_id": ""
}

Generoitu status-sopimuksesta

404Resurssia ei löytynytapplication/json

{
  "error": {
    "code": "",
    "message": ""
  },
  "request_id": ""
}

Generoitu status-sopimuksesta

409Samanaikainen muutos tai idempotenssiristiriitaapplication/json

{
  "error": {
    "code": "",
    "message": ""
  },
  "request_id": ""
}

Generoitu status-sopimuksesta

413Pyyntö on liian suuriapplication/json

{
  "error": {
    "code": "",
    "message": ""
  },
  "request_id": ""
}

Generoitu status-sopimuksesta

429Pyyntömäärän tai kapasiteetin rajaapplication/json

{
  "error": {
    "code": "",
    "message": ""
  },
  "request_id": ""
}

Generoitu status-sopimuksesta

503Lähdeaineisto tai toimitus ei ole käytettävissäapplication/json

{
  "error": {
    "code": "",
    "message": ""
  },
  "request_id": ""
}

Generoitu status-sopimuksesta

KokeileSandbox

GET /v1/sourcing/options

GET/v1/sourcing/options

Todennus vaaditaan

Lue hankintavaihtoehdotlistSourcingOptions

Lue hankintavaihtoehdot

Parametrit

limitqueryintegerValinnainen

offsetqueryintegerValinnainen

canonical_product_idquerystringValinnainen

Koodiesimerkit

cURLillustrative

Esimerkin luotettavuus: illustrativeNäyttää muodon tai idean; älä käytä sellaisenaan tuotannossa.

curl --fail-with-body -X GET "https://hintadata.fi/v1/sourcing/options?limit=25&offset=0&canonical_product_id=" \
  -H "Authorization: Bearer $HINTADATA_API_KEY"

Vastaukset9

200Onnistunut vastausapplication/json

{
  "items": [],
  "total": 0,
  "next_offset": "",
  "evidence": {
    "source_id": "",
    "source_ref": "",
    "observed_at": "",
    "expires_at": "",
    "market": "",
    "currency": "",
    "tax_basis": "inclusive"
  }
}

Generoitu status-sopimuksesta

400Virheellinen pyyntöapplication/json

{
  "error": {
    "code": "",
    "message": ""
  },
  "request_id": ""
}

Generoitu status-sopimuksesta

401API-avain vaaditaanapplication/json

{
  "error": {
    "code": "",
    "message": ""
  },
  "request_id": ""
}

Generoitu status-sopimuksesta

403Avaimen tai tilauksen käyttöoikeus puuttuuapplication/json

{
  "error": {
    "code": "",
    "message": ""
  },
  "request_id": ""
}

Generoitu status-sopimuksesta

404Resurssia ei löytynytapplication/json

{
  "error": {
    "code": "",
    "message": ""
  },
  "request_id": ""
}

Generoitu status-sopimuksesta

409Samanaikainen muutos tai idempotenssiristiriitaapplication/json

{
  "error": {
    "code": "",
    "message": ""
  },
  "request_id": ""
}

Generoitu status-sopimuksesta

413Pyyntö on liian suuriapplication/json

{
  "error": {
    "code": "",
    "message": ""
  },
  "request_id": ""
}

Generoitu status-sopimuksesta

429Pyyntömäärän tai kapasiteetin rajaapplication/json

{
  "error": {
    "code": "",
    "message": ""
  },
  "request_id": ""
}

Generoitu status-sopimuksesta

503Lähdeaineisto tai toimitus ei ole käytettävissäapplication/json

{
  "error": {
    "code": "",
    "message": ""
  },
  "request_id": ""
}

Generoitu status-sopimuksesta

KokeileSandbox

GET /v1/campaigns/signals

GET/v1/campaigns/signals

Todennus vaaditaan

Lue kampanjasignaalitlistCampaignSignals

Lue kampanjasignaalit

Parametrit

limitqueryintegerValinnainen

offsetqueryintegerValinnainen

canonical_product_idquerystringValinnainen

Koodiesimerkit

cURLillustrative

Esimerkin luotettavuus: illustrativeNäyttää muodon tai idean; älä käytä sellaisenaan tuotannossa.

curl --fail-with-body -X GET "https://hintadata.fi/v1/campaigns/signals?limit=25&offset=0&canonical_product_id=" \
  -H "Authorization: Bearer $HINTADATA_API_KEY"

Vastaukset9

200Onnistunut vastausapplication/json

{
  "items": [],
  "total": 0,
  "next_offset": "",
  "evidence": {
    "source_id": "",
    "source_ref": "",
    "observed_at": "",
    "expires_at": "",
    "market": "",
    "currency": "",
    "tax_basis": "inclusive"
  }
}

Generoitu status-sopimuksesta

400Virheellinen pyyntöapplication/json

{
  "error": {
    "code": "",
    "message": ""
  },
  "request_id": ""
}

Generoitu status-sopimuksesta

401API-avain vaaditaanapplication/json

{
  "error": {
    "code": "",
    "message": ""
  },
  "request_id": ""
}

Generoitu status-sopimuksesta

403Avaimen tai tilauksen käyttöoikeus puuttuuapplication/json

{
  "error": {
    "code": "",
    "message": ""
  },
  "request_id": ""
}

Generoitu status-sopimuksesta

404Resurssia ei löytynytapplication/json

{
  "error": {
    "code": "",
    "message": ""
  },
  "request_id": ""
}

Generoitu status-sopimuksesta

409Samanaikainen muutos tai idempotenssiristiriitaapplication/json

{
  "error": {
    "code": "",
    "message": ""
  },
  "request_id": ""
}

Generoitu status-sopimuksesta

413Pyyntö on liian suuriapplication/json

{
  "error": {
    "code": "",
    "message": ""
  },
  "request_id": ""
}

Generoitu status-sopimuksesta

429Pyyntömäärän tai kapasiteetin rajaapplication/json

{
  "error": {
    "code": "",
    "message": ""
  },
  "request_id": ""
}

Generoitu status-sopimuksesta

503Lähdeaineisto tai toimitus ei ole käytettävissäapplication/json

{
  "error": {
    "code": "",
    "message": ""
  },
  "request_id": ""
}

Generoitu status-sopimuksesta

KokeileSandbox

PUT /v1/sources/{source_id}/snapshot

PUT/v1/sources/{source_id}/snapshot

Todennus vaaditaan

Korvaa työtilan markkina-aineisto lähdetiedot säilyttävällä tilannekuvallaputSourceSnapshot

Korvaa työtilan markkina-aineisto lähdetiedot säilyttävällä tilannekuvalla

Parametrit

source_idpathstringPakollinen

Idempotency-KeyheaderstringPakollinen

PyyntörunkoPakollinen

application/json

Koodiesimerkit

cURLillustrative

Esimerkin luotettavuus: illustrativeNäyttää muodon tai idean; älä käytä sellaisenaan tuotannossa.

curl --fail-with-body -X PUT "https://hintadata.fi/v1/sources//snapshot" \
  -H "Authorization: Bearer $HINTADATA_API_KEY" \
  -H "Content-Type: application/json" \
  --data '{
  "evidence": {
    "source_id": "",
    "source_ref": "",
    "observed_at": "",
    "expires_at": "",
    "market": "",
    "currency": "",
    "tax_basis": "inclusive"
  },
  "products": [],
  "supplier_offers": [],
  "campaign_signals": []
}'

Vastaukset9

200Onnistunut vastausapplication/json

{
  "source_id": "",
  "observed_at": "",
  "products": 0,
  "events_queued": 0
}

Generoitu status-sopimuksesta

400Virheellinen pyyntöapplication/json

{
  "error": {
    "code": "",
    "message": ""
  },
  "request_id": ""
}

Generoitu status-sopimuksesta

401API-avain vaaditaanapplication/json

{
  "error": {
    "code": "",
    "message": ""
  },
  "request_id": ""
}

Generoitu status-sopimuksesta

403Avaimen tai tilauksen käyttöoikeus puuttuuapplication/json

{
  "error": {
    "code": "",
    "message": ""
  },
  "request_id": ""
}

Generoitu status-sopimuksesta

404Resurssia ei löytynytapplication/json

{
  "error": {
    "code": "",
    "message": ""
  },
  "request_id": ""
}

Generoitu status-sopimuksesta

409Samanaikainen muutos tai idempotenssiristiriitaapplication/json

{
  "error": {
    "code": "",
    "message": ""
  },
  "request_id": ""
}

Generoitu status-sopimuksesta

413Pyyntö on liian suuriapplication/json

{
  "error": {
    "code": "",
    "message": ""
  },
  "request_id": ""
}

Generoitu status-sopimuksesta

429Pyyntömäärän tai kapasiteetin rajaapplication/json

{
  "error": {
    "code": "",
    "message": ""
  },
  "request_id": ""
}

Generoitu status-sopimuksesta

503Lähdeaineisto tai toimitus ei ole käytettävissäapplication/json

{
  "error": {
    "code": "",
    "message": ""
  },
  "request_id": ""
}

Generoitu status-sopimuksesta

KokeileSandbox

GET /v1/webhook-metrics

GET/v1/webhook-metrics

Todennus vaaditaan

Lue webhook-toimitusten mittaritgetWebhookMetrics

Vaatii webhooks:write-oikeuden ja webhooks:manage-käyttöoikeuden. Työtila ja testi-/tuotantoympäristö määräytyvät varmennetusta tunnuksesta.

Koodiesimerkit

cURLillustrative

Esimerkin luotettavuus: illustrativeNäyttää muodon tai idean; älä käytä sellaisenaan tuotannossa.

curl --fail-with-body -X GET "https://hintadata.fi/v1/webhook-metrics" \
  -H "Authorization: Bearer $HINTADATA_API_KEY"

Vastaukset8

200Onnistunut vastausapplication/json

{
  "active_incidents": 0,
  "unresolved_incidents": 0,
  "counts": {
    "pending": 0,
    "sending": 0,
    "delivered": 0,
    "failed": 0,
    "cancelled": 0
  },
  "oldest_pending_age_ms": 0,
  "observed_at": 0,
  "window_days": 7
}

Generoitu status-sopimuksesta

400Pyyntö hylättiin; tarkista turvallinen virhekoodi.application/json

{
  "error": {
    "code": "",
    "message": ""
  },
  "request_id": ""
}

Generoitu status-sopimuksesta

401Pyyntö hylättiin; tarkista turvallinen virhekoodi.application/json

{
  "error": {
    "code": "",
    "message": ""
  },
  "request_id": ""
}

Generoitu status-sopimuksesta

403Pyyntö hylättiin; tarkista turvallinen virhekoodi.application/json

{
  "error": {
    "code": "",
    "message": ""
  },
  "request_id": ""
}

Generoitu status-sopimuksesta

404Pyyntö hylättiin; tarkista turvallinen virhekoodi.application/json

{
  "error": {
    "code": "",
    "message": ""
  },
  "request_id": ""
}

Generoitu status-sopimuksesta

409Pyyntö hylättiin; tarkista turvallinen virhekoodi.application/json

{
  "error": {
    "code": "",
    "message": ""
  },
  "request_id": ""
}

Generoitu status-sopimuksesta

429Pyyntö hylättiin; tarkista turvallinen virhekoodi.application/json

{
  "error": {
    "code": "",
    "message": ""
  },
  "request_id": ""
}

Generoitu status-sopimuksesta

503Pyyntö hylättiin; tarkista turvallinen virhekoodi.application/json

{
  "error": {
    "code": "",
    "message": ""
  },
  "request_id": ""
}

Generoitu status-sopimuksesta

KokeileSandbox

GET /v1/webhook-audit

GET/v1/webhook-audit

Todennus vaaditaan

Lue webhookien auditointihistorialistWebhookAudit

Vaatii webhooks:write-oikeuden ja webhooks:manage-käyttöoikeuden. Työtila ja testi-/tuotantoympäristö määräytyvät varmennetusta tunnuksesta.

Koodiesimerkit

cURLillustrative

Esimerkin luotettavuus: illustrativeNäyttää muodon tai idean; älä käytä sellaisenaan tuotannossa.

curl --fail-with-body -X GET "https://hintadata.fi/v1/webhook-audit" \
  -H "Authorization: Bearer $HINTADATA_API_KEY"

Vastaukset8

200Onnistunut vastausapplication/json

{
  "items": []
}

Generoitu status-sopimuksesta

400Pyyntö hylättiin; tarkista turvallinen virhekoodi.application/json

{
  "error": {
    "code": "",
    "message": ""
  },
  "request_id": ""
}

Generoitu status-sopimuksesta

401Pyyntö hylättiin; tarkista turvallinen virhekoodi.application/json

{
  "error": {
    "code": "",
    "message": ""
  },
  "request_id": ""
}

Generoitu status-sopimuksesta

403Pyyntö hylättiin; tarkista turvallinen virhekoodi.application/json

{
  "error": {
    "code": "",
    "message": ""
  },
  "request_id": ""
}

Generoitu status-sopimuksesta

404Pyyntö hylättiin; tarkista turvallinen virhekoodi.application/json

{
  "error": {
    "code": "",
    "message": ""
  },
  "request_id": ""
}

Generoitu status-sopimuksesta

409Pyyntö hylättiin; tarkista turvallinen virhekoodi.application/json

{
  "error": {
    "code": "",
    "message": ""
  },
  "request_id": ""
}

Generoitu status-sopimuksesta

429Pyyntö hylättiin; tarkista turvallinen virhekoodi.application/json

{
  "error": {
    "code": "",
    "message": ""
  },
  "request_id": ""
}

Generoitu status-sopimuksesta

503Pyyntö hylättiin; tarkista turvallinen virhekoodi.application/json

{
  "error": {
    "code": "",
    "message": ""
  },
  "request_id": ""
}

Generoitu status-sopimuksesta

KokeileSandbox

POST /v1/webhooks/{webhook_id}/test

POST/v1/webhooks/{webhook_id}/test

Todennus vaaditaan

Jonota vahvistettu webhook-testitoimitustestWebhook

Vaatii webhooks:write-oikeuden ja webhooks:manage-käyttöoikeuden. Työtila ja ympäristö määräytyvät varmennetusta tunnuksesta. Vain tuotantoympäristössä: nimenomainen vahvistus jonottaa webhook.test-tapahtuman datalla {test:true}, ei asiakasdataa. Yksi testi päätepistettä kohti minuutissa. Verkkopyyntö lähtee vasta työntekijän käsittelyssä.

Parametrit

webhook_idpathstringPakollinen

Idempotency-KeyheaderstringPakollinen

PyyntörunkoPakollinen

application/json

Koodiesimerkit

cURLillustrative

Esimerkin luotettavuus: illustrativeNäyttää muodon tai idean; älä käytä sellaisenaan tuotannossa.

curl --fail-with-body -X POST "https://hintadata.fi/v1/webhooks//test" \
  -H "Authorization: Bearer $HINTADATA_API_KEY" \
  -H "Content-Type: application/json" \
  --data '{
  "confirm": true
}'

Vastaukset8

200Onnistunut vastausapplication/json

{
  "attempt_history": [],
  "id": "",
  "event_id": "",
  "event_type": "",
  "subscription_id": "",
  "created_at": "",
  "status": "pending",
  "attempts": 0,
  "next_at": 0,
  "http_status": "",
  "completed_at": 0,
  "cycle_attempts": 0,
  "replays": 0,
  "last_error_code": ""
}

Generoitu status-sopimuksesta

400Pyyntö hylättiin; tarkista turvallinen virhekoodi.application/json

{
  "error": {
    "code": "",
    "message": ""
  },
  "request_id": ""
}

Generoitu status-sopimuksesta

401Pyyntö hylättiin; tarkista turvallinen virhekoodi.application/json

{
  "error": {
    "code": "",
    "message": ""
  },
  "request_id": ""
}

Generoitu status-sopimuksesta

403Pyyntö hylättiin; tarkista turvallinen virhekoodi.application/json

{
  "error": {
    "code": "",
    "message": ""
  },
  "request_id": ""
}

Generoitu status-sopimuksesta

404Pyyntö hylättiin; tarkista turvallinen virhekoodi.application/json

{
  "error": {
    "code": "",
    "message": ""
  },
  "request_id": ""
}

Generoitu status-sopimuksesta

409Pyyntö hylättiin; tarkista turvallinen virhekoodi.application/json

{
  "error": {
    "code": "",
    "message": ""
  },
  "request_id": ""
}

Generoitu status-sopimuksesta

429Pyyntö hylättiin; tarkista turvallinen virhekoodi.application/json

{
  "error": {
    "code": "",
    "message": ""
  },
  "request_id": ""
}

Generoitu status-sopimuksesta

503Pyyntö hylättiin; tarkista turvallinen virhekoodi.application/json

{
  "error": {
    "code": "",
    "message": ""
  },
  "request_id": ""
}

Generoitu status-sopimuksesta

KokeileSandbox

POST /v1/webhook-deliveries/{delivery_id}/retry

POST/v1/webhook-deliveries/{delivery_id}/retry

Todennus vaaditaan

Yritä voimassa olevaa epäonnistunutta toimitusta uudelleenretryWebhookDelivery

Vaatii webhooks:write-oikeuden ja webhooks:manage-käyttöoikeuden. Työtila ja ympäristö määräytyvät varmennetusta tunnuksesta. Vain tuotantoympäristössä: enintään kolme epäonnistuneen toimituksen manuaalista uusintaa seitsemässä päivässä. Kohteen ja suodatusten on oltava ennallaan, tilauksen aktiivinen ja havainnon voimassa. Tapahtuma- ja toimitustunnisteet säilyvät. Kahdeksan yritystä kierroksessa; idempotenssi 24 tuntia.

Parametrit

delivery_idpathstringPakollinen

Idempotency-KeyheaderstringPakollinen

Koodiesimerkit

cURLillustrative

Esimerkin luotettavuus: illustrativeNäyttää muodon tai idean; älä käytä sellaisenaan tuotannossa.

curl --fail-with-body -X POST "https://hintadata.fi/v1/webhook-deliveries//retry" \
  -H "Authorization: Bearer $HINTADATA_API_KEY"

Vastaukset8

200Onnistunut vastausapplication/json

{
  "attempt_history": [],
  "id": "",
  "event_id": "",
  "event_type": "",
  "subscription_id": "",
  "created_at": "",
  "status": "pending",
  "attempts": 0,
  "next_at": 0,
  "http_status": "",
  "completed_at": 0,
  "cycle_attempts": 0,
  "replays": 0,
  "last_error_code": ""
}

Generoitu status-sopimuksesta

400Pyyntö hylättiin; tarkista turvallinen virhekoodi.application/json

{
  "error": {
    "code": "",
    "message": ""
  },
  "request_id": ""
}

Generoitu status-sopimuksesta

401Pyyntö hylättiin; tarkista turvallinen virhekoodi.application/json

{
  "error": {
    "code": "",
    "message": ""
  },
  "request_id": ""
}

Generoitu status-sopimuksesta

403Pyyntö hylättiin; tarkista turvallinen virhekoodi.application/json

{
  "error": {
    "code": "",
    "message": ""
  },
  "request_id": ""
}

Generoitu status-sopimuksesta

404Pyyntö hylättiin; tarkista turvallinen virhekoodi.application/json

{
  "error": {
    "code": "",
    "message": ""
  },
  "request_id": ""
}

Generoitu status-sopimuksesta

409Pyyntö hylättiin; tarkista turvallinen virhekoodi.application/json

{
  "error": {
    "code": "",
    "message": ""
  },
  "request_id": ""
}

Generoitu status-sopimuksesta

429Pyyntö hylättiin; tarkista turvallinen virhekoodi.application/json

{
  "error": {
    "code": "",
    "message": ""
  },
  "request_id": ""
}

Generoitu status-sopimuksesta

503Pyyntö hylättiin; tarkista turvallinen virhekoodi.application/json

{
  "error": {
    "code": "",
    "message": ""
  },
  "request_id": ""
}

Generoitu status-sopimuksesta

KokeileSandbox

PUT /v1/merchant/catalog

PUT/v1/merchant/catalog

Todennus vaaditaan

Tuo kauppiaan oma katalogiimportMerchantCatalog

Vaatii merchant:write-oikeuden. Korvaa rajatun kauppiaskatalogin erillään markkina-aineistosta. Tyhjä items tarkoittaa tyhjää valikoimaa. Hinnat ja kulut käyttävät ilmoitettua valuuttaa ja veropohjaa; puuttuvat kulut estävät hinnoittelusuositukset.

Parametrit

Idempotency-KeyheaderstringPakollinen

PyyntörunkoPakollinen

application/json

Koodiesimerkit

cURLillustrative

Esimerkin luotettavuus: illustrativeNäyttää muodon tai idean; älä käytä sellaisenaan tuotannossa.

curl --fail-with-body -X PUT "https://hintadata.fi/v1/merchant/catalog" \
  -H "Authorization: Bearer $HINTADATA_API_KEY" \
  -H "Content-Type: application/json" \
  --data '{
  "evidence": {
    "source_id": "",
    "source_ref": "",
    "observed_at": "",
    "expires_at": "",
    "market": "",
    "currency": "",
    "tax_basis": "inclusive"
  },
  "items": []
}'

Vastaukset9

200Onnistunut vastausapplication/json

{
  "imported": 0,
  "evidence": {
    "source_id": "",
    "source_ref": "",
    "observed_at": "",
    "expires_at": "",
    "market": "",
    "currency": "",
    "tax_basis": "inclusive"
  }
}

Generoitu status-sopimuksesta

400Virheellinen pyyntöapplication/json

{
  "error": {
    "code": "",
    "message": ""
  },
  "request_id": ""
}

Generoitu status-sopimuksesta

401API-avain vaaditaanapplication/json

{
  "error": {
    "code": "",
    "message": ""
  },
  "request_id": ""
}

Generoitu status-sopimuksesta

403Avaimen tai tilauksen käyttöoikeus puuttuuapplication/json

{
  "error": {
    "code": "",
    "message": ""
  },
  "request_id": ""
}

Generoitu status-sopimuksesta

404Resurssia ei löytynytapplication/json

{
  "error": {
    "code": "",
    "message": ""
  },
  "request_id": ""
}

Generoitu status-sopimuksesta

409Samanaikainen muutos tai idempotenssiristiriitaapplication/json

{
  "error": {
    "code": "",
    "message": ""
  },
  "request_id": ""
}

Generoitu status-sopimuksesta

413Pyyntö on liian suuriapplication/json

{
  "error": {
    "code": "",
    "message": ""
  },
  "request_id": ""
}

Generoitu status-sopimuksesta

429Pyyntömäärän tai kapasiteetin rajaapplication/json

{
  "error": {
    "code": "",
    "message": ""
  },
  "request_id": ""
}

Generoitu status-sopimuksesta

503Lähdeaineisto tai toimitus ei ole käytettävissäapplication/json

{
  "error": {
    "code": "",
    "message": ""
  },
  "request_id": ""
}

Generoitu status-sopimuksesta

KokeileSandbox

GET /v1/merchant/coverage

GET/v1/merchant/coverage

Todennus vaaditaan

Tarkista katalogin kattavuus ja tuoreusgetMerchantCoverage

Vaatii intelligence:read-oikeuden. Näyttää katalogin osumat ja molempien lähteiden tuoreuden myös puuttuvan tai vanhentuneen markkina-aineiston tapauksessa. Ei kuluta vertailukrediittejä.

Parametrit

limitqueryintegerValinnainen

offsetqueryintegerValinnainen

resolutionquerystringValinnainen

enum: matched, ambiguous, unmatched

Koodiesimerkit

cURLillustrative

Esimerkin luotettavuus: illustrativeNäyttää muodon tai idean; älä käytä sellaisenaan tuotannossa.

curl --fail-with-body -X GET "https://hintadata.fi/v1/merchant/coverage?limit=25&offset=0&resolution=matched" \
  -H "Authorization: Bearer $HINTADATA_API_KEY"

Vastaukset9

200Onnistunut vastausapplication/json

{
  "market_status": "missing",
  "merchant_status": "missing",
  "evidence": {
    "source_id": "",
    "source_ref": "",
    "observed_at": "",
    "expires_at": "",
    "market": "",
    "currency": "",
    "tax_basis": "inclusive"
  },
  "merchant_evidence": {
    "source_id": "",
    "source_ref": "",
    "observed_at": "",
    "expires_at": "",
    "market": "",
    "currency": "",
    "tax_basis": "inclusive"
  },
  "counts": {
    "imported": 0,
    "matched": 0,
    "ambiguous": 0,
    "unmatched": 0,
    "with_available_offers": 0
  },
  "total": 0,
  "next_offset": "",
  "items": []
}

Generoitu status-sopimuksesta

400Virheellinen pyyntöapplication/json

{
  "error": {
    "code": "",
    "message": ""
  },
  "request_id": ""
}

Generoitu status-sopimuksesta

401API-avain vaaditaanapplication/json

{
  "error": {
    "code": "",
    "message": ""
  },
  "request_id": ""
}

Generoitu status-sopimuksesta

403Avaimen tai tilauksen käyttöoikeus puuttuuapplication/json

{
  "error": {
    "code": "",
    "message": ""
  },
  "request_id": ""
}

Generoitu status-sopimuksesta

404Resurssia ei löytynytapplication/json

{
  "error": {
    "code": "",
    "message": ""
  },
  "request_id": ""
}

Generoitu status-sopimuksesta

409Samanaikainen muutos tai idempotenssiristiriitaapplication/json

{
  "error": {
    "code": "",
    "message": ""
  },
  "request_id": ""
}

Generoitu status-sopimuksesta

413Pyyntö on liian suuriapplication/json

{
  "error": {
    "code": "",
    "message": ""
  },
  "request_id": ""
}

Generoitu status-sopimuksesta

429Pyyntömäärän tai kapasiteetin rajaapplication/json

{
  "error": {
    "code": "",
    "message": ""
  },
  "request_id": ""
}

Generoitu status-sopimuksesta

503Lähdeaineisto tai toimitus ei ole käytettävissäapplication/json

{
  "error": {
    "code": "",
    "message": ""
  },
  "request_id": ""
}

Generoitu status-sopimuksesta

KokeileSandbox

POST /v1/products/resolve

POST/v1/products/resolve

Todennus vaaditaan

Yhdistä tuotetunnisteet täsmällisestiresolveProducts

Vaatii catalog:read-oikeuden. Yhdistää täsmälliset kanoniset tunnisteet, tarkistusnumeroltaan kelvolliset GTINit tai työtilan SKU:t ilman sumeaa tunnistusta. Vain lukeva POST hyväksyy 1–100 tunnistetta ja säilyttää järjestyksen. Tuotannossa yksi vertailukrediitti syötettä kohden, myös moniselitteisistä tai puuttuvista osumista. Testitila on maksuton. Idempotency-Key-otsaketta ei tarvita.

PyyntörunkoPakollinen

application/json

Koodiesimerkit

cURLillustrative

Esimerkin luotettavuus: illustrativeNäyttää muodon tai idean; älä käytä sellaisenaan tuotannossa.

curl --fail-with-body -X POST "https://hintadata.fi/v1/products/resolve" \
  -H "Authorization: Bearer $HINTADATA_API_KEY" \
  -H "Content-Type: application/json" \
  --data '{
  "items": []
}'

Vastaukset9

200Onnistunut vastausapplication/json

{
  "items": [],
  "evidence": {
    "source_id": "",
    "source_ref": "",
    "observed_at": "",
    "expires_at": "",
    "market": "",
    "currency": "",
    "tax_basis": "inclusive"
  }
}

Generoitu status-sopimuksesta

400Virheellinen pyyntöapplication/json

{
  "error": {
    "code": "",
    "message": ""
  },
  "request_id": ""
}

Generoitu status-sopimuksesta

401API-avain vaaditaanapplication/json

{
  "error": {
    "code": "",
    "message": ""
  },
  "request_id": ""
}

Generoitu status-sopimuksesta

403Avaimen tai tilauksen käyttöoikeus puuttuuapplication/json

{
  "error": {
    "code": "",
    "message": ""
  },
  "request_id": ""
}

Generoitu status-sopimuksesta

404Resurssia ei löytynytapplication/json

{
  "error": {
    "code": "",
    "message": ""
  },
  "request_id": ""
}

Generoitu status-sopimuksesta

409Samanaikainen muutos tai idempotenssiristiriitaapplication/json

{
  "error": {
    "code": "",
    "message": ""
  },
  "request_id": ""
}

Generoitu status-sopimuksesta

413Pyyntö on liian suuriapplication/json

{
  "error": {
    "code": "",
    "message": ""
  },
  "request_id": ""
}

Generoitu status-sopimuksesta

429Pyyntömäärän tai kapasiteetin rajaapplication/json

{
  "error": {
    "code": "",
    "message": ""
  },
  "request_id": ""
}

Generoitu status-sopimuksesta

503Lähdeaineisto tai toimitus ei ole käytettävissäapplication/json

{
  "error": {
    "code": "",
    "message": ""
  },
  "request_id": ""
}

Generoitu status-sopimuksesta

KokeileSandbox

POST /v1/offers/batch

POST/v1/offers/batch

Todennus vaaditaan

Lue tarjoukset eränägetOffersBatch

Vaatii catalog:read-oikeuden. Lukee tarjoukset rajatulle erälle rivikohtaisilla osumatiloilla. Vain lukeva POST hyväksyy 1–100 tunnistetta ja säilyttää järjestyksen. Tuotannossa yksi vertailukrediitti syötettä kohden, myös moniselitteisistä tai puuttuvista osumista. Testitila on maksuton. Idempotency-Key-otsaketta ei tarvita.

PyyntörunkoPakollinen

application/json

Koodiesimerkit

cURLillustrative

Esimerkin luotettavuus: illustrativeNäyttää muodon tai idean; älä käytä sellaisenaan tuotannossa.

curl --fail-with-body -X POST "https://hintadata.fi/v1/offers/batch" \
  -H "Authorization: Bearer $HINTADATA_API_KEY" \
  -H "Content-Type: application/json" \
  --data '{
  "items": []
}'

Vastaukset9

200Onnistunut vastausapplication/json

{
  "items": [],
  "evidence": {
    "source_id": "",
    "source_ref": "",
    "observed_at": "",
    "expires_at": "",
    "market": "",
    "currency": "",
    "tax_basis": "inclusive"
  }
}

Generoitu status-sopimuksesta

400Virheellinen pyyntöapplication/json

{
  "error": {
    "code": "",
    "message": ""
  },
  "request_id": ""
}

Generoitu status-sopimuksesta

401API-avain vaaditaanapplication/json

{
  "error": {
    "code": "",
    "message": ""
  },
  "request_id": ""
}

Generoitu status-sopimuksesta

403Avaimen tai tilauksen käyttöoikeus puuttuuapplication/json

{
  "error": {
    "code": "",
    "message": ""
  },
  "request_id": ""
}

Generoitu status-sopimuksesta

404Resurssia ei löytynytapplication/json

{
  "error": {
    "code": "",
    "message": ""
  },
  "request_id": ""
}

Generoitu status-sopimuksesta

409Samanaikainen muutos tai idempotenssiristiriitaapplication/json

{
  "error": {
    "code": "",
    "message": ""
  },
  "request_id": ""
}

Generoitu status-sopimuksesta

413Pyyntö on liian suuriapplication/json

{
  "error": {
    "code": "",
    "message": ""
  },
  "request_id": ""
}

Generoitu status-sopimuksesta

429Pyyntömäärän tai kapasiteetin rajaapplication/json

{
  "error": {
    "code": "",
    "message": ""
  },
  "request_id": ""
}

Generoitu status-sopimuksesta

503Lähdeaineisto tai toimitus ei ole käytettävissäapplication/json

{
  "error": {
    "code": "",
    "message": ""
  },
  "request_id": ""
}

Generoitu status-sopimuksesta

KokeileSandbox

POST /v1/watchlists/batch

POST/v1/watchlists/batch

Todennus vaaditaan

Hallitse hintavahteja atomisena eränämanagePriceWatchesBatch

Vaatii watchlists:write-oikeuden. Keskeyttää, jatkaa tai poistaa atomisesti enintään 100 eri vahtia. Jokaisen version on täsmättävä; muuten mitään ei muuteta.

Parametrit

Idempotency-KeyheaderstringPakollinen

PyyntörunkoPakollinen

application/json

Koodiesimerkit

cURLillustrative

Esimerkin luotettavuus: illustrativeNäyttää muodon tai idean; älä käytä sellaisenaan tuotannossa.

curl --fail-with-body -X POST "https://hintadata.fi/v1/watchlists/batch" \
  -H "Authorization: Bearer $HINTADATA_API_KEY" \
  -H "Content-Type: application/json" \
  --data '{
  "items": []
}'

Vastaukset9

200Onnistunut vastausapplication/json

{
  "updated": 0
}

Generoitu status-sopimuksesta

400Virheellinen pyyntöapplication/json

{
  "error": {
    "code": "",
    "message": ""
  },
  "request_id": ""
}

Generoitu status-sopimuksesta

401API-avain vaaditaanapplication/json

{
  "error": {
    "code": "",
    "message": ""
  },
  "request_id": ""
}

Generoitu status-sopimuksesta

403Avaimen tai tilauksen käyttöoikeus puuttuuapplication/json

{
  "error": {
    "code": "",
    "message": ""
  },
  "request_id": ""
}

Generoitu status-sopimuksesta

404Resurssia ei löytynytapplication/json

{
  "error": {
    "code": "",
    "message": ""
  },
  "request_id": ""
}

Generoitu status-sopimuksesta

409Samanaikainen muutos tai idempotenssiristiriitaapplication/json

{
  "error": {
    "code": "",
    "message": ""
  },
  "request_id": ""
}

Generoitu status-sopimuksesta

413Pyyntö on liian suuriapplication/json

{
  "error": {
    "code": "",
    "message": ""
  },
  "request_id": ""
}

Generoitu status-sopimuksesta

429Pyyntömäärän tai kapasiteetin rajaapplication/json

{
  "error": {
    "code": "",
    "message": ""
  },
  "request_id": ""
}

Generoitu status-sopimuksesta

503Lähdeaineisto tai toimitus ei ole käytettävissäapplication/json

{
  "error": {
    "code": "",
    "message": ""
  },
  "request_id": ""
}

Generoitu status-sopimuksesta

KokeileSandbox