REST-gränssnitt

Komplett API-dokumentation för integration med Shoporama

Vänligen notera

Dokumentationen har flyttats till det nya Swagger-gränssnittet. Den här sidan underhålls inte längre och kan innehålla föråldrad information.

Slutpunkter

Om REST-gränssnittet

Vårt REST-gränssnitt är utformat för att våra kunder själva ska kunna utveckla integrationer med lager- och redovisningssystem. Det är därför endast metoder som stödjer det vi stödjer.

Vi använder HTTP-protokollet över SSL/TLS och all data skickas och tas emot i JSON-format.

Auktoriseringen sker på butiksnivå och varje butik har möjlighet att skapa de tokende vill ha. Som standard tillåter varje token 1 000 dagliga samtal. Denna gräns kan höjas om du kontaktar oss och förklarar varför. För att ställa in token måste ett auktoriseringshuvud som det nedan anges:

Authorization: Shoporama ade0fe8617b0825996baa9c8a9324ddb

Observera att metoden i ovanstående måste vara Shoporama.

Paginering

I anrop som innehåller listor - t.ex. produkter eller order - finns det ett maximalt antal resultat som vi returnerar. Därför kommer resultatet att innehålla ett personsökningselement som visar vilken del av datauppsättningen du tittar på:

{
  "paging": {
    "offset": 30,
    "limit": 10,
    "count": 10,
    "total": 1000
  },
  "products": [
    [...]
  ]
}

Om du vill välja vilken del av datasetet du vill titta på kan du ange argumenten limit=100 och offset=30 i URL:en du anropar.

Exempel på ett API-anrop

Ett komplett exempel på hur man drar produkter som har ändrats sedan den 1 januari 2020:

Begäran:

GET /REST/product?last_modified=2020-01-01T00:00:00&limit=100 HTTP/1.1
Host: www.shoporama.dk
Accept: */*
Authorization: Shoporama ade0fe8617b0825996baa9c8a9324ddb
User-Agent: Min Shoporama integration

Svar:

HTTP/1.1 200 OK
Content-Type: application/json

{
  "paging": {
    "offset": 30,
    "limit": 10,
    "count": 10,
    "total": 1000
  },
  "products": [
    [...]
  ]
}

Nödsituation