REST-rajapinta,
jonka päälle voi rakentaa.
Bearer-avaimella tunnistetut, rajatut päätepisteet palautuksille, seurannalle ja osoitekorteille. Mukana on myös palautusagentti, jolta voi kysyä luonnollisella kielellä. Kutsurajat ovat avainkohtaisia, ja laajempi ohjelmallinen alusta on tiekartalla.
Kokeile kutsua.
Valitse päätepiste. Kutsu ja vastaus päivittyvät viereen.
Hae yksi palautus
Hakee yhden palautuksen JSON-muodossa. {id} hyväksyy palautusnumeron (RET-####) tai sisäisen id:n. Vaatii scopen returns:read.
curl https://app.returner.me/api/v1/returns/RET-9284 \
-H "Authorization: Bearer $RETURNER_API_KEY"{
"return_id": "RET-9284",
"order": "#1042",
"status": "in_transit",
"type": "refund",
"created_at": "2026-03-14T09:12:00Z",
"customer": { "name": "Maria Holm", "email": "[email protected]" },
"refund": { "amount": 49.00, "currency": "EUR" },
"carrier": "postnord",
"tracking_number": "SE392847561",
"items": [
{ "sku": "TEE-BLK-L", "name": "Cotton Tee",
"quantity": 1, "reason": "too_small", "condition": null }
]
}Päätepisteet yhtenä listana.
/api/v1/returns/{id} Hae palautus (JSON) · returns:read käytössä/api/v1/returns/{id}/tracking Seurannan nykytila · returns:read käytössä/api/v1/returns/{id}/label Osoitekortti-PDF (302-ohjaus) · labels:read käytössä/api/v1/agent Luonnollisen kielen palautusagentti · returns:read käytössä/api/v1/openapi.json OpenAPI 3.1 -spesifikaatio · julkinen käytössäreturn.* Allekirjoitetut webhookit: created · approved · received · refunded · exchanged · cancelled käytössäNäin kutsut valtuutetaan.
Bearer-avaimet
Lähetä Authorization: Bearer ret_live_<key> jokaisessa /api/v1/* kutsussa. Avain näytetään kerran luontihetkellä, ja me tallennamme siitä vain tiivisteen. Luo ja mitätöi avaimia täällä: Settings → API Keys.
Virheet
- 401 tuntematon tai mitätöity avain
- 403 avaimelta puuttuu vaadittu scope
- 404 kaupassasi ei ole tätä palautusta
- 429 kutsuraja ylittyi (katso
Retry-After)
Jokainen virhe palauttaa JSONin { error, message, code }: error ja message ovat sama ihmisluettava teksti; code on pysyvä konetunniste
(unauthorized, forbidden, not_found, rate_limited, …) johon koodi voi turvallisesti nojata.
Kutsurajat
120 kutsua minuutissa avainta kohti. Jokaisessa vastauksessa ovat otsakkeet X-RateLimit-Limit, X-RateLimit-Remaining, ja X-RateLimit-Reset; 429-vastaukset lisäävät Retry-After.
Mitä rajapinta antaa.
Integraatioiden tiekartta.
Shopify on käytössä tänään. Kerro, mikä on seuraava omassa pinossasi, niin priorisoimme sen.
Rakenna Returnerin päälle.
Luo avain kohdassa Settings → API Keys, ja lue sitten spesifikaatio tai generoi client-kirjasto.