Update storefront presentation

PUT /api/v2/shops/{shopId}/storefront

Update storefront presentation

cURL

curl --request PUT \
  --url https://api.itemshop.dev/api/v2/shops/{shopId}/storefront \
  --header 'Content-Type: application/json' \
  --header 'X-API-Key: <api-key>' \
  --data '
{
  "description": "<string>",
  "serverIp": "play.shop.pl",
  "discordInviteUrl": "<string>",
  "communitySize": 1,
  "announcement": "<string>",
  "languages": [
    "<string>"
  ],
  "translations": {},
  "socials": {
    "discord": "<string>",
    "tiktok": "<string>",
    "facebook": "<string>",
    "youtube": "<string>",
    "instagram": "<string>"
  },
  "monthlyGoal": {
    "enabled": true,
    "target": 1
  },
  "administration": [
    {
      "nickname": "Steve",
      "role": "CEO"
    }
  ],
  "theme": {
    "brandColor": "#ef592d",
    "accentColor": "#facc15"
  },
  "hideCheckoutDiscount": true,
  "hideCheckoutPaymentInfo": true,
  "hideCheckoutSummary": true,
  "hero": {
    "title": "<string>",
    "tagline": "<string>",
    "renderNicks": [
      "<string>"
    ],
    "ctaLabel": "<string>",
    "ctaHref": "<string>"
  },
  "sections": {
    "showAnnouncement": true,
    "showMonthlyGoal": true,
    "showCatalog": true,
    "showRecentPurchases": true,
    "showTopSpenders": true,
    "showAdministration": true
  },
  "publicData": {
    "recentPurchases": true,
    "topSpenders": true,
    "monthlyGoal": true,
    "onlinePlayers": true
  },
  "legal": {
    "termsHtml": "<string>",
    "privacyHtml": "<string>",
    "companyInfo": "<string>"
  },
  "payments": {
    "showStrip": true
  },
  "fontFamily": "<string>",
  "navHideHome": true,
  "logoUrl": "<string>",
  "shopCtaLabel": "<string>",
  "shopCtaHidden": true,
  "chrome": {
    "navbarTitle": "<string>",
    "navShowOnline": true,
    "navLinks": [
      {
        "label": "<string>",
        "url": "<string>",
        "newTab": true
      }
    ],
    "navHidden": true,
    "footerHidden": true,
    "navHeight": 200,
    "navMaxWidth": 2000,
    "footerPadY": 200,
    "footerMaxWidth": 2000,
    "footerDiscordTitle": "<string>",
    "footerDiscordSubtitle": "<string>",
    "footerHideDiscord": true,
    "footerCopyright": "<string>",
    "footerBrand": "<string>",
    "footerLegalPl": "<string>",
    "footerLegalEn": "<string>"
  },
  "layout": [
    {
      "id": "<string>",
      "visible": true,
      "props": {}
    }
  ],
  "pages": [
    {
      "id": "<string>",
      "slug": "<string>",
      "title": "<string>",
      "nav": true,
      "layout": [
        {
          "id": "<string>",
          "visible": true,
          "props": {}
        }
      ]
    }
  ]
}
'

200

{
  "success": true,
  "data": {
    "_id": "664f1a2b3c4d5e6f7a8b9c0d",
    "uniqueName": "moj-sklep",
    "displayName": "Mój Sklep",
    "frontEndUrl": "https://moj-sklep.pl",
    "isActive": true,
    "createdAt": "2023-11-07T05:31:56Z"
  },
  "message": "<string>"
}

Authorizations

apiKeyAuthbearerAuth

X-API-Key · string · header · required

Path Parameters

shopId · string · required

Shop ID (ObjectId)

Body

application/json

description · string

Hero tagline

Maximum string length: 500

serverIp · string

Server IP

Maximum string length: 120

Example:

"play.shop.pl"

discordInviteUrl · string

Discord invite

Maximum string length: 300

communitySize · number

Community size

Required range: x >= 0

announcement · string

Announcement banner

Maximum string length: 500

languages · string[]

Enabled languages (ISO)

Maximum array length: 20

translations · object

Per-language storefront translations

socials · object

Show child attributes

monthlyGoal · object

Show child attributes

administration · object[]

Maximum array length: 50

Show child attributes

theme · object

Show child attributes

checkoutLayout · enum<string>

Checkout page layout

Available options: split, inline, modal

hideCheckoutDiscount · boolean

Hide the discount-code field in checkout

hideCheckoutPaymentInfo · boolean

Hide the payment-operator legal strip in checkout

hideCheckoutSummary · boolean

Hide the order-summary block in the 2-step modal checkout

hero · object

Show child attributes

sections · object

Show child attributes

publicData · object

Show child attributes

legal · object

Show child attributes

payments · object

Show child attributes

fontFamily · string

Storefront font family

Maximum string length: 60

navHideHome · boolean

Hide the home link in the nav

logoUrl · string

Navbar logo URL

Maximum string length: 500

Pattern: ^(https?:\/\/|\/|$)

shopCtaLabel · string

"Sklep" CTA label

Maximum string length: 40

shopCtaHidden · boolean

Hide the "Sklep" CTA

chrome · object

Navbar/footer overrides

Show child attributes

layout · object[]

Page block layout

Maximum array length: 50

Show child attributes

pages · object[]

Builder subpages

Maximum array length: 30

Show child attributes

Response

200

application/json

OK

success · boolean

Example:

true

data · object

Show child attributes

message · string