Nyehandel API v3 är ett REST API för att koppla din butik till externa system som ERP, PIM, lager- och ekonomisystem, marknadsplatser och egna backoffice-verktyg.
Det är mer omfattande än v2: det täcker i stort sett allt du kan hantera i butikens admin.
Med API:t kan du läsa och hantera bland annat:
Produkter, varianter, kategorier, varumärken, attribut, filtertaggar och produktflöden
Lager: lagersaldon, lagerställen, lagerflyttar, lagerhistorik och reservationer
Kunder, kundgrupper och nyhetsbrevsprenumeranter
Beställningar (skapa, uppdatera, leverera, avbryt, returer och anteckningar), plus följesedlar, fakturor och orderbekräftelser
Inköp, inleveranser och leverantörer
Kampanjer, rabattkoder, presentkort och merförsäljning i kassan
Innehåll: sidor, blogginlägg, menyer, texter, e-postmallar och omdirigeringar
Recensioner, produktfrågor, offertförfrågningar och bevakningar för när en vara är i lager igen
Valutor, länder, leveransmetoder och betalningsmetoder
Rapporter, till exempel försäljning över tid, per produkt, per kategori och lagervärde
Massuppdateringar och importer, som körs i bakgrunden
Grundläggande krav för API-anrop
API:t använder JSON över HTTPS. Skicka
Content-Type: application/jsonpå anrop som har innehåll ochAccept: application/jsonpå alla anrop.Alla endpoints ligger under
https://api.nyehandel.se/api/v3. Adressen är densamma för alla butiker.Inloggningen sker med en API-integration som butikens ägare skapar i admin under Inställningar → API → API-integrationer. Där väljer du exakt vilka behörigheter integrationen ska ha. Med integrationens klient-ID och hemlighet hämtar du en åtkomsttoken som gäller i en timme. Den skickas som bearer-token. Tokenen är kopplad till en butik, så du behöver ingen separat butiksrubrik. Se Kom igång.
Alla listor använder samma regler för sidindelning och filtrering.
Okända fält skickas tillbaka med ett felmeddelande, de ignoreras aldrig i tysthet. Det du läser med GET kan du skicka tillbaka oförändrat för att spara. Se Fel och begränsningar.
Varje integration får göra 500 anrop per minut.
Hålla externa system uppdaterade
Det finns två sätt att hålla ett externt system uppdaterat med ändringar i butiken:
Hämta bara det som har ändrats sedan förra synken, genom att filtrera på när posten senast uppdaterades. Se Listor.
Prenumerera på webhooks, som du skapar och hanterar direkt via API:t. Butiken skickar då händelser till en adress som du styr över.
För att komma åt dokumentationen använder ni denna url:
