Hopp til innhold
skribbskribb

Utviklere

Toppseksjoner

Nettbutikk

Teksten over produktene: én toppseksjon for hele butikken, og én for hver kategori. Den er bygd av de samme blokkene som en side. Har du ikke skrevet noen, er blocks tom, og butikken viser bare overskriften og produktene.

Krever at nettbutikken er slått på.

Alle sidene

Referanse

Kodeeksemplene kaller en skribb-funksjon. Hent klienten for språket ditt →

GET/v1/shop/masthead

products:read

Hent toppseksjonen over butikken

Svaret · 200

mastheadShopMasthead
Toppseksjonen.
Svar
{
  "masthead": {
    "title": "Nytt fra verkstedet",
    "blocks": [
      { "type": "prose", "heading": "", "body": "Alt er laget for hånd i Bergen." }
    ]
  }
}
# Kaller skribb-klienten: https://skribb.no/utviklere/autentisering#klient
skribb "/shop/masthead"

PUT/v1/shop/masthead

products:write

Erstatt toppseksjonen over butikken

Send hele toppseksjonen: det du sender, erstatter det som står der. Blokker vi ikke kjenner igjen, blir forkastet i stedet for å velte lagringen, så les blocks i svaret om du er i tvil. Egen HTML legger du inn i butikkinnstillingene på skribb.no, ikke her.

Bodyen du sender

titlestring | null
Overskriften, inntil 200 tegn. Utelatt, null eller tom gir standarden.
blocksobject[]påkrevd
Blokkene, i rekkefølge. Tom liste fjerner toppseksjonen. En html-blokk gir 422 html-block-not-allowed, og index i svaret sier hvilken.

Svaret · 200

mastheadShopMasthead
Toppseksjonen slik den ble lagret.
# Kaller skribb-klienten: https://skribb.no/utviklere/autentisering#klient
skribb "/shop/masthead" \
  -X PUT \
  -H "content-type: application/json" \
  -d '{
    "blocks": [
      {
        "_type": "block",
        "style": "normal",
        "children": [
          {
            "_type": "span",
            "text": "Det ble en lang måned."
          }
        ]
      }
    ]
  }'

GET/v1/shop/categories/{slug}/masthead

products:read

Hent toppseksjonen over en kategori

Kategorien må stå i kategoriregisteret, ellers svarer vi 404 unknown-category.

Svaret · 200

mastheadShopMasthead
Toppseksjonen.
Svar
{
  "masthead": {
    "title": "Nytt fra verkstedet",
    "blocks": [
      { "type": "prose", "heading": "", "body": "Alt er laget for hånd i Bergen." }
    ]
  }
}
# Kaller skribb-klienten: https://skribb.no/utviklere/autentisering#klient
categorie_slug="om-oss"

skribb "/shop/categories/$categorie_slug/masthead"

PUT/v1/shop/categories/{slug}/masthead

products:write

Erstatt toppseksjonen over en kategori

Send hele toppseksjonen: det du sender, erstatter det som står der. Blokker vi ikke kjenner igjen, blir forkastet i stedet for å velte lagringen, så les blocks i svaret om du er i tvil. Egen HTML legger du inn i butikkinnstillingene på skribb.no, ikke her. Kategorien må stå i kategoriregisteret, ellers svarer vi 404 unknown-category.

Bodyen du sender

titlestring | null
Overskriften, inntil 200 tegn. Utelatt, null eller tom gir standarden.
blocksobject[]påkrevd
Blokkene, i rekkefølge. Tom liste fjerner toppseksjonen. En html-blokk gir 422 html-block-not-allowed, og index i svaret sier hvilken.

Svaret · 200

mastheadShopMasthead
Toppseksjonen slik den ble lagret.
# Kaller skribb-klienten: https://skribb.no/utviklere/autentisering#klient
categorie_slug="om-oss"

skribb "/shop/categories/$categorie_slug/masthead" \
  -X PUT \
  -H "content-type: application/json" \
  -d '{
    "blocks": [
      {
        "_type": "block",
        "style": "normal",
        "children": [
          {
            "_type": "span",
            "text": "Det ble en lang måned."
          }
        ]
      }
    ]
  }'

Objekter

ShopMasthead

Toppseksjonen over produktene i butikken eller i en kategori.

Felter

categorystring
Slugen til kategorien. Bare med når toppseksjonen hører til en kategori.
titlestring
Overskriften. Tom betyr standarden: «Butikk» over butikken, navnet på kategorien over en kategori.
blocksobject[]
Blokkene, i rekkefølge, i samme format som på en side. Tom liste betyr at det ikke står noe over produktene.

← Alle rutene