API-nøgler oprettes under Settings → Integrations → Custom Integrations.
Vores åbne REST API giver dit system adgang til returordrer, reklamationer, labels og kundedata. Det bruges typisk af kundeserviceværktøjer og egne integrationer der skal slå returdata op eller handle på dem.
Sådan kommer du i gang
a) Klik Add API Key, giv nøglen et beskrivende navn og klik Create.
b) Gem nøglen sikkert. Den bruges som autentificering i dine API-kald via HTTP-headeren.
c) Klik Go to API docs for den fulde Swagger-dokumentation, hvor du kan se alle endpoints, formater og teste kald direkte.
Hvad kan API'et?
API'et dækker hele returforløbet.
Returordrer med handlinger som close, cancel og label-hentning
Reklamationer med review og lukning
Returårsager
Claims-indstillinger
Kombinér det med webhooks, så dit system får besked ved hændelser og henter detaljerne via API'et bagefter.
Nøgler kan slettes igen i tabellen, og du kan se hvem der har oprettet hvilke nøgler og hvornår. Opret en nøgle pr. system, så adgang kan lukkes enkeltvis.
Webhooks
Med webhooks sender vi returhændelser direkte til dit eget system, f.eks. ERP, CRM, Make, Zapier eller et custom endpoint. Du vælger selv hvilke events du lytter på. Det kræver en HTTPS-adresse der kan modtage POST-requests.
Sådan opsætter du
a) Klik Install på Webhook-integrationen og indtast din webhook-adresse.
b) Angiv en Secret Key. Vi signerer alle payloads med HMAC SHA256, så du kan verificere at dataen kommer fra os.
c) Vælg de events du vil modtage, og gennemfør opsætningen.
Events
Vi understøtter 20 events der dækker hele returforløbet.
Oprettelse, gennemførsel og annullering
Pause og genoptagelse
Lukning
Instant Exchange
Redigering
Labelgenerering
Alle Auto Close trin
Frigivelse og afsendelse af ombytningsordrer
Gavekorthændelser
Vælg kun de events din opsætning faktisk skal bruge.
Webhook-payloaden indeholder returens kernedata. Skal du bruge flere detaljer, f.eks. returårsagen, henter du den fulde retur via vores API med returens id.
Returårsag i payloaden. return.completed indeholder også returnReasonId og returnReasonNote, så du kan aflæse kundens returårsag direkte i payloaden.
Flere shops. Webhooks opsættes pr. shop, så har du flere shops, opretter du en webhook i hver. De kan sagtens pege på samme endpoint.