Opret din shop

Du er ét skridt væk fra en lynhurtig webshop

Ingen kreditkort eller andet bøvl påkrævet. Kom i gang med det samme.

Bestil opringning

Udfyld formularen, så ringer vi dig op hurtigst muligt

Nødsituation

Ved akutte situationer eller nedbrud kan du sende en SMS til vores vagttelefon

Vagttelefon (kun SMS)

+45 29 70 15 95

Send en SMS med følgende information:

  • Dit navn og webshop
  • Beskrivelse af problemet
  • Dit telefonnummer for tilbageringning

Bemærk: Denne service er kun til kritiske situationer hvor din webshop er nede eller har alvorlige problemer. For almindelig support, brug venligst vores normale supportkanaler.

REST interface

Komplet API dokumentation for integration med Shoporama

Bemærk

Dokumentationen er flyttet til den nye Swagger UI. Denne side er ikke længere vedligeholdt og kan indeholde forældet information.

Endpoints

Om REST interfacet

Vores REST-interface er udviklet med det udgangspunkt, at det skal være muligt for vores kunder selv at udvikle integrationer med lager- og regnskabssystemer. Det er derfor kun metoder der støtter omkring det vi understøtter.

Vi benytter os af HTTP-protokollen over SSL/TLS, og al data sendes og modtages i JSON-format.

Authorization fungerer på shop-niveau, og hver shop har mulighed for at oprette de tokens de ønsker. Hver token tillader som udgangspunkt 1.000 daglige kald. Denne grænse kan godt sættes op, hvis I kontakter os og forklarer hvorfor. For at angive token skal der angives en Authorization-header som nedenstående: 

Authorization: Shoporama ade0fe8617b0825996baa9c8a9324ddb

Bemærk at metoden i ovenstående skal være Shoporama.

Paginering

I kald der indeholder lister - fx produkter eller ordrer, er der et maks. antal resultater vi returnerer. Derfor vil resultatet indeholde et paging element der viser hvilken del af datasættet man kigger på: 

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

For at vælge hvilken del af datasættet man vil se på kan man angive argumenterne limit=100 og offset=30 i den URL man kalder.

Eksempel på API kald

Et komplet eksempel på hvordan man trækker produkter der er blevet ændret siden 1. januar 2020:

Request:

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

Response:

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

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

Endpoint oversigt

Brands

GET /REST/brand
POST /REST/brand
GET /REST/brand/{id}
PUT /REST/brand/{id}
DELETE /REST/brand

Order Labels

GET /REST/order-label
POST /REST/order-label
GET /REST/order-label/{id}
PUT /REST/order-label/{id}
DELETE /REST/order-label

Lande

GET /REST/country
POST /REST/country
GET /REST/country/{id}
PUT /REST/country/{id}
DELETE /REST/country

Leverandører

GET /REST/supplier
POST /REST/supplier
GET /REST/supplier/{id}
PUT /REST/supplier/{id}
DELETE /REST/supplier/{id}

Profiler

GET /REST/profile
POST /REST/profile
GET /REST/profile/{id}
PUT /REST/profile/{id}
DELETE /REST/profile/{id}

Profilattribut

GET /REST/profile-attribute?profile_id={id}
POST /REST/profile-attribute?profile_id={id}
GET /REST/profile-attribute/{id}
PUT /REST/profile-attribute/{id}
DELETE /REST/profile-attribute/{id}

Profilattributværdi

GET /REST/profile-attribute-value?attribute_id={id}
POST /REST/profile-attribute-value?attribute_id={id}
GET /REST/profile-attribute-value/{id}
PUT /REST/profile-attribute-value/{id}
DELETE /REST/profile-attribute-value/{id}

Kategorier

GET /REST/category
POST /REST/category
GET /REST/category/{id}
PUT /REST/category/{id}
DELETE /REST/category/{id}

Produkter

GET /REST/product
POST /REST/product
GET /REST/product/{id}
PUT /REST/product/{id}
DELETE /REST/product/{id}

Produktlabels

GET /REST/product-label
POST /REST/product-label
GET /REST/product-label/{id}
PUT /REST/product-label/{id}
DELETE /REST/product-label/{id}

Lager

GET /REST/stock
POST /REST/stock
GET /REST/stock/{id}

Ordrer

GET /REST/order/{id}
GET /REST/order
POST /REST/order
GET /REST/order/{id}
PUT /REST/order/{id}

Rabatkoder

GET /REST/voucher
POST /REST/voucher
GET /REST/voucher/{id}
PUT /REST/voucher/{id}
DELETE /REST/voucher/{id}

Menus

GET /REST/menu
POST /REST/menu
GET /REST/menu/{id}
PUT /REST/menu/{id}
DELETE /REST/menu/{id}

Landing Pages

GET /REST/landing-page
POST /REST/landing-page
GET /REST/landing-page/{id}
PUT /REST/landing-page/{id}
DELETE /REST/landing-page/{id}

Landing Page Items

GET /REST/landing-page-item
POST /REST/landing-page-item
GET /REST/landing-page-item/{id}
PUT /REST/landing-page-item/{id}
DELETE /REST/landing-page-item/{id}

Brands

GET /REST/brand

Henter alle brands

POST /REST/brand

Opretter nyt brand

POST-argumenter

Bemærk at argumenterne skal pakkes ind i et json-objekt som fx { "foo" : "bar" } der sendes i body-området.

Argument Beskrivelse Datatype
name Navnet på brand Tekst

GET /REST/brand/{id}

Henter det specifikke brand

PUT /REST/brand/{id}

Opdaterer brand

PUT-argumenter

Bemærk at argumenterne skal pakkes ind i et json-objekt som fx { "foo" : "bar" } der sendes i body-området.

Argument Beskrivelse Datatype
name Navnet på brand Tekst

DELETE /REST/brand

Sletter brand

Order Labels

GET /REST/order-label

Henter alle labels

POST /REST/order-label

Opretter nyt label

POST-argumenter

Bemærk at argumenterne skal pakkes ind i et json-objekt som fx { "foo" : "bar" } der sendes i body-området.

Argument Beskrivelse Datatype
name Navnet på label Tekst
color Farvekode Tekst
auto_filter E-mail på kunder labelen automatisk skal på Tekst
auto_from_subscription Automatisk tildel ordre fra abonnementer 0/1
auto_from_bundle Automatisk tildel ordre med samlepakker 0/1

GET /REST/order-label/{id}

Henter den specifikke label

PUT /REST/order-label/{id}

Opdaterer label

PUT-argumenter

Bemærk at argumenterne skal pakkes ind i et json-objekt som fx { "foo" : "bar" } der sendes i body-området.

Argument Beskrivelse Datatype
name Navnet på label Tekst
color Farvekode Tekst
auto_filter E-mail på kunder labelen automatisk skal på Tekst
auto_from_subscription Automatisk tildel ordre fra abonnementer 0/1
auto_from_bundle Automatisk tildel ordre med samlepakker 0/1

DELETE /REST/order-label

Sletter label

Lande

GET /REST/country

Henter alle lande

POST /REST/country

Opretter nyt land

POST-argumenter

Bemærk at argumenterne skal pakkes ind i et json-objekt som fx { "foo" : "bar" } der sendes i body-området.

Argument Beskrivelse Datatype
name Navnet på land Tekst
is_default Angiver om landet er default land 1/0
default_shipping_id Default shipping_id på landet ID
code Landekoden, fx DK eller DE Tekst
b2b_vat B2B moms Tal
b2c_vat B2C moms Tal
free_above Gratis fragt over dette beløb Tal
weight Vægtning til sortering Tal

GET /REST/country/{id}

Henter det specifikke land

PUT /REST/country/{id}

Opdaterer land

PUT-argumenter

Bemærk at argumenterne skal pakkes ind i et json-objekt som fx { "foo" : "bar" } der sendes i body-området.

Argument Beskrivelse Datatype
name Navnet på land Tekst
is_default Angiver om landet er default land 1/0
default_shipping_id Default shipping_id på landet ID
code Landekoden, fx DK eller DE Tekst
b2b_vat B2B moms Tal
b2c_vat B2C moms Tal
free_above Gratis fragt over dette beløb Tal
weight Vægtning til sortering Tal

DELETE /REST/country

Sletter land

Leverandører

GET /REST/supplier

Henter alle leverandører

POST /REST/supplier

Opretter ny leverandør

POST-argumenter

Bemærk at argumenterne skal pakkes ind i et json-objekt som fx { "foo" : "bar" } der sendes i body-området.

Argument Beskrivelse Datatype
name Navnet på leverandør Tekst
dropshipping_mail E-mail-adresse på dropshipping Tekst

GET /REST/supplier/{id}

Henter den specifikke leverandør

PUT /REST/supplier/{id}

Opdaterer leverandør

PUT-argumenter

Bemærk at argumenterne skal pakkes ind i et json-objekt som fx { "foo" : "bar" } der sendes i body-området.

Argument Beskrivelse Datatype
name Navnet på leverandør Tekst
dropshipping_mail E-mail-adresse på dropshipping Tekst

DELETE /REST/supplier/{id}

Sletter leverandør

Profiler

GET /REST/profile

Henter alle profiler

POST /REST/profile

Opretter ny profil

POST-argumenter

Bemærk at argumenterne skal pakkes ind i et json-objekt som fx { "foo" : "bar" } der sendes i body-området.

Argument Beskrivelse Datatype
name Navnet på profil Tekst

GET /REST/profile/{id}

Henter den specifikke profil

PUT /REST/profile/{id}

Opdaterer profil

PUT-argumenter

Bemærk at argumenterne skal pakkes ind i et json-objekt som fx { "foo" : "bar" } der sendes i body-området.

Argument Beskrivelse Datatype
name Navnet på profil Tekst

DELETE /REST/profile/{id}

Sletter profil

Profilattribut

GET /REST/profile-attribute?profile_id={id}

Henter alle profilattributter på en profil

GET-argumenter

Argument Beskrivelse Datatype
profile_id Profilen ID

POST /REST/profile-attribute?profile_id={id}

Opretter ny profilattribut

GET-argumenter

Argument Beskrivelse Datatype
profile_id Profilen ID

POST-argumenter

Bemærk at argumenterne skal pakkes ind i et json-objekt som fx { "foo" : "bar" } der sendes i body-området.

Argument Beskrivelse Datatype
type Typen. Mulighederne er valuelist, string, integer og boolean Tekst
name Navnet på profilattributten Tekst
is_variant Om attributten er en variant 1/0
has_price Om der er pris på variantniveau 1/0
weight Rækkefølge Tekst

GET /REST/profile-attribute/{id}

Henter den specifikke profilattribut

PUT /REST/profile-attribute/{id}

Opdaterer profilattribut

PUT-argumenter

Bemærk at argumenterne skal pakkes ind i et json-objekt som fx { "foo" : "bar" } der sendes i body-området.

Argument Beskrivelse Datatype
type Typen. Mulighederne er valuelist, string, integer og boolean Tekst
name Navnet på profilattributten Tekst
is_variant Om attributten er en variant 1/0
has_price Om der er pris på variantniveau 1/0
weight Rækkefølge Tekst

DELETE /REST/profile-attribute/{id}

Sletter profilattribut

Profilattributværdi

GET /REST/profile-attribute-value?attribute_id={id}

Henter alle profilattributværdier på profilattributten

GET-argumenter

Argument Beskrivelse Datatype
attribute_id Profilattributten ID

POST /REST/profile-attribute-value?attribute_id={id}

Opretter ny profilattributværdi

GET-argumenter

Argument Beskrivelse Datatype
attribute_id Profilattributten ID

POST-argumenter

Bemærk at argumenterne skal pakkes ind i et json-objekt som fx { "foo" : "bar" } der sendes i body-området.

Argument Beskrivelse Datatype
attribute_id ID på attributten ID
val Værdien Tekst
weight Rækkefølge Tekst
tag Tag Tekst

GET /REST/profile-attribute-value/{id}

Henter den specifikke profilattributværdi

PUT /REST/profile-attribute-value/{id}

Opdaterer profilattributværdi

PUT-argumenter

Bemærk at argumenterne skal pakkes ind i et json-objekt som fx { "foo" : "bar" } der sendes i body-området.

Argument Beskrivelse Datatype
attribute_id ID på attributten ID
val Værdien Tekst
weight Rækkefølge Tekst
tag Tag Tekst

DELETE /REST/profile-attribute-value/{id}

Sletter profilattributværdi

Kategorier

GET /REST/category

Henter alle kategorier

GET-argumenter

Argument Beskrivelse Datatype
fields Hent kun udvalgte felter. Fx category_id, parent_id, tag Tekst

POST /REST/category

Opretter ny kategori

POST-argumenter

Bemærk at argumenterne skal pakkes ind i et json-objekt som fx { "foo" : "bar" } der sendes i body-området.

Argument Beskrivelse Datatype
name Navn på kategori Tekst
in_menu Angiver om menuen er i kategorien 1/0
weight Rækkefølge Tal
parent_id ID på kategoriens parent ID
parent_name Navnet på kategoriens parent Tekst
sort_order normal, no_stock_last eller random Tekst
no_index Om der skal være no_index på kategorien 1/0
tag Tag Tekst
empty_redir URL hvis der skal viderestilles hvis kategorien er tom Tekst
description_a Beskrivelse A Tekst
description_b Beskrivelse B Tekst
meta_title Meta title Tekst
meta_description Meta description Tekst
google_category Googlekategori ID
open_graph_title Open graph titel Tekst
open_graph_description Open graph bekrivelse Tekst
canonical_id ID hvis der skal sættes canonical_id ID
meta Ekstrafelter Tekst
images Et array af json-objekter der beskriver billeder. Sæt image_id hvis et billede skal opdateres.
Se værdier
image_id ID, hvis billedet skal opdateres.
weight Vægtning
description Beskrivelse
data base64 encoded billede
url URL til billedet hvis det skal hentes (i stedet for at bruge data)
remove 1/0
rewrite_url URL på kategorien Tekst
extension_data Et objekt med udvidede felter. Sendes som 'key': 'value' med felterne svarende til hvad der bruges i temaet. Objekt
add_products Et array af produkter der skal tilføjes til kategorien. Produkterne gemmes i den rækkefølge de er i arrayet Array af ID'er
remove_products Et array af produkter der skal fjernes fra kategorien Array af ID'er
set_products Et array af produkter der skal være i kategorien. Produkterne gemmes i den rækkefølge de er i arrayet. Produkter der ikke er i arrayet fjernes fra kategorien Array af ID'er

GET /REST/category/{id}

Henter den specifikke kategori

PUT /REST/category/{id}

Opdaterer kategori

PUT-argumenter

Bemærk at argumenterne skal pakkes ind i et json-objekt som fx { "foo" : "bar" } der sendes i body-området.

Argument Beskrivelse Datatype
name Navn på kategori Tekst
in_menu Angiver om menuen er i kategorien 1/0
weight Rækkefølge Tal
parent_id ID på kategoriens parent ID
parent_name Navnet på kategoriens parent Tekst
sort_order normal, no_stock_last eller random Tekst
no_index Om der skal være no_index på kategorien 1/0
tag Tag Tekst
empty_redir URL hvis der skal viderestilles hvis kategorien er tom Tekst
description_a Beskrivelse A Tekst
description_b Beskrivelse B Tekst
meta_title Meta title Tekst
meta_description Meta description Tekst
google_category Googlekategori ID
open_graph_title Open graph titel Tekst
open_graph_description Open graph bekrivelse Tekst
canonical_id ID hvis der skal sættes canonical_id ID
meta Ekstrafelter Tekst
images Et array af json-objekter der beskriver billeder. Sæt image_id hvis et billede skal opdateres.
Se værdier
image_id ID, hvis billedet skal opdateres.
weight Vægtning
description Beskrivelse
data base64 encoded billede
url URL til billedet hvis det skal hentes (i stedet for at bruge data)
remove Sæt dette felt hvis billedet skal slettes
rewrite_url URL på kategorien Tekst
extension_data Et objekt med udvidede felter. Sendes som 'key': 'value' med felterne svarende til hvad der bruges i temaet. Objekt
add_products Et array af produkter der skal tilføjes til kategorien. Produkterne gemmes i den rækkefølge de er i arrayet Array af ID'er
remove_products Et array af produkter der skal fjernes fra kategorien Array af ID'er
set_products Et array af produkter der skal være i kategorien. Produkterne gemmes i den rækkefølge de er i arrayet. Produkter der ikke er i arrayet fjernes fra kategorien Array af ID'er

DELETE /REST/category/{id}

Sletter kategori

Produkter

GET /REST/product

Henter alle produkter

GET-argumenter

Argument Beskrivelse Datatype
search Fritekstsøgning Tekst
profile_id Alle produkter i profilen ID
supplier_id Alle produkter med denne leverandør ID
brand_id Alle produkter med dette brand ID
category_id Alle produkter i denne kategori ID
has_images Produkter med/uden billeder yes/no
in_stock Produkter der er på lager yes/no
is_online Produkter der er online yes/no
sort Hvilket felt der skal sorteres efter Tekst
sort_order Rækkefølge asc/desc
last_modified Kun produkter der er redigeret efter en bestemt dato. Fx 2019-09-10T12:00:00. Dette argument kan ikke kombineres med de andre. Tekst
product_ids Kun produkter der matcher denne liste. Fx 1, 2, 3. Dette argument kan ikke kombineres med de andre. Tekst
fields Hent kun udvalgte felter. Fx product_id,own_id,sale_price Tekst

POST /REST/product

Opretter nyt produkt. Bemærk at hvis der skal oprettes flere produkter understøtter denne metode at der sendes et array af nedenstående objekter.

POST-argumenter

Bemærk at argumenterne skal pakkes ind i et json-objekt som fx { "foo" : "bar" } der sendes i body-området.

Argument Beskrivelse Datatype
profile_id ID på profilen ID
name Navn på produktet Tekst
description Beskrivelse Tekst
supplier_name Leverandørnavn Tekst
brand_name Brandnavn Tekst
supplier_id Leverandør ID Tekst
brand_id Brand ID Tekst
list_description Listebeskrivelse Tekst
main_category_id Hovedkategori Tekst
vat Moms Tekst
price Pris Tekst
sale_price Tilbudspris Tekst
shipping Fragtpris Tekst
shipping_weight Fragtvægt i gram Tekst
never_free_shipping Tillad aldrig fri fragt 1/0
delivery_time Leveringstid Tekst
delivery_time_not_in_stock Leveringstid hvis varen ikke er på lager Tekst
auto_offline Om produktet automatisk skal sættes offline når det ikke er på lager 1/0
no_index Tilføj no_index 1/0
no_shopping Tilføj no_shopping 1/0
no_partner_ads Tilføj no_partner_ads 1/0
meta Ekstrafelter Tekst
meta_title Meta titel Tekst
meta_description Meta beskrivelse Tekst
canonical_id Canonical ID ID
allow_negative_stock Tillad at produktet har negativ lagerværdi 1/0
search Til intern søgning Tekst
is_online Om produktet er online 1/0
mailing_list_ids ID'er til Mailchimp Tekst
own_id SKU-numer Tekst
sec_own_id Sekundært SKU-nummer Tekst
gtin GTIN Tekst
mpn MPN Tekst
purchase_price Indkøbspris Tekst
google_category Googlekategori ID
open_graph_title Open graph titel Tekst
open_graph_description Open graph bekrivelse Tekst
google_shopping_title Google shopping titel Tekst
rewrite_url URL Tekst
bundle Samlepakker. Et array af produkt ID'er Array
auto_online Auto online hvis produktet kommer på lager 1/0
location Lagerplacering Tekst
categories Et array af kategorier. Enten et array af id'er, eller et array af navne eller tags
Se værdier
tag Tekst
name Tekst
related Et array af produkt ID'er på relaterede produkter Array
similar Et array af produkt ID'er på lignende produkter Array
locations Et array af SKU-numre og placering
Se værdier
sku SKU-nummer
location Lokation
images Et array af json-objekter der beskriver billeder. Sæt image_id hvis et billede skal opdateres.
Se værdier
image_id ID, hvis billedet skal opdateres.
weight Vægtning
description Beskrivelse
data base64 encoded billede
url URL til billedet hvis det skal hentes (i stedet for at bruge data)
remove 1/0
remove_images Fjern alle billeder 0/1
country_of_origin Oprindelsesland Tekst
variant_images Et array af billeder til varianter
Se værdier
attribute_value_id ID
image_id ID
file Hvis produktet skal have en fil til download
Se værdier
data Array med filens indhold. Skal indeholde felterne data, filename, content-type og is_public
url URL hvis filen skal hentes
remove 1/0
pdf Hvis produktet skal have en pdf til download
Se værdier
data Array med filens indhold. Skal indeholde felterne data og filename
url URL hvis filen skal hentes
stock_settings Et array af værdier
Se værdier
own_id SKU-nummer
sec_own_id Sekundært SKU-nummer
purchase_price Indkøbspris
gtin GTIN
price Pris
sale_price Udsalgspris
attribute_value_name Navnet på varianten i stedet for at bruge id'er
min_stock_value Minimum lagerbeholdning
mpn MPN
location Lagerplacering
product_labels Et array af labels
Se værdier
product_label_id ID
add_product_labels Et array af labels der skal tilføjes
Se værdier
product_label_id ID
remove_product_labels Et array af labels der skal fjernes
Se værdier
product_label_id ID
attributes Array af værdier på attributterne
Se værdier
attribute_id Evt. ID
name Navn
value Værdi
tag Værdi
value_name værdi
data_type Tom eller 'valuelist'
html_fields HTML-felter
Se værdier
html HTML
append head, body eller tomt afhængig af om feltet automatisk til tilføjes.
bulk_discount Mængderabat
Se værdier
over Mængderabat ved køb af flere end
discount Sæt prisen (u. moms) for alle ned med
discount_intervals Trapperabat
Se værdier
discount [{"3": "900.00"}, {"6": "800.00"}, {"9": "700.00"}]

Hvis der skal sættes trapperabat på variantniveau skal prisen i ovenstående være et array bestående af et array med et objekt pr. variant med attribute_value_id og price fx: "3": [
    {
        "attribute_value_id": 123,
        "price": "101"
    },
    [...]
],
[...]
extension_data Et objekt med udvidede felter. Sendes som 'key': 'value' med felterne svarende til hvad der bruges i temaet. Objekt

GET /REST/product/{id}

Henter det specifikke produkt

PUT /REST/product/{id}

Opdaterer produkt

PUT-argumenter

Bemærk at argumenterne skal pakkes ind i et json-objekt som fx { "foo" : "bar" } der sendes i body-området.

Argument Beskrivelse Datatype
profile_id ID på profilen ID
name Navn på produktet Tekst
description Beskrivelse Tekst
supplier_name Leverandørnavn Tekst
brand_name Brandnavn Tekst
supplier_id Leverandør ID Tekst
brand_id Brand ID Tekst
list_description Listebeskrivelse Tekst
main_category_id Hovedkategori Tekst
vat Moms Tekst
price Pris Tekst
sale_price Tilbudspris Tekst
shipping Fragtpris Tekst
shipping_weight Fragtvægt i gram Tekst
never_free_shipping Tillad aldrig fri fragt 1/0
delivery_time Leveringstid Tekst
delivery_time_not_in_stock Leveringstid hvis varen ikke er på lager Tekst
auto_offline Om produktet automatisk skal sættes offline når det ikke er på lager 1/0
no_index Tilføj no_index 1/0
meta Ekstrafelter Tekst
meta_title Meta titel Tekst
meta_description Meta beskrivelse Tekst
canonical_id Canonical ID ID
allow_negative_stock Tillad at produktet har negativ lagerværdi 1/0
search Til intern søgning Tekst
is_online Om produktet er online 1/0
mailing_list_ids ID'er til Mailchimp Tekst
own_id SKU-numer Tekst
sec_own_id Sekundært SKU-nummer Tekst
gtin GTIN Tekst
mpn MPN Tekst
purchase_price Indkøbspris Tekst
google_category Googlekategori ID
open_graph_title Open graph titel Tekst
open_graph_description Open graph bekrivelse Tekst
google_shopping_title Google shopping titel Tekst
rewrite_url URL Tekst
bundle Samlepakker. Et array af produkt ID'er Array
auto_online Auto online hvis produktet kommer på lager 1/0
location Lagerplacering Tekst
categories Et array af kategorier. Enten et array af id'er, eller et array af navne eller tags
Se værdier
tag Tekst
name Tekst
related Et array af produkt ID'er på relaterede produkter Array
similar Et array af produkt ID'er på lignende produkter Array
locations Et array af SKU-numre og placering
Se værdier
sku SKU-nummer
location Lokation
images Et array af json-objekter der beskriver billeder. Sæt image_id hvis et billede skal opdateres.
Se værdier
image_id ID, hvis billedet skal opdateres.
weight Vægtning
description Beskrivelse
data base64 encoded billede
url URL til billedet hvis det skal hentes (i stedet for at bruge data)
remove 1/0
remove_images Fjern alle billeder 0/1
country_of_origin Oprindelsesland Tekst
variant_images Et array af billeder til varianter
Se værdier
attribute_value_id ID
image_id ID
file Hvis produktet skal have en fil til download
Se værdier
data Array med filens indhold. Skal indeholde felterne data, filename, content-type og is_public
url URL hvis filen skal hentes
remove 1/0
pdf Hvis produktet skal have en pdf til download
Se værdier
data Array med filens indhold. Skal indeholde felterne data og filename
url URL hvis filen skal hentes
stock_settings Et array af værdier
Se værdier
own_id SKU-nummer
sec_own_id Sekundært SKU-nummer
purchase_price Indkøbspris
gtin GTIN
price Pris
sale_price Udsalgspris
attribute_value_name Navnet på varianten i stedet for at bruge id'er
min_stock_value Minimum lagerbeholdning
mpn MPN
location Lagerplacering
product_labels Et array af labels
Se værdier
product_label_id ID
add_product_labels Et array af labels der skal tilføjes
Se værdier
product_label_id ID
remove_product_labels Et array af labels der skal fjernes
Se værdier
product_label_id ID
attributes Array af værdier på attributterne
Se værdier
attribute_id Evt. ID
name Navn
value Værdi
tag Værdi
value_name værdi
data_type Tom eller 'valuelist'
html_fields HTML-felter
Se værdier
html HTML
append head, body eller tomt afhængig af om feltet automatisk til tilføjes.
bulk_discount Mængderabat
Se værdier
over Mængderabat ved køb af flere end
discount Sæt prisen (u. moms) for alle ned med
discount_intervals Trapperabat
Se værdier
discount [{"3": "900.00"}, {"6": "800.00"}, {"9": "700.00"}]

Hvis der skal sættes trapperabat på variantniveau skal prisen i ovenstående være et array bestående af et array med et objekt pr. variant med attribute_value_id og price fx: "3": [
    {
        "attribute_value_id": 123,
        "price": "101"
    },
    [...]
],
[...]
extension_data Et objekt med udvidede felter. Sendes som 'key': 'value' med felterne svarende til hvad der bruges i temaet. Objekt

DELETE /REST/product/{id}

Sletter produkt

Produktlabels

GET /REST/product-label

Henter alle produktlabels

POST /REST/product-label

Opretter nyt produktlabel

POST-argumenter

Bemærk at argumenterne skal pakkes ind i et json-objekt som fx { "foo" : "bar" } der sendes i body-området.

Argument Beskrivelse Datatype
name Navn Tekst

GET /REST/product-label/{id}

Henter det specifikke produktlabel

PUT /REST/product-label/{id}

Opdaterer produktlabel

PUT-argumenter

Bemærk at argumenterne skal pakkes ind i et json-objekt som fx { "foo" : "bar" } der sendes i body-området.

Argument Beskrivelse Datatype
name Navn Tekst

DELETE /REST/product-label/{id}

Sletter produktlabel

Lager

GET /REST/stock

Henter alle lagerposteringer udfra en produktsøgning

GET-argumenter

Argument Beskrivelse Datatype
search Fritekstsøgning Tekst
profile_id Alle produkter i profilen ID
supplier_id Alle produkter med denne leverandør ID
brand_id Alle produkter med dette brand ID
category_id Alle produkter i denne kategori ID
has_images Produkter med/uden billeder yes/no
in_stock Produkter der er på lager yes/no
is_online Produkter der er online yes/no
sort Hvilket felt der skal sorteres efter Tekst
sort_order Rækkefølge asc/desc
last_modified Kun produkter der er redigeret efter en bestemt dato. Fx 2019-09-10T12:00:00. Dette argument kan ikke kombineres med de andre. Tekst
product_ids Kun produkter der matcher denne liste. Fx 1, 2, 3. Dette argument kan ikke kombineres med de andre. Tekst

POST /REST/stock

Laver lagerpostering. Hvis GET-argumentet 'background' er sat vil synkroniseringen af lagerstatus blive kørt i baggrunden, og serveren returnerer med det samme.

POST-argumenter

Bemærk at argumenterne skal pakkes ind i et json-objekt som fx { "foo" : "bar" } der sendes i body-området.

Argument Beskrivelse Datatype
{Array i body} Array af lagerposteringer
Se værdier
SKU SKU-nummer
stock Lagerværdi
tag Tag på lagerlokation

GET /REST/stock/{id}

Henter lagerstatus på det specifikke produkt

Ordrer

GET /REST/order/{id}

Henter én ordre

GET-argumenter

Argument Beskrivelse Datatype
is_webshop_order_id Angiver om ID'et man henter er Shoporamas ID eller webshoppens eget Boolean

GET /REST/order

Henter alle ordrer

GET-argumenter

Argument Beskrivelse Datatype
last_modified Dato for senest ændret. Format yyyy-mm-dd h:i:s. Denne parametre kan ikke kombineres med andre. Tekst
time_interval Interval for oprettelse af ordrer adskilt af komma, fx time_interval=2000-08-24,2021-09-20. Format yyyy-mm-dd h:i:s. Denne parametre kan ikke kombineres med andre. Tekst
from Returnerer kun ordre hvor ID'et er større end dette. Denne parametre kan ikke kombineres med andre. ID
time_from Til søgning i datointervaller. Både time_from og time_to skal sættes for at opslaget laves. yyyy-mm-dd
time_to Til søgning i datointervaller yyyy-mm-dd
status Status på ordren Tekst
search Fritekstsøgning Tekst
order_label_id ID på ordrelabel ID
paid Betalte eller ubetalte ordre 1/0
captured Kun ordre der er udført capturekald på 1/0
shipping_id ID på shipping ID
del_country_id ID på leveringsland ID
supplier_id ID på leverandør ID
sort order_id eller time Tekst
sort_order Rækkefølgen, asc eller desc Tekst

POST /REST/order

Opretter ny ordre

POST-argumenter

Bemærk at argumenterne skal pakkes ind i et json-objekt som fx { "foo" : "bar" } der sendes i body-området.

Argument Beskrivelse Datatype
status Status på ordren Tekst
original_order_id ID på ordre hvis det er en kreditnota Tal
price Pris Tal
shipping_price Fragtpris Tal
vat Moms Tal
total_price Totalpris Tal
customer_id Customer ID Tal
add_points Antal point der skal tilføjes kundens profil Tal
add_points_in_currency Samme som add_points. Bare i shoppens valuta Tal
email E-mail Tekst
phone Telefonnummer Tekst
shipping_id ID på fragtmetode ID
voucher_id ID på rabatkode ID
del_country_id ID på leveringsland ID
order_country_id ID på ordreland ID
invoice_id Fakturanummer Tekst
voucher_code Rabatkode Tekst
voucher_discount Rabat Tekst
voucher_discount_amount Rabatbeløb Tekst
paid Betalt Tekst
captured Om der er lavet capturekald Tekst
card_type Korttypen Tekst
tracking_number Trackingnummer Tekst
tracking_numbers Liste af trackingnumre. Én linje pr. nummer. Tekst
add_tracking_number Tilføj trackingnummer til listen over trackingnumre Tekst
ean_number EAN-nummer Tekst
vat_number CVR-nummer Tekst
order_company_name Firmanavn på bestillingen Tekst
order_name Bestillingsnavn Tekst
order_address Bestillingsadresse Tekst
order_zipcode Bestillingspostnummer Tekst
order_city Bestillingsby Tekst
del_company_name Firmanavn på leveringen Tekst
del_name Modtagernavn Tekst
del_address Modtageradresse Tekst
del_zipcode Modtagerpostnummer Tekst
del_city Modtagerby Tekst
comments Kommentar Tekst
extra Ekstrafelter Tekst
note Intern note Tekst
add_note Tilføj til intern note Tekst
pickup_address Afhentningsadresse, fx pakkeshop Tekst
shop_gateway_need_update Om ordren skal sendes til regnskabsprogram Tekst
add_label_id ID'er på labels der skal tilføjes ID/array
remove_label_id ID'er på labels der skal fjernes ID/array
tt_status Track and trace status Tekst
tt_data Track and trace data Tekst
products Array af produkter
Se værdier
product_id ID på produkt
order_product_id ID på ordre_produkt hvis det kendes, ellers oprettes det
amount Antal. 0 = slet, default 1
own_id SKU-nummer
unit_price Pris
unit_vat Moms
stock Lagerpostering
attributes

GET /REST/order/{id}

Henter den specifikke ordre

PUT /REST/order/{id}

Opdaterer ordre

PUT-argumenter

Bemærk at argumenterne skal pakkes ind i et json-objekt som fx { "foo" : "bar" } der sendes i body-området.

Argument Beskrivelse Datatype
status Status på ordren Tekst
original_order_id ID på ordre hvis det er en kreditnota Tal
price Pris Tal
shipping_price Fragtpris Tal
vat Moms Tal
total_price Totalpris Tal
customer_id Customer ID Tal
add_points Antal point der skal tilføjes kundens profil Tal
add_points_in_currency Samme som add_points. Bare i shoppens valuta Tal
email E-mail Tekst
phone Telefonnummer Tekst
shipping_id ID på fragtmetode ID
voucher_id ID på rabatkode ID
del_country_id ID på leveringsland ID
order_country_id ID på ordreland ID
invoice_id Fakturanummer Tekst
voucher_code Rabatkode Tekst
voucher_discount Rabat Tekst
voucher_discount_amount Rabatbeløb Tekst
paid Betalt Tekst
captured Om der er lavet capturekald Tekst
card_type Korttypen Tekst
tracking_number Trackingnummer Tekst
tracking_numbers Liste af trackingnumre. Én linje pr. nummer. Tekst
add_tracking_number Tilføj trackingnummer til listen over trackingnumre Tekst
ean_number EAN-nummer Tekst
vat_number CVR-nummer Tekst
order_company_name Firmanavn på bestillingen Tekst
order_name Bestillingsnavn Tekst
order_address Bestillingsadresse Tekst
order_zipcode Bestillingspostnummer Tekst
order_city Bestillingsby Tekst
del_company_name Firmanavn på leveringen Tekst
del_name Modtagernavn Tekst
del_address Modtageradresse Tekst
del_zipcode Modtagerpostnummer Tekst
del_city Modtagerby Tekst
comments Kommentar Tekst
extra Ekstrafelter Tekst
note Intern note Tekst
add_note Tilføj til intern note Tekst
pickup_address Afhentningsadresse, fx pakkeshop Tekst
shop_gateway_need_update Om ordren skal sendes til regnskabsprogram Tekst
add_label_id ID'er på labels der skal tilføjes ID/array
remove_label_id ID'er på labels der skal fjernes ID/array
tt_status Track and trace status Tekst
tt_data Track and trace data Tekst
products Array af produkter
Se værdier
product_id ID på produkt
order_product_id ID på ordre_produkt hvis det kendes, ellers oprettes det
amount Antal. 0 = slet, default 1
own_id SKU-nummer
unit_price Pris
unit_vat Moms
stock Lagerpostering
attributes

Rabatkoder

GET /REST/voucher

Henter alle rabatkoder

POST /REST/voucher

Opretter ny rabatkode

POST-argumenter

Bemærk at argumenterne skal pakkes ind i et json-objekt som fx { "foo" : "bar" } der sendes i body-området.

Argument Beskrivelse Datatype
code Koden til rabatkoden Tekst
amount_left Antal gange koden må bruges Tal
allow_on_sale Om rabatkoden må benyttes på nedsatte produkter 1/0
allow_on_campaign Om rabatkoden må benyttes på kampagneprodukter 1/0
allow_with_points Om rabatkoden må benyttes sammen med point 1/0
save_change Om rabatkoden skal gemme restbeløbet 1/0
only_over Anvend kun hvis beløbet er over Tal
free_shipping Gratis fragt 1/0
is_public Om rabatkoden er med i offentlige lister 1/0
percent_discount Rabatten i procent Tal
price_discount Rabatbeløb Tal
expires Udløbsdato Dato (yyyy-mm-hh h:i:s)
note Intern note Tekst
categories Kategorier rabatkoden må anvendes på Array af ID'er
products Produkter rabatkoden må anvendes på Array af ID'er

GET /REST/voucher/{id}

Henter den specifikke rabatkode

PUT /REST/voucher/{id}

Opdaterer rabatkode

PUT-argumenter

Bemærk at argumenterne skal pakkes ind i et json-objekt som fx { "foo" : "bar" } der sendes i body-området.

Argument Beskrivelse Datatype
code Koden til rabatkoden Tekst
amount_left Antal gange koden må bruges Tal
allow_on_sale Om rabatkoden må benyttes på nedsatte produkter 1/0
allow_on_campaign Om rabatkoden må benyttes på kampagneprodukter 1/0
allow_with_points Om rabatkoden må benyttes sammen med point 1/0
save_change Om rabatkoden skal gemme restbeløbet 1/0
only_over Anvend kun hvis beløbet er over Tal
free_shipping Gratis fragt 1/0
is_public Om rabatkoden er med i offentlige lister 1/0
percent_discount Rabatten i procent Tal
price_discount Rabatbeløb Tal
expires Udløbsdato Dato (yyyy-mm-hh h:i:s)
note Intern note Tekst
categories Kategorier rabatkoden må anvendes på Array af ID'er
products Produkter rabatkoden må anvendes på Array af ID'er

DELETE /REST/voucher/{id}

Sletter rabatkode

Menus

GET /REST/menu

Henter alle menuer

POST /REST/menu

Opretter ny menu

POST-argumenter

Bemærk at argumenterne skal pakkes ind i et json-objekt som fx { "foo" : "bar" } der sendes i body-området.

Argument Beskrivelse Datatype
name Navnet på menuen Tekst
tag Tag til identificering Tekst
location Placering af menuen Tekst

GET /REST/menu/{id}

Henter den specifikke menu

PUT /REST/menu/{id}

Opdaterer menu

PUT-argumenter

Bemærk at argumenterne skal pakkes ind i et json-objekt som fx { "foo" : "bar" } der sendes i body-området.

Argument Beskrivelse Datatype
name Navnet på menuen Tekst
tag Tag til identificering Tekst
location Placering af menuen Tekst
parent_id ID på parent menu Tal

DELETE /REST/menu/{id}

Sletter menu

Landing Pages

GET /REST/landing-page

Henter alle landing pages

POST /REST/landing-page

Opretter ny landing page

POST-argumenter

Bemærk at argumenterne skal pakkes ind i et json-objekt som fx { "foo" : "bar" } der sendes i body-området.

Argument Beskrivelse Datatype
name Navnet på landing page Tekst
description Beskrivelse Tekst
rewrite_url URL rewrite Tekst
meta_title Meta title Tekst
meta_description Meta beskrivelse Tekst

GET /REST/landing-page/{id}

Henter den specifikke landing page

PUT /REST/landing-page/{id}

Opdaterer landing page

PUT-argumenter

Bemærk at argumenterne skal pakkes ind i et json-objekt som fx { "foo" : "bar" } der sendes i body-området.

Argument Beskrivelse Datatype
name Navnet på landing page Tekst
description_a Beskrivelse A Tekst
description_b Beskrivelse B Tekst
rewrite_url URL rewrite Tekst
meta_title Meta title Tekst
meta_description Meta beskrivelse Tekst
is_online Om landing page er online 0/1
tag Tag til identificering Tekst

DELETE /REST/landing-page/{id}

Sletter landing page

Landing Page Items

GET /REST/landing-page-item

Henter alle landing page items for en landing page

POST /REST/landing-page-item

Opretter ny landing page item

POST-argumenter

Bemærk at argumenterne skal pakkes ind i et json-objekt som fx { "foo" : "bar" } der sendes i body-området.

Argument Beskrivelse Datatype
landing_page_id ID på landing page Tal
type Type af item (price, sale_price, real_price, profile_id, category_id, label_id, attribute_id, attribute_value_id, product_id, supplier_id, brand_id, search, extension_field) Tekst
is Operator (=, <, >, in, not in) Tekst
val Værdi Tekst

GET /REST/landing-page-item/{id}

Henter den specifikke landing page item

PUT /REST/landing-page-item/{id}

Opdaterer landing page item

PUT-argumenter

Bemærk at argumenterne skal pakkes ind i et json-objekt som fx { "foo" : "bar" } der sendes i body-området.

Argument Beskrivelse Datatype
type Type af item Tekst
is Operator Tekst
val Værdi Tekst

DELETE /REST/landing-page-item/{id}

Sletter landing page item