REST API

Översikt över Shoporama

Shoporamas REST API gör att du kan integrera din webbutik med externa system - ERP, lagerhantering, PIM, CRM och andra tjänster. API:et stöder CRUD (skapa, läsa, uppdatera, ta bort) på de flesta resurser i din webbutik.

Dokumentation

Den fullständiga API-dokumentationen med alla ändpunkter, parametrar och exempel finns i vår interaktiva Swagger-dokumentation:

Öppna Swagger-dokumentationen

Här kan du testa API-anrop direkt i webbläsaren och se alla tillgängliga fält och parametrar för varje resurs.

Så här kommer du igång

1. Gå till Inställningar → API i din Shoporama-administration
2. Skapa en ny API-nyckel
3. Välj rättigheter för nyckeln - du kan ge läs- och/eller skrivåtkomst till varje resurs
4. Använd nyckeln i auktoriseringshuvudet för dina API-anrop

Autentisering

Lägg till din API-nyckel i Auktoriseringshuvudet. Du kan antingen skicka nyckeln direkt eller använda Bearer-formatet:

Authorisation: YOUR-API-KEY # Eller med Bearer: Authorisation: Bearer YOUR-API-KEY

Tillgängliga resurser

API:et ger tillgång till följande resurser. Alla slutpunkter nås via https://dinshop.dk/REST/:

Produkter och katalog

• /product - Produkter (med varianter, bilder, priser, kategorier, extra fält)
• /category - Kategorier
• /brand - Varumärken/varumärken
• /manufacturer - Tillverkare
• /supplier - Leverantörer
• /product-label - Produktetiketter
• /profile, /profile-attribute, /profile-attribute-value - Produktprofiler, attribut och värden

Lager

• /stock - Inventering och bokföring
• /batch - Lagerpartier

Beställningar och kunder

• /order - Beställningar
• /order/{id}/create-label - Skapa fraktetikett på ordern
• /order/{id}/download-label - Ladda ner fraktsedel
• /order-queue - Beställningskö
• /order-label - Beställningsetiketter
• /order-return - Returer
• /customer - Kunder
• /customer-field - Kundfält
• /voucher - Rabattkoder och presentkort

Innehåll /page - Statiska sidor

• /page - Statiska sidor
• /blog-post - Blogginlägg
• /landing-page och /landing-page-item - Landningssidor och element
• /menu - Menyer och navigering

/newsletter-list - Nyhetsbrev

• /newsletter-list - Listor med nyhetsbrev
• /newsletter-subscriber - Prenumeranter
• /nyhetsbrev-kampanj - Kampanjer

Inställning - Inställning

• /shipping - Fraktmetoder
• /payment_gateway - Betalningsmetoder
• /country - Länder
• /redirect - Omdirigering av webbadresser
• /webhook - Webhooks

Filer för teman

• /theme-file - Läs, skapa, uppdatera och radera filer i dina teman. Kräver att "Åtkomst till temafiler" är aktiverat på API-nyckeln

HTTP-metoder

• GET - Hämta en lista eller en enskild resurs
• POST - Skapa en ny resurs
• PUT - Uppdatera en befintlig resurs
• DELETE - Ta bort en resurs

Exempel på dessa metoder

Hämta produkter:

curl -H "Authorisation: YOUR-API-KEY" \ https://dinshop.dk/REST/product?limit=10

Skapa en produkt:

curl -X POST -H "Authorisation: YOUR-API-KEY" \ -H "Content-Type: application/json" \ -d '{"name": "New Product", "price": 199.00}' \ https://dinshop.dk/REST/product

Uppdatera lager:

curl -X PUT -H "Authorisation: YOUR-API-KEY" \ -H "Content-Type: application/json" \ -d '{"lager": 50}' \ https://dinshop.dk/REST/product/123

Filtrering och personsökning

Listans slutpunkter stöder följande frågeparametrar:

• ?limit=25 - antal resultat per sida (max 100)
• ?offset=0 - hoppa över resultat (för personsökning)
• ?search=text - fritextsökning
• ?fields=namn,pris - begränsa returnerade fält
• ?last_modified=2026-01-01 - endast resurser som ändrats sedan datumet

Webhooks

Du kan skapa webhooks via API:et så att ditt system automatiskt meddelas när ändringar görs. När du skapar en webhook får du en hemlighet som används för att verifiera webhook-anrop via HMAC.

Svarskoder

• 200 - Framgång
• 201 - Resurs skapad
• 204 - Uppdatering/radering framgångsrik
• 400 - Ogiltig begäran
• 401 - Ej behörig (felaktig eller saknad API-nyckel)
• 404 - Resursen hittades inte
• 429 - För många samtal (hastighetsbegränsning)

Behöver du hjälp med API-integration? Kontakta oss på support@shoporama.dk.