# Kauppojen API

Kauppa on yksi myyntimahdollisuus [myyntiputkessasi](../deals/sales-pipeline.md) — se sisältää otsikon, arvon, vaiheen, jossa se on, sekä valinnaisesti siihen liittyvän yhteyshenkilön ja sille määritetyn tiimin jäsenen. Tämä opas käsittelee kauppojen lukemista ja hallintaa API:n kautta.

- **Perus-URL** — `https://api.dmchamp.com/v1`
- **Todennus** — API-avaimesi (katso [Todennus](authentication.md))
- **Virheet ja sivutus** — katso [Virheet ja sivutus](errors-and-pagination.md)

Kaikki alla olevat esimerkit näyttävät `?apiKey=`-kyselymuodon cURL-muodossa ja `X-API-Key`-otsikon JavaScriptissä ja Pythonissa – kumpi tahansa toimii jokaisessa päätepisteessä.

---

## Kauppa-objekti

```json
{
  "id": "deal_abc123",
  "title": "Annual plan – Jane's Clinic",
  "description": "Asked for pricing on the annual plan.",
  "company": "Jane's Clinic",
  "stage": "stage-2",
  "value": 4800,
  "probability": 60,
  "priority": "high",
  "status": "open",
  "source": "whatsapp",
  "position": 0,
  "contact_id": "ctc_9f8e7d",
  "assigned_to": "usr_4a2b",
  "tags": ["clinic"],
  "close_date": "2026-10-01T00:00:00.000Z",
  "created_at": "2026-09-05T09:12:00.000Z",
  "updated_at": "2026-09-05T09:40:00.000Z",
  "stage_entered_at": "2026-09-05T09:40:00.000Z"
}
```

`stage` on yksi myyntiputkesi vaiheiden tunnisteista — lue ne myyntiputkesi asetuksista (`GET /users/me/pipeline-settings`). Aikaleimat ovat ISO 8601 -muodossa.

---

## Listaa kaupat

`GET /deals` — palauttaa tilisi kaupat, uusimmat ensin.

**Kyselyparametrit** (kaikki valinnaisia): `stage` (vaiheen tunniste), `contact_id`, `limit` (oletus 50, enintään 200), `cursor` (edellisen sivun `next_cursor`).

**cURL**

```bash
curl "https://api.dmchamp.com/v1/deals?apiKey=YOUR_API_KEY&stage=stage-2&limit=50"
```

**JavaScript**

```javascript
const res = await fetch("https://api.dmchamp.com/v1/deals?stage=stage-2&limit=50", {
  headers: { "X-API-Key": "YOUR_API_KEY" },
});
const { deals, next_cursor } = await res.json();
```

**Python**

```python
res = requests.get(
    "https://api.dmchamp.com/v1/deals",
    headers={"X-API-Key": "YOUR_API_KEY"},
    params={"stage": "stage-2", "limit": 50},
)
deals = res.json()["deals"]
```

**Vastaus** (`200`)

```json
{ "success": true, "deals": [{ "id": "deal_abc123", "title": "Annual plan – Jane's Clinic", "...": "..." }], "next_cursor": null }
```

---

## Hae kauppa

`GET /deals/{dealId}`

```bash
curl "https://api.dmchamp.com/v1/deals/deal_abc123?apiKey=YOUR_API_KEY"
```

**Vastaus** (`200`)

```json
{ "success": true, "deal": { "id": "deal_abc123", "title": "Annual plan – Jane's Clinic", "...": "..." } }
```

Kauppa, jota ei ole olemassa tai joka kuuluu toiselle tilille, palauttaa `404`.

---

## Luo kauppa

`POST /deals` — `title` ja `stage` ovat pakollisia; `stage` on oltava yksi myyntiputkesi vaihetunnisteista.

```bash
curl -X POST "https://api.dmchamp.com/v1/deals?apiKey=YOUR_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{ "title": "Annual plan – Jane'"'"'s Clinic", "stage": "stage-1", "value": 4800, "contact_id": "ctc_9f8e7d" }'
```

**Vastaus** (`201`)

```json
{ "success": true, "deal_id": "deal_abc123" }
```

---

## Päivitä kauppa

`PUT /deals/{dealId}` — lähetä vain ne kentät, joita haluat muuttaa (`title`, `description`, `value`, `stage`, `status`, `priority`, `contact_id`, …). `value` on oltava numero.

```bash
curl -X PUT "https://api.dmchamp.com/v1/deals/deal_abc123?apiKey=YOUR_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{ "value": 5200, "priority": "high" }'
```

**Vastaus** (`200`): `{ "success": true, "deal_id": "deal_abc123" }`

---

## Siirrä kauppa toiseen vaiheeseen

`POST /deals/{dealId}/move` — runko `{ "new_stage_id": "stage-3", "new_position": 0 }`. Sijainti `0` asettaa kortin sarakkeen yläreunaan.

```bash
curl -X POST "https://api.dmchamp.com/v1/deals/deal_abc123/move?apiKey=YOUR_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{ "new_stage_id": "stage-3", "new_position": 0 }'
```

**Vastaus** (`200`): `{ "success": true, "deal_id": "deal_abc123", "stage": "stage-3", "position": 0 }`

---

## Poista kauppa

`DELETE /deals/{dealId}` — poistaa kaupan. **Tätä toimintoa ei voi kumota.**

```bash
curl -X DELETE "https://api.dmchamp.com/v1/deals/deal_abc123?apiKey=YOUR_API_KEY"
```

**Vastaus** (`200`): `{ "success": true }`

---

## Seuraavat vaiheet

- [Myyntiputki](../deals/sales-pipeline.md) — miten vaiheet, vaihetunnisteet ja näkymä toimivat.
- [Tehtävien API](tasks.md) — tehtävät voidaan linkittää kauppaan käyttämällä `deal_id`.
- [Automaatiot](../automations/automations.md) — **Etsi kauppoja**- ja **Etsi kauppa** -vaiheet lukevat samoja tietoja työnkulun sisällä.