REST API

Översikt

Shoporamas REST-API ger dig möjlighet att integrera din webbutik med externa system – ERP, lagerhantering, PIM, CRM och andra tjänster. API:et stöder CRUD (skapa, läs, uppdatera, radera) för de flesta resurserna i din webbutik.

Dokumentation

Den fullständiga API-dokumentationen med alla endpunkter, parametrar och exempel hittar du 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.

Kom igång

1. Gå till Integrationer → API-åtkomst i din Shoporama-administration
2. Skapa en ny API-nyckel
3. Välj behörigheter för nyckeln – du kan ge läs- och/eller skrivbehörighet till varje resurs
4. Använd nyckeln i Authorization-rubriken i dina API-anrop

Autentisering

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

Authorization: DIN-API-NYCKEL

# Eller med Bearer:
Authorization: Bearer DIN-API-NYCKEL

Tillgängliga resurser

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

Produkter och katalog

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

Lager

• /stock — Lagerbeholdning och poster
• /batch — Lagerpartier

Order och kunder

• /order — Order
• /order/{id}/create-label — Skapa fraktetikett för order
• /order/{id}/download-label — Ladda ner fraktetikett
• /order-queue — Orderkö
• /order-label — Orderetiketter
• /order-return — Returer
• /customer — Kunder
• /customer-field — Kundfält
• /voucher — Rabattkoder och presentkort

Innehåll

• /page — Statiska sidor
• /blog-post — Blogginlägg
• /landing-page och /landing-page-item — Landningssidor och element. GET /landing-page/{id} returnerar nu sidans regler (rules) och matchtyp (match_type) direkt i svaret, så att du slipper ett separat anrop till /landing-page-item
• /menu — Menyer och navigering

Nyhetsbrev

• /newsletter-list — Nyhetsbrevslistor
• /newsletter-subscriber — Prenumeranter
• /newsletter-campaign — Kampanjer

Inställningar

• /shipping — Fraktmetoder
• /payment_gateway — Betalningsmetoder
• /country — Länder
• /redirect — URL-omdirigeringar
• /webhook — Webhooks

Temafiler

• /theme-file — Läs, skapa, uppdatera och ta bort 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

Hämta produkter:

curl -H "Authorization: DIN-API-NYCKEL" \
  https://dinshop.dk/REST/product?limit=10

Skapa en produkt:

curl -X POST -H "Authorization: DIN-API-NYCKEL" \
  -H "Content-Type: application/json" \
  -d '{"name": "Ny produkt", "price": 199.00}' \
  https://dinshop.dk/REST/product

Uppdatera lagerbeholdning:

curl -X PUT -H "Authorization: DIN-API-NYCKEL" \
  -H "Content-Type: application/json" \
  -d '{"stock": 50}' \
  https://dinshop.dk/REST/product/123

Filtrering och sidindelning

List-endpoints stöder följande sökparametrar:

• ?limit=25 — antal resultat per sida (max 100)
• ?offset=0 — hoppa över resultat (för sidindelning)
• ?search=text — fritextsökning
• ?fields=name,price — begränsa antalet fält som returneras
• ?last_modified=2026-01-01 — endast resurser som ändrats efter detta datum

Webhooks

Du kan skapa webhooks via API:et så att ditt system automatiskt får ett meddelande när ändringar sker. Vid skapandet får du en hemlig nyckel som används för att verifiera webhook-anrop via HMAC.

Svarskoder

• 200 — Framgång
• 201 — Resurs skapad
• 204 — Uppdatering/radering lyckades
• 400 — Ogiltig förfrågan
• 401 — Ej auktoriserad (felaktig eller saknad API-nyckel)
• 404 — Resursen hittades inte
• 429 — För många anrop (begränsning av anropsfrekvens)

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