Get storefront settings

curl --request GET \
  --url https://{operatorDomain}/v1/admin/storefront/settings \
  --header 'Authorization: Bearer <token>'

{
  "brandName": "<string>",
  "primaryColor": "<string>",
  "domains": [
    "<string>"
  ],
  "checkoutEnabled": true
}

GET

admin

storefront

settings

Get storefront settings

curl --request GET \
  --url https://{operatorDomain}/v1/admin/storefront/settings \
  --header 'Authorization: Bearer <token>'

{
  "brandName": "<string>",
  "primaryColor": "<string>",
  "domains": [
    "<string>"
  ],
  "checkoutEnabled": true
}

Authorization

string

header

required

Staff session or API token issued by your Voyant app.

200 - application/json

Storefront settings

brandName

string | null

primaryColor

string | null

domains

string[]

checkoutEnabled

boolean

⌘I