Et REST-API
du kan bygge på.
Endepunkter for returer, sporing, returetiketter og en returagent du kan spørre på naturlig språk. Autentisering med Bearer-nøkkel, avgrensing med scopes og rategrenser per nøkkel. Resten av plattformen står på veikartet.
Prøv et kall.
Velg et endepunkt. Kallet og svaret oppdaterer seg ved siden av.
Hent en retur
Henter én retur som JSON. {id} tar enten returnummeret (RET-####) eller den interne id-en. Krever 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 }
]
}Oversikt over endepunktene.
/api/v1/returns/{id} Hent en retur (JSON) · returns:read i drift/api/v1/returns/{id}/tracking Sporingsstatus akkurat nå · returns:read i drift/api/v1/returns/{id}/label Returetikett som PDF (302-videresending) · labels:read i drift/api/v1/agent Returagent på naturlig språk · returns:read i drift/api/v1/openapi.json OpenAPI 3.1-spesifikasjon · offentlig i driftreturn.* Signerte webhooks: created · approved · received · refunded · exchanged · cancelled i driftSlik autoriseres kallene.
Bearer-nøkler
Send Authorization: Bearer ret_live_<key> på hvert /api/v1/* kall. Nøkkelen vises én gang når den opprettes, og vi lagrer bare en hash. Du lager og trekker tilbake nøkler i Settings → API Keys.
Feil
- 401 ukjent eller tilbaketrukket nøkkel
- 403 nøkkelen mangler det scopet som kreves
- 404 ingen slik retur i butikken din
- 429 rategrensen er brukt opp (se
Retry-After)
Hver feil svarer med JSON { error, message, code }: error og message er den samme teksten skrevet for mennesker, code er en stabil maskinlesbar slug
(unauthorized, forbidden, not_found, rate_limited, …) som du trygt kan bygge logikk på.
Rategrenser
120 kall per minutt per nøkkel. Hvert svar bærer X-RateLimit-Limit, X-RateLimit-Remaining, og X-RateLimit-Reset. 429-svar legger på Retry-After.
Dette gir API-et deg.
Veikart for integrasjoner.
Shopify er i drift i dag. Si fra hva som står for tur hos deg, så prioriterer vi det.
Begynn å bygge med Returner.
Lag en nøkkel under Settings → API Keys, og les så spesifikasjonen eller generer en klient.