← API Index


ShopUrl (v7)

Shop binding information for initial client connection

Change Note: migrated from legacy bind4 to POJO pattern

# Field Type Description
0 displayName string display name of the shop
1 webDomain string web domain of the shop
2 secureWebDomain string secure (HTTPS) web domain of the shop
3 homeUrl string homepage URL of the shop
4 hasLogo string logo URL if available, null otherwise
5 sysName string internal system name of the shop
6 isTest int 1 if this is a test shop binding, 0 otherwise
7 lat double latitude of the shop location
8 lng double longitude of the shop location
9 dbId int internal database id of the shop
10 seoDesc string SEO description text
11 seoCities string SEO city names, comma separated
12 seoBio int 1 if SEO bio flag is enabled, 0 otherwise
13 pushEnabled int 1 if push notifications are enabled, 0 otherwise
14 esstBioUrl string esstBio partner URL
15 playStoreUrl string Google Play Store URL for the app
16 appleStoreUrl string Apple App Store URL for the app
17 whitelabelApiHostname string white-label API hostname if configured
18 b2b bool true if this shop operates as a B2B shop. As such,
  • prices are to be interpret as net value
  • vat is indication only
  • New and unknown customers should not see prices

Used in endpoints

Referenced in skills

Other versions